blob: d7616a6f1436b1130ed28e8aa6b87d12ab7367aa [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
Joe Perches0d7835f2015-02-13 14:38:35 -08003036# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08003037 if ($in_commit_log && !$commit_log_possible_stack_dump &&
John Hubbarda8972572020-04-06 20:10:55 -07003038 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07003039 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07003040 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07003041 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08003042 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
3043 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07003044 my $init_char = "c";
3045 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08003046 my $short = 1;
3047 my $long = 0;
3048 my $case = 1;
3049 my $space = 1;
3050 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08003051 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08003052 my $id = '0123456789ab';
3053 my $orig_desc = "commit description";
3054 my $description = "";
3055
Joe Perchesfe043ea2015-09-09 15:37:25 -07003056 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
3057 $init_char = $1;
3058 $orig_commit = lc($2);
3059 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
3060 $orig_commit = lc($1);
3061 }
3062
Joe Perches0d7835f2015-02-13 14:38:35 -08003063 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
3064 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
3065 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
3066 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
3067 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
3068 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003069 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08003070 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
3071 defined $rawlines[$linenr] &&
3072 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
3073 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003074 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08003075 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
3076 defined $rawlines[$linenr] &&
3077 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
3078 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
3079 $orig_desc = $1;
3080 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
3081 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08003082 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08003083 }
3084
3085 ($id, $description) = git_commit_info($orig_commit,
3086 $id, $orig_desc);
3087
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07003088 if (defined($id) &&
3089 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08003090 ERROR("GIT_COMMIT_ID",
3091 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
3092 }
Joe Perchesd311cd42014-08-06 16:10:57 -07003093 }
3094
Joe Perches13f19372014-08-06 16:10:59 -07003095# Check for added, moved or deleted files
3096 if (!$reported_maintainer_file && !$in_commit_log &&
3097 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
3098 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
3099 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
3100 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08003101 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07003102 $reported_maintainer_file = 1;
3103 WARN("FILE_PATH_CHANGES",
3104 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
3105 }
3106
Rob Herringe400edb2019-09-12 15:18:20 +01003107# Check for adding new DT bindings not in schema format
3108 if (!$in_commit_log &&
3109 ($line =~ /^new file mode\s*\d+\s*$/) &&
3110 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
3111 WARN("DT_SCHEMA_BINDING_PATCH",
3112 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
3113 }
3114
Andy Whitcroft00df3442007-06-08 13:47:06 -07003115# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08003116 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003117 ERROR("CORRUPTED_PATCH",
3118 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003119 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003120 }
3121
3122# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3123 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003124 $rawline !~ m/^$UTF8*$/) {
3125 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
3126
3127 my $blank = copy_spacing($rawline);
3128 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
3129 my $hereptr = "$hereline$ptr\n";
3130
Joe Perches34d99212011-07-25 17:13:26 -07003131 CHK("INVALID_UTF8",
3132 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003133 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003134
Joe Perches15662b32011-10-31 17:13:12 -07003135# Check if it's the start of a commit log
3136# (not a header line and we haven't seen the patch filename)
3137 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07003138 !($rawline =~ /^\s+(?:\S|$)/ ||
3139 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07003140 $in_header_lines = 0;
3141 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07003142 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07003143 }
3144
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07003145# Check if there is UTF-8 in a commit log when a mail header has explicitly
3146# declined it, i.e defined some charset where it is missing.
3147 if ($in_header_lines &&
3148 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
3149 $1 !~ /utf-8/i) {
3150 $non_utf8_charset = 1;
3151 }
3152
3153 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07003154 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07003155 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07003156 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
3157 }
3158
Joe Perchesd6430f72016-12-12 16:46:28 -08003159# Check for absolute kernel paths in commit message
3160 if ($tree && $in_commit_log) {
3161 while ($line =~ m{(?:^|\s)(/\S*)}g) {
3162 my $file = $1;
3163
3164 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
3165 check_absolute_file($1, $herecurr)) {
3166 #
3167 } else {
3168 check_absolute_file($file, $herecurr);
3169 }
3170 }
3171 }
3172
Kees Cook66b47b42014-10-13 15:51:57 -07003173# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07003174 if (defined($misspellings) &&
3175 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07003176 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07003177 my $typo = $1;
3178 my $typo_fix = $spelling_fix{lc($typo)};
3179 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
3180 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07003181 my $msg_level = \&WARN;
3182 $msg_level = \&CHK if ($file);
3183 if (&{$msg_level}("TYPO_SPELLING",
3184 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07003185 $fix) {
3186 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
3187 }
3188 }
3189 }
3190
Matteo Crocea8dd86b2019-09-25 16:46:38 -07003191# check for invalid commit id
3192 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
3193 my $id;
3194 my $description;
3195 ($id, $description) = git_commit_info($2, undef, undef);
3196 if (!defined($id)) {
3197 WARN("UNKNOWN_COMMIT_ID",
3198 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3199 }
3200 }
3201
Joe Perches310cd062020-10-15 20:11:52 -07003202# check for repeated words separated by a single space
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08003203# avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3204 if (($rawline =~ /^\+/ || $in_commit_log) &&
3205 $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) {
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003206 pos($rawline) = 1 if (!$in_commit_log);
Joe Perches310cd062020-10-15 20:11:52 -07003207 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3208
3209 my $first = $1;
3210 my $second = $2;
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003211 my $start_pos = $-[1];
3212 my $end_pos = $+[2];
Joe Perches310cd062020-10-15 20:11:52 -07003213 if ($first =~ /(?:struct|union|enum)/) {
3214 pos($rawline) += length($first) + length($second) + 1;
3215 next;
3216 }
3217
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003218 next if (lc($first) ne lc($second));
Joe Perches310cd062020-10-15 20:11:52 -07003219 next if ($first eq 'long');
3220
Dwaipayan Ray1db81a62020-12-15 20:44:20 -08003221 # check for character before and after the word matches
3222 my $start_char = '';
3223 my $end_char = '';
3224 $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1));
3225 $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline));
3226
3227 next if ($start_char =~ /^\S$/);
3228 next if (index(" \t.,;?!", $end_char) == -1);
3229
Aditya Srivastava8d0325c2020-12-15 20:44:24 -08003230 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3231 if ($first =~ /\b[0-9a-f]{2,}\b/i) {
3232 next if (!exists($allow_repeated_words{lc($first)}));
3233 }
3234
Joe Perches310cd062020-10-15 20:11:52 -07003235 if (WARN("REPEATED_WORD",
3236 "Possible repeated word: '$first'\n" . $herecurr) &&
3237 $fix) {
3238 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3239 }
3240 }
3241
3242 # if it's a repeated word on consecutive lines in a comment block
3243 if ($prevline =~ /$;+\s*$/ &&
3244 $prevrawline =~ /($word_pattern)\s*$/) {
3245 my $last_word = $1;
3246 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3247 if (WARN("REPEATED_WORD",
3248 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3249 $fix) {
3250 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3251 }
3252 }
3253 }
3254 }
3255
Andy Whitcroft306708542008-10-15 22:02:28 -07003256# ignore non-hunk lines and lines being removed
3257 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003258
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003259#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003260 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003261 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07003262 if (ERROR("DOS_LINE_ENDINGS",
3263 "DOS line endings\n" . $herevet) &&
3264 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003265 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003266 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003267 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3268 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003269 if (ERROR("TRAILING_WHITESPACE",
3270 "trailing whitespace\n" . $herevet) &&
3271 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003272 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07003273 }
3274
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003275 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003276 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07003277
Josh Triplett4783f892013-11-12 15:10:12 -08003278# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08003279 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08003280 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08003281 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3282 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08003283 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07003284 my $msg_level = \&ERROR;
3285 $msg_level = \&CHK if ($file);
3286 &{$msg_level}("FSF_MAILING_ADDRESS",
3287 "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 -08003288 }
3289
Andi Kleen33549572010-05-24 14:33:29 -07003290# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003291# Only applies when adding the entry originally, after that we do not have
3292# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07003293 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01003294 # 'choice' is usually the last thing on the line (though
3295 # Kconfig supports named choices), so use a word boundary
3296 # (\b) rather than a whitespace character (\s)
3297 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07003298 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003299 my $cnt = $realcnt;
3300 my $ln = $linenr + 1;
3301 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003302 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003303 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003304 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003305 $f = $lines[$ln - 1];
3306 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3307 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003308
3309 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07003310 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08003311
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01003312 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003313 $is_start = 1;
Masahiro Yamada22a4ac02020-06-17 12:02:20 +09003314 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003315 $length = -1;
3316 }
3317
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003318 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07003319 $f =~ s/#.*//;
3320 $f =~ s/^\s+//;
3321 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01003322
3323 # This only checks context lines in the patch
3324 # and so hopefully shouldn't trigger false
3325 # positives, even though some of these are
3326 # common words in help texts
3327 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3328 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003329 $is_end = 1;
3330 last;
3331 }
Andi Kleen33549572010-05-24 14:33:29 -07003332 $length++;
3333 }
Vadim Bendebury56193272014-10-13 15:51:48 -07003334 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3335 WARN("CONFIG_DESCRIPTION",
3336 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3337 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003338 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003339 }
3340
Joe Perches7ccf41a2020-06-04 16:50:33 -07003341# check MAINTAINERS entries
3342 if ($realfile =~ /^MAINTAINERS$/) {
3343# check MAINTAINERS entries for the right form
3344 if ($rawline =~ /^\+[A-Z]:/ &&
3345 $rawline !~ /^\+[A-Z]:\t\S/) {
3346 if (WARN("MAINTAINERS_STYLE",
3347 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3348 $fix) {
3349 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3350 }
3351 }
3352# check MAINTAINERS entries for the right ordering too
3353 my $preferred_order = 'MRLSWQBCPTFXNK';
3354 if ($rawline =~ /^\+[A-Z]:/ &&
3355 $prevrawline =~ /^[\+ ][A-Z]:/) {
3356 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3357 my $cur = $1;
3358 my $curval = $2;
3359 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3360 my $prev = $1;
3361 my $prevval = $2;
3362 my $curindex = index($preferred_order, $cur);
3363 my $previndex = index($preferred_order, $prev);
3364 if ($curindex < 0) {
3365 WARN("MAINTAINERS_STYLE",
3366 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3367 } else {
3368 if ($previndex >= 0 && $curindex < $previndex) {
3369 WARN("MAINTAINERS_STYLE",
3370 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3371 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3372 ($prev eq 'X' && $cur eq 'X')) &&
3373 ($prevval cmp $curval) > 0) {
3374 WARN("MAINTAINERS_STYLE",
3375 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3376 }
3377 }
Joe Perches628f91a2017-07-10 15:52:07 -07003378 }
3379 }
3380
Christoph Jaeger327953e2015-02-13 14:38:29 -08003381# discourage the use of boolean for type definition attributes of Kconfig options
3382 if ($realfile =~ /Kconfig/ &&
3383 $line =~ /^\+\s*\bboolean\b/) {
3384 WARN("CONFIG_TYPE_BOOLEAN",
3385 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3386 }
3387
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003388 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3389 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3390 my $flag = $1;
3391 my $replacement = {
3392 'EXTRA_AFLAGS' => 'asflags-y',
3393 'EXTRA_CFLAGS' => 'ccflags-y',
3394 'EXTRA_CPPFLAGS' => 'cppflags-y',
3395 'EXTRA_LDFLAGS' => 'ldflags-y',
3396 };
3397
3398 WARN("DEPRECATED_VARIABLE",
3399 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3400 }
3401
Rob Herringbff5da42014-01-23 15:54:51 -08003402# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003403 if (defined $root &&
3404 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3405 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3406
Rob Herringbff5da42014-01-23 15:54:51 -08003407 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3408
Florian Vaussardcc933192014-04-03 14:49:27 -07003409 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003410 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003411
Rob Herringbff5da42014-01-23 15:54:51 -08003412 foreach my $compat (@compats) {
3413 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003414 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3415 my $compat3 = $compat;
3416 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3417 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003418 if ( $? >> 8 ) {
3419 WARN("UNDOCUMENTED_DT_STRING",
3420 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3421 }
3422
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003423 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3424 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003425 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003426 if ( $? >> 8 ) {
3427 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003428 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003429 }
3430 }
3431 }
3432
Rob Herring9f3a8992018-04-10 16:33:13 -07003433# check for using SPDX license tag at beginning of files
3434 if ($realline == $checklicenseline) {
3435 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3436 $checklicenseline = 2;
3437 } elsif ($rawline =~ /^\+/) {
3438 my $comment = "";
3439 if ($realfile =~ /\.(h|s|S)$/) {
3440 $comment = '/*';
3441 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3442 $comment = '//';
Lubomir Rintelc8df0ab2020-04-06 20:10:51 -07003443 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003444 $comment = '#';
3445 } elsif ($realfile =~ /\.rst$/) {
3446 $comment = '..';
3447 }
3448
Joe Perchesfdf13692019-03-07 16:28:32 -08003449# check SPDX comment style for .[chsS] files
3450 if ($realfile =~ /\.[chsS]$/ &&
3451 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003452 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003453 WARN("SPDX_LICENSE_TAG",
3454 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3455 }
3456
Rob Herring9f3a8992018-04-10 16:33:13 -07003457 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003458 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3459 WARN("SPDX_LICENSE_TAG",
3460 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003461 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003462 my $spdx_license = $1;
3463 if (!is_SPDX_License_valid($spdx_license)) {
3464 WARN("SPDX_LICENSE_TAG",
3465 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3466 }
Lubomir Rintel50c92902020-04-06 20:11:13 -07003467 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3468 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3469 my $msg_level = \&WARN;
3470 $msg_level = \&CHK if ($file);
3471 if (&{$msg_level}("SPDX_LICENSE_TAG",
3472
3473 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3474 $fix) {
3475 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3476 }
3477 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003478 }
3479 }
3480 }
3481
Joe Perchesa0154cd2020-10-15 20:12:19 -07003482# check for embedded filenames
3483 if ($rawline =~ /^\+.*\Q$realfile\E/) {
3484 WARN("EMBEDDED_FILENAME",
3485 "It's generally not useful to have the filename in the file\n" . $herecurr);
3486 }
3487
Andy Whitcroft5368df202008-10-15 22:02:27 -07003488# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003489 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003490
Joe Perchesa8da38a2019-03-07 16:28:42 -08003491# check for using SPDX-License-Identifier on the wrong line number
3492 if ($realline != $checklicenseline &&
3493 $rawline =~ /\bSPDX-License-Identifier:/ &&
3494 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3495 WARN("SPDX_LICENSE_TAG",
3496 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3497 }
3498
Joe Perches47e0c882015-06-25 15:02:57 -07003499# line length limit (with some exclusions)
3500#
3501# There are a few types of lines that may extend beyond $max_line_length:
3502# logging functions like pr_info that end in a string
3503# lines with a single string
3504# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003505# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003506#
3507# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003508# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003509# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3510# LONG_LINE all other lines longer than $max_line_length
3511#
3512# if LONG_LINE is ignored, the other 2 types are also ignored
3513#
3514
Joe Perchesb4749e92015-07-17 16:24:01 -07003515 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003516 my $msg_type = "LONG_LINE";
3517
3518 # Check the allowed long line types first
3519
3520 # logging functions that end in a string that starts
3521 # before $max_line_length
3522 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3523 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3524 $msg_type = "";
3525
3526 # lines with only strings (w/ possible termination)
3527 # #defines with only strings
3528 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3529 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3530 $msg_type = "";
3531
Joe Perchescc147502017-11-17 15:28:44 -08003532 # More special cases
3533 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3534 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003535 $msg_type = "";
3536
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003537 # URL ($rawline is used in case the URL is in a comment)
3538 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3539 $msg_type = "";
3540
Joe Perches47e0c882015-06-25 15:02:57 -07003541 # Otherwise set the alternate message types
3542
3543 # a comment starts before $max_line_length
3544 } elsif ($line =~ /($;[\s$;]*)$/ &&
3545 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3546 $msg_type = "LONG_LINE_COMMENT"
3547
3548 # a quoted string starts before $max_line_length
3549 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3550 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3551 $msg_type = "LONG_LINE_STRING"
3552 }
3553
3554 if ($msg_type ne "" &&
3555 (show_type("LONG_LINE") || show_type($msg_type))) {
Joe Perchesbdc48fa2020-05-29 16:12:21 -07003556 my $msg_level = \&WARN;
3557 $msg_level = \&CHK if ($file);
3558 &{$msg_level}($msg_type,
3559 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
Joe Perches47e0c882015-06-25 15:02:57 -07003560 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003561 }
3562
Andy Whitcroft8905a672007-11-28 16:21:06 -08003563# check for adding lines without a newline.
3564 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Tom Rix47ca69b2020-12-15 20:44:40 -08003565 if (WARN("MISSING_EOF_NEWLINE",
3566 "adding a line without newline at end of file\n" . $herecurr) &&
3567 $fix) {
3568 fix_delete_line($fixlinenr+1, "No newline at end of file");
3569 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003570 }
3571
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003572# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003573 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003574
3575# at the beginning of a line any tabs must come first and anything
Antonio Borneo713a09d2020-04-06 20:11:07 -07003576# more than $tabsize must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003577 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3578 $rawline =~ /^\+\s* \s*/) {
3579 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003580 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003581 if (ERROR("CODE_INDENT",
3582 "code indent should use tabs where possible\n" . $herevet) &&
3583 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003584 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003585 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003586 }
3587
Alberto Panizzo08e44362010-03-05 13:43:54 -08003588# check for space before tabs.
3589 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3590 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003591 if (WARN("SPACE_BEFORE_TAB",
3592 "please, no space before tabs\n" . $herevet) &&
3593 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003594 while ($fixed[$fixlinenr] =~
Antonio Borneo713a09d2020-04-06 20:11:07 -07003595 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003596 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003597 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003598 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003599 }
3600
Joe Perches6a487212018-04-10 16:34:04 -07003601# check for assignments on the start of a line
3602 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
Aditya Srivastavada7355a2020-12-15 20:45:06 -08003603 my $operator = $1;
3604 if (CHK("ASSIGNMENT_CONTINUATIONS",
3605 "Assignment operator '$1' should be on the previous line\n" . $hereprev) &&
3606 $fix && $prevrawline =~ /^\+/) {
3607 # add assignment operator to the previous line, remove from current line
3608 $fixed[$fixlinenr - 1] .= " $operator";
3609 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3610 }
Joe Perches6a487212018-04-10 16:34:04 -07003611 }
3612
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003613# check for && or || at the start of a line
3614 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
Aditya Srivastava8e08f072020-12-15 20:45:09 -08003615 my $operator = $1;
3616 if (CHK("LOGICAL_CONTINUATIONS",
3617 "Logical continuations should be on the previous line\n" . $hereprev) &&
3618 $fix && $prevrawline =~ /^\+/) {
3619 # insert logical operator at last non-comment, non-whitepsace char on previous line
3620 $prevline =~ /[\s$;]*$/;
3621 my $line_end = substr($prevrawline, $-[0]);
3622 $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/;
3623 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//;
3624 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003625 }
3626
Joe Perchesa91e8992016-05-20 17:04:05 -07003627# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003628 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003629 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003630 my $indent = length($1);
Antonio Borneo713a09d2020-04-06 20:11:07 -07003631 if ($indent % $tabsize) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003632 if (WARN("TABSTOP",
3633 "Statements should start on a tabstop\n" . $herecurr) &&
3634 $fix) {
Antonio Borneo713a09d2020-04-06 20:11:07 -07003635 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
Joe Perchesa91e8992016-05-20 17:04:05 -07003636 }
3637 }
3638 }
3639
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003640# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003641 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003642 $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 -07003643 $prevline =~ /^\+(\t*)(.*)$/;
3644 my $oldindent = $1;
3645 my $rest = $2;
3646
3647 my $pos = pos_last_openparen($rest);
3648 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003649 $line =~ /^(\+| )([ \t]*)/;
3650 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003651
3652 my $goodtabindent = $oldindent .
Antonio Borneo713a09d2020-04-06 20:11:07 -07003653 "\t" x ($pos / $tabsize) .
3654 " " x ($pos % $tabsize);
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003655 my $goodspaceindent = $oldindent . " " x $pos;
3656
3657 if ($newindent ne $goodtabindent &&
3658 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003659
3660 if (CHK("PARENTHESIS_ALIGNMENT",
3661 "Alignment should match open parenthesis\n" . $hereprev) &&
3662 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003663 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003664 s/^\+[ \t]*/\+$goodtabindent/;
3665 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003666 }
3667 }
3668 }
3669
Joe Perches6ab3a972015-04-16 12:44:05 -07003670# check for space after cast like "(int) foo" or "(struct foo) bar"
3671# avoid checking a few false positives:
3672# "sizeof(<type>)" or "__alignof__(<type>)"
3673# function pointer declarations like "(*foo)(int) = bar;"
3674# structure definitions like "(struct foo) { 0 };"
3675# multiline macros that define functions
3676# known attributes or the __attribute__ keyword
3677 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3678 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003679 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003680 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003681 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003682 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003683 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003684 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003685 }
3686
Joe Perches86406b12015-09-09 15:37:41 -07003687# Block comment styles
3688# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003689 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003690 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003691 $rawline =~ /^\+[ \t]*\*/ &&
Łukasz Stelmachc70735c2020-10-15 20:12:25 -07003692 $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
Joe Perches05880602012-10-04 17:13:35 -07003693 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3694 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3695 }
3696
Joe Perches86406b12015-09-09 15:37:41 -07003697# Block comments use * on subsequent lines
3698 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3699 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003700 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003701 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003702 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003703 WARN("BLOCK_COMMENT_STYLE",
3704 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003705 }
3706
Joe Perches86406b12015-09-09 15:37:41 -07003707# Block comments use */ on trailing lines
3708 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003709 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3710 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3711 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003712 WARN("BLOCK_COMMENT_STYLE",
3713 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003714 }
3715
Joe Perches08eb9b82016-10-11 13:51:50 -07003716# Block comment * alignment
3717 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003718 $line =~ /^\+[ \t]*$;/ && #leading comment
3719 $rawline =~ /^\+[ \t]*\*/ && #leading *
3720 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003721 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003722 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3723 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003724 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003725 if (defined($1)) {
3726 $oldindent = expand_tabs($1);
3727 } else {
3728 $prevrawline =~ m@^\+(.*/?)\*@;
3729 $oldindent = expand_tabs($1);
3730 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003731 $rawline =~ m@^\+([ \t]*)\*@;
3732 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003733 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003734 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003735 WARN("BLOCK_COMMENT_STYLE",
3736 "Block comments should align the * on each line\n" . $hereprev);
3737 }
3738 }
3739
Joe Perches7f619192014-08-06 16:10:39 -07003740# check for missing blank lines after struct/union declarations
3741# with exceptions for various attributes and macros
3742 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3743 $line =~ /^\+/ &&
3744 !($line =~ /^\+\s*$/ ||
3745 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3746 $line =~ /^\+\s*MODULE_/i ||
3747 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3748 $line =~ /^\+[a-z_]*init/ ||
3749 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3750 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003751 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003752 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003753 if (CHK("LINE_SPACING",
3754 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3755 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003756 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003757 }
Joe Perches7f619192014-08-06 16:10:39 -07003758 }
3759
Joe Perches365dd4e2014-08-06 16:10:42 -07003760# check for multiple consecutive blank lines
3761 if ($prevline =~ /^[\+ ]\s*$/ &&
3762 $line =~ /^\+\s*$/ &&
3763 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003764 if (CHK("LINE_SPACING",
3765 "Please don't use multiple blank lines\n" . $hereprev) &&
3766 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003767 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003768 }
3769
Joe Perches365dd4e2014-08-06 16:10:42 -07003770 $last_blank_line = $linenr;
3771 }
3772
Joe Perches3b617e32014-04-03 14:49:28 -07003773# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003774 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3775 # actual declarations
3776 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003777 # function pointer declarations
3778 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003779 # foo bar; where foo is some local typedef or #define
3780 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3781 # known declaration macros
3782 $prevline =~ /^\+\s+$declaration_macros/) &&
3783 # for "else if" which can look like "$Ident $Ident"
3784 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3785 # other possible extensions of declaration lines
3786 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3787 # not starting a section or a macro "\" extended line
3788 $prevline =~ /(?:\{\s*|\\)$/) &&
3789 # looks like a declaration
3790 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003791 # function pointer declarations
3792 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003793 # foo bar; where foo is some local typedef or #define
3794 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3795 # known declaration macros
3796 $sline =~ /^\+\s+$declaration_macros/ ||
3797 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003798 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003799 # start or end of block or continuation of declaration
3800 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3801 # bitfield continuation
3802 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3803 # other possible extensions of declaration lines
3804 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3805 # indentation of previous and current line are the same
3806 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003807 if (WARN("LINE_SPACING",
3808 "Missing a blank line after declarations\n" . $hereprev) &&
3809 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003810 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003811 }
Joe Perches3b617e32014-04-03 14:49:28 -07003812 }
3813
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003814# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003815# Exceptions:
3816# 1) within comments
3817# 2) indented preprocessor commands
3818# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003819 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003820 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003821 if (WARN("LEADING_SPACE",
3822 "please, no spaces at the start of a line\n" . $herevet) &&
3823 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003824 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003825 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003826 }
3827
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003828# check we are in a valid C source file if not then ignore this hunk
3829 next if ($realfile !~ /\.(h|c)$/);
3830
Joe Perches5751a242017-11-17 15:28:52 -08003831# check for unusual line ending [ or (
3832 if ($line =~ /^\+.*([\[\(])\s*$/) {
3833 CHK("OPEN_ENDED_LINE",
3834 "Lines should not end with a '$1'\n" . $herecurr);
3835 }
3836
Joe Perches4dbed762017-05-08 15:55:39 -07003837# check if this appears to be the start function declaration, save the name
3838 if ($sline =~ /^\+\{\s*$/ &&
3839 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3840 $context_function = $1;
3841 }
3842
3843# check if this appears to be the end of function declaration
3844 if ($sline =~ /^\+\}\s*$/) {
3845 undef $context_function;
3846 }
3847
Joe Perches032a4c02014-08-06 16:10:29 -07003848# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003849# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003850# if the previous line is a break or return and is indented 1 tab more...
3851 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3852 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003853 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3854 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3855 defined $lines[$linenr] &&
3856 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003857 WARN("UNNECESSARY_ELSE",
3858 "else is not generally useful after a break or return\n" . $hereprev);
3859 }
3860 }
3861
Joe Perchesc00df192014-08-06 16:11:01 -07003862# check indentation of a line with a break;
Joe Perchesdc58bc52020-12-15 20:44:33 -08003863# if the previous line is a goto, return or break
3864# and is indented the same # of tabs
Joe Perchesc00df192014-08-06 16:11:01 -07003865 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3866 my $tabs = $1;
Joe Perchesdc58bc52020-12-15 20:44:33 -08003867 if ($prevline =~ /^\+$tabs(goto|return|break)\b/) {
3868 if (WARN("UNNECESSARY_BREAK",
3869 "break is not useful after a $1\n" . $hereprev) &&
3870 $fix) {
3871 fix_delete_line($fixlinenr, $rawline);
3872 }
Joe Perchesc00df192014-08-06 16:11:01 -07003873 }
3874 }
3875
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003876# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003877 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003878 WARN("CVS_KEYWORD",
3879 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003880 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003881
Joe Perches56e77d72013-02-21 16:44:14 -08003882# check for old HOTPLUG __dev<foo> section markings
3883 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3884 WARN("HOTPLUG_SECTION",
3885 "Using $1 is unnecessary\n" . $herecurr);
3886 }
3887
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003888# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003889 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3890 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003891#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003892 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003893 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003894 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003895 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003896 $stat =~ s/\n./\n /g;
3897 $cond =~ s/\n./\n /g;
3898
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003899#print "linenr<$linenr> <$stat>\n";
3900 # If this statement has no statement boundaries within
3901 # it there is no point in retrying a statement scan
3902 # until we hit end of it.
3903 my $frag = $stat; $frag =~ s/;+\s*$//;
3904 if ($frag !~ /(?:{|;)/) {
3905#print "skip<$line_nr_next>\n";
3906 $suppress_statement = $line_nr_next;
3907 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003908
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003909 # Find the real next line.
3910 $realline_next = $line_nr_next;
3911 if (defined $realline_next &&
3912 (!defined $lines[$realline_next - 1] ||
3913 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3914 $realline_next++;
3915 }
3916
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003917 my $s = $stat;
3918 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003919
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003920 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003921 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003922
3923 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003924 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003925
Andy Whitcroft463f2862009-09-21 17:04:34 -07003926 } elsif ($s =~ /^.\s*else\b/s) {
3927
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003928 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003929 } 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 -07003930 my $type = $1;
3931 $type =~ s/\s+/ /g;
3932 possible($type, "A:" . $s);
3933
Andy Whitcroft8905a672007-11-28 16:21:06 -08003934 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003935 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003936 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003937 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003938
3939 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003940 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003941 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003942 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003943
3944 # Check for any sort of function declaration.
3945 # int foo(something bar, other baz);
3946 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003947 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 -08003948 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003949
Andy Whitcroftcf655042008-03-04 14:28:20 -08003950 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003951 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003952 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003953
Andy Whitcroft8905a672007-11-28 16:21:06 -08003954 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003955 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003956
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003957 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003958 }
3959 }
3960 }
3961
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003962 }
3963
Andy Whitcroft653d4872007-06-23 17:16:34 -07003964#
3965# Checks which may be anchored in the context.
3966#
3967
3968# Check for switch () and associated case and default
3969# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003970 if ($line=~/\bswitch\s*\(.*\)/) {
3971 my $err = '';
3972 my $sep = '';
3973 my @ctx = ctx_block_outer($linenr, $realcnt);
3974 shift(@ctx);
3975 for my $ctx (@ctx) {
3976 my ($clen, $cindent) = line_stats($ctx);
3977 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3978 $indent != $cindent) {
3979 $err .= "$sep$ctx\n";
3980 $sep = '';
3981 } else {
3982 $sep = "[...]\n";
3983 }
3984 }
3985 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003986 ERROR("SWITCH_CASE_INDENT_LEVEL",
3987 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003988 }
3989 }
3990
3991# if/while/etc brace do not go on next line, unless defining a do while loop,
3992# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003993 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 -07003994 my $pre_ctx = "$1$2";
3995
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003996 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003997
3998 if ($line =~ /^\+\t{6,}/) {
3999 WARN("DEEP_INDENTATION",
4000 "Too many leading tabs - consider code refactoring\n" . $herecurr);
4001 }
4002
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004003 my $ctx_cnt = $realcnt - $#ctx - 1;
4004 my $ctx = join("\n", @ctx);
4005
Andy Whitcroft548596d2008-07-23 21:29:01 -07004006 my $ctx_ln = $linenr;
4007 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004008
Andy Whitcroft548596d2008-07-23 21:29:01 -07004009 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
4010 defined $lines[$ctx_ln - 1] &&
4011 $lines[$ctx_ln - 1] =~ /^-/)) {
4012 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4013 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004014 $ctx_ln++;
4015 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07004016
Andy Whitcroft53210162008-07-23 21:29:03 -07004017 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4018 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07004019
Joe Perchesd752fcc2014-08-06 16:11:05 -07004020 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004021 ERROR("OPEN_BRACE",
4022 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07004023 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07004024 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004025 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
4026 $ctx =~ /\)\s*\;\s*$/ &&
4027 defined $lines[$ctx_ln - 1])
4028 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004029 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
4030 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004031 WARN("TRAILING_SEMICOLON",
4032 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07004033 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004034 }
4035 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004036 }
4037
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004038# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07004039 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 -08004040 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4041 ctx_statement_block($linenr, $realcnt, 0)
4042 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004043 my ($s, $c) = ($stat, $cond);
4044
4045 substr($s, 0, length($c), '');
4046
Joe Perches9f5af482015-09-09 15:37:30 -07004047 # remove inline comments
4048 $s =~ s/$;/ /g;
4049 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004050
4051 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07004052 my @newlines = ($c =~ /\n/gs);
4053 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004054
Joe Perches9f5af482015-09-09 15:37:30 -07004055 # Make sure we remove the line prefixes as we have
4056 # none on the first line, and are going to readd them
4057 # where necessary.
4058 $s =~ s/\n./\n/gs;
4059 while ($s =~ /\n\s+\\\n/) {
4060 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
4061 }
4062
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004063 # We want to check the first line inside the block
4064 # starting at the end of the conditional, so remove:
4065 # 1) any blank line termination
4066 # 2) any opening brace { on end of the line
4067 # 3) any do (...) {
4068 my $continuation = 0;
4069 my $check = 0;
4070 $s =~ s/^.*\bdo\b//;
4071 $s =~ s/^\s*{//;
4072 if ($s =~ s/^\s*\\//) {
4073 $continuation = 1;
4074 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004075 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004076 $check = 1;
4077 $cond_lines++;
4078 }
4079
4080 # Also ignore a loop construct at the end of a
4081 # preprocessor statement.
4082 if (($prevline =~ /^.\s*#\s*define\s/ ||
4083 $prevline =~ /\\\s*$/) && $continuation == 0) {
4084 $check = 0;
4085 }
4086
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004087 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07004088 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004089 while ($cond_ptr != $cond_lines) {
4090 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004091
Andy Whitcroftf16fa282008-10-15 22:02:32 -07004092 # If we see an #else/#elif then the code
4093 # is not linear.
4094 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
4095 $check = 0;
4096 }
4097
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004098 # Ignore:
4099 # 1) blank lines, they should be at 0,
4100 # 2) preprocessor lines, and
4101 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07004102 if ($continuation ||
4103 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004104 $s =~ /^\s*#\s*?/ ||
4105 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07004106 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07004107 if ($s =~ s/^.*?\n//) {
4108 $cond_lines++;
4109 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004110 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004111 }
4112
4113 my (undef, $sindent) = line_stats("+" . $s);
4114 my $stat_real = raw_line($linenr, $cond_lines);
4115
4116 # Check if either of these lines are modified, else
4117 # this is not this patch's fault.
4118 if (!defined($stat_real) ||
4119 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
4120 $check = 0;
4121 }
4122 if (defined($stat_real) && $cond_lines > 1) {
4123 $stat_real = "[...]\n$stat_real";
4124 }
4125
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07004126 #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 -07004127
Joe Perches9f5af482015-09-09 15:37:30 -07004128 if ($check && $s ne '' &&
Antonio Borneo713a09d2020-04-06 20:11:07 -07004129 (($sindent % $tabsize) != 0 ||
Joe Perches9f5af482015-09-09 15:37:30 -07004130 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07004131 ($sindent == $indent &&
4132 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Antonio Borneo713a09d2020-04-06 20:11:07 -07004133 ($sindent > $indent + $tabsize))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004134 WARN("SUSPECT_CODE_INDENT",
4135 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07004136 }
4137 }
4138
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004139 # Track the 'values' across context and added lines.
4140 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004141 my ($curr_values, $curr_vars) =
4142 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004143 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004144 if ($dbg_values) {
4145 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004146 print "$linenr > .$outline\n";
4147 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004148 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004149 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004150 $prev_values = substr($curr_values, -1);
4151
Andy Whitcroft00df3442007-06-08 13:47:06 -07004152#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07004153 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07004154
Joe Perches99ca38c2020-10-15 20:12:09 -07004155# check for self assignments used to avoid compiler warnings
4156# e.g.: int foo = foo, *bar = NULL;
4157# struct foo bar = *(&(bar));
4158 if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
4159 my $var = $1;
4160 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4161 WARN("SELF_ASSIGNMENT",
4162 "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
4163 }
4164 }
4165
Joe Perches11ca40a2016-12-12 16:46:31 -08004166# check for dereferences that span multiple lines
4167 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
4168 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
4169 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
4170 my $ref = $1;
4171 $line =~ /^.\s*($Lval)/;
4172 $ref .= $1;
4173 $ref =~ s/\s//g;
4174 WARN("MULTILINE_DEREFERENCE",
4175 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
4176 }
4177
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004178# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07004179 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 -07004180 my $type = $1;
4181 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07004182 $var = "" if (!defined $var);
4183 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004184 my $sign = $1;
4185 my $pointer = $2;
4186
4187 $pointer = "" if (!defined $pointer);
4188
4189 if (WARN("UNSPECIFIED_INT",
4190 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4191 $fix) {
4192 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07004193 my $comp_pointer = $pointer;
4194 $comp_pointer =~ s/\s//g;
4195 $decl .= $comp_pointer;
4196 $decl = rtrim($decl) if ($var eq "");
4197 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07004198 }
4199 }
4200 }
4201
Andy Whitcroft653d4872007-06-23 17:16:34 -07004202# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07004203 if ($dbg_type) {
4204 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004205 ERROR("TEST_TYPE",
4206 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07004207 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004208 ERROR("TEST_NOT_TYPE",
4209 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07004210 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004211 next;
4212 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07004213# TEST: allow direct testing of the attribute matcher.
4214 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08004215 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004216 ERROR("TEST_ATTR",
4217 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08004218 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004219 ERROR("TEST_NOT_ATTR",
4220 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07004221 }
4222 next;
4223 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004224
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004225# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07004226 if ($line =~ /^.\s*{/ &&
4227 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07004228 if (ERROR("OPEN_BRACE",
4229 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004230 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4231 fix_delete_line($fixlinenr - 1, $prevrawline);
4232 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004233 my $fixedline = $prevrawline;
4234 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004235 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004236 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004237 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07004238 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004239 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004240 }
4241
Andy Whitcroft653d4872007-06-23 17:16:34 -07004242#
4243# Checks which are anchored on the added line.
4244#
4245
4246# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004247 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07004248 my $path = $1;
4249 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004250 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08004251 "malformed #include filename\n" . $herecurr);
4252 }
4253 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4254 ERROR("UAPI_INCLUDE",
4255 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004256 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004257 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004258
4259# no C99 // comments
4260 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07004261 if (ERROR("C99_COMMENTS",
4262 "do not use C99 // comments\n" . $herecurr) &&
4263 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004264 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07004265 if ($line =~ /\/\/(.*)$/) {
4266 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07004267 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07004268 }
4269 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004270 }
4271 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004272 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004273 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004274
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004275# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4276# the whole statement.
4277#print "APW <$lines[$realline_next - 1]>\n";
4278 if (defined $realline_next &&
4279 exists $lines[$realline_next - 1] &&
4280 !defined $suppress_export{$realline_next} &&
4281 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4282 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004283 # Handle definitions which produce identifiers with
4284 # a prefix:
4285 # XXX(foo);
4286 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004287 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08004288 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004289 $name =~ /^${Ident}_$2/) {
4290#print "FOO C name<$name>\n";
4291 $suppress_export{$realline_next} = 1;
4292
4293 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004294 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07004295 ^.DEFINE_$Ident\(\Q$name\E\)|
4296 ^.DECLARE_$Ident\(\Q$name\E\)|
4297 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004298 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4299 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07004300 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004301#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4302 $suppress_export{$realline_next} = 2;
4303 } else {
4304 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004305 }
4306 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004307 if (!defined $suppress_export{$linenr} &&
4308 $prevline =~ /^.\s*$/ &&
4309 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4310 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4311#print "FOO B <$lines[$linenr - 1]>\n";
4312 $suppress_export{$linenr} = 2;
4313 }
4314 if (defined $suppress_export{$linenr} &&
4315 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004316 WARN("EXPORT_SYMBOL",
4317 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004318 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004319
Joe Eloff5150bda2010-08-09 17:21:00 -07004320# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004321 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004322 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004323 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07004324 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004325 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004326 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004327 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004328# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004329 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004330 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004331 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07004332 $herecurr) &&
4333 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004334 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004335 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004336 }
4337
Joe Perches18130872014-08-06 16:11:22 -07004338# check for misordered declarations of char/short/int/long with signed/unsigned
4339 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4340 my $tmp = trim($1);
4341 WARN("MISORDERED_TYPE",
4342 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4343 }
4344
Joe Perches809e0822018-08-21 21:58:12 -07004345# check for unnecessary <signed> int declarations of short/long/long long
4346 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4347 my $type = trim($1);
4348 next if ($type !~ /\bint\b/);
4349 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4350 my $new_type = $type;
4351 $new_type =~ s/\b\s*int\s*\b/ /;
4352 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4353 $new_type =~ s/^const\s+//;
4354 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4355 $new_type = "const $new_type" if ($type =~ /^const\b/);
4356 $new_type =~ s/\s+/ /g;
4357 $new_type = trim($new_type);
4358 if (WARN("UNNECESSARY_INT",
4359 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4360 $fix) {
4361 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4362 }
4363 }
4364
Joe Perchescb710ec2010-10-26 14:23:20 -07004365# check for static const char * arrays.
4366 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004367 WARN("STATIC_CONST_CHAR_ARRAY",
4368 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004369 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004370 }
4371
4372# check for initialized const char arrays that should be static const
4373 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4374 if (WARN("STATIC_CONST_CHAR_ARRAY",
4375 "const array should probably be static const\n" . $herecurr) &&
4376 $fix) {
4377 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4378 }
4379 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004380
4381# check for static char foo[] = "bar" declarations.
4382 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004383 WARN("STATIC_CONST_CHAR_ARRAY",
4384 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004385 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004386 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004387
Joe Perchesab7e23f2015-04-16 12:44:22 -07004388# check for const <foo> const where <foo> is not a pointer or array type
4389 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4390 my $found = $1;
4391 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4392 WARN("CONST_CONST",
4393 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4394 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4395 WARN("CONST_CONST",
4396 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4397 }
4398 }
4399
Joe Perches73169762020-12-15 20:44:30 -08004400# check for const static or static <non ptr type> const declarations
4401# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4402 if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ ||
4403 $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) {
4404 if (WARN("STATIC_CONST",
4405 "Move const after static - use 'static const $1'\n" . $herecurr) &&
4406 $fix) {
4407 $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/;
4408 $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/;
4409 }
4410 }
4411
Joe Perches9b0fa602014-04-03 14:49:18 -07004412# check for non-global char *foo[] = {"bar", ...} declarations.
4413 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4414 WARN("STATIC_CONST_CHAR_ARRAY",
4415 "char * array declaration might be better as static const\n" .
4416 $herecurr);
4417 }
4418
Joe Perchesb598b672015-04-16 12:44:36 -07004419# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4420 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4421 my $array = $1;
4422 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4423 my $array_div = $1;
4424 if (WARN("ARRAY_SIZE",
4425 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4426 $fix) {
4427 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4428 }
4429 }
4430 }
4431
Joe Perchesb36190c2014-01-27 17:07:18 -08004432# check for function declarations without arguments like "int foo()"
Joe Perches16b7f3c2020-04-06 20:11:17 -07004433 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
Joe Perchesb36190c2014-01-27 17:07:18 -08004434 if (ERROR("FUNCTION_WITHOUT_ARGS",
4435 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4436 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004437 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004438 }
4439 }
4440
Andy Whitcroft653d4872007-06-23 17:16:34 -07004441# check for new typedefs, only function parameters and sparse annotations
4442# make sense.
4443 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004444 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004445 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004446 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004447 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004448 WARN("NEW_TYPEDEFS",
4449 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004450 }
4451
4452# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004453 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004454 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4455 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004456 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004457
Andy Whitcroft65863862009-01-06 14:41:21 -08004458 # Should start with a space.
4459 $to =~ s/^(\S)/ $1/;
4460 # Should not end with a space.
4461 $to =~ s/\s+$//;
4462 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004463 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004464 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004465
Joe Perches3705ce52013-07-03 15:05:31 -07004466## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004467 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004468 if (ERROR("POINTER_LOCATION",
4469 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4470 $fix) {
4471 my $sub_from = $ident;
4472 my $sub_to = $ident;
4473 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004474 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004475 s@\Q$sub_from\E@$sub_to@;
4476 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004477 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004478 }
4479 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4480 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004481 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004482
Andy Whitcroft65863862009-01-06 14:41:21 -08004483 # Should start with a space.
4484 $to =~ s/^(\S)/ $1/;
4485 # Should not end with a space.
4486 $to =~ s/\s+$//;
4487 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004488 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004489 }
4490 # Modifiers should have spaces.
4491 $to =~ s/(\b$Modifier$)/$1 /;
4492
Joe Perches3705ce52013-07-03 15:05:31 -07004493## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004494 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004495 if (ERROR("POINTER_LOCATION",
4496 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4497 $fix) {
4498
4499 my $sub_from = $match;
4500 my $sub_to = $match;
4501 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004502 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004503 s@\Q$sub_from\E@$sub_to@;
4504 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004505 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004506 }
4507
Joe Perches9d3e3c72015-09-09 15:37:27 -07004508# avoid BUG() or BUG_ON()
4509 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004510 my $msg_level = \&WARN;
4511 $msg_level = \&CHK if ($file);
4512 &{$msg_level}("AVOID_BUG",
4513 "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 -07004514 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004515
Joe Perches9d3e3c72015-09-09 15:37:27 -07004516# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004517 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004518 WARN("LINUX_VERSION_CODE",
4519 "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 -08004520 }
4521
Joe Perches17441222011-06-15 15:08:17 -07004522# check for uses of printk_ratelimit
4523 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004524 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004525 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004526 }
4527
Joe Percheseeef5732017-11-17 15:28:41 -08004528# printk should use KERN_* levels
4529 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4530 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4531 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004532 }
4533
Joe Perches243f3802012-05-31 16:26:09 -07004534 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4535 my $orig = $1;
4536 my $level = lc($orig);
4537 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004538 my $level2 = $level;
4539 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004540 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004541 "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 -07004542 }
4543
Joe Perchesdc139312013-02-21 16:44:13 -08004544 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4545 my $orig = $1;
4546 my $level = lc($orig);
4547 $level = "warn" if ($level eq "warning");
4548 $level = "dbg" if ($level eq "debug");
4549 WARN("PREFER_DEV_LEVEL",
4550 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4551 }
4552
Nicolas Boichat8020b252020-10-15 20:12:02 -07004553# trace_printk should not be used in production code.
4554 if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
4555 WARN("TRACE_PRINTK",
4556 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4557 }
4558
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004559# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4560# number of false positives, but assembly files are not checked, so at
4561# least the arch entry code will not trigger this warning.
4562 if ($line =~ /\bENOSYS\b/) {
4563 WARN("ENOSYS",
4564 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4565 }
4566
Jakub Kicinski6b9ea5f2020-05-11 10:08:07 -07004567# ENOTSUPP is not a standard error code and should be avoided in new patches.
4568# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4569# Similarly to ENOSYS warning a small number of false positives is expected.
4570 if (!$file && $line =~ /\bENOTSUPP\b/) {
4571 if (WARN("ENOTSUPP",
4572 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4573 $fix) {
4574 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4575 }
4576 }
4577
Andy Whitcroft653d4872007-06-23 17:16:34 -07004578# function brace can't be on same line, except for #defines of do while,
4579# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004580 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004581 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4582 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4583 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004584 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004585 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004586 $fix) {
4587 fix_delete_line($fixlinenr, $rawline);
4588 my $fixed_line = $rawline;
Dwaipayan Ray03f49352020-12-15 20:45:02 -08004589 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/;
Joe Perches8d182472014-08-06 16:11:12 -07004590 my $line1 = $1;
4591 my $line2 = $2;
4592 fix_insert_line($fixlinenr, ltrim($line1));
4593 fix_insert_line($fixlinenr, "\+{");
4594 if ($line2 !~ /^\s*$/) {
4595 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4596 }
4597 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004598 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004599
Andy Whitcroft8905a672007-11-28 16:21:06 -08004600# open braces for enum, union and struct go on the same line.
4601 if ($line =~ /^.\s*{/ &&
4602 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004603 if (ERROR("OPEN_BRACE",
4604 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4605 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4606 fix_delete_line($fixlinenr - 1, $prevrawline);
4607 fix_delete_line($fixlinenr, $rawline);
4608 my $fixedline = rtrim($prevrawline) . " {";
4609 fix_insert_line($fixlinenr, $fixedline);
4610 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004611 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004612 if ($fixedline !~ /^\+\s*$/) {
4613 fix_insert_line($fixlinenr, $fixedline);
4614 }
4615 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004616 }
4617
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004618# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004619 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4620 if (WARN("SPACING",
4621 "missing space after $1 definition\n" . $herecurr) &&
4622 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004623 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004624 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4625 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004626 }
4627
Joe Perches31070b52014-01-23 15:54:49 -08004628# Function pointer declarations
4629# check spacing between type, funcptr, and args
4630# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004631 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004632 my $declare = $1;
4633 my $pre_pointer_space = $2;
4634 my $post_pointer_space = $3;
4635 my $funcname = $4;
4636 my $post_funcname_space = $5;
4637 my $pre_args_space = $6;
4638
Joe Perches91f72e92014-04-03 14:49:12 -07004639# the $Declare variable will capture all spaces after the type
4640# so check it for a missing trailing missing space but pointer return types
4641# don't need a space so don't warn for those.
4642 my $post_declare_space = "";
4643 if ($declare =~ /(\s+)$/) {
4644 $post_declare_space = $1;
4645 $declare = rtrim($declare);
4646 }
4647 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004648 WARN("SPACING",
4649 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004650 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004651 }
4652
4653# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004654# This test is not currently implemented because these declarations are
4655# equivalent to
4656# int foo(int bar, ...)
4657# and this is form shouldn't/doesn't generate a checkpatch warning.
4658#
4659# elsif ($declare =~ /\s{2,}$/) {
4660# WARN("SPACING",
4661# "Multiple spaces after return type\n" . $herecurr);
4662# }
Joe Perches31070b52014-01-23 15:54:49 -08004663
4664# unnecessary space "type ( *funcptr)(args...)"
4665 if (defined $pre_pointer_space &&
4666 $pre_pointer_space =~ /^\s/) {
4667 WARN("SPACING",
4668 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4669 }
4670
4671# unnecessary space "type (* funcptr)(args...)"
4672 if (defined $post_pointer_space &&
4673 $post_pointer_space =~ /^\s/) {
4674 WARN("SPACING",
4675 "Unnecessary space before function pointer name\n" . $herecurr);
4676 }
4677
4678# unnecessary space "type (*funcptr )(args...)"
4679 if (defined $post_funcname_space &&
4680 $post_funcname_space =~ /^\s/) {
4681 WARN("SPACING",
4682 "Unnecessary space after function pointer name\n" . $herecurr);
4683 }
4684
4685# unnecessary space "type (*funcptr) (args...)"
4686 if (defined $pre_args_space &&
4687 $pre_args_space =~ /^\s/) {
4688 WARN("SPACING",
4689 "Unnecessary space before function pointer arguments\n" . $herecurr);
4690 }
4691
4692 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004693 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004694 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004695 }
4696 }
4697
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004698# check for spacing round square brackets; allowed:
4699# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004700# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4701# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004702 while ($line =~ /(.*?\s)\[/g) {
4703 my ($where, $prefix) = ($-[1], $1);
4704 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004705 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004706 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004707 if (ERROR("BRACKET_SPACE",
4708 "space prohibited before open square bracket '['\n" . $herecurr) &&
4709 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004710 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004711 s/^(\+.*?)\s+\[/$1\[/;
4712 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004713 }
4714 }
4715
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004716# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004717 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004718 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004719 my $ctx_before = substr($line, 0, $-[1]);
4720 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004721
4722 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004723 if ($name =~ /^(?:
4724 if|for|while|switch|return|case|
4725 volatile|__volatile__|
4726 __attribute__|format|__extension__|
4727 asm|__asm__)$/x)
4728 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004729 # cpp #define statements have non-optional spaces, ie
4730 # if there is a space between the name and the open
4731 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004732 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004733
4734 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004735 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004736
4737 # If this whole things ends with a type its most
4738 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004739 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004740
4741 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004742 if (WARN("SPACING",
4743 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4744 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004745 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004746 s/\b$name\s+\(/$name\(/;
4747 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004748 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004749 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004750
Andy Whitcroft653d4872007-06-23 17:16:34 -07004751# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004752 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004753 my $fixed_line = "";
4754 my $line_fixed = 0;
4755
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004756 my $ops = qr{
4757 <<=|>>=|<=|>=|==|!=|
4758 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4759 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004760 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004761 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004762 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004763 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004764
4765## print("element count: <" . $#elements . ">\n");
4766## foreach my $el (@elements) {
4767## print("el: <$el>\n");
4768## }
4769
4770 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004771 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004772
Joe Perches3705ce52013-07-03 15:05:31 -07004773 foreach my $el (@elements) {
4774 push(@fix_elements, substr($rawline, $off, length($el)));
4775 $off += length($el);
4776 }
4777
4778 $off = 0;
4779
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004780 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004781 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004782
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004783 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004784
4785 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4786
4787## print("n: <$n> good: <$good>\n");
4788
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004789 $off += length($elements[$n]);
4790
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004791 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004792 my $ca = substr($opline, 0, $off);
4793 my $cc = '';
4794 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4795 $cc = substr($opline, $off + length($elements[$n + 1]));
4796 }
4797 my $cb = "$ca$;$cc";
4798
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004799 my $a = '';
4800 $a = 'V' if ($elements[$n] ne '');
4801 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004802 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004803 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4804 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004805 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004806
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004807 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004808
4809 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004810 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004811 $c = 'V' if ($elements[$n + 2] ne '');
4812 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004813 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004814 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4815 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004816 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004817 } else {
4818 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004819 }
4820
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004821 my $ctx = "${a}x${c}";
4822
4823 my $at = "(ctx:$ctx)";
4824
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004825 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004826 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004827
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004828 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004829 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004830
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004831 # Get the full operator variant.
4832 my $opv = $op . substr($curr_vars, $off, 1);
4833
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004834 # Ignore operators passed as parameters.
4835 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004836 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004837
Andy Whitcroftcf655042008-03-04 14:28:20 -08004838# # Ignore comments
4839# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004840
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004841 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004842 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004843 if ($ctx !~ /.x[WEBC]/ &&
4844 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004845 if (ERROR("SPACING",
4846 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004847 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004848 $line_fixed = 1;
4849 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004850 }
4851
4852 # // is a comment
4853 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004854
Joe Perchesb00e4812014-04-03 14:49:33 -07004855 # : when part of a bitfield
4856 } elsif ($opv eq ':B') {
4857 # skip the bitfield test for now
4858
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004859 # No spaces for:
4860 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004861 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004862 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004863 if (ERROR("SPACING",
4864 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004865 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004866 if (defined $fix_elements[$n + 2]) {
4867 $fix_elements[$n + 2] =~ s/^\s+//;
4868 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004869 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004870 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004871 }
4872
Joe Perches23810972014-12-10 15:51:32 -08004873 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004874 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004875 my $rtrim_before = 0;
4876 my $space_after = 0;
4877 if ($ctx =~ /Wx./) {
4878 if (ERROR("SPACING",
4879 "space prohibited before that '$op' $at\n" . $hereptr)) {
4880 $line_fixed = 1;
4881 $rtrim_before = 1;
4882 }
4883 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004884 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004885 if (ERROR("SPACING",
4886 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004887 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004888 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004889 $space_after = 1;
4890 }
4891 }
4892 if ($rtrim_before || $space_after) {
4893 if ($rtrim_before) {
4894 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4895 } else {
4896 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4897 }
4898 if ($space_after) {
4899 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004900 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004901 }
4902
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004903 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004904 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004905 #warn "'*' is part of type\n";
4906
4907 # unary operators should have a space before and
4908 # none after. May be left adjacent to another
4909 # unary operator, or a cast
4910 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004911 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004912 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004913 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004914 if (ERROR("SPACING",
4915 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004916 if ($n != $last_after + 2) {
4917 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4918 $line_fixed = 1;
4919 }
Joe Perches3705ce52013-07-03 15:05:31 -07004920 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004921 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004922 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004923 # A unary '*' may be const
4924
4925 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004926 if (ERROR("SPACING",
4927 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004928 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004929 if (defined $fix_elements[$n + 2]) {
4930 $fix_elements[$n + 2] =~ s/^\s+//;
4931 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004932 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004933 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004934 }
4935
4936 # unary ++ and unary -- are allowed no space on one side.
4937 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004938 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004939 if (ERROR("SPACING",
4940 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004941 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004942 $line_fixed = 1;
4943 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004944 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004945 if ($ctx =~ /Wx[BE]/ ||
4946 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004947 if (ERROR("SPACING",
4948 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004949 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004950 $line_fixed = 1;
4951 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004952 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004953 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004954 if (ERROR("SPACING",
4955 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004956 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004957 if (defined $fix_elements[$n + 2]) {
4958 $fix_elements[$n + 2] =~ s/^\s+//;
4959 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004960 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004961 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004962 }
4963
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004964 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004965 } elsif ($op eq '<<' or $op eq '>>' or
4966 $op eq '&' or $op eq '^' or $op eq '|' or
4967 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004968 $op eq '*' or $op eq '/' or
4969 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004970 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004971 if ($check) {
4972 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4973 if (CHK("SPACING",
4974 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4975 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4976 $fix_elements[$n + 2] =~ s/^\s+//;
4977 $line_fixed = 1;
4978 }
4979 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4980 if (CHK("SPACING",
4981 "space preferred before that '$op' $at\n" . $hereptr)) {
4982 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4983 $line_fixed = 1;
4984 }
4985 }
4986 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004987 if (ERROR("SPACING",
4988 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004989 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4990 if (defined $fix_elements[$n + 2]) {
4991 $fix_elements[$n + 2] =~ s/^\s+//;
4992 }
Joe Perches3705ce52013-07-03 15:05:31 -07004993 $line_fixed = 1;
4994 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004995 }
4996
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004997 # A colon needs no spaces before when it is
4998 # terminating a case value or a label.
4999 } elsif ($opv eq ':C' || $opv eq ':L') {
5000 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07005001 if (ERROR("SPACING",
5002 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005003 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005004 $line_fixed = 1;
5005 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005006 }
5007
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005008 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08005009 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005010 my $ok = 0;
5011
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005012 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005013 if (($op eq '<' &&
5014 $cc =~ /^\S+\@\S+>/) ||
5015 ($op eq '>' &&
5016 $ca =~ /<\S+\@\S+$/))
5017 {
Antonio Borneo342d3d22020-04-06 20:11:01 -07005018 $ok = 1;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005019 }
5020
Joe Perchese0df7e12015-04-16 12:44:53 -07005021 # for asm volatile statements
5022 # ignore a colon with another
5023 # colon immediately before or after
5024 if (($op eq ':') &&
5025 ($ca =~ /:$/ || $cc =~ /^:/)) {
5026 $ok = 1;
5027 }
5028
Joe Perches84731622013-11-12 15:10:05 -08005029 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07005030 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07005031 my $msg_level = \&ERROR;
5032 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08005033
Jean Delvare0675a8f2017-09-08 16:16:07 -07005034 if (&{$msg_level}("SPACING",
5035 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07005036 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
5037 if (defined $fix_elements[$n + 2]) {
5038 $fix_elements[$n + 2] =~ s/^\s+//;
5039 }
Joe Perches3705ce52013-07-03 15:05:31 -07005040 $line_fixed = 1;
5041 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005042 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005043 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005044 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07005045
5046## print("n: <$n> GOOD: <$good>\n");
5047
5048 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005049 }
Joe Perches3705ce52013-07-03 15:05:31 -07005050
5051 if (($#elements % 2) == 0) {
5052 $fixed_line = $fixed_line . $fix_elements[$#elements];
5053 }
5054
Joe Perches194f66f2014-08-06 16:11:03 -07005055 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
5056 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07005057 }
5058
5059
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005060 }
5061
Joe Perches786b6322013-07-03 15:05:32 -07005062# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08005063 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07005064 if (WARN("SPACING",
5065 "space prohibited before semicolon\n" . $herecurr) &&
5066 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005067 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07005068 s/^(\+.*\S)\s+;/$1;/;
5069 }
5070 }
5071
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005072# check for multiple assignments
5073 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005074 CHK("MULTIPLE_ASSIGNMENTS",
5075 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005076 }
5077
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005078## # check for multiple declarations, allowing for a function declaration
5079## # continuation.
5080## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5081## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5082##
5083## # Remove any bracketed sections to ensure we do not
Dwaipayan Raye73d2712020-12-15 20:44:56 -08005084## # falsely report the parameters of functions.
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005085## my $ln = $line;
5086## while ($ln =~ s/\([^\(\)]*\)//g) {
5087## }
5088## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005089## WARN("MULTIPLE_DECLARATION",
5090## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005091## }
5092## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005093
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005094#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07005095 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07005096 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005097 if (ERROR("SPACING",
5098 "space required before the open brace '{'\n" . $herecurr) &&
5099 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07005100 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07005101 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005102 }
5103
Joe Perchesc4a62ef2013-07-03 15:05:28 -07005104## # check for blank lines before declarations
5105## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5106## $prevrawline =~ /^.\s*$/) {
5107## WARN("SPACING",
5108## "No blank lines before declarations\n" . $hereprev);
5109## }
5110##
5111
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005112# closing brace should have a space following it when it has anything
5113# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07005114 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005115 if (ERROR("SPACING",
5116 "space required after that close brace '}'\n" . $herecurr) &&
5117 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005118 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07005119 s/}((?!(?:,|;|\)))\S)/} $1/;
5120 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005121 }
5122
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005123# check spacing on square brackets
5124 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005125 if (ERROR("SPACING",
5126 "space prohibited after that open square bracket '['\n" . $herecurr) &&
5127 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005128 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005129 s/\[\s+/\[/;
5130 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005131 }
5132 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005133 if (ERROR("SPACING",
5134 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
5135 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005136 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005137 s/\s+\]/\]/;
5138 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005139 }
5140
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005141# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005142 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
5143 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005144 if (ERROR("SPACING",
5145 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
5146 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005147 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005148 s/\(\s+/\(/;
5149 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005150 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005151 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005152 $line !~ /for\s*\(.*;\s+\)/ &&
5153 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005154 if (ERROR("SPACING",
5155 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
5156 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005157 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005158 s/\s+\)/\)/;
5159 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005160 }
5161
Joe Perchese2826fd2014-08-06 16:10:48 -07005162# check unnecessary parentheses around addressof/dereference single $Lvals
5163# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5164
5165 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08005166 my $var = $1;
5167 if (CHK("UNNECESSARY_PARENTHESES",
5168 "Unnecessary parentheses around $var\n" . $herecurr) &&
5169 $fix) {
5170 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
5171 }
5172 }
5173
5174# check for unnecessary parentheses around function pointer uses
5175# ie: (foo->bar)(); should be foo->bar();
5176# but not "if (foo->bar) (" to avoid some false positives
5177 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
5178 my $var = $2;
5179 if (CHK("UNNECESSARY_PARENTHESES",
5180 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
5181 $fix) {
5182 my $var2 = deparenthesize($var);
5183 $var2 =~ s/\s//g;
5184 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
5185 }
5186 }
Joe Perchese2826fd2014-08-06 16:10:48 -07005187
Joe Perches63b7c732017-09-08 16:16:01 -07005188# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08005189# when !drivers/staging or command-line uses --strict
5190 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07005191 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07005192 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
5193 my $if_stat = $1;
5194 my $test = substr($2, 1, -1);
5195 my $herectx;
5196 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5197 my $match = $1;
5198 # avoid parentheses around potential macro args
5199 next if ($match =~ /^\s*\w+\s*$/);
5200 if (!defined($herectx)) {
5201 $herectx = $here . "\n";
5202 my $cnt = statement_rawlines($if_stat);
5203 for (my $n = 0; $n < $cnt; $n++) {
5204 my $rl = raw_line($linenr, $n);
5205 $herectx .= $rl . "\n";
5206 last if $rl =~ /^[ \+].*\{/;
5207 }
5208 }
5209 CHK("UNNECESSARY_PARENTHESES",
5210 "Unnecessary parentheses around '$match'\n" . $herectx);
5211 }
5212 }
5213
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005214#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005215 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005216 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07005217 if (WARN("INDENTED_LABEL",
5218 "labels should not be indented\n" . $herecurr) &&
5219 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005220 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005221 s/^(.)\s+/$1/;
5222 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005223 }
5224
Joe Perches40873ab2020-10-15 20:11:56 -07005225# check if a statement with a comma should be two statements like:
5226# foo = bar(), /* comma should be semicolon */
5227# bar = baz();
5228 if (defined($stat) &&
5229 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5230 my $cnt = statement_rawlines($stat);
5231 my $herectx = get_stat_here($linenr, $cnt, $here);
5232 WARN("SUSPECT_COMMA_SEMICOLON",
5233 "Possible comma where semicolon could be used\n" . $herectx);
5234 }
5235
Joe Perches5b9553a2014-04-03 14:49:21 -07005236# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08005237 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005238 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07005239 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07005240 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
5241 my $value = $1;
5242 $value = deparenthesize($value);
5243 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
5244 ERROR("RETURN_PARENTHESES",
5245 "return is not a function, parentheses are not required\n" . $herecurr);
5246 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005247 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005248 ERROR("SPACING",
5249 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005250 }
5251 }
Joe Perches507e5142013-11-12 15:10:13 -08005252
Joe Perchesb43ae212014-06-23 13:22:07 -07005253# unnecessary return in a void function
5254# at end-of-function, with the previous line a single leading tab, then return;
5255# and the line before that not a goto label target like "out:"
5256 if ($sline =~ /^[ \+]}\s*$/ &&
5257 $prevline =~ /^\+\treturn\s*;\s*$/ &&
5258 $linenr >= 3 &&
5259 $lines[$linenr - 3] =~ /^[ +]/ &&
5260 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07005261 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07005262 "void function return statements are not generally useful\n" . $hereprev);
5263 }
Joe Perches9819cf22014-06-04 16:12:09 -07005264
Joe Perches189248d2014-01-23 15:54:47 -08005265# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07005266 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08005267 $line =~ /\bif\s*((?:\(\s*){2,})/) {
5268 my $openparens = $1;
5269 my $count = $openparens =~ tr@\(@\(@;
5270 my $msg = "";
5271 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5272 my $comp = $4; #Not $1 because of $LvalOrFunc
5273 $msg = " - maybe == should be = ?" if ($comp eq "==");
5274 WARN("UNNECESSARY_PARENTHESES",
5275 "Unnecessary parentheses$msg\n" . $herecurr);
5276 }
5277 }
5278
Joe Perchesc5595fa2015-09-09 15:37:58 -07005279# comparisons with a constant or upper case identifier on the left
5280# avoid cases like "foo + BAR < baz"
5281# only fix matches surrounded by parentheses to avoid incorrect
5282# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07005283 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005284 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5285 my $lead = $1;
5286 my $const = $2;
5287 my $comp = $3;
5288 my $to = $4;
5289 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07005290 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005291 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5292 WARN("CONSTANT_COMPARISON",
5293 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5294 $fix) {
5295 if ($comp eq "<") {
5296 $newcomp = ">";
5297 } elsif ($comp eq "<=") {
5298 $newcomp = ">=";
5299 } elsif ($comp eq ">") {
5300 $newcomp = "<";
5301 } elsif ($comp eq ">=") {
5302 $newcomp = "<=";
5303 }
5304 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5305 }
5306 }
5307
Joe Perchesf34e4a42015-04-16 12:44:19 -07005308# Return of what appears to be an errno should normally be negative
5309 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005310 my $name = $1;
5311 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07005312 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07005313 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005314 }
5315 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005316
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005317# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07005318 if ($line =~ /\b(if|while|for|switch)\(/) {
5319 if (ERROR("SPACING",
5320 "space required before the open parenthesis '('\n" . $herecurr) &&
5321 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005322 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005323 s/\b(if|while|for|switch)\(/$1 \(/;
5324 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005325 }
5326
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07005327# Check for illegal assignment in if conditional -- and check for trailing
5328# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005329 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08005330 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5331 ctx_statement_block($linenr, $realcnt, 0)
5332 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005333 my ($stat_next) = ctx_statement_block($line_nr_next,
5334 $remain_next, $off_next);
5335 $stat_next =~ s/\n./\n /g;
5336 ##print "stat<$stat> stat_next<$stat_next>\n";
5337
5338 if ($stat_next =~ /^\s*while\b/) {
5339 # If the statement carries leading newlines,
5340 # then count those as offsets.
5341 my ($whitespace) =
5342 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5343 my $offset =
5344 statement_rawlines($whitespace) - 1;
5345
5346 $suppress_whiletrailers{$line_nr_next +
5347 $offset} = 1;
5348 }
5349 }
5350 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08005351 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005352 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005353 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005354
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08005355 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches65b64b32020-08-11 18:35:10 -07005356 if (ERROR("ASSIGN_IN_IF",
5357 "do not use assignment in if condition\n" . $herecurr) &&
5358 $fix && $perl_version_ok) {
5359 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5360 my $space = $1;
5361 my $not = $2;
5362 my $statement = $3;
5363 my $assigned = $4;
5364 my $test = $8;
5365 my $against = $9;
5366 my $brace = $15;
5367 fix_delete_line($fixlinenr, $rawline);
5368 fix_insert_line($fixlinenr, "$space$statement;");
5369 my $newline = "${space}if (";
5370 $newline .= '!' if defined($not);
5371 $newline .= '(' if (defined $not && defined($test) && defined($against));
5372 $newline .= "$assigned";
5373 $newline .= " $test $against" if (defined($test) && defined($against));
5374 $newline .= ')' if (defined $not && defined($test) && defined($against));
5375 $newline .= ')';
5376 $newline .= " {" if (defined($brace));
5377 fix_insert_line($fixlinenr + 1, $newline);
5378 }
5379 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005380 }
5381
5382 # Find out what is on the end of the line after the
5383 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005384 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08005385 $s =~ s/\n.*//g;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005386 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07005387 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5388 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005389 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005390 # Find out how long the conditional actually is.
5391 my @newlines = ($c =~ /\n/gs);
5392 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005393 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005394
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005395 $stat_real = raw_line($linenr, $cond_lines)
5396 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005397 if (defined($stat_real) && $cond_lines > 1) {
5398 $stat_real = "[...]\n$stat_real";
5399 }
5400
Joe Perches000d1cc12011-07-25 17:13:25 -07005401 ERROR("TRAILING_STATEMENTS",
5402 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005403 }
5404 }
5405
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005406# Check for bitwise tests written as boolean
5407 if ($line =~ /
5408 (?:
5409 (?:\[|\(|\&\&|\|\|)
5410 \s*0[xX][0-9]+\s*
5411 (?:\&\&|\|\|)
5412 |
5413 (?:\&\&|\|\|)
5414 \s*0[xX][0-9]+\s*
5415 (?:\&\&|\|\||\)|\])
5416 )/x)
5417 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005418 WARN("HEXADECIMAL_BOOLEAN_TEST",
5419 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005420 }
5421
Andy Whitcroft8905a672007-11-28 16:21:06 -08005422# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005423 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5424 my $s = $1;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005425 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005426 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005427 ERROR("TRAILING_STATEMENTS",
5428 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005429 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005430 }
Andy Whitcroft39667782009-01-15 13:51:06 -08005431# if should not continue a brace
5432 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005433 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07005434 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08005435 $herecurr);
5436 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005437# case and default should not have general statements after them
5438 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5439 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07005440 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005441 \s*return\s+
5442 )/xg)
5443 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005444 ERROR("TRAILING_STATEMENTS",
5445 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005446 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005447
5448 # Check for }<nl>else {, these must be at the same
5449 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07005450 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5451 $previndent == $indent) {
5452 if (ERROR("ELSE_AFTER_BRACE",
5453 "else should follow close brace '}'\n" . $hereprev) &&
5454 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5455 fix_delete_line($fixlinenr - 1, $prevrawline);
5456 fix_delete_line($fixlinenr, $rawline);
5457 my $fixedline = $prevrawline;
5458 $fixedline =~ s/}\s*$//;
5459 if ($fixedline !~ /^\+\s*$/) {
5460 fix_insert_line($fixlinenr, $fixedline);
5461 }
5462 $fixedline = $rawline;
5463 $fixedline =~ s/^(.\s*)else/$1} else/;
5464 fix_insert_line($fixlinenr, $fixedline);
5465 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005466 }
5467
Joe Perches8b8856f2014-08-06 16:11:14 -07005468 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5469 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005470 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5471
5472 # Find out what is on the end of the line after the
5473 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005474 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005475 $s =~ s/\n.*//g;
5476
5477 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005478 if (ERROR("WHILE_AFTER_BRACE",
5479 "while should follow close brace '}'\n" . $hereprev) &&
5480 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5481 fix_delete_line($fixlinenr - 1, $prevrawline);
5482 fix_delete_line($fixlinenr, $rawline);
5483 my $fixedline = $prevrawline;
5484 my $trailing = $rawline;
5485 $trailing =~ s/^\+//;
5486 $trailing = trim($trailing);
5487 $fixedline =~ s/}\s*$/} $trailing/;
5488 fix_insert_line($fixlinenr, $fixedline);
5489 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005490 }
5491 }
5492
Joe Perches95e2c602013-07-03 15:05:20 -07005493#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005494 while ($line =~ m{($Constant|$Lval)}g) {
5495 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005496
Joe Perches95e2c602013-07-03 15:05:20 -07005497#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005498 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005499 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Łukasz Stelmach4104a202020-12-15 20:44:27 -08005500#Ignore some autogenerated defines and enum values
5501 $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005502#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005503 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perchesd439e6a2019-12-04 16:52:06 -08005504#Ignore SI style variants like nS, mV and dB
5505#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5506 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Julius Wernerf5123572014-12-10 15:51:54 -08005507#Ignore some three character SI units explicitly, like MiB and KHz
5508 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005509 while ($var =~ m{($Ident)}g) {
5510 my $word = $1;
5511 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005512 if ($check) {
5513 seed_camelcase_includes();
5514 if (!$file && !$camelcase_file_seeded) {
5515 seed_camelcase_file($realfile);
5516 $camelcase_file_seeded = 1;
5517 }
5518 }
Joe Perches7e781f62013-09-11 14:23:55 -07005519 if (!defined $camelcase{$word}) {
5520 $camelcase{$word} = 1;
5521 CHK("CAMELCASE",
5522 "Avoid CamelCase: <$word>\n" . $herecurr);
5523 }
Joe Perches34456862013-07-03 15:05:34 -07005524 }
Joe Perches323c1262012-12-17 16:02:07 -08005525 }
5526 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005527
5528#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005529 if ($line =~ /\#\s*define.*\\\s+$/) {
5530 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5531 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5532 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005533 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005534 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005535 }
5536
Fabian Frederick0e212e02015-04-16 12:44:25 -07005537# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5538# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005539 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005540 my $file = "$1.h";
5541 my $checkfile = "include/linux/$file";
5542 if (-f "$root/$checkfile" &&
5543 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005544 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005545 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005546 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5547 if ($asminclude > 0) {
5548 if ($realfile =~ m{^arch/}) {
5549 CHK("ARCH_INCLUDE_LINUX",
5550 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5551 } else {
5552 WARN("INCLUDE_LINUX",
5553 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5554 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005555 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005556 }
5557 }
5558
Andy Whitcroft653d4872007-06-23 17:16:34 -07005559# multi-statement macros should be enclosed in a do while loop, grab the
5560# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005561# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07005562 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5563 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005564 my $ln = $linenr;
5565 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005566 my ($off, $dstat, $dcond, $rest);
5567 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005568 my $has_flow_statement = 0;
5569 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005570 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005571 ctx_statement_block($linenr, $realcnt, 0);
5572 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005573 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005574 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005575
Joe Perches08a28432014-10-13 15:51:55 -07005576 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005577 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005578
Joe Perchesf59b64b2016-10-11 13:52:08 -07005579 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5580 my $define_args = $1;
5581 my $define_stmt = $dstat;
5582 my @def_args = ();
5583
5584 if (defined $define_args && $define_args ne "") {
5585 $define_args = substr($define_args, 1, length($define_args) - 2);
5586 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005587 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005588 @def_args = split(",", $define_args);
5589 }
5590
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005591 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005592 $dstat =~ s/\\\n.//g;
5593 $dstat =~ s/^\s*//s;
5594 $dstat =~ s/\s*$//s;
5595
5596 # Flatten any parentheses and braces
Dwaipayan Ray2e44e802020-10-15 20:12:22 -07005597 while ($dstat =~ s/\([^\(\)]*\)/1u/ ||
5598 $dstat =~ s/\{[^\{\}]*\}/1u/ ||
5599 $dstat =~ s/.\[[^\[\]]*\]/1u/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005600 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005601 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005602
Antonio Borneo342d3d22020-04-06 20:11:01 -07005603 # Flatten any obvious string concatenation.
Joe Perches33acb542015-06-25 15:02:54 -07005604 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5605 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005606 {
5607 }
5608
Joe Perches42e15292016-03-15 14:58:01 -07005609 # Make asm volatile uses seem like a generic function
5610 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5611
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005612 my $exceptions = qr{
5613 $Declare|
5614 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005615 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005616 DECLARE_PER_CPU|
5617 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005618 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005619 union|
5620 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005621 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005622 ^\"|\"$|
5623 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005624 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005625 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005626
5627 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005628 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005629 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005630
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005631 if ($dstat ne '' &&
5632 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5633 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005634 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005635 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005636 $dstat !~ /$exceptions/ &&
5637 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005638 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005639 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Dwaipayan Ray2e44e802020-10-15 20:12:22 -07005640 $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...}
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005641 $dstat !~ /^for\s*$Constant$/ && # for (...)
5642 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5643 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005644 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005645 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005646 {
Joe Perchese7955562017-05-08 15:55:48 -07005647 if ($dstat =~ /^\s*if\b/) {
5648 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5649 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5650 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005651 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5652 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5653 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005654 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005655 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005656 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005657
5658 }
Joe Perches52076492016-10-11 13:52:14 -07005659
5660 # Make $define_stmt single line, comment-free, etc
5661 my @stmt_array = split('\n', $define_stmt);
5662 my $first = 1;
5663 $define_stmt = "";
5664 foreach my $l (@stmt_array) {
5665 $l =~ s/\\$//;
5666 if ($first) {
5667 $define_stmt = $l;
5668 $first = 0;
5669 } elsif ($l =~ /^[\+ ]/) {
5670 $define_stmt .= substr($l, 1);
5671 }
5672 }
5673 $define_stmt =~ s/$;//g;
5674 $define_stmt =~ s/\s+/ /g;
5675 $define_stmt = trim($define_stmt);
5676
Joe Perchesf59b64b2016-10-11 13:52:08 -07005677# check if any macro arguments are reused (ignore '...' and 'type')
5678 foreach my $arg (@def_args) {
5679 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005680 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005681 my $tmp_stmt = $define_stmt;
Brendan Jackman6dba8242019-09-25 16:46:41 -07005682 $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 -07005683 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5684 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005685 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005686 if ($use_cnt > 1) {
5687 CHK("MACRO_ARG_REUSE",
5688 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005689 }
5690# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005691 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005692 ((defined($1) && $1 ne ',') ||
5693 (defined($2) && $2 ne ','))) {
5694 CHK("MACRO_ARG_PRECEDENCE",
5695 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005696 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005697 }
Joe Perches5023d342012-12-17 16:01:47 -08005698
Joe Perches08a28432014-10-13 15:51:55 -07005699# check for macros with flow control, but without ## concatenation
5700# ## concatenation is commonly a macro that defines a function so ignore those
5701 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005702 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005703 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005704
Joe Perches08a28432014-10-13 15:51:55 -07005705 WARN("MACRO_WITH_FLOW_CONTROL",
5706 "Macros with flow control statements should be avoided\n" . "$herectx");
5707 }
5708
Joe Perches481eb482012-12-17 16:01:56 -08005709# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005710
5711 } else {
5712 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005713 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5714 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005715 $line =~ /^\+.*\\$/) {
5716 WARN("LINE_CONTINUATIONS",
5717 "Avoid unnecessary line continuations\n" . $herecurr);
5718 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005719 }
5720
Joe Perchesb13edf72012-07-30 14:41:24 -07005721# do {} while (0) macro tests:
5722# single-statement macros do not need to be enclosed in do while (0) loop,
5723# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005724 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005725 $realfile !~ m@/vmlinux.lds.h$@ &&
5726 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5727 my $ln = $linenr;
5728 my $cnt = $realcnt;
5729 my ($off, $dstat, $dcond, $rest);
5730 my $ctx = '';
5731 ($dstat, $dcond, $ln, $cnt, $off) =
5732 ctx_statement_block($linenr, $realcnt, 0);
5733 $ctx = $dstat;
5734
5735 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005736 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005737
5738 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5739 my $stmts = $2;
5740 my $semis = $3;
5741
5742 $ctx =~ s/\n*$//;
5743 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005744 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005745
Joe Perchesac8e97f2012-08-21 16:15:53 -07005746 if (($stmts =~ tr/;/;/) == 1 &&
5747 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005748 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5749 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5750 }
5751 if (defined $semis && $semis ne "") {
5752 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5753 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5754 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005755 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5756 $ctx =~ s/\n*$//;
5757 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005758 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005759
5760 WARN("TRAILING_SEMICOLON",
5761 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005762 }
5763 }
5764
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005765# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005766 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5767 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005768 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005769 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005770 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5771 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005772 my @allowed = ();
5773 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005774 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005775 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005776 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005777 for my $chunk (@chunks) {
5778 my ($cond, $block) = @{$chunk};
5779
Andy Whitcroft773647a2008-03-28 14:15:58 -07005780 # If the condition carries leading newlines, then count those as offsets.
5781 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5782 my $offset = statement_rawlines($whitespace) - 1;
5783
Joe Perchesaad4f612012-03-23 15:02:19 -07005784 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005785 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5786
5787 # We have looked at and allowed this specific line.
5788 $suppress_ifbraces{$ln + $offset} = 1;
5789
5790 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005791 $ln += statement_rawlines($block) - 1;
5792
Andy Whitcroft773647a2008-03-28 14:15:58 -07005793 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005794
5795 $seen++ if ($block =~ /^\s*{/);
5796
Joe Perchesaad4f612012-03-23 15:02:19 -07005797 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005798 if (statement_lines($cond) > 1) {
5799 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005800 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005801 }
5802 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005803 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005804 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005805 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005806 if (statement_block_size($block) > 1) {
5807 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005808 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005809 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005810 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005811 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005812 if ($seen) {
5813 my $sum_allowed = 0;
5814 foreach (@allowed) {
5815 $sum_allowed += $_;
5816 }
5817 if ($sum_allowed == 0) {
5818 WARN("BRACES",
5819 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5820 } elsif ($sum_allowed != $allow &&
5821 $seen != $allow) {
5822 CHK("BRACES",
5823 "braces {} should be used on all arms of this statement\n" . $herectx);
5824 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005825 }
5826 }
5827 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005828 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005829 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005830 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005831
Andy Whitcroftcf655042008-03-04 14:28:20 -08005832 # Check the pre-context.
5833 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5834 #print "APW: ALLOWED: pre<$1>\n";
5835 $allowed = 1;
5836 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005837
5838 my ($level, $endln, @chunks) =
5839 ctx_statement_full($linenr, $realcnt, $-[0]);
5840
Andy Whitcroftcf655042008-03-04 14:28:20 -08005841 # Check the condition.
5842 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005843 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005844 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005845 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005846 }
5847 if (statement_lines($cond) > 1) {
5848 #print "APW: ALLOWED: cond<$cond>\n";
5849 $allowed = 1;
5850 }
5851 if ($block =~/\b(?:if|for|while)\b/) {
5852 #print "APW: ALLOWED: block<$block>\n";
5853 $allowed = 1;
5854 }
5855 if (statement_block_size($block) > 1) {
5856 #print "APW: ALLOWED: lines block<$block>\n";
5857 $allowed = 1;
5858 }
5859 # Check the post-context.
5860 if (defined $chunks[1]) {
5861 my ($cond, $block) = @{$chunks[1]};
5862 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005863 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005864 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005865 if ($block =~ /^\s*\{/) {
5866 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5867 $allowed = 1;
5868 }
5869 }
5870 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005871 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005872 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005873
Joe Perches000d1cc12011-07-25 17:13:25 -07005874 WARN("BRACES",
5875 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005876 }
5877 }
5878
Joe Perchese4c5bab2017-02-24 15:01:41 -08005879# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005880 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5881 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005882 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5883 }
5884
Joe Perches0979ae62012-12-17 16:01:59 -08005885# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005886 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005887 if (CHK("BRACES",
5888 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5889 $fix && $prevrawline =~ /^\+/) {
5890 fix_delete_line($fixlinenr - 1, $prevrawline);
5891 }
Joe Perches0979ae62012-12-17 16:01:59 -08005892 }
Joe Perches77b9a532013-07-03 15:05:29 -07005893 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005894 if (CHK("BRACES",
5895 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5896 $fix) {
5897 fix_delete_line($fixlinenr, $rawline);
5898 }
Joe Perches0979ae62012-12-17 16:01:59 -08005899 }
5900
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005901# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005902 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5903 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005904 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005905 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005906 }
5907
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005908# Check for user-visible strings broken across lines, which breaks the ability
5909# to grep for the string. Make exceptions when the previous string ends in a
5910# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5911# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005912 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005913 $prevline =~ /"\s*$/ &&
5914 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5915 if (WARN("SPLIT_STRING",
5916 "quoted string split across lines\n" . $hereprev) &&
5917 $fix &&
5918 $prevrawline =~ /^\+.*"\s*$/ &&
5919 $last_coalesced_string_linenr != $linenr - 1) {
5920 my $extracted_string = get_quoted_string($line, $rawline);
5921 my $comma_close = "";
5922 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5923 $comma_close = $1;
5924 }
5925
5926 fix_delete_line($fixlinenr - 1, $prevrawline);
5927 fix_delete_line($fixlinenr, $rawline);
5928 my $fixedline = $prevrawline;
5929 $fixedline =~ s/"\s*$//;
5930 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5931 fix_insert_line($fixlinenr - 1, $fixedline);
5932 $fixedline = $rawline;
5933 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5934 if ($fixedline !~ /\+\s*$/) {
5935 fix_insert_line($fixlinenr, $fixedline);
5936 }
5937 $last_coalesced_string_linenr = $linenr;
5938 }
5939 }
5940
5941# check for missing a space in a string concatenation
5942 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5943 WARN('MISSING_SPACE',
5944 "break quoted strings at a space character\n" . $hereprev);
5945 }
5946
Joe Perchese4b7d302017-05-08 15:55:51 -07005947# check for an embedded function name in a string when the function is known
5948# This does not work very well for -f --file checking as it depends on patch
5949# context providing the function name or a single line form for in-file
5950# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005951 if ($line =~ /^\+.*$String/ &&
5952 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005953 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5954 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005955 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005956 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005957 }
5958
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005959# check for spaces before a quoted newline
5960 if ($rawline =~ /^.*\".*\s\\n/) {
5961 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5962 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5963 $fix) {
5964 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5965 }
5966
5967 }
5968
Joe Perchesf17dba42014-10-13 15:51:51 -07005969# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005970 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5971 if (CHK("CONCATENATED_STRING",
5972 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5973 $fix) {
5974 while ($line =~ /($String)/g) {
5975 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5976 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5977 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5978 }
5979 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005980 }
5981
Joe Perches90ad30e2014-12-10 15:51:59 -08005982# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005983 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005984 if (WARN("STRING_FRAGMENTS",
5985 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5986 $fix) {
5987 while ($line =~ /($String)(?=\s*")/g) {
5988 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5989 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5990 }
5991 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005992 }
5993
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005994# check for non-standard and hex prefixed decimal printf formats
5995 my $show_L = 1; #don't show the same defect twice
5996 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005997 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005998 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005999 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006000 # check for %L
6001 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006002 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006003 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
6004 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006005 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08006006 # check for %Z
6007 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
6008 WARN("PRINTF_Z",
6009 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
6010 $show_Z = 0;
6011 }
6012 # check for 0x<decimal>
6013 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
6014 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07006015 "Prefixing 0x with decimal output is defective\n" . $herecurr);
6016 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006017 }
6018
6019# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08006020 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08006021 WARN("LINE_CONTINUATIONS",
6022 "Avoid line continuations in quoted strings\n" . $herecurr);
6023 }
6024
Andy Whitcroft00df3442007-06-08 13:47:06 -07006025# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006026 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07006027 WARN("IF_0",
6028 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
6029 }
6030
6031# warn about #if 1
6032 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
6033 WARN("IF_1",
6034 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006035 }
6036
Andy Whitcroft03df4b52012-12-17 16:01:52 -08006037# check for needless "if (<foo>) fn(<foo>)" uses
6038 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07006039 my $tested = quotemeta($1);
6040 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
6041 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6042 my $func = $1;
6043 if (WARN('NEEDLESS_IF',
6044 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
6045 $fix) {
6046 my $do_fix = 1;
6047 my $leading_tabs = "";
6048 my $new_leading_tabs = "";
6049 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
6050 $leading_tabs = $1;
6051 } else {
6052 $do_fix = 0;
6053 }
6054 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
6055 $new_leading_tabs = $1;
6056 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
6057 $do_fix = 0;
6058 }
6059 } else {
6060 $do_fix = 0;
6061 }
6062 if ($do_fix) {
6063 fix_delete_line($fixlinenr - 1, $prevrawline);
6064 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
6065 }
6066 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07006067 }
6068 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006069
Joe Perchesebfdc402014-08-06 16:10:27 -07006070# check for unnecessary "Out of Memory" messages
6071 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
6072 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
6073 (defined $1 || defined $3) &&
6074 $linenr > 3) {
6075 my $testval = $2;
6076 my $testline = $lines[$linenr - 3];
6077
6078 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
6079# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6080
Joe Perchese29a70f2019-03-07 16:28:35 -08006081 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6082 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07006083 WARN("OOM_MESSAGE",
6084 "Possible unnecessary 'out of memory' message\n" . $hereprev);
6085 }
6086 }
6087
Joe Perchesf78d98f2014-10-13 15:52:01 -07006088# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08006089 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07006090 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
6091 my $level = $1;
6092 if (WARN("UNNECESSARY_KERN_LEVEL",
6093 "Possible unnecessary $level\n" . $herecurr) &&
6094 $fix) {
6095 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
6096 }
6097 }
6098
Joe Perches45c55e92017-02-24 15:01:31 -08006099# check for logging continuations
6100 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
6101 WARN("LOGGING_CONTINUATION",
6102 "Avoid logging continuation uses where feasible\n" . $herecurr);
6103 }
6104
Joe Perchesabb08a52014-12-10 15:51:46 -08006105# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07006106 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08006107 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
6108 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
6109 WARN("MASK_THEN_SHIFT",
6110 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
6111 }
6112
Joe Perchesb75ac612014-12-10 15:52:02 -08006113# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07006114 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08006115 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
6116 my $val = $1;
6117 my $equal = "!";
6118 $equal = "" if ($4 eq "!=");
6119 if (CHK("COMPARISON_TO_NULL",
6120 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
6121 $fix) {
6122 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
6123 }
6124 }
6125 }
6126
Joe Perches8716de32013-09-11 14:24:05 -07006127# check for bad placement of section $InitAttribute (e.g.: __initdata)
6128 if ($line =~ /(\b$InitAttribute\b)/) {
6129 my $attr = $1;
6130 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6131 my $ptr = $1;
6132 my $var = $2;
6133 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
6134 ERROR("MISPLACED_INIT",
6135 "$attr should be placed after $var\n" . $herecurr)) ||
6136 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
6137 WARN("MISPLACED_INIT",
6138 "$attr should be placed after $var\n" . $herecurr))) &&
6139 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006140 $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 -07006141 }
6142 }
6143 }
6144
Joe Perchese970b8842013-11-12 15:10:10 -08006145# check for $InitAttributeData (ie: __initdata) with const
6146 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
6147 my $attr = $1;
6148 $attr =~ /($InitAttributePrefix)(.*)/;
6149 my $attr_prefix = $1;
6150 my $attr_type = $2;
6151 if (ERROR("INIT_ATTRIBUTE",
6152 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
6153 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006154 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08006155 s/$InitAttributeData/${attr_prefix}initconst/;
6156 }
6157 }
6158
6159# check for $InitAttributeConst (ie: __initconst) without const
6160 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
6161 my $attr = $1;
6162 if (ERROR("INIT_ATTRIBUTE",
6163 "Use of $attr requires a separate use of const\n" . $herecurr) &&
6164 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006165 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08006166 /(^\+\s*(?:static\s+))/;
6167 $lead = rtrim($1);
6168 $lead = "$lead " if ($lead !~ /^\+$/);
6169 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07006170 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08006171 }
6172 }
6173
Joe Perchesc17893c2015-04-16 12:44:42 -07006174# check for __read_mostly with const non-pointer (should just be const)
6175 if ($line =~ /\b__read_mostly\b/ &&
6176 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
6177 if (ERROR("CONST_READ_MOSTLY",
6178 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
6179 $fix) {
6180 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
6181 }
6182 }
6183
Joe Perchesfbdb8132014-04-03 14:49:14 -07006184# don't use __constant_<foo> functions outside of include/uapi/
6185 if ($realfile !~ m@^include/uapi/@ &&
6186 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6187 my $constant_func = $1;
6188 my $func = $constant_func;
6189 $func =~ s/^__constant_//;
6190 if (WARN("CONSTANT_CONVERSION",
6191 "$constant_func should be $func\n" . $herecurr) &&
6192 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006193 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07006194 }
6195 }
6196
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006197# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08006198 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07006199 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006200 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07006201 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006202 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006203 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07006204 }
6205 if ($delay > 2000) {
6206 WARN("LONG_UDELAY",
6207 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07006208 }
6209 }
6210
Patrick Pannuto09ef8722010-08-09 17:21:02 -07006211# warn about unexpectedly long msleep's
6212 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
6213 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006214 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006215 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07006216 }
6217 }
6218
Joe Perches36ec1932013-07-03 15:05:25 -07006219# check for comparisons of jiffies
6220 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
6221 WARN("JIFFIES_COMPARISON",
6222 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6223 }
6224
Joe Perches9d7a34a2013-07-03 15:05:26 -07006225# check for comparisons of get_jiffies_64()
6226 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
6227 WARN("JIFFIES_COMPARISON",
6228 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6229 }
6230
Andy Whitcroft00df3442007-06-08 13:47:06 -07006231# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006232# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07006233# print "#ifdef in C files should be avoided\n";
6234# print "$herecurr";
6235# $clean = 0;
6236# }
6237
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07006238# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006239 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07006240 if (ERROR("SPACING",
6241 "exactly one space required after that #$1\n" . $herecurr) &&
6242 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006243 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07006244 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
6245 }
6246
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07006247 }
6248
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006249# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006250 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
6251 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006252 my $which = $1;
6253 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006254 CHK("UNCOMMENTED_DEFINITION",
6255 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006256 }
6257 }
6258# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006259
6260 my $barriers = qr{
6261 mb|
6262 rmb|
Will Deaconad83ec62019-11-07 14:49:00 +00006263 wmb
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006264 }x;
6265 my $barrier_stems = qr{
6266 mb__before_atomic|
6267 mb__after_atomic|
6268 store_release|
6269 load_acquire|
6270 store_mb|
6271 (?:$barriers)
6272 }x;
6273 my $all_barriers = qr{
6274 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02006275 smp_(?:$barrier_stems)|
6276 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006277 }x;
6278
6279 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006280 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08006281 WARN("MEMORY_BARRIER",
6282 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006283 }
6284 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006285
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02006286 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6287
6288 if ($realfile !~ m@^include/asm-generic/@ &&
6289 $realfile !~ m@/barrier\.h$@ &&
6290 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6291 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6292 WARN("MEMORY_BARRIER",
6293 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6294 }
6295
Joe Perchescb426e92015-06-25 15:02:46 -07006296# check for waitqueue_active without a comment.
6297 if ($line =~ /\bwaitqueue_active\s*\(/) {
6298 if (!ctx_has_comment($first_line, $linenr)) {
6299 WARN("WAITQUEUE_ACTIVE",
6300 "waitqueue_active without comment\n" . $herecurr);
6301 }
6302 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006303
Marco Elver5099a722020-04-01 12:17:14 +02006304# check for data_race without a comment.
6305 if ($line =~ /\bdata_race\s*\(/) {
6306 if (!ctx_has_comment($first_line, $linenr)) {
6307 WARN("DATA_RACE",
6308 "data_race without comment\n" . $herecurr);
6309 }
6310 }
6311
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006312# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006313 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006314 CHK("ARCH_DEFINES",
6315 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006316 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006317
Joe Perches596ed452017-07-12 14:37:02 -07006318# check that the storage class is not after a type
6319 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006320 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07006321 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6322 }
6323# Check that the storage class is at the beginning of a declaration
6324 if ($line =~ /\b$Storage\b/ &&
6325 $line !~ /^.\s*$Storage/ &&
6326 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6327 $1 !~ /[\,\)]\s*$/) {
6328 WARN("STORAGE_CLASS",
6329 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07006330 }
6331
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006332# check the location of the inline attribute, that it is between
6333# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006334 if ($line =~ /\b$Type\s+$Inline\b/ ||
6335 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006336 ERROR("INLINE_LOCATION",
6337 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006338 }
6339
Andy Whitcroft8905a672007-11-28 16:21:06 -08006340# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08006341 if ($realfile !~ m@\binclude/uapi/@ &&
6342 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006343 if (WARN("INLINE",
6344 "plain inline is preferred over $1\n" . $herecurr) &&
6345 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006346 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006347
6348 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006349 }
6350
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006351# Check for compiler attributes
Joe Perches2b7ab452013-11-12 15:10:14 -08006352 if ($realfile !~ m@\binclude/uapi/@ &&
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006353 $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) {
6354 my $attr = $1;
6355 $attr =~ s/\s*\(\s*(.*)\)\s*/$1/;
Joe Perches3d130fd2011-01-12 17:00:00 -08006356
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006357 my %attr_list = (
Joe Perches0830aab2020-12-15 20:44:50 -08006358 "alias" => "__alias",
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006359 "aligned" => "__aligned",
6360 "always_inline" => "__always_inline",
6361 "assume_aligned" => "__assume_aligned",
6362 "cold" => "__cold",
6363 "const" => "__attribute_const__",
6364 "copy" => "__copy",
6365 "designated_init" => "__designated_init",
6366 "externally_visible" => "__visible",
6367 "format" => "printf|scanf",
6368 "gnu_inline" => "__gnu_inline",
6369 "malloc" => "__malloc",
6370 "mode" => "__mode",
6371 "no_caller_saved_registers" => "__no_caller_saved_registers",
6372 "noclone" => "__noclone",
6373 "noinline" => "noinline",
6374 "nonstring" => "__nonstring",
6375 "noreturn" => "__noreturn",
6376 "packed" => "__packed",
6377 "pure" => "__pure",
Joe Perches339f29d2020-12-15 20:44:43 -08006378 "section" => "__section",
Joe Perches0830aab2020-12-15 20:44:50 -08006379 "used" => "__used",
6380 "weak" => "__weak"
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006381 );
Joe Perches39b7e282011-07-25 17:13:24 -07006382
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006383 while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) {
Joe Perches339f29d2020-12-15 20:44:43 -08006384 my $orig_attr = $1;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006385 my $params = '';
6386 $params = $2 if defined($2);
Joe Perches339f29d2020-12-15 20:44:43 -08006387 my $curr_attr = $orig_attr;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006388 $curr_attr =~ s/^[\s_]+|[\s_]+$//g;
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006389 if (exists($attr_list{$curr_attr})) {
Joe Perches339f29d2020-12-15 20:44:43 -08006390 my $new = $attr_list{$curr_attr};
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006391 if ($curr_attr eq "format" && $params) {
6392 $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/;
Joe Perches339f29d2020-12-15 20:44:43 -08006393 $new = "__$1\($2";
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006394 } else {
Joe Perches339f29d2020-12-15 20:44:43 -08006395 $new = "$new$params";
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006396 }
Joe Perches339f29d2020-12-15 20:44:43 -08006397 if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6398 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) &&
6399 $fix) {
6400 my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?';
6401 $fixed[$fixlinenr] =~ s/$remove//;
6402 $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/;
6403 $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/;
6404 $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//;
6405 }
Dwaipayan Ray7ebe1d12020-12-15 20:44:36 -08006406 }
6407 }
6408
6409 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6410 if ($attr =~ /^_*unused/) {
6411 WARN("PREFER_DEFINED_ATTRIBUTE_MACRO",
6412 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
Joe Perchesd5e616f2013-09-11 14:23:54 -07006413 }
Joe Perches6061d942012-03-23 15:02:16 -07006414 }
6415
Joe Perches619a9082014-12-10 15:51:35 -08006416# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07006417 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08006418 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6419 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6420 $line =~ /\b__weak\b/)) {
6421 ERROR("WEAK_DECLARATION",
6422 "Using weak declarations can have unintended link defects\n" . $herecurr);
6423 }
6424
Tomas Winklerfd39f902016-12-12 16:46:34 -08006425# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07006426 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08006427 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07006428 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6429 my $type = $1;
6430 if ($type =~ /\b($typeC99Typedefs)\b/) {
6431 $type = $1;
6432 my $kernel_type = 'u';
6433 $kernel_type = 's' if ($type =~ /^_*[si]/);
6434 $type =~ /(\d+)/;
6435 $kernel_type .= $1;
6436 if (CHK("PREFER_KERNEL_TYPES",
6437 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6438 $fix) {
6439 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6440 }
6441 }
6442 }
6443
Joe Perches938224b2016-01-20 14:59:15 -08006444# check for cast of C90 native int or longer types constants
6445 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6446 my $cast = $1;
6447 my $const = $2;
6448 if (WARN("TYPECAST_INT_CONSTANT",
6449 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6450 $fix) {
6451 my $suffix = "";
6452 my $newconst = $const;
6453 $newconst =~ s/${Int_type}$//;
6454 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6455 if ($cast =~ /\blong\s+long\b/) {
6456 $suffix .= 'LL';
6457 } elsif ($cast =~ /\blong\b/) {
6458 $suffix .= 'L';
6459 }
6460 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6461 }
6462 }
6463
Joe Perches8f53a9b2010-03-05 13:43:48 -08006464# check for sizeof(&)
6465 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006466 WARN("SIZEOF_ADDRESS",
6467 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08006468 }
6469
Joe Perches66c80b62012-07-30 14:41:22 -07006470# check for sizeof without parenthesis
6471 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006472 if (WARN("SIZEOF_PARENTHESIS",
6473 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6474 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006475 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006476 }
Joe Perches66c80b62012-07-30 14:41:22 -07006477 }
6478
Joe Perches88982fe2012-12-17 16:02:00 -08006479# check for struct spinlock declarations
6480 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6481 WARN("USE_SPINLOCK_T",
6482 "struct spinlock should be spinlock_t\n" . $herecurr);
6483 }
6484
Joe Perchesa6962d72013-04-29 16:18:13 -07006485# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006486 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006487 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006488 $fmt =~ s/%%//g;
6489 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006490 if (WARN("PREFER_SEQ_PUTS",
6491 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6492 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006493 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006494 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006495 }
6496 }
6497
Joe Perches478b1792018-04-10 16:33:34 -07006498# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006499 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006500 defined $stat &&
6501 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6502 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006503 my $stat_real;
6504
Joe Perches0b523762017-05-08 15:55:36 -07006505 my $lc = $stat =~ tr@\n@@;
6506 $lc = $lc + $linenr;
6507 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006508 my $specifier;
6509 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006510 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006511 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006512 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6513 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006514
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006515 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006516 $specifier = $1;
6517 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006518 $qualifier = $3;
Linus Torvalds361b0d22019-11-26 19:45:12 -08006519 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006520 ($extension eq "f" &&
6521 defined $qualifier && $qualifier !~ /^w/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006522 $bad_specifier = $specifier;
6523 last;
6524 }
6525 if ($extension eq "x" && !defined($stat_real)) {
6526 if (!defined($stat_real)) {
6527 $stat_real = get_stat_real($linenr, $lc);
6528 }
6529 WARN("VSPRINTF_SPECIFIER_PX",
6530 "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");
6531 }
6532 }
6533 if ($bad_specifier ne "") {
6534 my $stat_real = get_stat_real($linenr, $lc);
6535 my $ext_type = "Invalid";
6536 my $use = "";
6537 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006538 $use = " - use %pS instead";
6539 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6540 }
6541
6542 WARN("VSPRINTF_POINTER_EXTENSION",
6543 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6544 }
Joe Perches0b523762017-05-08 15:55:36 -07006545 }
6546 }
6547
Andy Whitcroft554e1652012-01-10 15:09:57 -08006548# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006549 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006550 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006551 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006552
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006553 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006554 my $ms_val = $7;
6555 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006556
Andy Whitcroft554e1652012-01-10 15:09:57 -08006557 if ($ms_size =~ /^(0x|)0$/i) {
6558 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006559 "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 -08006560 } elsif ($ms_size =~ /^(0x|)1$/i) {
6561 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006562 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6563 }
6564 }
6565
Joe Perches98a9bba2014-01-23 15:54:52 -08006566# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006567# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006568# defined $stat &&
6569# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6570# if (WARN("PREFER_ETHER_ADDR_COPY",
6571# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6572# $fix) {
6573# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6574# }
6575# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006576
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006577# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006578# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006579# defined $stat &&
6580# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6581# WARN("PREFER_ETHER_ADDR_EQUAL",
6582# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6583# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006584
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006585# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6586# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006587# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006588# defined $stat &&
6589# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6590#
6591# my $ms_val = $7;
6592#
6593# if ($ms_val =~ /^(?:0x|)0+$/i) {
6594# if (WARN("PREFER_ETH_ZERO_ADDR",
6595# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6596# $fix) {
6597# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6598# }
6599# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6600# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6601# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6602# $fix) {
6603# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6604# }
6605# }
6606# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006607
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006608# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006609 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006610 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006611 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006612 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006613 my $call = $1;
6614 my $cast1 = deparenthesize($2);
6615 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006616 my $cast2 = deparenthesize($7);
6617 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006618 my $cast;
6619
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006620 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006621 $cast = "$cast1 or $cast2";
6622 } elsif ($cast1 ne "") {
6623 $cast = $cast1;
6624 } else {
6625 $cast = $cast2;
6626 }
6627 WARN("MINMAX",
6628 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006629 }
6630 }
6631
Joe Perches4a273192012-07-30 14:41:20 -07006632# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006633 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006634 defined $stat &&
6635 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6636 my $min = $1;
6637 my $max = $7;
6638 if ($min eq $max) {
6639 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006640 "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 -07006641 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6642 $min > $max) {
6643 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006644 "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 -07006645 }
6646 }
6647
Joe Perches823b7942013-11-12 15:10:15 -08006648# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006649 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006650 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006651 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006652 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6653 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6654 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6655 my $lc = $stat =~ tr@\n@@;
6656 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006657 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006658 WARN("NAKED_SSCANF",
6659 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6660 }
6661
Joe Perchesafc819a2014-06-04 16:12:08 -07006662# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006663 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006664 defined $stat &&
6665 $line =~ /\bsscanf\b/) {
6666 my $lc = $stat =~ tr@\n@@;
6667 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006668 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006669 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6670 my $format = $6;
6671 my $count = $format =~ tr@%@%@;
6672 if ($count == 1 &&
6673 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6674 WARN("SSCANF_TO_KSTRTO",
6675 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6676 }
6677 }
6678 }
6679
Joe Perches70dc8a42013-09-11 14:23:58 -07006680# check for new externs in .h files.
6681 if ($realfile =~ /\.h$/ &&
6682 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006683 if (CHK("AVOID_EXTERNS",
6684 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006685 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006686 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006687 }
6688 }
6689
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006690# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006691 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006692 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006693 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006694 my $function_name = $1;
6695 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006696
6697 my $s = $stat;
6698 if (defined $cond) {
6699 substr($s, 0, length($cond), '');
6700 }
Kees Cookd8b44b52020-06-03 14:18:09 -07006701 if ($s =~ /^\s*;/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006702 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006703 WARN("AVOID_EXTERNS",
6704 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006705 }
6706
6707 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006708 WARN("FUNCTION_ARGUMENTS",
6709 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006710 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006711
6712 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6713 $stat =~ /^.\s*extern\s+/)
6714 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006715 WARN("AVOID_EXTERNS",
6716 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006717 }
6718
Joe Perchesa0ad7592017-07-10 15:52:19 -07006719# check for function declarations that have arguments without identifier names
6720 if (defined $stat &&
Kees Cookd8b44b52020-06-03 14:18:09 -07006721 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6722 $1 ne "void") {
6723 my $args = trim($1);
Joe Perchesca0d8922016-10-11 13:52:16 -07006724 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6725 my $arg = trim($1);
Kees Cookd8b44b52020-06-03 14:18:09 -07006726 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
Joe Perchesca0d8922016-10-11 13:52:16 -07006727 WARN("FUNCTION_ARGUMENTS",
6728 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6729 }
6730 }
6731 }
6732
Joe Perchesa0ad7592017-07-10 15:52:19 -07006733# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006734 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006735 defined $stat &&
6736 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6737 $context_function = $1;
6738
6739# check for multiline function definition with misplaced open brace
6740 my $ok = 0;
6741 my $cnt = statement_rawlines($stat);
6742 my $herectx = $here . "\n";
6743 for (my $n = 0; $n < $cnt; $n++) {
6744 my $rl = raw_line($linenr, $n);
6745 $herectx .= $rl . "\n";
6746 $ok = 1 if ($rl =~ /^[ \+]\{/);
6747 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6748 last if $rl =~ /^[ \+].*\{/;
6749 }
6750 if (!$ok) {
6751 ERROR("OPEN_BRACE",
6752 "open brace '{' following function definitions go on the next line\n" . $herectx);
6753 }
6754 }
6755
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006756# checks for new __setup's
6757 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6758 my $name = $1;
6759
6760 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006761 CHK("UNDOCUMENTED_SETUP",
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07006762 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006763 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006764 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006765
Joe Perchese29a70f2019-03-07 16:28:35 -08006766# check for pointless casting of alloc functions
6767 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006768 WARN("UNNECESSARY_CASTS",
6769 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006770 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006771
Joe Perchesa640d252013-07-03 15:05:21 -07006772# alloc style
6773# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006774 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006775 $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 -07006776 CHK("ALLOC_SIZEOF_STRUCT",
6777 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6778 }
6779
Joe Perches60a55362014-06-04 16:12:07 -07006780# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006781 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006782 defined $stat &&
6783 $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 -07006784 my $oldfunc = $3;
6785 my $a1 = $4;
6786 my $a2 = $10;
6787 my $newfunc = "kmalloc_array";
6788 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006789 my $r1 = $a1;
6790 my $r2 = $a2;
6791 if ($a1 =~ /^sizeof\s*\S/) {
6792 $r1 = $a2;
6793 $r2 = $a1;
6794 }
6795 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6796 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006797 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006798 my $herectx = get_stat_here($linenr, $cnt, $here);
6799
Joe Perches60a55362014-06-04 16:12:07 -07006800 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006801 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6802 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006803 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006804 $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 -07006805 }
6806 }
6807 }
6808
Joe Perches972fdea2013-04-29 16:18:12 -07006809# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006810 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006811 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6812 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006813 WARN("KREALLOC_ARG_REUSE",
6814 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6815 }
6816
Joe Perches5ce59ae2013-02-21 16:44:18 -08006817# check for alloc argument mismatch
6818 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6819 WARN("ALLOC_ARRAY_ARGS",
6820 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6821 }
6822
Joe Perchescaf2a542011-01-12 16:59:56 -08006823# check for multiple semicolons
6824 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006825 if (WARN("ONE_SEMICOLON",
6826 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6827 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006828 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006829 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006830 }
6831
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006832# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6833 if ($realfile !~ m@^include/uapi/@ &&
6834 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006835 my $ull = "";
6836 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6837 if (CHK("BIT_MACRO",
6838 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6839 $fix) {
6840 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6841 }
6842 }
6843
Joe Perches50161262020-08-11 18:35:07 -07006844# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006845 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
Joe Perches50161262020-08-11 18:35:07 -07006846 WARN("IS_ENABLED_CONFIG",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006847 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
Joe Perches50161262020-08-11 18:35:07 -07006848 }
6849
Joe Perches2d632742016-05-20 17:04:00 -07006850# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006851 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 -07006852 my $config = $1;
6853 if (WARN("PREFER_IS_ENABLED",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006854 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
Joe Perches2d632742016-05-20 17:04:00 -07006855 $fix) {
6856 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6857 }
6858 }
6859
Joe Perchesf36d3eb2020-04-06 20:10:58 -07006860# check for /* fallthrough */ like comment, prefer fallthrough;
6861 my @fallthroughs = (
6862 'fallthrough',
6863 '@fallthrough@',
6864 'lint -fallthrough[ \t]*',
6865 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6866 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6867 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6868 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6869 );
6870 if ($raw_comment ne '') {
6871 foreach my $ft (@fallthroughs) {
6872 if ($raw_comment =~ /$ft/) {
6873 my $msg_level = \&WARN;
6874 $msg_level = \&CHK if ($file);
6875 &{$msg_level}("PREFER_FALLTHROUGH",
6876 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6877 last;
6878 }
6879 }
6880 }
6881
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006882# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006883 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006884 defined $stat &&
6885 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006886 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006887 my $herectx = get_stat_here($linenr, $cnt, $here);
6888
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006889 WARN("DEFAULT_NO_BREAK",
6890 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006891 }
6892
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006893# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006894 if ($line =~ /\b__FUNCTION__\b/) {
6895 if (WARN("USE_FUNC",
6896 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6897 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006898 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006899 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006900 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006901
Joe Perches62ec8182015-02-13 14:38:18 -08006902# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6903 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6904 ERROR("DATE_TIME",
6905 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6906 }
6907
Joe Perches2c924882012-03-23 15:02:20 -07006908# check for use of yield()
6909 if ($line =~ /\byield\s*\(\s*\)/) {
6910 WARN("YIELD",
6911 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6912 }
6913
Joe Perches179f8f42013-07-03 15:05:30 -07006914# check for comparisons against true and false
6915 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6916 my $lead = $1;
6917 my $arg = $2;
6918 my $test = $3;
6919 my $otype = $4;
6920 my $trail = $5;
6921 my $op = "!";
6922
6923 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6924
6925 my $type = lc($otype);
6926 if ($type =~ /^(?:true|false)$/) {
6927 if (("$test" eq "==" && "$type" eq "true") ||
6928 ("$test" eq "!=" && "$type" eq "false")) {
6929 $op = "";
6930 }
6931
6932 CHK("BOOL_COMPARISON",
6933 "Using comparison to $otype is error prone\n" . $herecurr);
6934
6935## maybe suggesting a correct construct would better
6936## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6937
6938 }
6939 }
6940
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006941# check for semaphores initialized locked
6942 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006943 WARN("CONSIDER_COMPLETION",
6944 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006945 }
Joe Perches6712d852012-03-23 15:02:20 -07006946
Joe Perches67d0a072011-10-31 17:13:10 -07006947# recommend kstrto* over simple_strto* and strict_strto*
6948 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006949 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006950 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006951 }
Joe Perches6712d852012-03-23 15:02:20 -07006952
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006953# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006954 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006955 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006956 "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 -07006957 }
Joe Perches6712d852012-03-23 15:02:20 -07006958
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006959# check for spin_is_locked(), suggest lockdep instead
6960 if ($line =~ /\bspin_is_locked\(/) {
6961 WARN("USE_LOCKDEP",
6962 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6963 }
6964
Joe Perches9189c7e2018-09-07 15:26:18 -07006965# check for deprecated apis
6966 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6967 my $deprecated_api = $1;
6968 my $new_api = $deprecated_apis{$deprecated_api};
6969 WARN("DEPRECATED_API",
6970 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6971 }
6972
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006973# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006974# and avoid what seem like struct definitions 'struct foo {'
Quentin Monnetced69da12020-08-11 18:35:13 -07006975 if (defined($const_structs) &&
6976 $line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006977 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006978 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006979 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006980 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006981
6982# use of NR_CPUS is usually wrong
6983# ignore definitions of NR_CPUS and usage to define arrays as likely right
6984 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006985 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6986 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006987 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6988 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6989 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006990 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006991 WARN("NR_CPUS",
6992 "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 -07006993 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006994
Joe Perches52ea8502013-11-12 15:10:09 -08006995# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6996 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6997 ERROR("DEFINE_ARCH_HAS",
6998 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6999 }
7000
Joe Perchesacd93622015-02-13 14:38:38 -08007001# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07007002 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08007003 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
7004 WARN("LIKELY_MISUSE",
7005 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
7006 }
7007
Denis Efremovde3f1862019-09-25 16:49:25 -07007008# nested likely/unlikely calls
7009 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
7010 WARN("LIKELY_MISUSE",
7011 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
7012 }
7013
Andy Whitcroft691d77b2009-01-06 14:41:16 -08007014# whine mightly about in_atomic
7015 if ($line =~ /\bin_atomic\s*\(/) {
7016 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007017 ERROR("IN_ATOMIC",
7018 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08007019 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007020 WARN("IN_ATOMIC",
7021 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08007022 }
7023 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01007024
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02007025# check for mutex_trylock_recursive usage
7026 if ($line =~ /mutex_trylock_recursive/) {
7027 ERROR("LOCKING",
7028 "recursive locking is bad, do not use this ever.\n" . $herecurr);
7029 }
7030
Peter Zijlstra1704f472010-03-19 01:37:42 +01007031# check for lockdep_set_novalidate_class
7032 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
7033 $line =~ /__lockdep_no_validate__\s*\)/ ) {
7034 if ($realfile !~ m@^kernel/lockdep@ &&
7035 $realfile !~ m@^include/linux/lockdep@ &&
7036 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007037 ERROR("LOCKDEP",
7038 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01007039 }
7040 }
Dave Jones88f88312011-01-12 16:59:59 -08007041
Joe Perchesb392c642015-04-16 12:44:16 -07007042 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
7043 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007044 WARN("EXPORTED_WORLD_WRITABLE",
7045 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08007046 }
Joe Perches24358802014-04-03 14:49:13 -07007047
Joe Perches00180462018-02-06 15:38:55 -08007048# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7049# and whether or not function naming is typical and if
7050# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07007051 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08007052 defined $stat &&
7053 $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*\)/) {
7054 my $var = $1;
7055 my $perms = $2;
7056 my $show = $3;
7057 my $store = $4;
7058 my $octal_perms = perms_to_octal($perms);
7059 if ($show =~ /^${var}_show$/ &&
7060 $store =~ /^${var}_store$/ &&
7061 $octal_perms eq "0644") {
7062 if (WARN("DEVICE_ATTR_RW",
7063 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
7064 $fix) {
7065 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7066 }
7067 } elsif ($show =~ /^${var}_show$/ &&
7068 $store =~ /^NULL$/ &&
7069 $octal_perms eq "0444") {
7070 if (WARN("DEVICE_ATTR_RO",
7071 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
7072 $fix) {
7073 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7074 }
7075 } elsif ($show =~ /^NULL$/ &&
7076 $store =~ /^${var}_store$/ &&
7077 $octal_perms eq "0200") {
7078 if (WARN("DEVICE_ATTR_WO",
7079 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
7080 $fix) {
7081 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7082 }
7083 } elsif ($octal_perms eq "0644" ||
7084 $octal_perms eq "0444" ||
7085 $octal_perms eq "0200") {
7086 my $newshow = "$show";
7087 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
7088 my $newstore = $store;
7089 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
7090 my $rename = "";
7091 if ($show ne $newshow) {
7092 $rename .= " '$show' to '$newshow'";
7093 }
7094 if ($store ne $newstore) {
7095 $rename .= " '$store' to '$newstore'";
7096 }
7097 WARN("DEVICE_ATTR_FUNCTIONS",
7098 "Consider renaming function(s)$rename\n" . $herecurr);
7099 } else {
7100 WARN("DEVICE_ATTR_PERMS",
7101 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
7102 }
7103 }
7104
Joe Perches515a2352014-04-03 14:49:24 -07007105# Mode permission misuses where it seems decimal should be octal
7106# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08007107# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7108# specific definition of not visible in sysfs.
7109# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7110# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07007111 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07007112 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07007113 $line =~ /$mode_perms_search/) {
7114 foreach my $entry (@mode_permission_funcs) {
7115 my $func = $entry->[0];
7116 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07007117
Joe Perches459cf0a2016-10-11 13:52:19 -07007118 my $lc = $stat =~ tr@\n@@;
7119 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07007120 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07007121
Joe Perches515a2352014-04-03 14:49:24 -07007122 my $skip_args = "";
7123 if ($arg_pos > 1) {
7124 $arg_pos--;
7125 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
7126 }
Joe Perchesf90774e2016-10-11 13:51:47 -07007127 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07007128 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07007129 my $val = $1;
7130 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08007131 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
7132 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
7133 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07007134 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07007135 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07007136 }
7137 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08007138 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07007139 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07007140 }
Joe Perches24358802014-04-03 14:49:13 -07007141 }
7142 }
7143 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007144
Joe Perches459cf0a2016-10-11 13:52:19 -07007145# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07007146 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08007147 my $oval = $1;
7148 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07007149 if (WARN("SYMBOLIC_PERMS",
7150 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7151 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08007152 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07007153 }
7154 }
7155
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07007156# validate content of MODULE_LICENSE against list from include/linux/module.h
7157 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
7158 my $extracted_string = get_quoted_string($line, $rawline);
7159 my $valid_licenses = qr{
7160 GPL|
7161 GPL\ v2|
7162 GPL\ and\ additional\ rights|
7163 Dual\ BSD/GPL|
7164 Dual\ MIT/GPL|
7165 Dual\ MPL/GPL|
7166 Proprietary
7167 }x;
7168 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
7169 WARN("MODULE_LICENSE",
7170 "unknown module license " . $extracted_string . "\n" . $herecurr);
7171 }
7172 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07007173
7174# check for sysctl duplicate constants
7175 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
7176 WARN("DUPLICATED_SYSCTL_CONST",
7177 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7178 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007179 }
7180
7181 # If we have no input at all, then there is nothing to report on
7182 # so just keep quiet.
7183 if ($#rawlines == -1) {
7184 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007185 }
7186
Andy Whitcroft8905a672007-11-28 16:21:06 -08007187 # In mailback mode only produce a report in the negative, for
7188 # things that appear to be patches.
7189 if ($mailback && ($clean == 1 || !$is_patch)) {
7190 exit(0);
7191 }
7192
Dwaipayan Raye73d2712020-12-15 20:44:56 -08007193 # This is not a patch, and we are in 'no-patch' mode so
Andy Whitcroft8905a672007-11-28 16:21:06 -08007194 # just keep quiet.
7195 if (!$chk_patch && !$is_patch) {
7196 exit(0);
7197 }
7198
Stafford Hornea08ffbe2017-10-03 16:16:51 -07007199 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07007200 ERROR("NOT_UNIFIED_DIFF",
7201 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007202 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07007203 if ($is_patch && $has_commit_log && $chk_signoff) {
7204 if ($signoff == 0) {
7205 ERROR("MISSING_SIGN_OFF",
7206 "Missing Signed-off-by: line(s)\n");
Dwaipayan Ray48ca2d82020-10-15 20:12:28 -07007207 } elsif ($authorsignoff != 1) {
7208 # authorsignoff values:
7209 # 0 -> missing sign off
7210 # 1 -> sign off identical
7211 # 2 -> names and addresses match, comments mismatch
7212 # 3 -> addresses match, names different
7213 # 4 -> names match, addresses different
7214 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7215
7216 my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'";
7217
7218 if ($authorsignoff == 0) {
7219 ERROR("NO_AUTHOR_SIGN_OFF",
7220 "Missing Signed-off-by: line by nominal patch author '$author'\n");
7221 } elsif ($authorsignoff == 2) {
7222 CHK("FROM_SIGN_OFF_MISMATCH",
7223 "From:/Signed-off-by: email comments mismatch: $sob_msg\n");
7224 } elsif ($authorsignoff == 3) {
7225 WARN("FROM_SIGN_OFF_MISMATCH",
7226 "From:/Signed-off-by: email name mismatch: $sob_msg\n");
7227 } elsif ($authorsignoff == 4) {
7228 WARN("FROM_SIGN_OFF_MISMATCH",
7229 "From:/Signed-off-by: email address mismatch: $sob_msg\n");
7230 } elsif ($authorsignoff == 5) {
7231 WARN("FROM_SIGN_OFF_MISMATCH",
7232 "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n");
7233 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07007234 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007235 }
7236
Andy Whitcroft8905a672007-11-28 16:21:06 -08007237 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08007238 if ($summary && !($clean == 1 && $quiet == 1)) {
7239 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08007240 print "total: $cnt_error errors, $cnt_warn warnings, " .
7241 (($check)? "$cnt_chk checks, " : "") .
7242 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07007243 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08007244
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007245 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07007246 # If there were any defects found and not already fixing them
7247 if (!$clean and !$fix) {
7248 print << "EOM"
7249
7250NOTE: For some of the reported defects, checkpatch may be able to
7251 mechanically convert to the typical style using --fix or --fix-inplace.
7252EOM
7253 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007254 # If there were whitespace errors which cleanpatch can fix
7255 # then suggest that.
7256 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07007257 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07007258 print << "EOM"
7259
7260NOTE: Whitespace errors detected.
7261 You may wish to use scripts/cleanpatch or scripts/cleanfile
7262EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07007263 }
7264 }
7265
Joe Perchesd752fcc2014-08-06 16:11:05 -07007266 if ($clean == 0 && $fix &&
7267 ("@rawlines" ne "@fixed" ||
7268 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08007269 my $newfile = $filename;
7270 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07007271 my $linecount = 0;
7272 my $f;
7273
Joe Perchesd752fcc2014-08-06 16:11:05 -07007274 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
7275
Joe Perches3705ce52013-07-03 15:05:31 -07007276 open($f, '>', $newfile)
7277 or die "$P: Can't open $newfile for write\n";
7278 foreach my $fixed_line (@fixed) {
7279 $linecount++;
7280 if ($file) {
7281 if ($linecount > 3) {
7282 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07007283 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07007284 }
7285 } else {
7286 print $f $fixed_line . "\n";
7287 }
7288 }
7289 close($f);
7290
7291 if (!$quiet) {
7292 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07007293
Joe Perches3705ce52013-07-03 15:05:31 -07007294Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
7295
7296Do _NOT_ trust the results written to this file.
7297Do _NOT_ submit these changes without inspecting them for correctness.
7298
7299This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7300No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07007301EOM
7302 }
7303 }
7304
Joe Perchesd8469f12015-06-25 15:03:00 -07007305 if ($quiet == 0) {
7306 print "\n";
7307 if ($clean == 1) {
7308 print "$vname has no obvious style problems and is ready for submission.\n";
7309 } else {
7310 print "$vname has style problems, please review.\n";
7311 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007312 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007313 return $clean;
7314}