blob: 74ccd122fc07e9af23fbad6009e8319e479f487a [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;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080046my %debug;
Joe Perches34456862013-07-03 15:05:34 -070047my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070048my %use_type = ();
49my @use = ();
50my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070051my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070052my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070053my $configuration_file = ".checkpatch.conf";
Joe Perchesbdc48fa2020-05-29 16:12:21 -070054my $max_line_length = 100;
Dave Hansend62a2012013-09-11 14:23:56 -070055my $ignore_perl_version = 0;
56my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070057my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070058my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070059my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070060my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070061my $conststructsfile = "$D/const_structs.checkpatch";
Quentin Monnetced69da12020-08-11 18:35:13 -070062my $typedefsfile;
John Brooks737c0762017-07-10 15:52:24 -070063my $color = "auto";
Vadim Bendebury98005e82019-03-07 16:28:38 -080064my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
Joe Perchesdbbf8692019-09-25 16:46:52 -070065# git output parsing needs US English output, so first set backtick child process LANGUAGE
66my $git_command ='export LANGUAGE=en_US.UTF-8; git';
Antonio Borneo713a09d2020-04-06 20:11:07 -070067my $tabsize = 8;
Jerome Forissier3e89ad82020-10-15 20:11:49 -070068my ${CONFIG_} = "CONFIG_";
Hannes Eder77f5b102009-09-21 17:04:37 -070069
70sub help {
71 my ($exitcode) = @_;
72
73 print << "EOM";
74Usage: $P [OPTION]... [FILE]...
75Version: $V
76
77Options:
78 -q, --quiet quiet
79 --no-tree run without a kernel tree
80 --no-signoff do not check for 'Signed-off-by' line
81 --patch treat FILE as patchfile (default)
82 --emacs emacs compile window format
83 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070084 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070085 -g, --git treat FILE as a single commit or git revision range
86 single git commit with:
87 <rev>
88 <rev>^
89 <rev>~n
90 multiple git commits with:
91 <rev1>..<rev2>
92 <rev1>...<rev2>
93 <rev>-<count>
94 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070095 -f, --file treat FILE as regular source file
96 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070097 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070098 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070099 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -0700100 --show-types show the specific message type in the output
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700101 --max-line-length=n set the maximum line length, (default $max_line_length)
102 if exceeded, warn on patches
103 requires --strict for use with --file
Vadim Bendebury56193272014-10-13 15:51:48 -0700104 --min-conf-desc-length=n set the min description length, if shorter, warn
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700105 --tab-size=n set the number of spaces for tab (default $tabsize)
Hannes Eder77f5b102009-09-21 17:04:37 -0700106 --root=PATH PATH to the kernel tree root
107 --no-summary suppress the per-file summary
108 --mailback only produce a report in case of warnings/errors
109 --summary-file include the filename in summary
110 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
111 'values', 'possible', 'type', and 'attr' (default
112 is all off)
113 --test-only=WORD report only warnings/errors containing WORD
114 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700115 --fix EXPERIMENTAL - may create horrible results
116 If correctable single-line errors exist, create
117 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
118 with potential errors corrected to the preferred
119 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800120 --fix-inplace EXPERIMENTAL - may create horrible results
121 Is the same as --fix, but overwrites the input
122 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700123 --ignore-perl-version override checking of perl version. expect
124 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700125 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700126 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700127 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700128 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700129 --color[=WHEN] Use colors 'always', 'never', or only when output
130 is a terminal ('auto'). Default is 'auto'.
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700131 --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default
132 ${CONFIG_})
Hannes Eder77f5b102009-09-21 17:04:37 -0700133 -h, --help, --version display this help and exit
134
135When FILE is - read standard input.
136EOM
137
138 exit($exitcode);
139}
140
Joe Perches3beb42e2016-05-20 17:04:14 -0700141sub uniq {
142 my %seen;
143 return grep { !$seen{$_}++ } @_;
144}
145
146sub list_types {
147 my ($exitcode) = @_;
148
149 my $count = 0;
150
151 local $/ = undef;
152
153 open(my $script, '<', abs_path($P)) or
154 die "$P: Can't read '$P' $!\n";
155
156 my $text = <$script>;
157 close($script);
158
159 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700160 # Also catch when type or level is passed through a variable
161 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700162 push (@types, $_);
163 }
164 @types = sort(uniq(@types));
165 print("#\tMessage type\n\n");
166 foreach my $type (@types) {
167 print(++$count . "\t" . $type . "\n");
168 }
169
170 exit($exitcode);
171}
172
Joe Perches000d1cc12011-07-25 17:13:25 -0700173my $conf = which_conf($configuration_file);
174if (-f $conf) {
175 my @conf_args;
176 open(my $conffile, '<', "$conf")
177 or warn "$P: Can't find a readable $configuration_file file $!\n";
178
179 while (<$conffile>) {
180 my $line = $_;
181
182 $line =~ s/\s*\n?$//g;
183 $line =~ s/^\s*//g;
184 $line =~ s/\s+/ /g;
185
186 next if ($line =~ m/^\s*#/);
187 next if ($line =~ m/^\s*$/);
188
189 my @words = split(" ", $line);
190 foreach my $word (@words) {
191 last if ($word =~ m/^#/);
192 push (@conf_args, $word);
193 }
194 }
195 close($conffile);
196 unshift(@ARGV, @conf_args) if @conf_args;
197}
198
John Brooks737c0762017-07-10 15:52:24 -0700199# Perl's Getopt::Long allows options to take optional arguments after a space.
200# Prevent --color by itself from consuming other arguments
201foreach (@ARGV) {
202 if ($_ eq "--color" || $_ eq "-color") {
203 $_ = "--color=$color";
204 }
205}
206
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700207GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700208 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700209 'tree!' => \$tree,
210 'signoff!' => \$chk_signoff,
211 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700212 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800213 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700214 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700215 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700216 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700217 'subjective!' => \$check,
218 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700219 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700220 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700221 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700222 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800223 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700224 'min-conf-desc-length=i' => \$min_conf_desc_length,
Antonio Borneo713a09d2020-04-06 20:11:07 -0700225 'tab-size=i' => \$tabsize,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700226 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800227 'summary!' => \$summary,
228 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800229 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700230 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800231 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700232 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800233 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700234 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700235 'codespell!' => \$codespell,
236 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700237 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700238 'color=s' => \$color,
239 'no-color' => \$color, #keep old behaviors of -nocolor
240 'nocolor' => \$color, #keep old behaviors of -nocolor
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700241 'kconfig-prefix=s' => \${CONFIG_},
Hannes Eder77f5b102009-09-21 17:04:37 -0700242 'h|help' => \$help,
243 'version' => \$help
244) or help(1);
245
246help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700247
Joe Perches3beb42e2016-05-20 17:04:14 -0700248list_types(0) if ($list_types);
249
Joe Perches9624b8d2014-01-23 15:54:44 -0800250$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700251$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800252
Joe Perches32f30ca2020-06-04 16:50:40 -0700253die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
254
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700255my $exit = 0;
256
Joe Perches5b579802018-08-21 21:57:33 -0700257my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700258if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700259 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700260 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700261 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700262}
263
Allen Hubbe45107ff2016-08-02 14:04:47 -0700264#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700265if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700266 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700267}
268
John Brooks737c0762017-07-10 15:52:24 -0700269if ($color =~ /^[01]$/) {
270 $color = !$color;
271} elsif ($color =~ /^always$/i) {
272 $color = 1;
273} elsif ($color =~ /^never$/i) {
274 $color = 0;
275} elsif ($color =~ /^auto$/i) {
276 $color = (-t STDOUT);
277} else {
Joe Perches32f30ca2020-06-04 16:50:40 -0700278 die "$P: Invalid color mode: $color\n";
John Brooks737c0762017-07-10 15:52:24 -0700279}
280
Antonio Borneo713a09d2020-04-06 20:11:07 -0700281# skip TAB size 1 to avoid additional checks on $tabsize - 1
Joe Perches32f30ca2020-06-04 16:50:40 -0700282die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
Antonio Borneo713a09d2020-04-06 20:11:07 -0700283
Joe Perches91bfe482013-09-11 14:23:59 -0700284sub hash_save_array_words {
285 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700286
Joe Perches91bfe482013-09-11 14:23:59 -0700287 my @array = split(/,/, join(',', @$arrayRef));
288 foreach my $word (@array) {
289 $word =~ s/\s*\n?$//g;
290 $word =~ s/^\s*//g;
291 $word =~ s/\s+/ /g;
292 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700293
Joe Perches91bfe482013-09-11 14:23:59 -0700294 next if ($word =~ m/^\s*#/);
295 next if ($word =~ m/^\s*$/);
296
297 $hashRef->{$word}++;
298 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700299}
300
Joe Perches91bfe482013-09-11 14:23:59 -0700301sub hash_show_words {
302 my ($hashRef, $prefix) = @_;
303
Joe Perches3c816e42015-06-25 15:03:29 -0700304 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700305 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700306 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700307 print " $word";
308 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700309 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700310 }
311}
312
313hash_save_array_words(\%ignore_type, \@ignore);
314hash_save_array_words(\%use_type, \@use);
315
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800316my $dbg_values = 0;
317my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700318my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700319my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800320for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800321 ## no critic
322 eval "\${dbg_$key} = '$debug{$key}';";
323 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800324}
325
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700326my $rpt_cleaners = 0;
327
Andy Whitcroft8905a672007-11-28 16:21:06 -0800328if ($terse) {
329 $emacs = 1;
330 $quiet++;
331}
332
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700333if ($tree) {
334 if (defined $root) {
335 if (!top_of_kernel_tree($root)) {
336 die "$P: $root: --root does not point at a valid tree\n";
337 }
338 } else {
339 if (top_of_kernel_tree('.')) {
340 $root = '.';
341 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
342 top_of_kernel_tree($1)) {
343 $root = $1;
344 }
345 }
346
347 if (!defined $root) {
348 print "Must be run from the top-level dir. of a kernel tree\n";
349 exit(2);
350 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700351}
352
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700353my $emitted_corrupt = 0;
354
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700355our $Ident = qr{
356 [A-Za-z_][A-Za-z\d_]*
357 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
358 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700359our $Storage = qr{extern|static|asmlinkage};
360our $Sparse = qr{
361 __user|
362 __kernel|
363 __force|
364 __iomem|
365 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800366 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700367 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700368 __refconst|
369 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800370 __rcu|
371 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700372 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800373our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
374our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
375our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
376our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
377our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700378
Wolfram Sang52131292010-03-05 13:43:51 -0800379# Notes to $Attribute:
380# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700381our $Attribute = qr{
382 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700383 __percpu|
384 __nocast|
385 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200386 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700387 __packed__|
388 __packed2__|
389 __naked|
390 __maybe_unused|
391 __always_unused|
392 __noreturn|
393 __used|
394 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800395 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700396 __noclone|
397 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700398 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700399 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700400 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700401 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700402 ____cacheline_aligned|
403 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800404 ____cacheline_internodealigned_in_smp|
405 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700406 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700407our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700408our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700409our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
410our $Lval = qr{$Ident(?:$Member)*};
411
Joe Perches95e2c602013-07-03 15:05:20 -0700412our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
413our $Binary = qr{(?i)0b[01]+$Int_type?};
414our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
415our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700416our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800417our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800418our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
419our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
420our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800421our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700422our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800423our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700424our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700425our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700426our $Operators = qr{
427 <=|>=|==|!=|
428 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700429 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700430 }x;
431
Joe Perches91cb5192014-04-03 14:49:32 -0700432our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
433
Joe Perchesab7e23f2015-04-16 12:44:22 -0700434our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800435our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700436our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700437our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800438our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700439our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800440our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700441our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800442
Joe Perches15662b32011-10-31 17:13:12 -0700443our $NON_ASCII_UTF8 = qr{
444 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700445 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
446 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
447 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
448 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
449 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
450 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
451}x;
452
Joe Perches15662b32011-10-31 17:13:12 -0700453our $UTF8 = qr{
454 [\x09\x0A\x0D\x20-\x7E] # ASCII
455 | $NON_ASCII_UTF8
456}x;
457
Joe Perchese6176fa2015-06-25 15:02:49 -0700458our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800459our $typeOtherOSTypedefs = qr{(?x:
460 u_(?:char|short|int|long) | # bsd
461 u(?:nchar|short|int|long) # sysv
462)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700463our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700464 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700465 atomic_t
466)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700467our $typeTypedefs = qr{(?x:
468 $typeC99Typedefs\b|
469 $typeOtherOSTypedefs\b|
470 $typeKernelTypedefs\b
471)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700472
Joe Perches6d32f7a2015-11-06 16:31:37 -0800473our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
474
Joe Perches691e6692010-03-05 13:43:51 -0800475our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800476 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700477 (?:[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 -0800478 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700479 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700480 panic|
Joe Perches06668722013-11-12 15:10:07 -0800481 MODULE_[A-Z_]+|
482 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800483)};
484
Joe Perchese29a70f2019-03-07 16:28:35 -0800485our $allocFunctions = qr{(?x:
486 (?:(?:devm_)?
487 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
488 kstrdup(?:_const)? |
489 kmemdup(?:_nul)?) |
Christophe JAILLET461e1562020-04-20 18:13:58 -0700490 (?:\w+)?alloc_skb(?:_ip_align)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800491 # dev_alloc_skb/netdev_alloc_skb, et al
492 dma_alloc_coherent
493)};
494
Joe Perches20112472011-07-25 17:13:23 -0700495our $signature_tags = qr{(?xi:
496 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800497 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700498 Acked-by:|
499 Tested-by:|
500 Reviewed-by:|
501 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700502 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700503 To:|
504 Cc:
505)};
506
Joe Perches18130872014-08-06 16:11:22 -0700507our @typeListMisordered = (
508 qr{char\s+(?:un)?signed},
509 qr{int\s+(?:(?:un)?signed\s+)?short\s},
510 qr{int\s+short(?:\s+(?:un)?signed)},
511 qr{short\s+int(?:\s+(?:un)?signed)},
512 qr{(?:un)?signed\s+int\s+short},
513 qr{short\s+(?:un)?signed},
514 qr{long\s+int\s+(?:un)?signed},
515 qr{int\s+long\s+(?:un)?signed},
516 qr{long\s+(?:un)?signed\s+int},
517 qr{int\s+(?:un)?signed\s+long},
518 qr{int\s+(?:un)?signed},
519 qr{int\s+long\s+long\s+(?:un)?signed},
520 qr{long\s+long\s+int\s+(?:un)?signed},
521 qr{long\s+long\s+(?:un)?signed\s+int},
522 qr{long\s+long\s+(?:un)?signed},
523 qr{long\s+(?:un)?signed},
524);
525
Andy Whitcroft8905a672007-11-28 16:21:06 -0800526our @typeList = (
527 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700528 qr{(?:(?:un)?signed\s+)?char},
529 qr{(?:(?:un)?signed\s+)?short\s+int},
530 qr{(?:(?:un)?signed\s+)?short},
531 qr{(?:(?:un)?signed\s+)?int},
532 qr{(?:(?:un)?signed\s+)?long\s+int},
533 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
534 qr{(?:(?:un)?signed\s+)?long\s+long},
535 qr{(?:(?:un)?signed\s+)?long},
536 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800537 qr{float},
538 qr{double},
539 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800540 qr{struct\s+$Ident},
541 qr{union\s+$Ident},
542 qr{enum\s+$Ident},
543 qr{${Ident}_t},
544 qr{${Ident}_handler},
545 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700546 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800547);
Joe Perches938224b2016-01-20 14:59:15 -0800548
549our $C90_int_types = qr{(?x:
550 long\s+long\s+int\s+(?:un)?signed|
551 long\s+long\s+(?:un)?signed\s+int|
552 long\s+long\s+(?:un)?signed|
553 (?:(?:un)?signed\s+)?long\s+long\s+int|
554 (?:(?:un)?signed\s+)?long\s+long|
555 int\s+long\s+long\s+(?:un)?signed|
556 int\s+(?:(?:un)?signed\s+)?long\s+long|
557
558 long\s+int\s+(?:un)?signed|
559 long\s+(?:un)?signed\s+int|
560 long\s+(?:un)?signed|
561 (?:(?:un)?signed\s+)?long\s+int|
562 (?:(?:un)?signed\s+)?long|
563 int\s+long\s+(?:un)?signed|
564 int\s+(?:(?:un)?signed\s+)?long|
565
566 int\s+(?:un)?signed|
567 (?:(?:un)?signed\s+)?int
568)};
569
Alex Dowad485ff232015-06-25 15:02:52 -0700570our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700571our @typeListWithAttr = (
572 @typeList,
573 qr{struct\s+$InitAttribute\s+$Ident},
574 qr{union\s+$InitAttribute\s+$Ident},
575);
576
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700577our @modifierList = (
578 qr{fastcall},
579);
Alex Dowad485ff232015-06-25 15:02:52 -0700580our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800581
Joe Perches24358802014-04-03 14:49:13 -0700582our @mode_permission_funcs = (
583 ["module_param", 3],
584 ["module_param_(?:array|named|string)", 4],
585 ["module_param_array_named", 5],
586 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
587 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700588 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
589 ["IIO_DEV_ATTR_[A-Z_]+", 1],
590 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
591 ["SENSOR_TEMPLATE(?:_2|)", 3],
592 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700593);
594
Joe Perches1a3dcf22020-08-11 18:35:16 -0700595my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
596
Joe Perches515a2352014-04-03 14:49:24 -0700597#Create a search pattern for all these functions to speed up a loop below
598our $mode_perms_search = "";
599foreach my $entry (@mode_permission_funcs) {
600 $mode_perms_search .= '|' if ($mode_perms_search ne "");
601 $mode_perms_search .= $entry->[0];
602}
Joe Perches00180462018-02-06 15:38:55 -0800603$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700604
Joe Perches9189c7e2018-09-07 15:26:18 -0700605our %deprecated_apis = (
606 "synchronize_rcu_bh" => "synchronize_rcu",
607 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
608 "call_rcu_bh" => "call_rcu",
609 "rcu_barrier_bh" => "rcu_barrier",
610 "synchronize_sched" => "synchronize_rcu",
611 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
612 "call_rcu_sched" => "call_rcu",
613 "rcu_barrier_sched" => "rcu_barrier",
614 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
615 "cond_synchronize_sched" => "cond_synchronize_rcu",
616);
617
618#Create a search pattern for all these strings to speed up a loop below
619our $deprecated_apis_search = "";
620foreach my $entry (keys %deprecated_apis) {
621 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
622 $deprecated_apis_search .= $entry;
623}
624$deprecated_apis_search = "(?:${deprecated_apis_search})";
625
Joe Perchesb392c642015-04-16 12:44:16 -0700626our $mode_perms_world_writable = qr{
627 S_IWUGO |
628 S_IWOTH |
629 S_IRWXUGO |
630 S_IALLUGO |
631 0[0-7][0-7][2367]
632}x;
633
Joe Perchesf90774e2016-10-11 13:51:47 -0700634our %mode_permission_string_types = (
635 "S_IRWXU" => 0700,
636 "S_IRUSR" => 0400,
637 "S_IWUSR" => 0200,
638 "S_IXUSR" => 0100,
639 "S_IRWXG" => 0070,
640 "S_IRGRP" => 0040,
641 "S_IWGRP" => 0020,
642 "S_IXGRP" => 0010,
643 "S_IRWXO" => 0007,
644 "S_IROTH" => 0004,
645 "S_IWOTH" => 0002,
646 "S_IXOTH" => 0001,
647 "S_IRWXUGO" => 0777,
648 "S_IRUGO" => 0444,
649 "S_IWUGO" => 0222,
650 "S_IXUGO" => 0111,
651);
652
653#Create a search pattern for all these strings to speed up a loop below
654our $mode_perms_string_search = "";
655foreach my $entry (keys %mode_permission_string_types) {
656 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
657 $mode_perms_string_search .= $entry;
658}
Joe Perches00180462018-02-06 15:38:55 -0800659our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
660our $multi_mode_perms_string_search = qr{
661 ${single_mode_perms_string_search}
662 (?:\s*\|\s*${single_mode_perms_string_search})*
663}x;
664
665sub perms_to_octal {
666 my ($string) = @_;
667
668 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
669
670 my $val = "";
671 my $oval = "";
672 my $to = 0;
673 my $curpos = 0;
674 my $lastpos = 0;
675 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
676 $curpos = pos($string);
677 my $match = $2;
678 my $omatch = $1;
679 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
680 $lastpos = $curpos;
681 $to |= $mode_permission_string_types{$match};
682 $val .= '\s*\|\s*' if ($val ne "");
683 $val .= $match;
684 $oval .= $omatch;
685 }
686 $oval =~ s/^\s*\|\s*//;
687 $oval =~ s/\s*\|\s*$//;
688 return sprintf("%04o", $to);
689}
Joe Perchesf90774e2016-10-11 13:51:47 -0700690
Wolfram Sang7840a942010-08-09 17:20:57 -0700691our $allowed_asm_includes = qr{(?x:
692 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700693 memory|
694 time|
695 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700696)};
697# memory.h: ARM has a custom one
698
Kees Cook66b47b42014-10-13 15:51:57 -0700699# Load common spelling mistakes and build regular expression list.
700my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700701my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700702
Joe Perches36061e32014-12-10 15:51:43 -0800703if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800704 while (<$spelling>) {
705 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700706
Joe Perches36061e32014-12-10 15:51:43 -0800707 $line =~ s/\s*\n?$//g;
708 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700709
Joe Perches36061e32014-12-10 15:51:43 -0800710 next if ($line =~ m/^\s*#/);
711 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700712
Joe Perches36061e32014-12-10 15:51:43 -0800713 my ($suspect, $fix) = split(/\|\|/, $line);
714
Joe Perches36061e32014-12-10 15:51:43 -0800715 $spelling_fix{$suspect} = $fix;
716 }
717 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800718} else {
719 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700720}
Kees Cook66b47b42014-10-13 15:51:57 -0700721
Joe Perchesebfd7d62015-04-16 12:44:14 -0700722if ($codespell) {
723 if (open(my $spelling, '<', $codespellfile)) {
724 while (<$spelling>) {
725 my $line = $_;
726
727 $line =~ s/\s*\n?$//g;
728 $line =~ s/^\s*//g;
729
730 next if ($line =~ m/^\s*#/);
731 next if ($line =~ m/^\s*$/);
732 next if ($line =~ m/, disabled/i);
733
734 $line =~ s/,.*$//;
735
736 my ($suspect, $fix) = split(/->/, $line);
737
738 $spelling_fix{$suspect} = $fix;
739 }
740 close($spelling);
741 } else {
742 warn "No codespell typos will be found - file '$codespellfile': $!\n";
743 }
744}
745
746$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
747
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700748sub read_words {
749 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700750
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700751 if (open(my $words, '<', $file)) {
752 while (<$words>) {
753 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700754
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700755 $line =~ s/\s*\n?$//g;
756 $line =~ s/^\s*//g;
757
758 next if ($line =~ m/^\s*#/);
759 next if ($line =~ m/^\s*$/);
760 if ($line =~ /\s/) {
761 print("$file: '$line' invalid - ignored\n");
762 next;
763 }
764
Quentin Monnetced69da12020-08-11 18:35:13 -0700765 $$wordsRef .= '|' if (defined $$wordsRef);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700766 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700767 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700768 close($file);
769 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700770 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700771
772 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700773}
774
Quentin Monnetced69da12020-08-11 18:35:13 -0700775my $const_structs;
776if (show_type("CONST_STRUCT")) {
777 read_words(\$const_structs, $conststructsfile)
778 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
779}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700780
Quentin Monnetced69da12020-08-11 18:35:13 -0700781if (defined($typedefsfile)) {
782 my $typeOtherTypedefs;
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700783 read_words(\$typeOtherTypedefs, $typedefsfile)
784 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
Quentin Monnetced69da12020-08-11 18:35:13 -0700785 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700786}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700787
Andy Whitcroft8905a672007-11-28 16:21:06 -0800788sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700789 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
790 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700791 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700792 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700793 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700794 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700795 (?:$typeTypedefs\b)|
796 (?:${all}\b)
797 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800798 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700799 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800800 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800801 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700802 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700803 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800804 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700805 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800806 }x;
Joe Perches18130872014-08-06 16:11:22 -0700807 $NonptrTypeMisordered = qr{
808 (?:$Modifier\s+|const\s+)*
809 (?:
810 (?:${Misordered}\b)
811 )
812 (?:\s+$Modifier|\s+const)*
813 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700814 $NonptrTypeWithAttr = qr{
815 (?:$Modifier\s+|const\s+)*
816 (?:
817 (?:typeof|__typeof__)\s*\([^\)]*\)|
818 (?:$typeTypedefs\b)|
819 (?:${allWithAttr}\b)
820 )
821 (?:\s+$Modifier|\s+const)*
822 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800823 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700824 $NonptrType
Antonio Borneo7b184962020-04-06 20:11:04 -0700825 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700826 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800827 }x;
Joe Perches18130872014-08-06 16:11:22 -0700828 $TypeMisordered = qr{
829 $NonptrTypeMisordered
Antonio Borneo7b184962020-04-06 20:11:04 -0700830 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Joe Perches18130872014-08-06 16:11:22 -0700831 (?:\s+$Inline|\s+$Modifier)*
832 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700833 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700834 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800835}
836build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700837
Joe Perches7d2367a2011-07-25 17:13:22 -0700838our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700839
840# Using $balanced_parens, $LvalOrFunc, or $FuncArg
841# requires at least perl version v5.10.0
842# Any use must be runtime checked with $^V
843
844our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700845our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800846our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700847
Joe Perchesf8422302014-08-06 16:11:31 -0700848our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700849 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700850 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700851 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700852)};
853
Joe Perches7d2367a2011-07-25 17:13:22 -0700854sub deparenthesize {
855 my ($string) = @_;
856 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700857
858 while ($string =~ /^\s*\(.*\)\s*$/) {
859 $string =~ s@^\s*\(\s*@@;
860 $string =~ s@\s*\)\s*$@@;
861 }
862
Joe Perches7d2367a2011-07-25 17:13:22 -0700863 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700864
Joe Perches7d2367a2011-07-25 17:13:22 -0700865 return $string;
866}
867
Joe Perches34456862013-07-03 15:05:34 -0700868sub seed_camelcase_file {
869 my ($file) = @_;
870
871 return if (!(-f $file));
872
873 local $/;
874
875 open(my $include_file, '<', "$file")
876 or warn "$P: Can't read '$file' $!\n";
877 my $text = <$include_file>;
878 close($include_file);
879
880 my @lines = split('\n', $text);
881
882 foreach my $line (@lines) {
883 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
884 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
885 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800886 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
887 $camelcase{$1} = 1;
888 } 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 -0700889 $camelcase{$1} = 1;
890 }
891 }
892}
893
Joe Perchescd28b112019-12-04 16:52:09 -0800894our %maintained_status = ();
895
Joe Perches85b0ee12016-10-11 13:51:44 -0700896sub is_maintained_obsolete {
897 my ($filename) = @_;
898
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800899 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700900
Joe Perchescd28b112019-12-04 16:52:09 -0800901 if (!exists($maintained_status{$filename})) {
902 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
903 }
Joe Perches85b0ee12016-10-11 13:51:44 -0700904
Joe Perchescd28b112019-12-04 16:52:09 -0800905 return $maintained_status{$filename} =~ /obsolete/i;
Joe Perches85b0ee12016-10-11 13:51:44 -0700906}
907
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700908sub is_SPDX_License_valid {
909 my ($license) = @_;
910
Joe Perches56294112018-08-21 21:58:04 -0700911 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700912
Joe Perches56294112018-08-21 21:58:04 -0700913 my $root_path = abs_path($root);
914 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700915 return 0 if ($status ne "");
916 return 1;
917}
918
Joe Perches34456862013-07-03 15:05:34 -0700919my $camelcase_seeded = 0;
920sub seed_camelcase_includes {
921 return if ($camelcase_seeded);
922
923 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700924 my $camelcase_cache = "";
925 my @include_files = ();
926
927 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700928
Richard Genoud3645e322014-02-10 14:25:32 -0800929 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700930 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Joe Perches351b2a12013-07-03 15:05:36 -0700931 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700932 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700933 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700934 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700935 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700936 @include_files = split('\n', $files);
937 foreach my $file (@include_files) {
938 my $date = POSIX::strftime("%Y%m%d%H%M",
939 localtime((stat $file)[9]));
940 $last_mod_date = $date if ($last_mod_date < $date);
941 }
942 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700943 }
Joe Perchesc707a812013-07-08 16:00:43 -0700944
945 if ($camelcase_cache ne "" && -f $camelcase_cache) {
946 open(my $camelcase_file, '<', "$camelcase_cache")
947 or warn "$P: Can't read '$camelcase_cache' $!\n";
948 while (<$camelcase_file>) {
949 chomp;
950 $camelcase{$_} = 1;
951 }
952 close($camelcase_file);
953
954 return;
955 }
956
Richard Genoud3645e322014-02-10 14:25:32 -0800957 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700958 $files = `${git_command} ls-files "include/*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700959 @include_files = split('\n', $files);
960 }
961
Joe Perches34456862013-07-03 15:05:34 -0700962 foreach my $file (@include_files) {
963 seed_camelcase_file($file);
964 }
Joe Perches351b2a12013-07-03 15:05:36 -0700965
Joe Perchesc707a812013-07-08 16:00:43 -0700966 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700967 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700968 open(my $camelcase_file, '>', "$camelcase_cache")
969 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700970 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
971 print $camelcase_file ("$_\n");
972 }
973 close($camelcase_file);
974 }
Joe Perches34456862013-07-03 15:05:34 -0700975}
976
Joe Perchesd311cd42014-08-06 16:10:57 -0700977sub git_commit_info {
978 my ($commit, $id, $desc) = @_;
979
980 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
981
Joe Perchesdbbf8692019-09-25 16:46:52 -0700982 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Joe Perchesd311cd42014-08-06 16:10:57 -0700983 $output =~ s/^\s*//gm;
984 my @lines = split("\n", $output);
985
Joe Perches0d7835f2015-02-13 14:38:35 -0800986 return ($id, $desc) if ($#lines < 0);
987
Sean Christopherson5a7f4452019-09-25 16:46:49 -0700988 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Joe Perchesd311cd42014-08-06 16:10:57 -0700989# Maybe one day convert this block of bash into something that returns
990# all matching commit ids, but it's very slow...
991#
992# echo "checking commits $1..."
993# git rev-list --remotes | grep -i "^$1" |
994# while read line ; do
995# git log --format='%H %s' -1 $line |
996# echo "commit $(cut -c 1-12,41-)"
997# done
998 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700999 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -07001000 } else {
1001 $id = substr($lines[0], 0, 12);
1002 $desc = substr($lines[0], 41);
1003 }
1004
1005 return ($id, $desc);
1006}
1007
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001008$chk_signoff = 0 if ($file);
1009
Andy Whitcroft00df3442007-06-08 13:47:06 -07001010my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001011my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001012my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001013my @fixed_inserted = ();
1014my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001015my $fixlinenr = -1;
1016
Du, Changbin4a593c32016-05-20 17:04:16 -07001017# If input is git commits, extract all commits from the commit expressions.
1018# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1019die "$P: No git repository found\n" if ($git && !-e ".git");
1020
1021if ($git) {
1022 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001023 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001024 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001025 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1026 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001027 } elsif ($commit_expr =~ m/\.\./) {
1028 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001029 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001030 $git_range = "-1 $commit_expr";
1031 }
Joe Perchesdbbf8692019-09-25 16:46:52 -07001032 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001033 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001034 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1035 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001036 my $sha1 = $1;
1037 my $subject = $2;
1038 unshift(@commits, $sha1);
1039 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001040 }
1041 }
1042 die "$P: no git commits after extraction!\n" if (@commits == 0);
1043 @ARGV = @commits;
1044}
1045
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001046my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001047$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001048for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001049 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -07001050 if ($git) {
1051 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1052 die "$P: $filename: git format-patch failed - $!\n";
1053 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001054 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001055 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001056 } elsif ($filename eq '-') {
1057 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001058 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001059 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001060 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001061 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001062 if ($filename eq '-') {
1063 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001064 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001065 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001066 } else {
1067 $vname = $filename;
1068 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001069 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001070 chomp;
1071 push(@rawlines, $_);
Geert Uytterhoevenc7f574d2020-06-04 16:50:43 -07001072 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001073 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001074 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001075
1076 if ($#ARGV > 0 && $quiet == 0) {
1077 print '-' x length($vname) . "\n";
1078 print "$vname\n";
1079 print '-' x length($vname) . "\n";
1080 }
1081
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001082 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001083 $exit = 1;
1084 }
1085 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001086 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001087 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001088 @fixed_inserted = ();
1089 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001090 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001091 @modifierListFile = ();
1092 @typeListFile = ();
1093 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001094}
1095
Joe Perchesd8469f12015-06-25 15:03:00 -07001096if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001097 hash_show_words(\%use_type, "Used");
1098 hash_show_words(\%ignore_type, "Ignored");
1099
Joe Perches5b579802018-08-21 21:57:33 -07001100 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001101 print << "EOM"
1102
1103NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001104 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001105EOM
1106 }
1107 if ($exit) {
1108 print << "EOM"
1109
1110NOTE: If any of the errors are false positives, please report
1111 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1112EOM
1113 }
1114}
1115
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001116exit($exit);
1117
1118sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001119 my ($root) = @_;
1120
1121 my @tree_check = (
1122 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1123 "README", "Documentation", "arch", "include", "drivers",
1124 "fs", "init", "ipc", "kernel", "lib", "scripts",
1125 );
1126
1127 foreach my $check (@tree_check) {
1128 if (! -e $root . '/' . $check) {
1129 return 0;
1130 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001131 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001132 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001133}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001134
Joe Perches20112472011-07-25 17:13:23 -07001135sub parse_email {
1136 my ($formatted_email) = @_;
1137
1138 my $name = "";
Joe Perchesdfa05c22020-04-06 20:10:48 -07001139 my $name_comment = "";
Joe Perches20112472011-07-25 17:13:23 -07001140 my $address = "";
1141 my $comment = "";
1142
1143 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1144 $name = $1;
1145 $address = $2;
1146 $comment = $3 if defined $3;
1147 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1148 $address = $1;
1149 $comment = $2 if defined $2;
1150 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1151 $address = $1;
1152 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001153 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001154 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001155 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001156 $name =~ s/^\"|\"$//g;
1157 # If there's a name left after stripping spaces and
1158 # leading quotes, and the address doesn't have both
1159 # leading and trailing angle brackets, the address
1160 # is invalid. ie:
1161 # "joe smith joe@smith.com" bad
1162 # "joe smith <joe@smith.com" bad
1163 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1164 $name = "";
1165 $address = "";
1166 $comment = "";
1167 }
1168 }
1169
Joe Perches3705ce52013-07-03 15:05:31 -07001170 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001171 $name =~ s/^\"|\"$//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001172 $name =~ s/(\s*\([^\)]+\))\s*//;
1173 if (defined($1)) {
1174 $name_comment = trim($1);
1175 }
Joe Perches3705ce52013-07-03 15:05:31 -07001176 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001177 $address =~ s/^\<|\>$//g;
1178
1179 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1180 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1181 $name = "\"$name\"";
1182 }
1183
Joe Perchesdfa05c22020-04-06 20:10:48 -07001184 return ($name, $name_comment, $address, $comment);
Joe Perches20112472011-07-25 17:13:23 -07001185}
1186
1187sub format_email {
1188 my ($name, $address) = @_;
1189
1190 my $formatted_email;
1191
Joe Perches3705ce52013-07-03 15:05:31 -07001192 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001193 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001194 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001195
1196 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1197 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1198 $name = "\"$name\"";
1199 }
1200
1201 if ("$name" eq "") {
1202 $formatted_email = "$address";
1203 } else {
1204 $formatted_email = "$name <$address>";
1205 }
1206
1207 return $formatted_email;
1208}
1209
Joe Perchesdfa05c22020-04-06 20:10:48 -07001210sub reformat_email {
1211 my ($email) = @_;
1212
1213 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1214 return format_email($email_name, $email_address);
1215}
1216
1217sub same_email_addresses {
1218 my ($email1, $email2) = @_;
1219
1220 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1221 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1222
1223 return $email1_name eq $email2_name &&
1224 $email1_address eq $email2_address;
1225}
1226
Joe Perchesd311cd42014-08-06 16:10:57 -07001227sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001228 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001229
Joe Perchesbd474ca2014-08-06 16:11:10 -07001230 foreach my $path (split(/:/, $ENV{PATH})) {
1231 if (-e "$path/$bin") {
1232 return "$path/$bin";
1233 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001234 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001235
Joe Perchesbd474ca2014-08-06 16:11:10 -07001236 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001237}
1238
Joe Perches000d1cc12011-07-25 17:13:25 -07001239sub which_conf {
1240 my ($conf) = @_;
1241
1242 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1243 if (-e "$path/$conf") {
1244 return "$path/$conf";
1245 }
1246 }
1247
1248 return "";
1249}
1250
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001251sub expand_tabs {
1252 my ($str) = @_;
1253
1254 my $res = '';
1255 my $n = 0;
1256 for my $c (split(//, $str)) {
1257 if ($c eq "\t") {
1258 $res .= ' ';
1259 $n++;
Antonio Borneo713a09d2020-04-06 20:11:07 -07001260 for (; ($n % $tabsize) != 0; $n++) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001261 $res .= ' ';
1262 }
1263 next;
1264 }
1265 $res .= $c;
1266 $n++;
1267 }
1268
1269 return $res;
1270}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001271sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001272 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001273 return $res;
1274}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001275
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001276sub line_stats {
1277 my ($line) = @_;
1278
1279 # Drop the diff line leader and expand tabs
1280 $line =~ s/^.//;
1281 $line = expand_tabs($line);
1282
1283 # Pick the indent from the front of the line.
1284 my ($white) = ($line =~ /^(\s*)/);
1285
1286 return (length($line), length($white));
1287}
1288
Andy Whitcroft773647a2008-03-28 14:15:58 -07001289my $sanitise_quote = '';
1290
1291sub sanitise_line_reset {
1292 my ($in_comment) = @_;
1293
1294 if ($in_comment) {
1295 $sanitise_quote = '*/';
1296 } else {
1297 $sanitise_quote = '';
1298 }
1299}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001300sub sanitise_line {
1301 my ($line) = @_;
1302
1303 my $res = '';
1304 my $l = '';
1305
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001306 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001307 my $off = 0;
1308 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001309
Andy Whitcroft773647a2008-03-28 14:15:58 -07001310 # Always copy over the diff marker.
1311 $res = substr($line, 0, 1);
1312
1313 for ($off = 1; $off < length($line); $off++) {
1314 $c = substr($line, $off, 1);
1315
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001316 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001317 # and end, all to $;.
1318 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1319 $sanitise_quote = '*/';
1320
1321 substr($res, $off, 2, "$;$;");
1322 $off++;
1323 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001324 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001325 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001326 $sanitise_quote = '';
1327 substr($res, $off, 2, "$;$;");
1328 $off++;
1329 next;
1330 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001331 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1332 $sanitise_quote = '//';
1333
1334 substr($res, $off, 2, $sanitise_quote);
1335 $off++;
1336 next;
1337 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001338
1339 # A \ in a string means ignore the next character.
1340 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1341 $c eq "\\") {
1342 substr($res, $off, 2, 'XX');
1343 $off++;
1344 next;
1345 }
1346 # Regular quotes.
1347 if ($c eq "'" || $c eq '"') {
1348 if ($sanitise_quote eq '') {
1349 $sanitise_quote = $c;
1350
1351 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001352 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001353 } elsif ($sanitise_quote eq $c) {
1354 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001355 }
1356 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001357
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001358 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001359 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1360 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001361 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1362 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001363 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1364 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001365 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001366 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001367 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001368 }
1369
Daniel Walker113f04a2009-09-21 17:04:35 -07001370 if ($sanitise_quote eq '//') {
1371 $sanitise_quote = '';
1372 }
1373
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001374 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001375 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001376 my $clean = 'X' x length($1);
1377 $res =~ s@\<.*\>@<$clean>@;
1378
1379 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001380 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001381 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001382 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001383 }
1384
Joe Perchesdadf6802016-08-02 14:04:33 -07001385 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1386 my $match = $1;
1387 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1388 }
1389
Andy Whitcroft00df3442007-06-08 13:47:06 -07001390 return $res;
1391}
1392
Joe Perchesa6962d72013-04-29 16:18:13 -07001393sub get_quoted_string {
1394 my ($line, $rawline) = @_;
1395
Joe Perches478b1792018-04-10 16:33:34 -07001396 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001397 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001398 return substr($rawline, $-[0], $+[0] - $-[0]);
1399}
1400
Andy Whitcroft8905a672007-11-28 16:21:06 -08001401sub ctx_statement_block {
1402 my ($linenr, $remain, $off) = @_;
1403 my $line = $linenr - 1;
1404 my $blk = '';
1405 my $soff = $off;
1406 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001407 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001408
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001409 my $loff = 0;
1410
Andy Whitcroft8905a672007-11-28 16:21:06 -08001411 my $type = '';
1412 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001413 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001414 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001415 my $c;
1416 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001417
1418 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001419 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001420 @stack = (['', 0]) if ($#stack == -1);
1421
Andy Whitcroft773647a2008-03-28 14:15:58 -07001422 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001423 # If we are about to drop off the end, pull in more
1424 # context.
1425 if ($off >= $len) {
1426 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001427 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001428 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001429 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001430 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001431 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001432 $len = length($blk);
1433 $line++;
1434 last;
1435 }
1436 # Bail if there is no further context.
1437 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001438 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001439 last;
1440 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001441 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1442 $level++;
1443 $type = '#';
1444 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001445 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001446 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001447 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001448 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001449
Andy Whitcroft773647a2008-03-28 14:15:58 -07001450 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001451
1452 # Handle nested #if/#else.
1453 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1454 push(@stack, [ $type, $level ]);
1455 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1456 ($type, $level) = @{$stack[$#stack - 1]};
1457 } elsif ($remainder =~ /^#\s*endif\b/) {
1458 ($type, $level) = @{pop(@stack)};
1459 }
1460
Andy Whitcroft8905a672007-11-28 16:21:06 -08001461 # Statement ends at the ';' or a close '}' at the
1462 # outermost level.
1463 if ($level == 0 && $c eq ';') {
1464 last;
1465 }
1466
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001467 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001468 if ($level == 0 && $coff_set == 0 &&
1469 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1470 $remainder =~ /^(else)(?:\s|{)/ &&
1471 $remainder !~ /^else\s+if\b/) {
1472 $coff = $off + length($1) - 1;
1473 $coff_set = 1;
1474 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1475 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001476 }
1477
Andy Whitcroft8905a672007-11-28 16:21:06 -08001478 if (($type eq '' || $type eq '(') && $c eq '(') {
1479 $level++;
1480 $type = '(';
1481 }
1482 if ($type eq '(' && $c eq ')') {
1483 $level--;
1484 $type = ($level != 0)? '(' : '';
1485
1486 if ($level == 0 && $coff < $soff) {
1487 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001488 $coff_set = 1;
1489 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001490 }
1491 }
1492 if (($type eq '' || $type eq '{') && $c eq '{') {
1493 $level++;
1494 $type = '{';
1495 }
1496 if ($type eq '{' && $c eq '}') {
1497 $level--;
1498 $type = ($level != 0)? '{' : '';
1499
1500 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001501 if (substr($blk, $off + 1, 1) eq ';') {
1502 $off++;
1503 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001504 last;
1505 }
1506 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001507 # Preprocessor commands end at the newline unless escaped.
1508 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1509 $level--;
1510 $type = '';
1511 $off++;
1512 last;
1513 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001514 $off++;
1515 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001516 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001517 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001518 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001519 $line++;
1520 $remain--;
1521 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001522
1523 my $statement = substr($blk, $soff, $off - $soff + 1);
1524 my $condition = substr($blk, $soff, $coff - $soff + 1);
1525
1526 #warn "STATEMENT<$statement>\n";
1527 #warn "CONDITION<$condition>\n";
1528
Andy Whitcroft773647a2008-03-28 14:15:58 -07001529 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001530
1531 return ($statement, $condition,
1532 $line, $remain + 1, $off - $loff + 1, $level);
1533}
1534
Andy Whitcroftcf655042008-03-04 14:28:20 -08001535sub statement_lines {
1536 my ($stmt) = @_;
1537
1538 # Strip the diff line prefixes and rip blank lines at start and end.
1539 $stmt =~ s/(^|\n)./$1/g;
1540 $stmt =~ s/^\s*//;
1541 $stmt =~ s/\s*$//;
1542
1543 my @stmt_lines = ($stmt =~ /\n/g);
1544
1545 return $#stmt_lines + 2;
1546}
1547
1548sub statement_rawlines {
1549 my ($stmt) = @_;
1550
1551 my @stmt_lines = ($stmt =~ /\n/g);
1552
1553 return $#stmt_lines + 2;
1554}
1555
1556sub statement_block_size {
1557 my ($stmt) = @_;
1558
1559 $stmt =~ s/(^|\n)./$1/g;
1560 $stmt =~ s/^\s*{//;
1561 $stmt =~ s/}\s*$//;
1562 $stmt =~ s/^\s*//;
1563 $stmt =~ s/\s*$//;
1564
1565 my @stmt_lines = ($stmt =~ /\n/g);
1566 my @stmt_statements = ($stmt =~ /;/g);
1567
1568 my $stmt_lines = $#stmt_lines + 2;
1569 my $stmt_statements = $#stmt_statements + 1;
1570
1571 if ($stmt_lines > $stmt_statements) {
1572 return $stmt_lines;
1573 } else {
1574 return $stmt_statements;
1575 }
1576}
1577
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001578sub ctx_statement_full {
1579 my ($linenr, $remain, $off) = @_;
1580 my ($statement, $condition, $level);
1581
1582 my (@chunks);
1583
Andy Whitcroftcf655042008-03-04 14:28:20 -08001584 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001585 ($statement, $condition, $linenr, $remain, $off, $level) =
1586 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001587 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001588 push(@chunks, [ $condition, $statement ]);
1589 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1590 return ($level, $linenr, @chunks);
1591 }
1592
1593 # Pull in the following conditional/block pairs and see if they
1594 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001595 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001596 ($statement, $condition, $linenr, $remain, $off, $level) =
1597 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001598 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001599 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001600 #print "C: push\n";
1601 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001602 }
1603
1604 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001605}
1606
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001607sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001608 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001609 my $line;
1610 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001611 my $blk = '';
1612 my @o;
1613 my @c;
1614 my @res = ();
1615
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001616 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001617 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001618 for ($line = $start; $remain > 0; $line++) {
1619 next if ($rawlines[$line] =~ /^-/);
1620 $remain--;
1621
1622 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001623
1624 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001625 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001626 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001627 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001628 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001629 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001630 $level = pop(@stack);
1631 }
1632
Andy Whitcroft01464f32010-10-26 14:23:19 -07001633 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001634 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1635 if ($off > 0) {
1636 $off--;
1637 next;
1638 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001639
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001640 if ($c eq $close && $level > 0) {
1641 $level--;
1642 last if ($level == 0);
1643 } elsif ($c eq $open) {
1644 $level++;
1645 }
1646 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001647
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001648 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001649 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001650 }
1651
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001652 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001653 }
1654
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001655 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001656}
1657sub ctx_block_outer {
1658 my ($linenr, $remain) = @_;
1659
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001660 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1661 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001662}
1663sub ctx_block {
1664 my ($linenr, $remain) = @_;
1665
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001666 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1667 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001668}
1669sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001670 my ($linenr, $remain, $off) = @_;
1671
1672 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1673 return @r;
1674}
1675sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001676 my ($linenr, $remain) = @_;
1677
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001678 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001679}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001680sub ctx_statement_level {
1681 my ($linenr, $remain, $off) = @_;
1682
1683 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1684}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001685
1686sub ctx_locate_comment {
1687 my ($first_line, $end_line) = @_;
1688
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001689 # If c99 comment on the current line, or the line before or after
1690 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1691 return $current_comment if (defined $current_comment);
1692 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1693 return $current_comment if (defined $current_comment);
1694 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1695 return $current_comment if (defined $current_comment);
1696
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001697 # Catch a comment on the end of the line itself.
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001698 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001699 return $current_comment if (defined $current_comment);
1700
1701 # Look through the context and try and figure out if there is a
1702 # comment.
1703 my $in_comment = 0;
1704 $current_comment = '';
1705 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001706 my $line = $rawlines[$linenr - 1];
1707 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001708 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1709 $in_comment = 1;
1710 }
1711 if ($line =~ m@/\*@) {
1712 $in_comment = 1;
1713 }
1714 if (!$in_comment && $current_comment ne '') {
1715 $current_comment = '';
1716 }
1717 $current_comment .= $line . "\n" if ($in_comment);
1718 if ($line =~ m@\*/@) {
1719 $in_comment = 0;
1720 }
1721 }
1722
1723 chomp($current_comment);
1724 return($current_comment);
1725}
1726sub ctx_has_comment {
1727 my ($first_line, $end_line) = @_;
1728 my $cmt = ctx_locate_comment($first_line, $end_line);
1729
Andy Whitcroft00df3442007-06-08 13:47:06 -07001730 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001731 ##print "CMMT: $cmt\n";
1732
1733 return ($cmt ne '');
1734}
1735
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001736sub raw_line {
1737 my ($linenr, $cnt) = @_;
1738
1739 my $offset = $linenr - 1;
1740 $cnt++;
1741
1742 my $line;
1743 while ($cnt) {
1744 $line = $rawlines[$offset++];
1745 next if (defined($line) && $line =~ /^-/);
1746 $cnt--;
1747 }
1748
1749 return $line;
1750}
1751
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001752sub get_stat_real {
1753 my ($linenr, $lc) = @_;
1754
1755 my $stat_real = raw_line($linenr, 0);
1756 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1757 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1758 }
1759
1760 return $stat_real;
1761}
1762
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001763sub get_stat_here {
1764 my ($linenr, $cnt, $here) = @_;
1765
1766 my $herectx = $here . "\n";
1767 for (my $n = 0; $n < $cnt; $n++) {
1768 $herectx .= raw_line($linenr, $n) . "\n";
1769 }
1770
1771 return $herectx;
1772}
1773
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001774sub cat_vet {
1775 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001776 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001777
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001778 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001779 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1780 $res .= $1;
1781 if ($2 ne '') {
1782 $coded = sprintf("^%c", unpack('C', $2) + 64);
1783 $res .= $coded;
1784 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001785 }
1786 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001787
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001788 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001789}
1790
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001791my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001792my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001793my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001794my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001795
1796sub annotate_reset {
1797 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001798 $av_pending = '_';
1799 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001800 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001801}
1802
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001803sub annotate_values {
1804 my ($stream, $type) = @_;
1805
1806 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001807 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001808 my $cur = $stream;
1809
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001810 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001811
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001812 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001813 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001814 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001815 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001816 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001817 print "WS($1)\n" if ($dbg_values > 1);
1818 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001819 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001820 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001821 }
1822
Florian Micklerc023e4732011-01-12 16:59:58 -08001823 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001824 print "CAST($1)\n" if ($dbg_values > 1);
1825 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001826 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001827
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001828 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001829 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001830 $type = 'T';
1831
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001832 } elsif ($cur =~ /^($Modifier)\s*/) {
1833 print "MODIFIER($1)\n" if ($dbg_values > 1);
1834 $type = 'T';
1835
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001836 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001837 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001838 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001839 push(@av_paren_type, $type);
1840 if ($2 ne '') {
1841 $av_pending = 'N';
1842 }
1843 $type = 'E';
1844
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001845 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001846 print "UNDEF($1)\n" if ($dbg_values > 1);
1847 $av_preprocessor = 1;
1848 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001849
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001850 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001851 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001852 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001853
1854 push(@av_paren_type, $type);
1855 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001856 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001857
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001858 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001859 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1860 $av_preprocessor = 1;
1861
1862 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1863
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001864 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001865
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001866 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001867 print "PRE_END($1)\n" if ($dbg_values > 1);
1868
1869 $av_preprocessor = 1;
1870
1871 # Assume all arms of the conditional end as this
1872 # one does, and continue as if the #endif was not here.
1873 pop(@av_paren_type);
1874 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001875 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001876
1877 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001878 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001879
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001880 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1881 print "ATTR($1)\n" if ($dbg_values > 1);
1882 $av_pending = $type;
1883 $type = 'N';
1884
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001885 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001886 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001887 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001888 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001889 }
1890 $type = 'N';
1891
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001892 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001893 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001894 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001895 $type = 'N';
1896
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001897 } elsif ($cur =~/^(case)/o) {
1898 print "CASE($1)\n" if ($dbg_values > 1);
1899 $av_pend_colon = 'C';
1900 $type = 'N';
1901
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001902 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001903 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001904 $type = 'N';
1905
1906 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001907 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001908 push(@av_paren_type, $av_pending);
1909 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001910 $type = 'N';
1911
1912 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001913 my $new_type = pop(@av_paren_type);
1914 if ($new_type ne '_') {
1915 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001916 print "PAREN('$1') -> $type\n"
1917 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001918 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001919 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001920 }
1921
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001922 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001923 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001924 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001925 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001926
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001927 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1928 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001929 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001930 } elsif ($type eq 'E') {
1931 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001932 }
1933 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1934 $type = 'V';
1935
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001936 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001937 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001938 $type = 'V';
1939
1940 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001941 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001942 $type = 'N';
1943
Andy Whitcroftcf655042008-03-04 14:28:20 -08001944 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001945 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001946 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001947 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001948
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001949 } elsif ($cur =~/^(,)/) {
1950 print "COMMA($1)\n" if ($dbg_values > 1);
1951 $type = 'C';
1952
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001953 } elsif ($cur =~ /^(\?)/o) {
1954 print "QUESTION($1)\n" if ($dbg_values > 1);
1955 $type = 'N';
1956
1957 } elsif ($cur =~ /^(:)/o) {
1958 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1959
1960 substr($var, length($res), 1, $av_pend_colon);
1961 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1962 $type = 'E';
1963 } else {
1964 $type = 'N';
1965 }
1966 $av_pend_colon = 'O';
1967
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001968 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001969 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001970 $type = 'N';
1971
Andy Whitcroft0d413862008-10-15 22:02:16 -07001972 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001973 my $variant;
1974
1975 print "OPV($1)\n" if ($dbg_values > 1);
1976 if ($type eq 'V') {
1977 $variant = 'B';
1978 } else {
1979 $variant = 'U';
1980 }
1981
1982 substr($var, length($res), 1, $variant);
1983 $type = 'N';
1984
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001985 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001986 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001987 if ($1 ne '++' && $1 ne '--') {
1988 $type = 'N';
1989 }
1990
1991 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001992 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001993 }
1994 if (defined $1) {
1995 $cur = substr($cur, length($1));
1996 $res .= $type x length($1);
1997 }
1998 }
1999
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002000 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002001}
2002
Andy Whitcroft8905a672007-11-28 16:21:06 -08002003sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002004 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002005 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002006 ^(?:
2007 $Modifier|
2008 $Storage|
2009 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002010 DEFINE_\S+
2011 )$|
2012 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002013 goto|
2014 return|
2015 case|
2016 else|
2017 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08002018 do|
2019 \#|
2020 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002021 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07002022 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002023 )}x;
2024 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2025 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002026 # Check for modifiers.
2027 $possible =~ s/\s*$Storage\s*//g;
2028 $possible =~ s/\s*$Sparse\s*//g;
2029 if ($possible =~ /^\s*$/) {
2030
2031 } elsif ($possible =~ /\s/) {
2032 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07002033 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002034 if ($modifier !~ $notPermitted) {
2035 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002036 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002037 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07002038 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002039
2040 } else {
2041 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002042 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002043 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002044 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07002045 } else {
2046 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002047 }
2048}
2049
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002050my $prefix = '';
2051
Joe Perches000d1cc12011-07-25 17:13:25 -07002052sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07002053 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002054
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002055 $type =~ tr/[a-z]/[A-Z]/;
2056
Joe Perchescbec18a2014-04-03 14:49:19 -07002057 return defined $use_type{$type} if (scalar keys %use_type > 0);
2058
2059 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002060}
2061
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002062sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002063 my ($level, $type, $msg) = @_;
2064
2065 if (!show_type($type) ||
2066 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002067 return 0;
2068 }
Joe Perches57230292015-06-25 15:03:03 -07002069 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002070 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002071 if ($level eq 'ERROR') {
2072 $output .= RED;
2073 } elsif ($level eq 'WARNING') {
2074 $output .= YELLOW;
2075 } else {
2076 $output .= GREEN;
2077 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002078 }
Joe Perches57230292015-06-25 15:03:03 -07002079 $output .= $prefix . $level . ':';
2080 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002081 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002082 $output .= "$type:";
2083 }
John Brooks737c0762017-07-10 15:52:24 -07002084 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002085 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002086
2087 if ($showfile) {
2088 my @lines = split("\n", $output, -1);
2089 splice(@lines, 1, 1);
2090 $output = join("\n", @lines);
2091 }
Joe Perches57230292015-06-25 15:03:03 -07002092 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002093
Joe Perches57230292015-06-25 15:03:03 -07002094 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002095
2096 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002097}
Joe Perchescbec18a2014-04-03 14:49:19 -07002098
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002099sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002100 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002101}
Joe Perches000d1cc12011-07-25 17:13:25 -07002102
Joe Perchesd752fcc2014-08-06 16:11:05 -07002103sub fixup_current_range {
2104 my ($lineRef, $offset, $length) = @_;
2105
2106 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2107 my $o = $1;
2108 my $l = $2;
2109 my $no = $o + $offset;
2110 my $nl = $l + $length;
2111 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2112 }
2113}
2114
2115sub fix_inserted_deleted_lines {
2116 my ($linesRef, $insertedRef, $deletedRef) = @_;
2117
2118 my $range_last_linenr = 0;
2119 my $delta_offset = 0;
2120
2121 my $old_linenr = 0;
2122 my $new_linenr = 0;
2123
2124 my $next_insert = 0;
2125 my $next_delete = 0;
2126
2127 my @lines = ();
2128
2129 my $inserted = @{$insertedRef}[$next_insert++];
2130 my $deleted = @{$deletedRef}[$next_delete++];
2131
2132 foreach my $old_line (@{$linesRef}) {
2133 my $save_line = 1;
2134 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002135 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002136 $delta_offset = 0;
2137 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2138 $range_last_linenr = $new_linenr;
2139 fixup_current_range(\$line, $delta_offset, 0);
2140 }
2141
2142 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2143 $deleted = @{$deletedRef}[$next_delete++];
2144 $save_line = 0;
2145 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2146 }
2147
2148 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2149 push(@lines, ${$inserted}{'LINE'});
2150 $inserted = @{$insertedRef}[$next_insert++];
2151 $new_linenr++;
2152 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2153 }
2154
2155 if ($save_line) {
2156 push(@lines, $line);
2157 $new_linenr++;
2158 }
2159
2160 $old_linenr++;
2161 }
2162
2163 return @lines;
2164}
2165
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002166sub fix_insert_line {
2167 my ($linenr, $line) = @_;
2168
2169 my $inserted = {
2170 LINENR => $linenr,
2171 LINE => $line,
2172 };
2173 push(@fixed_inserted, $inserted);
2174}
2175
2176sub fix_delete_line {
2177 my ($linenr, $line) = @_;
2178
2179 my $deleted = {
2180 LINENR => $linenr,
2181 LINE => $line,
2182 };
2183
2184 push(@fixed_deleted, $deleted);
2185}
2186
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002187sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002188 my ($type, $msg) = @_;
2189
2190 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002191 our $clean = 0;
2192 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002193 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002194 }
Joe Perches3705ce52013-07-03 15:05:31 -07002195 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002196}
2197sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002198 my ($type, $msg) = @_;
2199
2200 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002201 our $clean = 0;
2202 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002203 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002204 }
Joe Perches3705ce52013-07-03 15:05:31 -07002205 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002206}
2207sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002208 my ($type, $msg) = @_;
2209
2210 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002211 our $clean = 0;
2212 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002213 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002214 }
Joe Perches3705ce52013-07-03 15:05:31 -07002215 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002216}
2217
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002218sub check_absolute_file {
2219 my ($absolute, $herecurr) = @_;
2220 my $file = $absolute;
2221
2222 ##print "absolute<$absolute>\n";
2223
2224 # See if any suffix of this path is a path within the tree.
2225 while ($file =~ s@^[^/]*/@@) {
2226 if (-f "$root/$file") {
2227 ##print "file<$file>\n";
2228 last;
2229 }
2230 }
2231 if (! -f _) {
2232 return 0;
2233 }
2234
2235 # It is, so see if the prefix is acceptable.
2236 my $prefix = $absolute;
2237 substr($prefix, -length($file)) = '';
2238
2239 ##print "prefix<$prefix>\n";
2240 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002241 WARN("USE_RELATIVE_PATH",
2242 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002243 }
2244}
2245
Joe Perches3705ce52013-07-03 15:05:31 -07002246sub trim {
2247 my ($string) = @_;
2248
Joe Perchesb34c6482013-09-11 14:24:01 -07002249 $string =~ s/^\s+|\s+$//g;
2250
2251 return $string;
2252}
2253
2254sub ltrim {
2255 my ($string) = @_;
2256
2257 $string =~ s/^\s+//;
2258
2259 return $string;
2260}
2261
2262sub rtrim {
2263 my ($string) = @_;
2264
2265 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002266
2267 return $string;
2268}
2269
Joe Perches52ea8502013-11-12 15:10:09 -08002270sub string_find_replace {
2271 my ($string, $find, $replace) = @_;
2272
2273 $string =~ s/$find/$replace/g;
2274
2275 return $string;
2276}
2277
Joe Perches3705ce52013-07-03 15:05:31 -07002278sub tabify {
2279 my ($leading) = @_;
2280
Antonio Borneo713a09d2020-04-06 20:11:07 -07002281 my $source_indent = $tabsize;
Joe Perches3705ce52013-07-03 15:05:31 -07002282 my $max_spaces_before_tab = $source_indent - 1;
2283 my $spaces_to_tab = " " x $source_indent;
2284
2285 #convert leading spaces to tabs
2286 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2287 #Remove spaces before a tab
2288 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2289
2290 return "$leading";
2291}
2292
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002293sub pos_last_openparen {
2294 my ($line) = @_;
2295
2296 my $pos = 0;
2297
2298 my $opens = $line =~ tr/\(/\(/;
2299 my $closes = $line =~ tr/\)/\)/;
2300
2301 my $last_openparen = 0;
2302
2303 if (($opens == 0) || ($closes >= $opens)) {
2304 return -1;
2305 }
2306
2307 my $len = length($line);
2308
2309 for ($pos = 0; $pos < $len; $pos++) {
2310 my $string = substr($line, $pos);
2311 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2312 $pos += length($1) - 1;
2313 } elsif (substr($line, $pos, 1) eq '(') {
2314 $last_openparen = $pos;
2315 } elsif (index($string, '(') == -1) {
2316 last;
2317 }
2318 }
2319
Joe Perches91cb5192014-04-03 14:49:32 -07002320 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002321}
2322
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002323sub get_raw_comment {
2324 my ($line, $rawline) = @_;
2325 my $comment = '';
2326
2327 for my $i (0 .. (length($line) - 1)) {
2328 if (substr($line, $i, 1) eq "$;") {
2329 $comment .= substr($rawline, $i, 1);
2330 }
2331 }
2332
2333 return $comment;
2334}
2335
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002336sub process {
2337 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002338
2339 my $linenr=0;
2340 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002341 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002342 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002343 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002344
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002345 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002346 my $indent;
2347 my $previndent=0;
2348 my $stashindent=0;
2349
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002350 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002351 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002352 my $author = '';
2353 my $authorsignoff = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002354 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002355 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002356 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002357 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches44d303e2020-04-06 20:11:10 -07002358 my $has_patch_separator = 0; #Found a --- line
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002359 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002360 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002361 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002362 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002363 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002364 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002365 my $non_utf8_charset = 0;
2366
Joe Perches365dd4e2014-08-06 16:10:42 -07002367 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002368 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002369
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002370 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002371 our $cnt_lines = 0;
2372 our $cnt_error = 0;
2373 our $cnt_warn = 0;
2374 our $cnt_chk = 0;
2375
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002376 # Trace the real file/line as we go.
2377 my $realfile = '';
2378 my $realline = 0;
2379 my $realcnt = 0;
2380 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002381 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002382 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002383 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002384 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002385 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002386
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002387 my $prev_values = 'E';
2388
2389 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002390 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002391 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002392 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002393 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002394
Joe Perches7e51f192013-09-11 14:23:57 -07002395 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002396
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002397 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002398 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002399 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002400 my @setup_docs = ();
2401 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002402
Joe Perchesd8b07712013-11-12 15:10:06 -08002403 my $camelcase_file_seeded = 0;
2404
Rob Herring9f3a8992018-04-10 16:33:13 -07002405 my $checklicenseline = 1;
2406
Andy Whitcroft773647a2008-03-28 14:15:58 -07002407 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002408 my $line;
2409 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002410 $linenr++;
2411 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002412
Joe Perches3705ce52013-07-03 15:05:31 -07002413 push(@fixed, $rawline) if ($fix);
2414
Andy Whitcroft773647a2008-03-28 14:15:58 -07002415 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002416 $setup_docs = 0;
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07002417 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002418 $setup_docs = 1;
2419 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002420 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002421 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002422 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002423 $realline=$1-1;
2424 if (defined $2) {
2425 $realcnt=$3+1;
2426 } else {
2427 $realcnt=1+1;
2428 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002429 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002430
2431 # Guestimate if this is a continuing comment. Run
2432 # the context looking for a comment "edge". If this
2433 # edge is a close comment then we must be in a comment
2434 # at context start.
2435 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002436 my $cnt = $realcnt;
2437 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2438 next if (defined $rawlines[$ln - 1] &&
2439 $rawlines[$ln - 1] =~ /^-/);
2440 $cnt--;
2441 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002442 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002443 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2444 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2445 ($edge) = $1;
2446 last;
2447 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002448 }
2449 if (defined $edge && $edge eq '*/') {
2450 $in_comment = 1;
2451 }
2452
2453 # Guestimate if this is a continuing comment. If this
2454 # is the start of a diff block and this line starts
2455 # ' *' then it is very likely a comment.
2456 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002457 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002458 {
2459 $in_comment = 1;
2460 }
2461
2462 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2463 sanitise_line_reset($in_comment);
2464
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002465 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002466 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002467 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002468 $line = sanitise_line($rawline);
2469 }
2470 push(@lines, $line);
2471
2472 if ($realcnt > 1) {
2473 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2474 } else {
2475 $realcnt = 0;
2476 }
2477
2478 #print "==>$rawline\n";
2479 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002480
2481 if ($setup_docs && $line =~ /^\+/) {
2482 push(@setup_docs, $line);
2483 }
2484 }
2485
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002486 $prefix = '';
2487
Andy Whitcroft773647a2008-03-28 14:15:58 -07002488 $realcnt = 0;
2489 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002490 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002491 foreach my $line (@lines) {
2492 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002493 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002494 my $sline = $line; #copy of $line
2495 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002496
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002497 my $rawline = $rawlines[$linenr - 1];
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002498 my $raw_comment = get_raw_comment($line, $rawline);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002499
Joe Perches12c253a2018-06-07 17:10:58 -07002500# check if it's a mode change, rename or start of a patch
2501 if (!$in_commit_log &&
2502 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2503 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2504 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2505 $is_patch = 1;
2506 }
2507
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002508#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002509 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002510 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2511 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002512 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002513 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002514 $realline=$1-1;
2515 if (defined $2) {
2516 $realcnt=$3+1;
2517 } else {
2518 $realcnt=1+1;
2519 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002520 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002521 $prev_values = 'E';
2522
Andy Whitcroft773647a2008-03-28 14:15:58 -07002523 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002524 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002525 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002526 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002527 if ($context =~ /\b(\w+)\s*\(/) {
2528 $context_function = $1;
2529 } else {
2530 undef $context_function;
2531 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002532 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002533
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002534# track the line number as we move through the hunk, note that
2535# new versions of GNU diff omit the leading space on completely
2536# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002537 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002538 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002539 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002540
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002541 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002542 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002543
2544 # Track the previous line.
2545 ($prevline, $stashline) = ($stashline, $line);
2546 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002547 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2548
Andy Whitcroft773647a2008-03-28 14:15:58 -07002549 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002550
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002551 } elsif ($realcnt == 1) {
2552 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002553 }
2554
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002555 my $hunk_line = ($realcnt != 0);
2556
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002557 $here = "#$linenr: " if (!$file);
2558 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002559
Joe Perches2ac73b42014-06-04 16:12:05 -07002560 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002561 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002562 if ($line =~ /^diff --git.*?(\S+)$/) {
2563 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002564 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002565 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002566 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002567 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002568 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002569 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002570 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002571
2572 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002573 if (!$file && $tree && $p1_prefix ne '' &&
2574 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002575 WARN("PATCH_PREFIX",
2576 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002577 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002578
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002579 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002580 ERROR("MODIFIED_INCLUDE_ASM",
2581 "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 -07002582 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002583 $found_file = 1;
2584 }
2585
Joe Perches34d88152015-06-25 15:03:05 -07002586#make up the handle for any error we report on this line
2587 if ($showfile) {
2588 $prefix = "$realfile:$realline: "
2589 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002590 if ($file) {
2591 $prefix = "$filename:$realline: ";
2592 } else {
2593 $prefix = "$filename:$linenr: ";
2594 }
Joe Perches34d88152015-06-25 15:03:05 -07002595 }
2596
Joe Perches2ac73b42014-06-04 16:12:05 -07002597 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002598 if (is_maintained_obsolete($realfile)) {
2599 WARN("OBSOLETE",
2600 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2601 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002602 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002603 $check = 1;
2604 } else {
2605 $check = $check_orig;
2606 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002607 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002608
2609 if ($realfile !~ /^MAINTAINERS/) {
2610 my $last_binding_patch = $is_binding_patch;
2611
2612 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2613
2614 if (($last_binding_patch != -1) &&
2615 ($last_binding_patch ^ $is_binding_patch)) {
2616 WARN("DT_SPLIT_BINDING_PATCH",
Mauro Carvalho Chehab858e6842020-04-15 16:45:25 +02002617 "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 -07002618 }
2619 }
2620
Andy Whitcroft773647a2008-03-28 14:15:58 -07002621 next;
2622 }
2623
Randy Dunlap389834b2007-06-08 13:47:03 -07002624 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002625
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002626 my $hereline = "$here\n$rawline\n";
2627 my $herecurr = "$here\n$rawline\n";
2628 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002629
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002630 $cnt_lines++ if ($realcnt != 0);
2631
Joe Perches490b2922018-08-21 21:58:01 -07002632# Verify the existence of a commit log if appropriate
2633# 2 is used because a $signature is counted in $commit_log_lines
2634 if ($in_commit_log) {
2635 if ($line !~ /^\s*$/) {
2636 $commit_log_lines++; #could be a $signature
2637 }
2638 } elsif ($has_commit_log && $commit_log_lines < 2) {
2639 WARN("COMMIT_MESSAGE",
2640 "Missing commit description - Add an appropriate one\n");
2641 $commit_log_lines = 2; #warn only once
2642 }
2643
Joe Perchese518e9a2015-06-25 15:03:27 -07002644# Check if the commit log has what seems like a diff which can confuse patch
2645 if ($in_commit_log && !$commit_log_has_diff &&
Mrinal Pandey13e45412020-09-04 16:35:52 -07002646 (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
2647 $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
Joe Perchese518e9a2015-06-25 15:03:27 -07002648 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2649 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2650 ERROR("DIFF_IN_COMMIT_MSG",
2651 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2652 $commit_log_has_diff = 1;
2653 }
2654
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002655# Check for incorrect file permissions
2656 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2657 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002658 if ($realfile !~ m@scripts/@ &&
2659 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002660 ERROR("EXECUTE_PERMISSIONS",
2661 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002662 }
2663 }
2664
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002665# Check the patch for a From:
2666 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2667 $author = $1;
2668 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2669 $author =~ s/"//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07002670 $author = reformat_email($author);
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002671 }
2672
Joe Perches20112472011-07-25 17:13:23 -07002673# Check the patch for a signoff:
Joe Perchesdfa05c22020-04-06 20:10:48 -07002674 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002675 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002676 $in_commit_log = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002677 if ($author ne '') {
Joe Perchesdfa05c22020-04-06 20:10:48 -07002678 if (same_email_addresses($1, $author)) {
2679 $authorsignoff = 1;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002680 }
2681 }
Joe Perches20112472011-07-25 17:13:23 -07002682 }
2683
Joe Perches44d303e2020-04-06 20:11:10 -07002684# Check for patch separator
2685 if ($line =~ /^---$/) {
2686 $has_patch_separator = 1;
2687 $in_commit_log = 0;
2688 }
2689
Joe Perchese0d975b2014-12-10 15:51:49 -08002690# Check if MAINTAINERS is being updated. If so, there's probably no need to
2691# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2692 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2693 $reported_maintainer_file = 1;
2694 }
2695
Joe Perches20112472011-07-25 17:13:23 -07002696# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002697 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002698 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002699 my $space_before = $1;
2700 my $sign_off = $2;
2701 my $space_after = $3;
2702 my $email = $4;
2703 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2704
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002705 if ($sign_off !~ /$signature_tags/) {
2706 WARN("BAD_SIGN_OFF",
2707 "Non-standard signature: $sign_off\n" . $herecurr);
2708 }
Joe Perches20112472011-07-25 17:13:23 -07002709 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002710 if (WARN("BAD_SIGN_OFF",
2711 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2712 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002713 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002714 "$ucfirst_sign_off $email";
2715 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002716 }
Joe Perches20112472011-07-25 17:13:23 -07002717 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002718 if (WARN("BAD_SIGN_OFF",
2719 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2720 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002721 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002722 "$ucfirst_sign_off $email";
2723 }
2724
Joe Perches20112472011-07-25 17:13:23 -07002725 }
2726 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002727 if (WARN("BAD_SIGN_OFF",
2728 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2729 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002730 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002731 "$ucfirst_sign_off $email";
2732 }
Joe Perches20112472011-07-25 17:13:23 -07002733 }
2734
Joe Perchesdfa05c22020-04-06 20:10:48 -07002735 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Joe Perches20112472011-07-25 17:13:23 -07002736 my $suggested_email = format_email(($email_name, $email_address));
2737 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002738 ERROR("BAD_SIGN_OFF",
2739 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002740 } else {
2741 my $dequoted = $suggested_email;
2742 $dequoted =~ s/^"//;
2743 $dequoted =~ s/" </ </;
2744 # Don't force email to have quotes
2745 # Allow just an angle bracketed address
Joe Perchesdfa05c22020-04-06 20:10:48 -07002746 if (!same_email_addresses($email, $suggested_email)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002747 WARN("BAD_SIGN_OFF",
2748 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002749 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002750 }
Joe Perches7e51f192013-09-11 14:23:57 -07002751
2752# Check for duplicate signatures
2753 my $sig_nospace = $line;
2754 $sig_nospace =~ s/\s//g;
2755 $sig_nospace = lc($sig_nospace);
2756 if (defined $signatures{$sig_nospace}) {
2757 WARN("BAD_SIGN_OFF",
2758 "Duplicate signature\n" . $herecurr);
2759 } else {
2760 $signatures{$sig_nospace} = 1;
2761 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07002762
2763# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2764 if ($sign_off =~ /^co-developed-by:$/i) {
2765 if ($email eq $author) {
2766 WARN("BAD_SIGN_OFF",
2767 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2768 }
2769 if (!defined $lines[$linenr]) {
2770 WARN("BAD_SIGN_OFF",
2771 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2772 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2773 WARN("BAD_SIGN_OFF",
2774 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2775 } elsif ($1 ne $email) {
2776 WARN("BAD_SIGN_OFF",
2777 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2778 }
2779 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002780 }
2781
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002782# Check email subject for common tools that don't need to be mentioned
2783 if ($in_header_lines &&
2784 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2785 WARN("EMAIL_SUBJECT",
2786 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2787 }
2788
Joe Perches44d303e2020-04-06 20:11:10 -07002789# Check for Gerrit Change-Ids not in any patch context
2790 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002791 ERROR("GERRIT_CHANGE_ID",
Joe Perches44d303e2020-04-06 20:11:10 -07002792 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002793 }
2794
Joe Perches369c8dd2015-11-06 16:31:34 -08002795# Check if the commit log is in a possible stack dump
2796 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2797 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2798 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2799 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07002800 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2801 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2802 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2803 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08002804 $commit_log_possible_stack_dump = 1;
2805 }
2806
Joe Perches2a076f42015-04-16 12:44:28 -07002807# Check for line lengths > 75 in commit log, warn once
2808 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002809 length($line) > 75 &&
2810 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2811 # file delta changes
2812 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2813 # filename then :
2814 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2815 # A Fixes: or Link: line
2816 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002817 WARN("COMMIT_LOG_LONG_LINE",
2818 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2819 $commit_log_long_line = 1;
2820 }
2821
Joe Perchesbf4daf12015-09-09 15:37:50 -07002822# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002823 if ($in_commit_log && $commit_log_possible_stack_dump &&
2824 $line =~ /^\s*$/) {
2825 $commit_log_possible_stack_dump = 0;
2826 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002827
Joe Perches0d7835f2015-02-13 14:38:35 -08002828# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002829 if ($in_commit_log && !$commit_log_possible_stack_dump &&
John Hubbarda8972572020-04-06 20:10:55 -07002830 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002831 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002832 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002833 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002834 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2835 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002836 my $init_char = "c";
2837 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002838 my $short = 1;
2839 my $long = 0;
2840 my $case = 1;
2841 my $space = 1;
2842 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002843 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002844 my $id = '0123456789ab';
2845 my $orig_desc = "commit description";
2846 my $description = "";
2847
Joe Perchesfe043ea2015-09-09 15:37:25 -07002848 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2849 $init_char = $1;
2850 $orig_commit = lc($2);
2851 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2852 $orig_commit = lc($1);
2853 }
2854
Joe Perches0d7835f2015-02-13 14:38:35 -08002855 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2856 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2857 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2858 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2859 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2860 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002861 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002862 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2863 defined $rawlines[$linenr] &&
2864 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2865 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002866 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002867 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2868 defined $rawlines[$linenr] &&
2869 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2870 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2871 $orig_desc = $1;
2872 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2873 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002874 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002875 }
2876
2877 ($id, $description) = git_commit_info($orig_commit,
2878 $id, $orig_desc);
2879
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002880 if (defined($id) &&
2881 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002882 ERROR("GIT_COMMIT_ID",
2883 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2884 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002885 }
2886
Joe Perches13f19372014-08-06 16:10:59 -07002887# Check for added, moved or deleted files
2888 if (!$reported_maintainer_file && !$in_commit_log &&
2889 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2890 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2891 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2892 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002893 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002894 $reported_maintainer_file = 1;
2895 WARN("FILE_PATH_CHANGES",
2896 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2897 }
2898
Rob Herringe400edb2019-09-12 15:18:20 +01002899# Check for adding new DT bindings not in schema format
2900 if (!$in_commit_log &&
2901 ($line =~ /^new file mode\s*\d+\s*$/) &&
2902 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2903 WARN("DT_SCHEMA_BINDING_PATCH",
2904 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2905 }
2906
Andy Whitcroft00df3442007-06-08 13:47:06 -07002907# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002908 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002909 ERROR("CORRUPTED_PATCH",
2910 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002911 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002912 }
2913
2914# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2915 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002916 $rawline !~ m/^$UTF8*$/) {
2917 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2918
2919 my $blank = copy_spacing($rawline);
2920 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2921 my $hereptr = "$hereline$ptr\n";
2922
Joe Perches34d99212011-07-25 17:13:26 -07002923 CHK("INVALID_UTF8",
2924 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002925 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002926
Joe Perches15662b32011-10-31 17:13:12 -07002927# Check if it's the start of a commit log
2928# (not a header line and we haven't seen the patch filename)
2929 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002930 !($rawline =~ /^\s+(?:\S|$)/ ||
2931 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002932 $in_header_lines = 0;
2933 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002934 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002935 }
2936
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002937# Check if there is UTF-8 in a commit log when a mail header has explicitly
2938# declined it, i.e defined some charset where it is missing.
2939 if ($in_header_lines &&
2940 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2941 $1 !~ /utf-8/i) {
2942 $non_utf8_charset = 1;
2943 }
2944
2945 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002946 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002947 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002948 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2949 }
2950
Joe Perchesd6430f72016-12-12 16:46:28 -08002951# Check for absolute kernel paths in commit message
2952 if ($tree && $in_commit_log) {
2953 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2954 my $file = $1;
2955
2956 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2957 check_absolute_file($1, $herecurr)) {
2958 #
2959 } else {
2960 check_absolute_file($file, $herecurr);
2961 }
2962 }
2963 }
2964
Kees Cook66b47b42014-10-13 15:51:57 -07002965# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002966 if (defined($misspellings) &&
2967 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002968 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002969 my $typo = $1;
2970 my $typo_fix = $spelling_fix{lc($typo)};
2971 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2972 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002973 my $msg_level = \&WARN;
2974 $msg_level = \&CHK if ($file);
2975 if (&{$msg_level}("TYPO_SPELLING",
2976 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002977 $fix) {
2978 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2979 }
2980 }
2981 }
2982
Matteo Crocea8dd86b2019-09-25 16:46:38 -07002983# check for invalid commit id
2984 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2985 my $id;
2986 my $description;
2987 ($id, $description) = git_commit_info($2, undef, undef);
2988 if (!defined($id)) {
2989 WARN("UNKNOWN_COMMIT_ID",
2990 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2991 }
2992 }
2993
Joe Perches310cd062020-10-15 20:11:52 -07002994# check for repeated words separated by a single space
2995 if ($rawline =~ /^\+/ || $in_commit_log) {
2996 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
2997
2998 my $first = $1;
2999 my $second = $2;
3000
3001 if ($first =~ /(?:struct|union|enum)/) {
3002 pos($rawline) += length($first) + length($second) + 1;
3003 next;
3004 }
3005
3006 next if ($first ne $second);
3007 next if ($first eq 'long');
3008
3009 if (WARN("REPEATED_WORD",
3010 "Possible repeated word: '$first'\n" . $herecurr) &&
3011 $fix) {
3012 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3013 }
3014 }
3015
3016 # if it's a repeated word on consecutive lines in a comment block
3017 if ($prevline =~ /$;+\s*$/ &&
3018 $prevrawline =~ /($word_pattern)\s*$/) {
3019 my $last_word = $1;
3020 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3021 if (WARN("REPEATED_WORD",
3022 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3023 $fix) {
3024 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3025 }
3026 }
3027 }
3028 }
3029
Andy Whitcroft306708542008-10-15 22:02:28 -07003030# ignore non-hunk lines and lines being removed
3031 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003032
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003033#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003034 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003035 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07003036 if (ERROR("DOS_LINE_ENDINGS",
3037 "DOS line endings\n" . $herevet) &&
3038 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003039 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003040 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003041 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3042 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003043 if (ERROR("TRAILING_WHITESPACE",
3044 "trailing whitespace\n" . $herevet) &&
3045 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003046 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07003047 }
3048
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003049 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003050 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07003051
Josh Triplett4783f892013-11-12 15:10:12 -08003052# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08003053 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08003054 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08003055 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3056 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08003057 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07003058 my $msg_level = \&ERROR;
3059 $msg_level = \&CHK if ($file);
3060 &{$msg_level}("FSF_MAILING_ADDRESS",
3061 "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 -08003062 }
3063
Andi Kleen33549572010-05-24 14:33:29 -07003064# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003065# Only applies when adding the entry originally, after that we do not have
3066# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07003067 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01003068 # 'choice' is usually the last thing on the line (though
3069 # Kconfig supports named choices), so use a word boundary
3070 # (\b) rather than a whitespace character (\s)
3071 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07003072 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003073 my $cnt = $realcnt;
3074 my $ln = $linenr + 1;
3075 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003076 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003077 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003078 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003079 $f = $lines[$ln - 1];
3080 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3081 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003082
3083 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07003084 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08003085
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01003086 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003087 $is_start = 1;
Masahiro Yamada22a4ac02020-06-17 12:02:20 +09003088 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003089 $length = -1;
3090 }
3091
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003092 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07003093 $f =~ s/#.*//;
3094 $f =~ s/^\s+//;
3095 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01003096
3097 # This only checks context lines in the patch
3098 # and so hopefully shouldn't trigger false
3099 # positives, even though some of these are
3100 # common words in help texts
3101 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3102 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003103 $is_end = 1;
3104 last;
3105 }
Andi Kleen33549572010-05-24 14:33:29 -07003106 $length++;
3107 }
Vadim Bendebury56193272014-10-13 15:51:48 -07003108 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3109 WARN("CONFIG_DESCRIPTION",
3110 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3111 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003112 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003113 }
3114
Joe Perches7ccf41a2020-06-04 16:50:33 -07003115# check MAINTAINERS entries
3116 if ($realfile =~ /^MAINTAINERS$/) {
3117# check MAINTAINERS entries for the right form
3118 if ($rawline =~ /^\+[A-Z]:/ &&
3119 $rawline !~ /^\+[A-Z]:\t\S/) {
3120 if (WARN("MAINTAINERS_STYLE",
3121 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3122 $fix) {
3123 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3124 }
3125 }
3126# check MAINTAINERS entries for the right ordering too
3127 my $preferred_order = 'MRLSWQBCPTFXNK';
3128 if ($rawline =~ /^\+[A-Z]:/ &&
3129 $prevrawline =~ /^[\+ ][A-Z]:/) {
3130 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3131 my $cur = $1;
3132 my $curval = $2;
3133 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3134 my $prev = $1;
3135 my $prevval = $2;
3136 my $curindex = index($preferred_order, $cur);
3137 my $previndex = index($preferred_order, $prev);
3138 if ($curindex < 0) {
3139 WARN("MAINTAINERS_STYLE",
3140 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3141 } else {
3142 if ($previndex >= 0 && $curindex < $previndex) {
3143 WARN("MAINTAINERS_STYLE",
3144 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3145 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3146 ($prev eq 'X' && $cur eq 'X')) &&
3147 ($prevval cmp $curval) > 0) {
3148 WARN("MAINTAINERS_STYLE",
3149 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3150 }
3151 }
Joe Perches628f91a2017-07-10 15:52:07 -07003152 }
3153 }
3154
Christoph Jaeger327953e2015-02-13 14:38:29 -08003155# discourage the use of boolean for type definition attributes of Kconfig options
3156 if ($realfile =~ /Kconfig/ &&
3157 $line =~ /^\+\s*\bboolean\b/) {
3158 WARN("CONFIG_TYPE_BOOLEAN",
3159 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3160 }
3161
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003162 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3163 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3164 my $flag = $1;
3165 my $replacement = {
3166 'EXTRA_AFLAGS' => 'asflags-y',
3167 'EXTRA_CFLAGS' => 'ccflags-y',
3168 'EXTRA_CPPFLAGS' => 'cppflags-y',
3169 'EXTRA_LDFLAGS' => 'ldflags-y',
3170 };
3171
3172 WARN("DEPRECATED_VARIABLE",
3173 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3174 }
3175
Rob Herringbff5da42014-01-23 15:54:51 -08003176# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003177 if (defined $root &&
3178 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3179 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3180
Rob Herringbff5da42014-01-23 15:54:51 -08003181 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3182
Florian Vaussardcc933192014-04-03 14:49:27 -07003183 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003184 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003185
Rob Herringbff5da42014-01-23 15:54:51 -08003186 foreach my $compat (@compats) {
3187 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003188 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3189 my $compat3 = $compat;
3190 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3191 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003192 if ( $? >> 8 ) {
3193 WARN("UNDOCUMENTED_DT_STRING",
3194 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3195 }
3196
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003197 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3198 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003199 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003200 if ( $? >> 8 ) {
3201 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003202 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003203 }
3204 }
3205 }
3206
Rob Herring9f3a8992018-04-10 16:33:13 -07003207# check for using SPDX license tag at beginning of files
3208 if ($realline == $checklicenseline) {
3209 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3210 $checklicenseline = 2;
3211 } elsif ($rawline =~ /^\+/) {
3212 my $comment = "";
3213 if ($realfile =~ /\.(h|s|S)$/) {
3214 $comment = '/*';
3215 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3216 $comment = '//';
Lubomir Rintelc8df0ab2020-04-06 20:10:51 -07003217 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003218 $comment = '#';
3219 } elsif ($realfile =~ /\.rst$/) {
3220 $comment = '..';
3221 }
3222
Joe Perchesfdf13692019-03-07 16:28:32 -08003223# check SPDX comment style for .[chsS] files
3224 if ($realfile =~ /\.[chsS]$/ &&
3225 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003226 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003227 WARN("SPDX_LICENSE_TAG",
3228 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3229 }
3230
Rob Herring9f3a8992018-04-10 16:33:13 -07003231 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003232 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3233 WARN("SPDX_LICENSE_TAG",
3234 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003235 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003236 my $spdx_license = $1;
3237 if (!is_SPDX_License_valid($spdx_license)) {
3238 WARN("SPDX_LICENSE_TAG",
3239 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3240 }
Lubomir Rintel50c92902020-04-06 20:11:13 -07003241 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3242 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3243 my $msg_level = \&WARN;
3244 $msg_level = \&CHK if ($file);
3245 if (&{$msg_level}("SPDX_LICENSE_TAG",
3246
3247 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3248 $fix) {
3249 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3250 }
3251 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003252 }
3253 }
3254 }
3255
Andy Whitcroft5368df202008-10-15 22:02:27 -07003256# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003257 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003258
Joe Perchesa8da38a2019-03-07 16:28:42 -08003259# check for using SPDX-License-Identifier on the wrong line number
3260 if ($realline != $checklicenseline &&
3261 $rawline =~ /\bSPDX-License-Identifier:/ &&
3262 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3263 WARN("SPDX_LICENSE_TAG",
3264 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3265 }
3266
Joe Perches47e0c882015-06-25 15:02:57 -07003267# line length limit (with some exclusions)
3268#
3269# There are a few types of lines that may extend beyond $max_line_length:
3270# logging functions like pr_info that end in a string
3271# lines with a single string
3272# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003273# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003274#
3275# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003276# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003277# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3278# LONG_LINE all other lines longer than $max_line_length
3279#
3280# if LONG_LINE is ignored, the other 2 types are also ignored
3281#
3282
Joe Perchesb4749e92015-07-17 16:24:01 -07003283 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003284 my $msg_type = "LONG_LINE";
3285
3286 # Check the allowed long line types first
3287
3288 # logging functions that end in a string that starts
3289 # before $max_line_length
3290 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3291 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3292 $msg_type = "";
3293
3294 # lines with only strings (w/ possible termination)
3295 # #defines with only strings
3296 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3297 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3298 $msg_type = "";
3299
Joe Perchescc147502017-11-17 15:28:44 -08003300 # More special cases
3301 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3302 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003303 $msg_type = "";
3304
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003305 # URL ($rawline is used in case the URL is in a comment)
3306 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3307 $msg_type = "";
3308
Joe Perches47e0c882015-06-25 15:02:57 -07003309 # Otherwise set the alternate message types
3310
3311 # a comment starts before $max_line_length
3312 } elsif ($line =~ /($;[\s$;]*)$/ &&
3313 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3314 $msg_type = "LONG_LINE_COMMENT"
3315
3316 # a quoted string starts before $max_line_length
3317 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3318 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3319 $msg_type = "LONG_LINE_STRING"
3320 }
3321
3322 if ($msg_type ne "" &&
3323 (show_type("LONG_LINE") || show_type($msg_type))) {
Joe Perchesbdc48fa2020-05-29 16:12:21 -07003324 my $msg_level = \&WARN;
3325 $msg_level = \&CHK if ($file);
3326 &{$msg_level}($msg_type,
3327 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
Joe Perches47e0c882015-06-25 15:02:57 -07003328 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003329 }
3330
Andy Whitcroft8905a672007-11-28 16:21:06 -08003331# check for adding lines without a newline.
3332 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003333 WARN("MISSING_EOF_NEWLINE",
3334 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003335 }
3336
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003337# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003338 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003339
3340# at the beginning of a line any tabs must come first and anything
Antonio Borneo713a09d2020-04-06 20:11:07 -07003341# more than $tabsize must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003342 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3343 $rawline =~ /^\+\s* \s*/) {
3344 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003345 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003346 if (ERROR("CODE_INDENT",
3347 "code indent should use tabs where possible\n" . $herevet) &&
3348 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003349 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003350 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003351 }
3352
Alberto Panizzo08e44362010-03-05 13:43:54 -08003353# check for space before tabs.
3354 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3355 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003356 if (WARN("SPACE_BEFORE_TAB",
3357 "please, no space before tabs\n" . $herevet) &&
3358 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003359 while ($fixed[$fixlinenr] =~
Antonio Borneo713a09d2020-04-06 20:11:07 -07003360 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003361 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003362 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003363 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003364 }
3365
Joe Perches6a487212018-04-10 16:34:04 -07003366# check for assignments on the start of a line
3367 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3368 CHK("ASSIGNMENT_CONTINUATIONS",
3369 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3370 }
3371
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003372# check for && or || at the start of a line
3373 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3374 CHK("LOGICAL_CONTINUATIONS",
3375 "Logical continuations should be on the previous line\n" . $hereprev);
3376 }
3377
Joe Perchesa91e8992016-05-20 17:04:05 -07003378# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003379 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003380 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003381 my $indent = length($1);
Antonio Borneo713a09d2020-04-06 20:11:07 -07003382 if ($indent % $tabsize) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003383 if (WARN("TABSTOP",
3384 "Statements should start on a tabstop\n" . $herecurr) &&
3385 $fix) {
Antonio Borneo713a09d2020-04-06 20:11:07 -07003386 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
Joe Perchesa91e8992016-05-20 17:04:05 -07003387 }
3388 }
3389 }
3390
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003391# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003392 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003393 $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 -07003394 $prevline =~ /^\+(\t*)(.*)$/;
3395 my $oldindent = $1;
3396 my $rest = $2;
3397
3398 my $pos = pos_last_openparen($rest);
3399 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003400 $line =~ /^(\+| )([ \t]*)/;
3401 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003402
3403 my $goodtabindent = $oldindent .
Antonio Borneo713a09d2020-04-06 20:11:07 -07003404 "\t" x ($pos / $tabsize) .
3405 " " x ($pos % $tabsize);
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003406 my $goodspaceindent = $oldindent . " " x $pos;
3407
3408 if ($newindent ne $goodtabindent &&
3409 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003410
3411 if (CHK("PARENTHESIS_ALIGNMENT",
3412 "Alignment should match open parenthesis\n" . $hereprev) &&
3413 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003414 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003415 s/^\+[ \t]*/\+$goodtabindent/;
3416 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003417 }
3418 }
3419 }
3420
Joe Perches6ab3a972015-04-16 12:44:05 -07003421# check for space after cast like "(int) foo" or "(struct foo) bar"
3422# avoid checking a few false positives:
3423# "sizeof(<type>)" or "__alignof__(<type>)"
3424# function pointer declarations like "(*foo)(int) = bar;"
3425# structure definitions like "(struct foo) { 0 };"
3426# multiline macros that define functions
3427# known attributes or the __attribute__ keyword
3428 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3429 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003430 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003431 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003432 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003433 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003434 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003435 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003436 }
3437
Joe Perches86406b12015-09-09 15:37:41 -07003438# Block comment styles
3439# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003440 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003441 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003442 $rawline =~ /^\+[ \t]*\*/ &&
3443 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003444 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3445 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3446 }
3447
Joe Perches86406b12015-09-09 15:37:41 -07003448# Block comments use * on subsequent lines
3449 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3450 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003451 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003452 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003453 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003454 WARN("BLOCK_COMMENT_STYLE",
3455 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003456 }
3457
Joe Perches86406b12015-09-09 15:37:41 -07003458# Block comments use */ on trailing lines
3459 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003460 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3461 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3462 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003463 WARN("BLOCK_COMMENT_STYLE",
3464 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003465 }
3466
Joe Perches08eb9b82016-10-11 13:51:50 -07003467# Block comment * alignment
3468 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003469 $line =~ /^\+[ \t]*$;/ && #leading comment
3470 $rawline =~ /^\+[ \t]*\*/ && #leading *
3471 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003472 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003473 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3474 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003475 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003476 if (defined($1)) {
3477 $oldindent = expand_tabs($1);
3478 } else {
3479 $prevrawline =~ m@^\+(.*/?)\*@;
3480 $oldindent = expand_tabs($1);
3481 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003482 $rawline =~ m@^\+([ \t]*)\*@;
3483 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003484 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003485 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003486 WARN("BLOCK_COMMENT_STYLE",
3487 "Block comments should align the * on each line\n" . $hereprev);
3488 }
3489 }
3490
Joe Perches7f619192014-08-06 16:10:39 -07003491# check for missing blank lines after struct/union declarations
3492# with exceptions for various attributes and macros
3493 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3494 $line =~ /^\+/ &&
3495 !($line =~ /^\+\s*$/ ||
3496 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3497 $line =~ /^\+\s*MODULE_/i ||
3498 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3499 $line =~ /^\+[a-z_]*init/ ||
3500 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3501 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003502 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003503 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003504 if (CHK("LINE_SPACING",
3505 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3506 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003507 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003508 }
Joe Perches7f619192014-08-06 16:10:39 -07003509 }
3510
Joe Perches365dd4e2014-08-06 16:10:42 -07003511# check for multiple consecutive blank lines
3512 if ($prevline =~ /^[\+ ]\s*$/ &&
3513 $line =~ /^\+\s*$/ &&
3514 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003515 if (CHK("LINE_SPACING",
3516 "Please don't use multiple blank lines\n" . $hereprev) &&
3517 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003518 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003519 }
3520
Joe Perches365dd4e2014-08-06 16:10:42 -07003521 $last_blank_line = $linenr;
3522 }
3523
Joe Perches3b617e32014-04-03 14:49:28 -07003524# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003525 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3526 # actual declarations
3527 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003528 # function pointer declarations
3529 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003530 # foo bar; where foo is some local typedef or #define
3531 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3532 # known declaration macros
3533 $prevline =~ /^\+\s+$declaration_macros/) &&
3534 # for "else if" which can look like "$Ident $Ident"
3535 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3536 # other possible extensions of declaration lines
3537 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3538 # not starting a section or a macro "\" extended line
3539 $prevline =~ /(?:\{\s*|\\)$/) &&
3540 # looks like a declaration
3541 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003542 # function pointer declarations
3543 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003544 # foo bar; where foo is some local typedef or #define
3545 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3546 # known declaration macros
3547 $sline =~ /^\+\s+$declaration_macros/ ||
3548 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003549 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003550 # start or end of block or continuation of declaration
3551 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3552 # bitfield continuation
3553 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3554 # other possible extensions of declaration lines
3555 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3556 # indentation of previous and current line are the same
3557 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003558 if (WARN("LINE_SPACING",
3559 "Missing a blank line after declarations\n" . $hereprev) &&
3560 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003561 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003562 }
Joe Perches3b617e32014-04-03 14:49:28 -07003563 }
3564
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003565# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003566# Exceptions:
3567# 1) within comments
3568# 2) indented preprocessor commands
3569# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003570 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003571 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003572 if (WARN("LEADING_SPACE",
3573 "please, no spaces at the start of a line\n" . $herevet) &&
3574 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003575 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003576 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003577 }
3578
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003579# check we are in a valid C source file if not then ignore this hunk
3580 next if ($realfile !~ /\.(h|c)$/);
3581
Joe Perches5751a242017-11-17 15:28:52 -08003582# check for unusual line ending [ or (
3583 if ($line =~ /^\+.*([\[\(])\s*$/) {
3584 CHK("OPEN_ENDED_LINE",
3585 "Lines should not end with a '$1'\n" . $herecurr);
3586 }
3587
Joe Perches4dbed762017-05-08 15:55:39 -07003588# check if this appears to be the start function declaration, save the name
3589 if ($sline =~ /^\+\{\s*$/ &&
3590 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3591 $context_function = $1;
3592 }
3593
3594# check if this appears to be the end of function declaration
3595 if ($sline =~ /^\+\}\s*$/) {
3596 undef $context_function;
3597 }
3598
Joe Perches032a4c02014-08-06 16:10:29 -07003599# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003600# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003601# if the previous line is a break or return and is indented 1 tab more...
3602 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3603 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003604 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3605 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3606 defined $lines[$linenr] &&
3607 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003608 WARN("UNNECESSARY_ELSE",
3609 "else is not generally useful after a break or return\n" . $hereprev);
3610 }
3611 }
3612
Joe Perchesc00df192014-08-06 16:11:01 -07003613# check indentation of a line with a break;
3614# if the previous line is a goto or return and is indented the same # of tabs
3615 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3616 my $tabs = $1;
3617 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3618 WARN("UNNECESSARY_BREAK",
3619 "break is not useful after a goto or return\n" . $hereprev);
3620 }
3621 }
3622
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003623# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003624 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003625 WARN("CVS_KEYWORD",
3626 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003627 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003628
Joe Perches56e77d72013-02-21 16:44:14 -08003629# check for old HOTPLUG __dev<foo> section markings
3630 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3631 WARN("HOTPLUG_SECTION",
3632 "Using $1 is unnecessary\n" . $herecurr);
3633 }
3634
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003635# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003636 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3637 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003638#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003639 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003640 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003641 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003642 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003643 $stat =~ s/\n./\n /g;
3644 $cond =~ s/\n./\n /g;
3645
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003646#print "linenr<$linenr> <$stat>\n";
3647 # If this statement has no statement boundaries within
3648 # it there is no point in retrying a statement scan
3649 # until we hit end of it.
3650 my $frag = $stat; $frag =~ s/;+\s*$//;
3651 if ($frag !~ /(?:{|;)/) {
3652#print "skip<$line_nr_next>\n";
3653 $suppress_statement = $line_nr_next;
3654 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003655
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003656 # Find the real next line.
3657 $realline_next = $line_nr_next;
3658 if (defined $realline_next &&
3659 (!defined $lines[$realline_next - 1] ||
3660 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3661 $realline_next++;
3662 }
3663
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003664 my $s = $stat;
3665 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003666
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003667 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003668 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003669
3670 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003671 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003672
Andy Whitcroft463f2862009-09-21 17:04:34 -07003673 } elsif ($s =~ /^.\s*else\b/s) {
3674
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003675 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003676 } 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 -07003677 my $type = $1;
3678 $type =~ s/\s+/ /g;
3679 possible($type, "A:" . $s);
3680
Andy Whitcroft8905a672007-11-28 16:21:06 -08003681 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003682 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003683 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003684 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003685
3686 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003687 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003688 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003689 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003690
3691 # Check for any sort of function declaration.
3692 # int foo(something bar, other baz);
3693 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003694 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 -08003695 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003696
Andy Whitcroftcf655042008-03-04 14:28:20 -08003697 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003698 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003699 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003700
Andy Whitcroft8905a672007-11-28 16:21:06 -08003701 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003702 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003703
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003704 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003705 }
3706 }
3707 }
3708
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003709 }
3710
Andy Whitcroft653d4872007-06-23 17:16:34 -07003711#
3712# Checks which may be anchored in the context.
3713#
3714
3715# Check for switch () and associated case and default
3716# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003717 if ($line=~/\bswitch\s*\(.*\)/) {
3718 my $err = '';
3719 my $sep = '';
3720 my @ctx = ctx_block_outer($linenr, $realcnt);
3721 shift(@ctx);
3722 for my $ctx (@ctx) {
3723 my ($clen, $cindent) = line_stats($ctx);
3724 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3725 $indent != $cindent) {
3726 $err .= "$sep$ctx\n";
3727 $sep = '';
3728 } else {
3729 $sep = "[...]\n";
3730 }
3731 }
3732 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003733 ERROR("SWITCH_CASE_INDENT_LEVEL",
3734 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003735 }
3736 }
3737
3738# if/while/etc brace do not go on next line, unless defining a do while loop,
3739# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003740 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 -07003741 my $pre_ctx = "$1$2";
3742
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003743 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003744
3745 if ($line =~ /^\+\t{6,}/) {
3746 WARN("DEEP_INDENTATION",
3747 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3748 }
3749
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003750 my $ctx_cnt = $realcnt - $#ctx - 1;
3751 my $ctx = join("\n", @ctx);
3752
Andy Whitcroft548596d2008-07-23 21:29:01 -07003753 my $ctx_ln = $linenr;
3754 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003755
Andy Whitcroft548596d2008-07-23 21:29:01 -07003756 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3757 defined $lines[$ctx_ln - 1] &&
3758 $lines[$ctx_ln - 1] =~ /^-/)) {
3759 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3760 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003761 $ctx_ln++;
3762 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003763
Andy Whitcroft53210162008-07-23 21:29:03 -07003764 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3765 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003766
Joe Perchesd752fcc2014-08-06 16:11:05 -07003767 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003768 ERROR("OPEN_BRACE",
3769 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003770 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003771 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003772 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3773 $ctx =~ /\)\s*\;\s*$/ &&
3774 defined $lines[$ctx_ln - 1])
3775 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003776 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3777 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003778 WARN("TRAILING_SEMICOLON",
3779 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003780 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003781 }
3782 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003783 }
3784
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003785# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003786 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 -08003787 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3788 ctx_statement_block($linenr, $realcnt, 0)
3789 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003790 my ($s, $c) = ($stat, $cond);
3791
3792 substr($s, 0, length($c), '');
3793
Joe Perches9f5af482015-09-09 15:37:30 -07003794 # remove inline comments
3795 $s =~ s/$;/ /g;
3796 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003797
3798 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003799 my @newlines = ($c =~ /\n/gs);
3800 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003801
Joe Perches9f5af482015-09-09 15:37:30 -07003802 # Make sure we remove the line prefixes as we have
3803 # none on the first line, and are going to readd them
3804 # where necessary.
3805 $s =~ s/\n./\n/gs;
3806 while ($s =~ /\n\s+\\\n/) {
3807 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3808 }
3809
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003810 # We want to check the first line inside the block
3811 # starting at the end of the conditional, so remove:
3812 # 1) any blank line termination
3813 # 2) any opening brace { on end of the line
3814 # 3) any do (...) {
3815 my $continuation = 0;
3816 my $check = 0;
3817 $s =~ s/^.*\bdo\b//;
3818 $s =~ s/^\s*{//;
3819 if ($s =~ s/^\s*\\//) {
3820 $continuation = 1;
3821 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003822 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003823 $check = 1;
3824 $cond_lines++;
3825 }
3826
3827 # Also ignore a loop construct at the end of a
3828 # preprocessor statement.
3829 if (($prevline =~ /^.\s*#\s*define\s/ ||
3830 $prevline =~ /\\\s*$/) && $continuation == 0) {
3831 $check = 0;
3832 }
3833
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003834 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003835 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003836 while ($cond_ptr != $cond_lines) {
3837 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003838
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003839 # If we see an #else/#elif then the code
3840 # is not linear.
3841 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3842 $check = 0;
3843 }
3844
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003845 # Ignore:
3846 # 1) blank lines, they should be at 0,
3847 # 2) preprocessor lines, and
3848 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003849 if ($continuation ||
3850 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003851 $s =~ /^\s*#\s*?/ ||
3852 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003853 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003854 if ($s =~ s/^.*?\n//) {
3855 $cond_lines++;
3856 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003857 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003858 }
3859
3860 my (undef, $sindent) = line_stats("+" . $s);
3861 my $stat_real = raw_line($linenr, $cond_lines);
3862
3863 # Check if either of these lines are modified, else
3864 # this is not this patch's fault.
3865 if (!defined($stat_real) ||
3866 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3867 $check = 0;
3868 }
3869 if (defined($stat_real) && $cond_lines > 1) {
3870 $stat_real = "[...]\n$stat_real";
3871 }
3872
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003873 #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 -07003874
Joe Perches9f5af482015-09-09 15:37:30 -07003875 if ($check && $s ne '' &&
Antonio Borneo713a09d2020-04-06 20:11:07 -07003876 (($sindent % $tabsize) != 0 ||
Joe Perches9f5af482015-09-09 15:37:30 -07003877 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003878 ($sindent == $indent &&
3879 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Antonio Borneo713a09d2020-04-06 20:11:07 -07003880 ($sindent > $indent + $tabsize))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003881 WARN("SUSPECT_CODE_INDENT",
3882 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003883 }
3884 }
3885
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003886 # Track the 'values' across context and added lines.
3887 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003888 my ($curr_values, $curr_vars) =
3889 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003890 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003891 if ($dbg_values) {
3892 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003893 print "$linenr > .$outline\n";
3894 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003895 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003896 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003897 $prev_values = substr($curr_values, -1);
3898
Andy Whitcroft00df3442007-06-08 13:47:06 -07003899#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003900 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003901
Joe Perches11ca40a2016-12-12 16:46:31 -08003902# check for dereferences that span multiple lines
3903 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3904 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3905 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3906 my $ref = $1;
3907 $line =~ /^.\s*($Lval)/;
3908 $ref .= $1;
3909 $ref =~ s/\s//g;
3910 WARN("MULTILINE_DEREFERENCE",
3911 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3912 }
3913
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003914# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003915 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 -07003916 my $type = $1;
3917 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003918 $var = "" if (!defined $var);
3919 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003920 my $sign = $1;
3921 my $pointer = $2;
3922
3923 $pointer = "" if (!defined $pointer);
3924
3925 if (WARN("UNSPECIFIED_INT",
3926 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3927 $fix) {
3928 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003929 my $comp_pointer = $pointer;
3930 $comp_pointer =~ s/\s//g;
3931 $decl .= $comp_pointer;
3932 $decl = rtrim($decl) if ($var eq "");
3933 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003934 }
3935 }
3936 }
3937
Andy Whitcroft653d4872007-06-23 17:16:34 -07003938# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003939 if ($dbg_type) {
3940 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003941 ERROR("TEST_TYPE",
3942 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003943 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003944 ERROR("TEST_NOT_TYPE",
3945 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003946 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003947 next;
3948 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003949# TEST: allow direct testing of the attribute matcher.
3950 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003951 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003952 ERROR("TEST_ATTR",
3953 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003954 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003955 ERROR("TEST_NOT_ATTR",
3956 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003957 }
3958 next;
3959 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003960
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003961# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003962 if ($line =~ /^.\s*{/ &&
3963 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003964 if (ERROR("OPEN_BRACE",
3965 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003966 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3967 fix_delete_line($fixlinenr - 1, $prevrawline);
3968 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003969 my $fixedline = $prevrawline;
3970 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003971 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003972 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003973 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003974 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003975 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003976 }
3977
Andy Whitcroft653d4872007-06-23 17:16:34 -07003978#
3979# Checks which are anchored on the added line.
3980#
3981
3982# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003983 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003984 my $path = $1;
3985 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003986 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003987 "malformed #include filename\n" . $herecurr);
3988 }
3989 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3990 ERROR("UAPI_INCLUDE",
3991 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003992 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003993 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003994
3995# no C99 // comments
3996 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003997 if (ERROR("C99_COMMENTS",
3998 "do not use C99 // comments\n" . $herecurr) &&
3999 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004000 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07004001 if ($line =~ /\/\/(.*)$/) {
4002 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07004003 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07004004 }
4005 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004006 }
4007 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004008 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004009 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004010
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004011# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4012# the whole statement.
4013#print "APW <$lines[$realline_next - 1]>\n";
4014 if (defined $realline_next &&
4015 exists $lines[$realline_next - 1] &&
4016 !defined $suppress_export{$realline_next} &&
4017 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4018 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004019 # Handle definitions which produce identifiers with
4020 # a prefix:
4021 # XXX(foo);
4022 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004023 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08004024 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004025 $name =~ /^${Ident}_$2/) {
4026#print "FOO C name<$name>\n";
4027 $suppress_export{$realline_next} = 1;
4028
4029 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004030 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07004031 ^.DEFINE_$Ident\(\Q$name\E\)|
4032 ^.DECLARE_$Ident\(\Q$name\E\)|
4033 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004034 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4035 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07004036 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004037#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4038 $suppress_export{$realline_next} = 2;
4039 } else {
4040 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004041 }
4042 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004043 if (!defined $suppress_export{$linenr} &&
4044 $prevline =~ /^.\s*$/ &&
4045 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4046 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4047#print "FOO B <$lines[$linenr - 1]>\n";
4048 $suppress_export{$linenr} = 2;
4049 }
4050 if (defined $suppress_export{$linenr} &&
4051 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004052 WARN("EXPORT_SYMBOL",
4053 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004054 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004055
Joe Eloff5150bda2010-08-09 17:21:00 -07004056# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004057 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004058 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004059 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07004060 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004061 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004062 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004063 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004064# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004065 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004066 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004067 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07004068 $herecurr) &&
4069 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004070 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004071 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004072 }
4073
Joe Perches18130872014-08-06 16:11:22 -07004074# check for misordered declarations of char/short/int/long with signed/unsigned
4075 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4076 my $tmp = trim($1);
4077 WARN("MISORDERED_TYPE",
4078 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4079 }
4080
Joe Perches809e0822018-08-21 21:58:12 -07004081# check for unnecessary <signed> int declarations of short/long/long long
4082 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4083 my $type = trim($1);
4084 next if ($type !~ /\bint\b/);
4085 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4086 my $new_type = $type;
4087 $new_type =~ s/\b\s*int\s*\b/ /;
4088 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4089 $new_type =~ s/^const\s+//;
4090 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4091 $new_type = "const $new_type" if ($type =~ /^const\b/);
4092 $new_type =~ s/\s+/ /g;
4093 $new_type = trim($new_type);
4094 if (WARN("UNNECESSARY_INT",
4095 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4096 $fix) {
4097 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4098 }
4099 }
4100
Joe Perchescb710ec2010-10-26 14:23:20 -07004101# check for static const char * arrays.
4102 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004103 WARN("STATIC_CONST_CHAR_ARRAY",
4104 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004105 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004106 }
4107
4108# check for initialized const char arrays that should be static const
4109 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4110 if (WARN("STATIC_CONST_CHAR_ARRAY",
4111 "const array should probably be static const\n" . $herecurr) &&
4112 $fix) {
4113 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4114 }
4115 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004116
4117# check for static char foo[] = "bar" declarations.
4118 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004119 WARN("STATIC_CONST_CHAR_ARRAY",
4120 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004121 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004122 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004123
Joe Perchesab7e23f2015-04-16 12:44:22 -07004124# check for const <foo> const where <foo> is not a pointer or array type
4125 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4126 my $found = $1;
4127 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4128 WARN("CONST_CONST",
4129 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4130 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4131 WARN("CONST_CONST",
4132 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4133 }
4134 }
4135
Joe Perches9b0fa602014-04-03 14:49:18 -07004136# check for non-global char *foo[] = {"bar", ...} declarations.
4137 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4138 WARN("STATIC_CONST_CHAR_ARRAY",
4139 "char * array declaration might be better as static const\n" .
4140 $herecurr);
4141 }
4142
Joe Perchesb598b672015-04-16 12:44:36 -07004143# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4144 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4145 my $array = $1;
4146 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4147 my $array_div = $1;
4148 if (WARN("ARRAY_SIZE",
4149 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4150 $fix) {
4151 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4152 }
4153 }
4154 }
4155
Joe Perchesb36190c2014-01-27 17:07:18 -08004156# check for function declarations without arguments like "int foo()"
Joe Perches16b7f3c2020-04-06 20:11:17 -07004157 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
Joe Perchesb36190c2014-01-27 17:07:18 -08004158 if (ERROR("FUNCTION_WITHOUT_ARGS",
4159 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4160 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004161 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004162 }
4163 }
4164
Andy Whitcroft653d4872007-06-23 17:16:34 -07004165# check for new typedefs, only function parameters and sparse annotations
4166# make sense.
4167 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004168 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004169 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004170 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004171 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004172 WARN("NEW_TYPEDEFS",
4173 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004174 }
4175
4176# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004177 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004178 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4179 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004180 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004181
Andy Whitcroft65863862009-01-06 14:41:21 -08004182 # Should start with a space.
4183 $to =~ s/^(\S)/ $1/;
4184 # Should not end with a space.
4185 $to =~ s/\s+$//;
4186 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004187 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004188 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004189
Joe Perches3705ce52013-07-03 15:05:31 -07004190## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004191 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004192 if (ERROR("POINTER_LOCATION",
4193 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4194 $fix) {
4195 my $sub_from = $ident;
4196 my $sub_to = $ident;
4197 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004198 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004199 s@\Q$sub_from\E@$sub_to@;
4200 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004201 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004202 }
4203 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4204 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004205 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004206
Andy Whitcroft65863862009-01-06 14:41:21 -08004207 # Should start with a space.
4208 $to =~ s/^(\S)/ $1/;
4209 # Should not end with a space.
4210 $to =~ s/\s+$//;
4211 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004212 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004213 }
4214 # Modifiers should have spaces.
4215 $to =~ s/(\b$Modifier$)/$1 /;
4216
Joe Perches3705ce52013-07-03 15:05:31 -07004217## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004218 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004219 if (ERROR("POINTER_LOCATION",
4220 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4221 $fix) {
4222
4223 my $sub_from = $match;
4224 my $sub_to = $match;
4225 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004226 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004227 s@\Q$sub_from\E@$sub_to@;
4228 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004229 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004230 }
4231
Joe Perches9d3e3c72015-09-09 15:37:27 -07004232# avoid BUG() or BUG_ON()
4233 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004234 my $msg_level = \&WARN;
4235 $msg_level = \&CHK if ($file);
4236 &{$msg_level}("AVOID_BUG",
4237 "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 -07004238 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004239
Joe Perches9d3e3c72015-09-09 15:37:27 -07004240# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004241 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004242 WARN("LINUX_VERSION_CODE",
4243 "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 -08004244 }
4245
Joe Perches17441222011-06-15 15:08:17 -07004246# check for uses of printk_ratelimit
4247 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004248 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004249 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004250 }
4251
Joe Percheseeef5732017-11-17 15:28:41 -08004252# printk should use KERN_* levels
4253 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4254 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4255 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004256 }
4257
Joe Perches243f3802012-05-31 16:26:09 -07004258 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4259 my $orig = $1;
4260 my $level = lc($orig);
4261 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004262 my $level2 = $level;
4263 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004264 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004265 "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 -07004266 }
4267
Joe Perchesdc139312013-02-21 16:44:13 -08004268 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4269 my $orig = $1;
4270 my $level = lc($orig);
4271 $level = "warn" if ($level eq "warning");
4272 $level = "dbg" if ($level eq "debug");
4273 WARN("PREFER_DEV_LEVEL",
4274 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4275 }
4276
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004277# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4278# number of false positives, but assembly files are not checked, so at
4279# least the arch entry code will not trigger this warning.
4280 if ($line =~ /\bENOSYS\b/) {
4281 WARN("ENOSYS",
4282 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4283 }
4284
Jakub Kicinski6b9ea5f2020-05-11 10:08:07 -07004285# ENOTSUPP is not a standard error code and should be avoided in new patches.
4286# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4287# Similarly to ENOSYS warning a small number of false positives is expected.
4288 if (!$file && $line =~ /\bENOTSUPP\b/) {
4289 if (WARN("ENOTSUPP",
4290 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4291 $fix) {
4292 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4293 }
4294 }
4295
Andy Whitcroft653d4872007-06-23 17:16:34 -07004296# function brace can't be on same line, except for #defines of do while,
4297# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004298 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004299 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4300 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4301 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004302 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004303 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004304 $fix) {
4305 fix_delete_line($fixlinenr, $rawline);
4306 my $fixed_line = $rawline;
4307 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4308 my $line1 = $1;
4309 my $line2 = $2;
4310 fix_insert_line($fixlinenr, ltrim($line1));
4311 fix_insert_line($fixlinenr, "\+{");
4312 if ($line2 !~ /^\s*$/) {
4313 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4314 }
4315 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004316 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004317
Andy Whitcroft8905a672007-11-28 16:21:06 -08004318# open braces for enum, union and struct go on the same line.
4319 if ($line =~ /^.\s*{/ &&
4320 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004321 if (ERROR("OPEN_BRACE",
4322 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4323 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4324 fix_delete_line($fixlinenr - 1, $prevrawline);
4325 fix_delete_line($fixlinenr, $rawline);
4326 my $fixedline = rtrim($prevrawline) . " {";
4327 fix_insert_line($fixlinenr, $fixedline);
4328 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004329 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004330 if ($fixedline !~ /^\+\s*$/) {
4331 fix_insert_line($fixlinenr, $fixedline);
4332 }
4333 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004334 }
4335
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004336# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004337 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4338 if (WARN("SPACING",
4339 "missing space after $1 definition\n" . $herecurr) &&
4340 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004341 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004342 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4343 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004344 }
4345
Joe Perches31070b52014-01-23 15:54:49 -08004346# Function pointer declarations
4347# check spacing between type, funcptr, and args
4348# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004349 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004350 my $declare = $1;
4351 my $pre_pointer_space = $2;
4352 my $post_pointer_space = $3;
4353 my $funcname = $4;
4354 my $post_funcname_space = $5;
4355 my $pre_args_space = $6;
4356
Joe Perches91f72e92014-04-03 14:49:12 -07004357# the $Declare variable will capture all spaces after the type
4358# so check it for a missing trailing missing space but pointer return types
4359# don't need a space so don't warn for those.
4360 my $post_declare_space = "";
4361 if ($declare =~ /(\s+)$/) {
4362 $post_declare_space = $1;
4363 $declare = rtrim($declare);
4364 }
4365 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004366 WARN("SPACING",
4367 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004368 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004369 }
4370
4371# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004372# This test is not currently implemented because these declarations are
4373# equivalent to
4374# int foo(int bar, ...)
4375# and this is form shouldn't/doesn't generate a checkpatch warning.
4376#
4377# elsif ($declare =~ /\s{2,}$/) {
4378# WARN("SPACING",
4379# "Multiple spaces after return type\n" . $herecurr);
4380# }
Joe Perches31070b52014-01-23 15:54:49 -08004381
4382# unnecessary space "type ( *funcptr)(args...)"
4383 if (defined $pre_pointer_space &&
4384 $pre_pointer_space =~ /^\s/) {
4385 WARN("SPACING",
4386 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4387 }
4388
4389# unnecessary space "type (* funcptr)(args...)"
4390 if (defined $post_pointer_space &&
4391 $post_pointer_space =~ /^\s/) {
4392 WARN("SPACING",
4393 "Unnecessary space before function pointer name\n" . $herecurr);
4394 }
4395
4396# unnecessary space "type (*funcptr )(args...)"
4397 if (defined $post_funcname_space &&
4398 $post_funcname_space =~ /^\s/) {
4399 WARN("SPACING",
4400 "Unnecessary space after function pointer name\n" . $herecurr);
4401 }
4402
4403# unnecessary space "type (*funcptr) (args...)"
4404 if (defined $pre_args_space &&
4405 $pre_args_space =~ /^\s/) {
4406 WARN("SPACING",
4407 "Unnecessary space before function pointer arguments\n" . $herecurr);
4408 }
4409
4410 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004411 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004412 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004413 }
4414 }
4415
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004416# check for spacing round square brackets; allowed:
4417# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004418# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4419# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004420 while ($line =~ /(.*?\s)\[/g) {
4421 my ($where, $prefix) = ($-[1], $1);
4422 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004423 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004424 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004425 if (ERROR("BRACKET_SPACE",
4426 "space prohibited before open square bracket '['\n" . $herecurr) &&
4427 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004428 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004429 s/^(\+.*?)\s+\[/$1\[/;
4430 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004431 }
4432 }
4433
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004434# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004435 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004436 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004437 my $ctx_before = substr($line, 0, $-[1]);
4438 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004439
4440 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004441 if ($name =~ /^(?:
4442 if|for|while|switch|return|case|
4443 volatile|__volatile__|
4444 __attribute__|format|__extension__|
4445 asm|__asm__)$/x)
4446 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004447 # cpp #define statements have non-optional spaces, ie
4448 # if there is a space between the name and the open
4449 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004450 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004451
4452 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004453 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004454
4455 # If this whole things ends with a type its most
4456 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004457 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004458
4459 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004460 if (WARN("SPACING",
4461 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4462 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004463 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004464 s/\b$name\s+\(/$name\(/;
4465 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004466 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004467 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004468
Andy Whitcroft653d4872007-06-23 17:16:34 -07004469# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004470 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004471 my $fixed_line = "";
4472 my $line_fixed = 0;
4473
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004474 my $ops = qr{
4475 <<=|>>=|<=|>=|==|!=|
4476 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4477 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004478 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004479 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004480 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004481 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004482
4483## print("element count: <" . $#elements . ">\n");
4484## foreach my $el (@elements) {
4485## print("el: <$el>\n");
4486## }
4487
4488 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004489 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004490
Joe Perches3705ce52013-07-03 15:05:31 -07004491 foreach my $el (@elements) {
4492 push(@fix_elements, substr($rawline, $off, length($el)));
4493 $off += length($el);
4494 }
4495
4496 $off = 0;
4497
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004498 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004499 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004500
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004501 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004502
4503 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4504
4505## print("n: <$n> good: <$good>\n");
4506
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004507 $off += length($elements[$n]);
4508
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004509 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004510 my $ca = substr($opline, 0, $off);
4511 my $cc = '';
4512 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4513 $cc = substr($opline, $off + length($elements[$n + 1]));
4514 }
4515 my $cb = "$ca$;$cc";
4516
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004517 my $a = '';
4518 $a = 'V' if ($elements[$n] ne '');
4519 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004520 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004521 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4522 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004523 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004524
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004525 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004526
4527 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004528 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004529 $c = 'V' if ($elements[$n + 2] ne '');
4530 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004531 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004532 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4533 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004534 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004535 } else {
4536 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004537 }
4538
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004539 my $ctx = "${a}x${c}";
4540
4541 my $at = "(ctx:$ctx)";
4542
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004543 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004544 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004545
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004546 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004547 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004548
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004549 # Get the full operator variant.
4550 my $opv = $op . substr($curr_vars, $off, 1);
4551
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004552 # Ignore operators passed as parameters.
4553 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004554 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004555
Andy Whitcroftcf655042008-03-04 14:28:20 -08004556# # Ignore comments
4557# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004558
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004559 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004560 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004561 if ($ctx !~ /.x[WEBC]/ &&
4562 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004563 if (ERROR("SPACING",
4564 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004565 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004566 $line_fixed = 1;
4567 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004568 }
4569
4570 # // is a comment
4571 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004572
Joe Perchesb00e4812014-04-03 14:49:33 -07004573 # : when part of a bitfield
4574 } elsif ($opv eq ':B') {
4575 # skip the bitfield test for now
4576
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004577 # No spaces for:
4578 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004579 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004580 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004581 if (ERROR("SPACING",
4582 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004583 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004584 if (defined $fix_elements[$n + 2]) {
4585 $fix_elements[$n + 2] =~ s/^\s+//;
4586 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004587 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004588 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004589 }
4590
Joe Perches23810972014-12-10 15:51:32 -08004591 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004592 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004593 my $rtrim_before = 0;
4594 my $space_after = 0;
4595 if ($ctx =~ /Wx./) {
4596 if (ERROR("SPACING",
4597 "space prohibited before that '$op' $at\n" . $hereptr)) {
4598 $line_fixed = 1;
4599 $rtrim_before = 1;
4600 }
4601 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004602 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004603 if (ERROR("SPACING",
4604 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004605 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004606 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004607 $space_after = 1;
4608 }
4609 }
4610 if ($rtrim_before || $space_after) {
4611 if ($rtrim_before) {
4612 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4613 } else {
4614 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4615 }
4616 if ($space_after) {
4617 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004618 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004619 }
4620
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004621 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004622 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004623 #warn "'*' is part of type\n";
4624
4625 # unary operators should have a space before and
4626 # none after. May be left adjacent to another
4627 # unary operator, or a cast
4628 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004629 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004630 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004631 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004632 if (ERROR("SPACING",
4633 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004634 if ($n != $last_after + 2) {
4635 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4636 $line_fixed = 1;
4637 }
Joe Perches3705ce52013-07-03 15:05:31 -07004638 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004639 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004640 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004641 # A unary '*' may be const
4642
4643 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004644 if (ERROR("SPACING",
4645 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004646 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004647 if (defined $fix_elements[$n + 2]) {
4648 $fix_elements[$n + 2] =~ s/^\s+//;
4649 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004650 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004651 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004652 }
4653
4654 # unary ++ and unary -- are allowed no space on one side.
4655 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004656 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004657 if (ERROR("SPACING",
4658 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004659 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004660 $line_fixed = 1;
4661 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004662 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004663 if ($ctx =~ /Wx[BE]/ ||
4664 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004665 if (ERROR("SPACING",
4666 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004667 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004668 $line_fixed = 1;
4669 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004670 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004671 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004672 if (ERROR("SPACING",
4673 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004674 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004675 if (defined $fix_elements[$n + 2]) {
4676 $fix_elements[$n + 2] =~ s/^\s+//;
4677 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004678 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004679 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004680 }
4681
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004682 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004683 } elsif ($op eq '<<' or $op eq '>>' or
4684 $op eq '&' or $op eq '^' or $op eq '|' or
4685 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004686 $op eq '*' or $op eq '/' or
4687 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004688 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004689 if ($check) {
4690 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4691 if (CHK("SPACING",
4692 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4693 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4694 $fix_elements[$n + 2] =~ s/^\s+//;
4695 $line_fixed = 1;
4696 }
4697 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4698 if (CHK("SPACING",
4699 "space preferred before that '$op' $at\n" . $hereptr)) {
4700 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4701 $line_fixed = 1;
4702 }
4703 }
4704 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004705 if (ERROR("SPACING",
4706 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004707 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4708 if (defined $fix_elements[$n + 2]) {
4709 $fix_elements[$n + 2] =~ s/^\s+//;
4710 }
Joe Perches3705ce52013-07-03 15:05:31 -07004711 $line_fixed = 1;
4712 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004713 }
4714
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004715 # A colon needs no spaces before when it is
4716 # terminating a case value or a label.
4717 } elsif ($opv eq ':C' || $opv eq ':L') {
4718 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004719 if (ERROR("SPACING",
4720 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004721 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004722 $line_fixed = 1;
4723 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004724 }
4725
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004726 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004727 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004728 my $ok = 0;
4729
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004730 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004731 if (($op eq '<' &&
4732 $cc =~ /^\S+\@\S+>/) ||
4733 ($op eq '>' &&
4734 $ca =~ /<\S+\@\S+$/))
4735 {
Antonio Borneo342d3d22020-04-06 20:11:01 -07004736 $ok = 1;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004737 }
4738
Joe Perchese0df7e12015-04-16 12:44:53 -07004739 # for asm volatile statements
4740 # ignore a colon with another
4741 # colon immediately before or after
4742 if (($op eq ':') &&
4743 ($ca =~ /:$/ || $cc =~ /^:/)) {
4744 $ok = 1;
4745 }
4746
Joe Perches84731622013-11-12 15:10:05 -08004747 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004748 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004749 my $msg_level = \&ERROR;
4750 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004751
Jean Delvare0675a8f2017-09-08 16:16:07 -07004752 if (&{$msg_level}("SPACING",
4753 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004754 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4755 if (defined $fix_elements[$n + 2]) {
4756 $fix_elements[$n + 2] =~ s/^\s+//;
4757 }
Joe Perches3705ce52013-07-03 15:05:31 -07004758 $line_fixed = 1;
4759 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004760 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004761 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004762 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004763
4764## print("n: <$n> GOOD: <$good>\n");
4765
4766 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004767 }
Joe Perches3705ce52013-07-03 15:05:31 -07004768
4769 if (($#elements % 2) == 0) {
4770 $fixed_line = $fixed_line . $fix_elements[$#elements];
4771 }
4772
Joe Perches194f66f2014-08-06 16:11:03 -07004773 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4774 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004775 }
4776
4777
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004778 }
4779
Joe Perches786b6322013-07-03 15:05:32 -07004780# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004781 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004782 if (WARN("SPACING",
4783 "space prohibited before semicolon\n" . $herecurr) &&
4784 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004785 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004786 s/^(\+.*\S)\s+;/$1;/;
4787 }
4788 }
4789
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004790# check for multiple assignments
4791 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004792 CHK("MULTIPLE_ASSIGNMENTS",
4793 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004794 }
4795
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004796## # check for multiple declarations, allowing for a function declaration
4797## # continuation.
4798## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4799## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4800##
4801## # Remove any bracketed sections to ensure we do not
4802## # falsly report the parameters of functions.
4803## my $ln = $line;
4804## while ($ln =~ s/\([^\(\)]*\)//g) {
4805## }
4806## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004807## WARN("MULTIPLE_DECLARATION",
4808## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004809## }
4810## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004811
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004812#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004813 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004814 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004815 if (ERROR("SPACING",
4816 "space required before the open brace '{'\n" . $herecurr) &&
4817 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004818 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004819 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004820 }
4821
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004822## # check for blank lines before declarations
4823## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4824## $prevrawline =~ /^.\s*$/) {
4825## WARN("SPACING",
4826## "No blank lines before declarations\n" . $hereprev);
4827## }
4828##
4829
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004830# closing brace should have a space following it when it has anything
4831# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07004832 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004833 if (ERROR("SPACING",
4834 "space required after that close brace '}'\n" . $herecurr) &&
4835 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004836 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004837 s/}((?!(?:,|;|\)))\S)/} $1/;
4838 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004839 }
4840
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004841# check spacing on square brackets
4842 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004843 if (ERROR("SPACING",
4844 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4845 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004846 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004847 s/\[\s+/\[/;
4848 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004849 }
4850 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004851 if (ERROR("SPACING",
4852 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4853 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004854 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004855 s/\s+\]/\]/;
4856 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004857 }
4858
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004859# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004860 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4861 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004862 if (ERROR("SPACING",
4863 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4864 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004865 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004866 s/\(\s+/\(/;
4867 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004868 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004869 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004870 $line !~ /for\s*\(.*;\s+\)/ &&
4871 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004872 if (ERROR("SPACING",
4873 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4874 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004875 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004876 s/\s+\)/\)/;
4877 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004878 }
4879
Joe Perchese2826fd2014-08-06 16:10:48 -07004880# check unnecessary parentheses around addressof/dereference single $Lvals
4881# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4882
4883 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004884 my $var = $1;
4885 if (CHK("UNNECESSARY_PARENTHESES",
4886 "Unnecessary parentheses around $var\n" . $herecurr) &&
4887 $fix) {
4888 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4889 }
4890 }
4891
4892# check for unnecessary parentheses around function pointer uses
4893# ie: (foo->bar)(); should be foo->bar();
4894# but not "if (foo->bar) (" to avoid some false positives
4895 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4896 my $var = $2;
4897 if (CHK("UNNECESSARY_PARENTHESES",
4898 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4899 $fix) {
4900 my $var2 = deparenthesize($var);
4901 $var2 =~ s/\s//g;
4902 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4903 }
4904 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004905
Joe Perches63b7c732017-09-08 16:16:01 -07004906# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004907# when !drivers/staging or command-line uses --strict
4908 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07004909 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004910 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4911 my $if_stat = $1;
4912 my $test = substr($2, 1, -1);
4913 my $herectx;
4914 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4915 my $match = $1;
4916 # avoid parentheses around potential macro args
4917 next if ($match =~ /^\s*\w+\s*$/);
4918 if (!defined($herectx)) {
4919 $herectx = $here . "\n";
4920 my $cnt = statement_rawlines($if_stat);
4921 for (my $n = 0; $n < $cnt; $n++) {
4922 my $rl = raw_line($linenr, $n);
4923 $herectx .= $rl . "\n";
4924 last if $rl =~ /^[ \+].*\{/;
4925 }
4926 }
4927 CHK("UNNECESSARY_PARENTHESES",
4928 "Unnecessary parentheses around '$match'\n" . $herectx);
4929 }
4930 }
4931
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004932#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004933 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004934 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004935 if (WARN("INDENTED_LABEL",
4936 "labels should not be indented\n" . $herecurr) &&
4937 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004938 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004939 s/^(.)\s+/$1/;
4940 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004941 }
4942
Joe Perches40873ab2020-10-15 20:11:56 -07004943# check if a statement with a comma should be two statements like:
4944# foo = bar(), /* comma should be semicolon */
4945# bar = baz();
4946 if (defined($stat) &&
4947 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
4948 my $cnt = statement_rawlines($stat);
4949 my $herectx = get_stat_here($linenr, $cnt, $here);
4950 WARN("SUSPECT_COMMA_SEMICOLON",
4951 "Possible comma where semicolon could be used\n" . $herectx);
4952 }
4953
Joe Perches5b9553a2014-04-03 14:49:21 -07004954# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004955 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004956 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07004957 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004958 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4959 my $value = $1;
4960 $value = deparenthesize($value);
4961 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4962 ERROR("RETURN_PARENTHESES",
4963 "return is not a function, parentheses are not required\n" . $herecurr);
4964 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004965 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004966 ERROR("SPACING",
4967 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004968 }
4969 }
Joe Perches507e5142013-11-12 15:10:13 -08004970
Joe Perchesb43ae212014-06-23 13:22:07 -07004971# unnecessary return in a void function
4972# at end-of-function, with the previous line a single leading tab, then return;
4973# and the line before that not a goto label target like "out:"
4974 if ($sline =~ /^[ \+]}\s*$/ &&
4975 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4976 $linenr >= 3 &&
4977 $lines[$linenr - 3] =~ /^[ +]/ &&
4978 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004979 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004980 "void function return statements are not generally useful\n" . $hereprev);
4981 }
Joe Perches9819cf22014-06-04 16:12:09 -07004982
Joe Perches189248d2014-01-23 15:54:47 -08004983# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07004984 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08004985 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4986 my $openparens = $1;
4987 my $count = $openparens =~ tr@\(@\(@;
4988 my $msg = "";
4989 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4990 my $comp = $4; #Not $1 because of $LvalOrFunc
4991 $msg = " - maybe == should be = ?" if ($comp eq "==");
4992 WARN("UNNECESSARY_PARENTHESES",
4993 "Unnecessary parentheses$msg\n" . $herecurr);
4994 }
4995 }
4996
Joe Perchesc5595fa2015-09-09 15:37:58 -07004997# comparisons with a constant or upper case identifier on the left
4998# avoid cases like "foo + BAR < baz"
4999# only fix matches surrounded by parentheses to avoid incorrect
5000# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07005001 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005002 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5003 my $lead = $1;
5004 my $const = $2;
5005 my $comp = $3;
5006 my $to = $4;
5007 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07005008 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005009 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5010 WARN("CONSTANT_COMPARISON",
5011 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5012 $fix) {
5013 if ($comp eq "<") {
5014 $newcomp = ">";
5015 } elsif ($comp eq "<=") {
5016 $newcomp = ">=";
5017 } elsif ($comp eq ">") {
5018 $newcomp = "<";
5019 } elsif ($comp eq ">=") {
5020 $newcomp = "<=";
5021 }
5022 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5023 }
5024 }
5025
Joe Perchesf34e4a42015-04-16 12:44:19 -07005026# Return of what appears to be an errno should normally be negative
5027 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005028 my $name = $1;
5029 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07005030 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07005031 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005032 }
5033 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005034
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005035# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07005036 if ($line =~ /\b(if|while|for|switch)\(/) {
5037 if (ERROR("SPACING",
5038 "space required before the open parenthesis '('\n" . $herecurr) &&
5039 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005040 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005041 s/\b(if|while|for|switch)\(/$1 \(/;
5042 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005043 }
5044
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07005045# Check for illegal assignment in if conditional -- and check for trailing
5046# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005047 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08005048 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5049 ctx_statement_block($linenr, $realcnt, 0)
5050 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005051 my ($stat_next) = ctx_statement_block($line_nr_next,
5052 $remain_next, $off_next);
5053 $stat_next =~ s/\n./\n /g;
5054 ##print "stat<$stat> stat_next<$stat_next>\n";
5055
5056 if ($stat_next =~ /^\s*while\b/) {
5057 # If the statement carries leading newlines,
5058 # then count those as offsets.
5059 my ($whitespace) =
5060 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5061 my $offset =
5062 statement_rawlines($whitespace) - 1;
5063
5064 $suppress_whiletrailers{$line_nr_next +
5065 $offset} = 1;
5066 }
5067 }
5068 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08005069 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005070 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005071 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005072
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08005073 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches65b64b32020-08-11 18:35:10 -07005074 if (ERROR("ASSIGN_IN_IF",
5075 "do not use assignment in if condition\n" . $herecurr) &&
5076 $fix && $perl_version_ok) {
5077 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5078 my $space = $1;
5079 my $not = $2;
5080 my $statement = $3;
5081 my $assigned = $4;
5082 my $test = $8;
5083 my $against = $9;
5084 my $brace = $15;
5085 fix_delete_line($fixlinenr, $rawline);
5086 fix_insert_line($fixlinenr, "$space$statement;");
5087 my $newline = "${space}if (";
5088 $newline .= '!' if defined($not);
5089 $newline .= '(' if (defined $not && defined($test) && defined($against));
5090 $newline .= "$assigned";
5091 $newline .= " $test $against" if (defined($test) && defined($against));
5092 $newline .= ')' if (defined $not && defined($test) && defined($against));
5093 $newline .= ')';
5094 $newline .= " {" if (defined($brace));
5095 fix_insert_line($fixlinenr + 1, $newline);
5096 }
5097 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005098 }
5099
5100 # Find out what is on the end of the line after the
5101 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005102 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08005103 $s =~ s/\n.*//g;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005104 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07005105 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5106 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005107 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005108 # Find out how long the conditional actually is.
5109 my @newlines = ($c =~ /\n/gs);
5110 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005111 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005112
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005113 $stat_real = raw_line($linenr, $cond_lines)
5114 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005115 if (defined($stat_real) && $cond_lines > 1) {
5116 $stat_real = "[...]\n$stat_real";
5117 }
5118
Joe Perches000d1cc12011-07-25 17:13:25 -07005119 ERROR("TRAILING_STATEMENTS",
5120 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005121 }
5122 }
5123
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005124# Check for bitwise tests written as boolean
5125 if ($line =~ /
5126 (?:
5127 (?:\[|\(|\&\&|\|\|)
5128 \s*0[xX][0-9]+\s*
5129 (?:\&\&|\|\|)
5130 |
5131 (?:\&\&|\|\|)
5132 \s*0[xX][0-9]+\s*
5133 (?:\&\&|\|\||\)|\])
5134 )/x)
5135 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005136 WARN("HEXADECIMAL_BOOLEAN_TEST",
5137 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005138 }
5139
Andy Whitcroft8905a672007-11-28 16:21:06 -08005140# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005141 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5142 my $s = $1;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005143 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005144 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005145 ERROR("TRAILING_STATEMENTS",
5146 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005147 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005148 }
Andy Whitcroft39667782009-01-15 13:51:06 -08005149# if should not continue a brace
5150 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005151 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07005152 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08005153 $herecurr);
5154 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005155# case and default should not have general statements after them
5156 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5157 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07005158 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005159 \s*return\s+
5160 )/xg)
5161 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005162 ERROR("TRAILING_STATEMENTS",
5163 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005164 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005165
5166 # Check for }<nl>else {, these must be at the same
5167 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07005168 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5169 $previndent == $indent) {
5170 if (ERROR("ELSE_AFTER_BRACE",
5171 "else should follow close brace '}'\n" . $hereprev) &&
5172 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5173 fix_delete_line($fixlinenr - 1, $prevrawline);
5174 fix_delete_line($fixlinenr, $rawline);
5175 my $fixedline = $prevrawline;
5176 $fixedline =~ s/}\s*$//;
5177 if ($fixedline !~ /^\+\s*$/) {
5178 fix_insert_line($fixlinenr, $fixedline);
5179 }
5180 $fixedline = $rawline;
5181 $fixedline =~ s/^(.\s*)else/$1} else/;
5182 fix_insert_line($fixlinenr, $fixedline);
5183 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005184 }
5185
Joe Perches8b8856f2014-08-06 16:11:14 -07005186 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5187 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005188 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5189
5190 # Find out what is on the end of the line after the
5191 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005192 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005193 $s =~ s/\n.*//g;
5194
5195 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005196 if (ERROR("WHILE_AFTER_BRACE",
5197 "while should follow close brace '}'\n" . $hereprev) &&
5198 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5199 fix_delete_line($fixlinenr - 1, $prevrawline);
5200 fix_delete_line($fixlinenr, $rawline);
5201 my $fixedline = $prevrawline;
5202 my $trailing = $rawline;
5203 $trailing =~ s/^\+//;
5204 $trailing = trim($trailing);
5205 $fixedline =~ s/}\s*$/} $trailing/;
5206 fix_insert_line($fixlinenr, $fixedline);
5207 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005208 }
5209 }
5210
Joe Perches95e2c602013-07-03 15:05:20 -07005211#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005212 while ($line =~ m{($Constant|$Lval)}g) {
5213 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005214
Joe Perches95e2c602013-07-03 15:05:20 -07005215#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005216 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005217 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005218#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005219 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perchesd439e6a2019-12-04 16:52:06 -08005220#Ignore SI style variants like nS, mV and dB
5221#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5222 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Julius Wernerf5123572014-12-10 15:51:54 -08005223#Ignore some three character SI units explicitly, like MiB and KHz
5224 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005225 while ($var =~ m{($Ident)}g) {
5226 my $word = $1;
5227 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005228 if ($check) {
5229 seed_camelcase_includes();
5230 if (!$file && !$camelcase_file_seeded) {
5231 seed_camelcase_file($realfile);
5232 $camelcase_file_seeded = 1;
5233 }
5234 }
Joe Perches7e781f62013-09-11 14:23:55 -07005235 if (!defined $camelcase{$word}) {
5236 $camelcase{$word} = 1;
5237 CHK("CAMELCASE",
5238 "Avoid CamelCase: <$word>\n" . $herecurr);
5239 }
Joe Perches34456862013-07-03 15:05:34 -07005240 }
Joe Perches323c1262012-12-17 16:02:07 -08005241 }
5242 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005243
5244#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005245 if ($line =~ /\#\s*define.*\\\s+$/) {
5246 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5247 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5248 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005249 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005250 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005251 }
5252
Fabian Frederick0e212e02015-04-16 12:44:25 -07005253# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5254# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005255 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005256 my $file = "$1.h";
5257 my $checkfile = "include/linux/$file";
5258 if (-f "$root/$checkfile" &&
5259 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005260 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005261 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005262 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5263 if ($asminclude > 0) {
5264 if ($realfile =~ m{^arch/}) {
5265 CHK("ARCH_INCLUDE_LINUX",
5266 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5267 } else {
5268 WARN("INCLUDE_LINUX",
5269 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5270 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005271 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005272 }
5273 }
5274
Andy Whitcroft653d4872007-06-23 17:16:34 -07005275# multi-statement macros should be enclosed in a do while loop, grab the
5276# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005277# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07005278 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5279 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005280 my $ln = $linenr;
5281 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005282 my ($off, $dstat, $dcond, $rest);
5283 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005284 my $has_flow_statement = 0;
5285 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005286 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005287 ctx_statement_block($linenr, $realcnt, 0);
5288 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005289 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005290 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005291
Joe Perches08a28432014-10-13 15:51:55 -07005292 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005293 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005294
Joe Perchesf59b64b2016-10-11 13:52:08 -07005295 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5296 my $define_args = $1;
5297 my $define_stmt = $dstat;
5298 my @def_args = ();
5299
5300 if (defined $define_args && $define_args ne "") {
5301 $define_args = substr($define_args, 1, length($define_args) - 2);
5302 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005303 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005304 @def_args = split(",", $define_args);
5305 }
5306
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005307 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005308 $dstat =~ s/\\\n.//g;
5309 $dstat =~ s/^\s*//s;
5310 $dstat =~ s/\s*$//s;
5311
5312 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005313 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5314 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005315 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005316 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005317 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005318
Antonio Borneo342d3d22020-04-06 20:11:01 -07005319 # Flatten any obvious string concatenation.
Joe Perches33acb542015-06-25 15:02:54 -07005320 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5321 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005322 {
5323 }
5324
Joe Perches42e15292016-03-15 14:58:01 -07005325 # Make asm volatile uses seem like a generic function
5326 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5327
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005328 my $exceptions = qr{
5329 $Declare|
5330 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005331 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005332 DECLARE_PER_CPU|
5333 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005334 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005335 union|
5336 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005337 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005338 ^\"|\"$|
5339 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005340 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005341 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005342
5343 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005344 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005345 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005346
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005347 if ($dstat ne '' &&
5348 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5349 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005350 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005351 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005352 $dstat !~ /$exceptions/ &&
5353 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005354 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005355 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005356 $dstat !~ /^for\s*$Constant$/ && # for (...)
5357 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5358 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005359 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005360 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005361 {
Joe Perchese7955562017-05-08 15:55:48 -07005362 if ($dstat =~ /^\s*if\b/) {
5363 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5364 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5365 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005366 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5367 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5368 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005369 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005370 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005371 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005372
5373 }
Joe Perches52076492016-10-11 13:52:14 -07005374
5375 # Make $define_stmt single line, comment-free, etc
5376 my @stmt_array = split('\n', $define_stmt);
5377 my $first = 1;
5378 $define_stmt = "";
5379 foreach my $l (@stmt_array) {
5380 $l =~ s/\\$//;
5381 if ($first) {
5382 $define_stmt = $l;
5383 $first = 0;
5384 } elsif ($l =~ /^[\+ ]/) {
5385 $define_stmt .= substr($l, 1);
5386 }
5387 }
5388 $define_stmt =~ s/$;//g;
5389 $define_stmt =~ s/\s+/ /g;
5390 $define_stmt = trim($define_stmt);
5391
Joe Perchesf59b64b2016-10-11 13:52:08 -07005392# check if any macro arguments are reused (ignore '...' and 'type')
5393 foreach my $arg (@def_args) {
5394 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005395 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005396 my $tmp_stmt = $define_stmt;
Brendan Jackman6dba8242019-09-25 16:46:41 -07005397 $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 -07005398 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5399 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005400 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005401 if ($use_cnt > 1) {
5402 CHK("MACRO_ARG_REUSE",
5403 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005404 }
5405# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005406 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005407 ((defined($1) && $1 ne ',') ||
5408 (defined($2) && $2 ne ','))) {
5409 CHK("MACRO_ARG_PRECEDENCE",
5410 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005411 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005412 }
Joe Perches5023d342012-12-17 16:01:47 -08005413
Joe Perches08a28432014-10-13 15:51:55 -07005414# check for macros with flow control, but without ## concatenation
5415# ## concatenation is commonly a macro that defines a function so ignore those
5416 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005417 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005418 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005419
Joe Perches08a28432014-10-13 15:51:55 -07005420 WARN("MACRO_WITH_FLOW_CONTROL",
5421 "Macros with flow control statements should be avoided\n" . "$herectx");
5422 }
5423
Joe Perches481eb482012-12-17 16:01:56 -08005424# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005425
5426 } else {
5427 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005428 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5429 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005430 $line =~ /^\+.*\\$/) {
5431 WARN("LINE_CONTINUATIONS",
5432 "Avoid unnecessary line continuations\n" . $herecurr);
5433 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005434 }
5435
Joe Perchesb13edf72012-07-30 14:41:24 -07005436# do {} while (0) macro tests:
5437# single-statement macros do not need to be enclosed in do while (0) loop,
5438# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005439 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005440 $realfile !~ m@/vmlinux.lds.h$@ &&
5441 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5442 my $ln = $linenr;
5443 my $cnt = $realcnt;
5444 my ($off, $dstat, $dcond, $rest);
5445 my $ctx = '';
5446 ($dstat, $dcond, $ln, $cnt, $off) =
5447 ctx_statement_block($linenr, $realcnt, 0);
5448 $ctx = $dstat;
5449
5450 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005451 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005452
5453 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5454 my $stmts = $2;
5455 my $semis = $3;
5456
5457 $ctx =~ s/\n*$//;
5458 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005459 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005460
Joe Perchesac8e97f2012-08-21 16:15:53 -07005461 if (($stmts =~ tr/;/;/) == 1 &&
5462 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005463 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5464 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5465 }
5466 if (defined $semis && $semis ne "") {
5467 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5468 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5469 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005470 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5471 $ctx =~ s/\n*$//;
5472 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005473 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005474
5475 WARN("TRAILING_SEMICOLON",
5476 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005477 }
5478 }
5479
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005480# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005481 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5482 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005483 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005484 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005485 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5486 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005487 my @allowed = ();
5488 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005489 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005490 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005491 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005492 for my $chunk (@chunks) {
5493 my ($cond, $block) = @{$chunk};
5494
Andy Whitcroft773647a2008-03-28 14:15:58 -07005495 # If the condition carries leading newlines, then count those as offsets.
5496 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5497 my $offset = statement_rawlines($whitespace) - 1;
5498
Joe Perchesaad4f612012-03-23 15:02:19 -07005499 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005500 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5501
5502 # We have looked at and allowed this specific line.
5503 $suppress_ifbraces{$ln + $offset} = 1;
5504
5505 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005506 $ln += statement_rawlines($block) - 1;
5507
Andy Whitcroft773647a2008-03-28 14:15:58 -07005508 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005509
5510 $seen++ if ($block =~ /^\s*{/);
5511
Joe Perchesaad4f612012-03-23 15:02:19 -07005512 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005513 if (statement_lines($cond) > 1) {
5514 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005515 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005516 }
5517 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005518 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005519 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005520 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005521 if (statement_block_size($block) > 1) {
5522 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005523 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005524 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005525 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005526 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005527 if ($seen) {
5528 my $sum_allowed = 0;
5529 foreach (@allowed) {
5530 $sum_allowed += $_;
5531 }
5532 if ($sum_allowed == 0) {
5533 WARN("BRACES",
5534 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5535 } elsif ($sum_allowed != $allow &&
5536 $seen != $allow) {
5537 CHK("BRACES",
5538 "braces {} should be used on all arms of this statement\n" . $herectx);
5539 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005540 }
5541 }
5542 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005543 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005544 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005545 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005546
Andy Whitcroftcf655042008-03-04 14:28:20 -08005547 # Check the pre-context.
5548 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5549 #print "APW: ALLOWED: pre<$1>\n";
5550 $allowed = 1;
5551 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005552
5553 my ($level, $endln, @chunks) =
5554 ctx_statement_full($linenr, $realcnt, $-[0]);
5555
Andy Whitcroftcf655042008-03-04 14:28:20 -08005556 # Check the condition.
5557 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005558 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005559 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005560 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005561 }
5562 if (statement_lines($cond) > 1) {
5563 #print "APW: ALLOWED: cond<$cond>\n";
5564 $allowed = 1;
5565 }
5566 if ($block =~/\b(?:if|for|while)\b/) {
5567 #print "APW: ALLOWED: block<$block>\n";
5568 $allowed = 1;
5569 }
5570 if (statement_block_size($block) > 1) {
5571 #print "APW: ALLOWED: lines block<$block>\n";
5572 $allowed = 1;
5573 }
5574 # Check the post-context.
5575 if (defined $chunks[1]) {
5576 my ($cond, $block) = @{$chunks[1]};
5577 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005578 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005579 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005580 if ($block =~ /^\s*\{/) {
5581 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5582 $allowed = 1;
5583 }
5584 }
5585 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005586 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005587 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005588
Joe Perches000d1cc12011-07-25 17:13:25 -07005589 WARN("BRACES",
5590 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005591 }
5592 }
5593
Joe Perchese4c5bab2017-02-24 15:01:41 -08005594# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005595 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5596 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005597 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5598 }
5599
Joe Perches0979ae62012-12-17 16:01:59 -08005600# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005601 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005602 if (CHK("BRACES",
5603 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5604 $fix && $prevrawline =~ /^\+/) {
5605 fix_delete_line($fixlinenr - 1, $prevrawline);
5606 }
Joe Perches0979ae62012-12-17 16:01:59 -08005607 }
Joe Perches77b9a532013-07-03 15:05:29 -07005608 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005609 if (CHK("BRACES",
5610 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5611 $fix) {
5612 fix_delete_line($fixlinenr, $rawline);
5613 }
Joe Perches0979ae62012-12-17 16:01:59 -08005614 }
5615
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005616# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005617 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5618 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005619 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005620 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005621 }
5622
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005623# Check for user-visible strings broken across lines, which breaks the ability
5624# to grep for the string. Make exceptions when the previous string ends in a
5625# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5626# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005627 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005628 $prevline =~ /"\s*$/ &&
5629 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5630 if (WARN("SPLIT_STRING",
5631 "quoted string split across lines\n" . $hereprev) &&
5632 $fix &&
5633 $prevrawline =~ /^\+.*"\s*$/ &&
5634 $last_coalesced_string_linenr != $linenr - 1) {
5635 my $extracted_string = get_quoted_string($line, $rawline);
5636 my $comma_close = "";
5637 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5638 $comma_close = $1;
5639 }
5640
5641 fix_delete_line($fixlinenr - 1, $prevrawline);
5642 fix_delete_line($fixlinenr, $rawline);
5643 my $fixedline = $prevrawline;
5644 $fixedline =~ s/"\s*$//;
5645 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5646 fix_insert_line($fixlinenr - 1, $fixedline);
5647 $fixedline = $rawline;
5648 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5649 if ($fixedline !~ /\+\s*$/) {
5650 fix_insert_line($fixlinenr, $fixedline);
5651 }
5652 $last_coalesced_string_linenr = $linenr;
5653 }
5654 }
5655
5656# check for missing a space in a string concatenation
5657 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5658 WARN('MISSING_SPACE',
5659 "break quoted strings at a space character\n" . $hereprev);
5660 }
5661
Joe Perchese4b7d302017-05-08 15:55:51 -07005662# check for an embedded function name in a string when the function is known
5663# This does not work very well for -f --file checking as it depends on patch
5664# context providing the function name or a single line form for in-file
5665# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005666 if ($line =~ /^\+.*$String/ &&
5667 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005668 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5669 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005670 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005671 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005672 }
5673
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005674# check for spaces before a quoted newline
5675 if ($rawline =~ /^.*\".*\s\\n/) {
5676 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5677 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5678 $fix) {
5679 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5680 }
5681
5682 }
5683
Joe Perchesf17dba42014-10-13 15:51:51 -07005684# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005685 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5686 if (CHK("CONCATENATED_STRING",
5687 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5688 $fix) {
5689 while ($line =~ /($String)/g) {
5690 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5691 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5692 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5693 }
5694 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005695 }
5696
Joe Perches90ad30e2014-12-10 15:51:59 -08005697# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005698 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005699 if (WARN("STRING_FRAGMENTS",
5700 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5701 $fix) {
5702 while ($line =~ /($String)(?=\s*")/g) {
5703 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5704 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5705 }
5706 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005707 }
5708
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005709# check for non-standard and hex prefixed decimal printf formats
5710 my $show_L = 1; #don't show the same defect twice
5711 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005712 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005713 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005714 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005715 # check for %L
5716 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005717 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005718 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5719 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005720 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005721 # check for %Z
5722 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5723 WARN("PRINTF_Z",
5724 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5725 $show_Z = 0;
5726 }
5727 # check for 0x<decimal>
5728 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5729 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005730 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5731 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005732 }
5733
5734# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005735 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005736 WARN("LINE_CONTINUATIONS",
5737 "Avoid line continuations in quoted strings\n" . $herecurr);
5738 }
5739
Andy Whitcroft00df3442007-06-08 13:47:06 -07005740# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005741 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07005742 WARN("IF_0",
5743 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5744 }
5745
5746# warn about #if 1
5747 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5748 WARN("IF_1",
5749 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005750 }
5751
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005752# check for needless "if (<foo>) fn(<foo>)" uses
5753 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005754 my $tested = quotemeta($1);
5755 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5756 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5757 my $func = $1;
5758 if (WARN('NEEDLESS_IF',
5759 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5760 $fix) {
5761 my $do_fix = 1;
5762 my $leading_tabs = "";
5763 my $new_leading_tabs = "";
5764 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5765 $leading_tabs = $1;
5766 } else {
5767 $do_fix = 0;
5768 }
5769 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5770 $new_leading_tabs = $1;
5771 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5772 $do_fix = 0;
5773 }
5774 } else {
5775 $do_fix = 0;
5776 }
5777 if ($do_fix) {
5778 fix_delete_line($fixlinenr - 1, $prevrawline);
5779 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5780 }
5781 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005782 }
5783 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005784
Joe Perchesebfdc402014-08-06 16:10:27 -07005785# check for unnecessary "Out of Memory" messages
5786 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5787 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5788 (defined $1 || defined $3) &&
5789 $linenr > 3) {
5790 my $testval = $2;
5791 my $testline = $lines[$linenr - 3];
5792
5793 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5794# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5795
Joe Perchese29a70f2019-03-07 16:28:35 -08005796 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5797 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005798 WARN("OOM_MESSAGE",
5799 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5800 }
5801 }
5802
Joe Perchesf78d98f2014-10-13 15:52:01 -07005803# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005804 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005805 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5806 my $level = $1;
5807 if (WARN("UNNECESSARY_KERN_LEVEL",
5808 "Possible unnecessary $level\n" . $herecurr) &&
5809 $fix) {
5810 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5811 }
5812 }
5813
Joe Perches45c55e92017-02-24 15:01:31 -08005814# check for logging continuations
5815 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5816 WARN("LOGGING_CONTINUATION",
5817 "Avoid logging continuation uses where feasible\n" . $herecurr);
5818 }
5819
Joe Perchesabb08a52014-12-10 15:51:46 -08005820# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07005821 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08005822 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5823 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5824 WARN("MASK_THEN_SHIFT",
5825 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5826 }
5827
Joe Perchesb75ac612014-12-10 15:52:02 -08005828# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07005829 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08005830 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5831 my $val = $1;
5832 my $equal = "!";
5833 $equal = "" if ($4 eq "!=");
5834 if (CHK("COMPARISON_TO_NULL",
5835 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5836 $fix) {
5837 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5838 }
5839 }
5840 }
5841
Joe Perches8716de32013-09-11 14:24:05 -07005842# check for bad placement of section $InitAttribute (e.g.: __initdata)
5843 if ($line =~ /(\b$InitAttribute\b)/) {
5844 my $attr = $1;
5845 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5846 my $ptr = $1;
5847 my $var = $2;
5848 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5849 ERROR("MISPLACED_INIT",
5850 "$attr should be placed after $var\n" . $herecurr)) ||
5851 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5852 WARN("MISPLACED_INIT",
5853 "$attr should be placed after $var\n" . $herecurr))) &&
5854 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005855 $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 -07005856 }
5857 }
5858 }
5859
Joe Perchese970b8842013-11-12 15:10:10 -08005860# check for $InitAttributeData (ie: __initdata) with const
5861 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5862 my $attr = $1;
5863 $attr =~ /($InitAttributePrefix)(.*)/;
5864 my $attr_prefix = $1;
5865 my $attr_type = $2;
5866 if (ERROR("INIT_ATTRIBUTE",
5867 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5868 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005869 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005870 s/$InitAttributeData/${attr_prefix}initconst/;
5871 }
5872 }
5873
5874# check for $InitAttributeConst (ie: __initconst) without const
5875 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5876 my $attr = $1;
5877 if (ERROR("INIT_ATTRIBUTE",
5878 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5879 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005880 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005881 /(^\+\s*(?:static\s+))/;
5882 $lead = rtrim($1);
5883 $lead = "$lead " if ($lead !~ /^\+$/);
5884 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005885 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005886 }
5887 }
5888
Joe Perchesc17893c2015-04-16 12:44:42 -07005889# check for __read_mostly with const non-pointer (should just be const)
5890 if ($line =~ /\b__read_mostly\b/ &&
5891 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5892 if (ERROR("CONST_READ_MOSTLY",
5893 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5894 $fix) {
5895 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5896 }
5897 }
5898
Joe Perchesfbdb8132014-04-03 14:49:14 -07005899# don't use __constant_<foo> functions outside of include/uapi/
5900 if ($realfile !~ m@^include/uapi/@ &&
5901 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5902 my $constant_func = $1;
5903 my $func = $constant_func;
5904 $func =~ s/^__constant_//;
5905 if (WARN("CONSTANT_CONVERSION",
5906 "$constant_func should be $func\n" . $herecurr) &&
5907 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005908 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005909 }
5910 }
5911
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005912# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005913 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005914 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005915 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005916 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005917 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005918 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07005919 }
5920 if ($delay > 2000) {
5921 WARN("LONG_UDELAY",
5922 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005923 }
5924 }
5925
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005926# warn about unexpectedly long msleep's
5927 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5928 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005929 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005930 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005931 }
5932 }
5933
Joe Perches36ec1932013-07-03 15:05:25 -07005934# check for comparisons of jiffies
5935 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5936 WARN("JIFFIES_COMPARISON",
5937 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5938 }
5939
Joe Perches9d7a34a2013-07-03 15:05:26 -07005940# check for comparisons of get_jiffies_64()
5941 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5942 WARN("JIFFIES_COMPARISON",
5943 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5944 }
5945
Andy Whitcroft00df3442007-06-08 13:47:06 -07005946# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005947# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005948# print "#ifdef in C files should be avoided\n";
5949# print "$herecurr";
5950# $clean = 0;
5951# }
5952
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005953# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005954 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005955 if (ERROR("SPACING",
5956 "exactly one space required after that #$1\n" . $herecurr) &&
5957 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005958 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005959 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5960 }
5961
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005962 }
5963
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005964# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005965 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5966 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005967 my $which = $1;
5968 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005969 CHK("UNCOMMENTED_DEFINITION",
5970 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005971 }
5972 }
5973# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005974
5975 my $barriers = qr{
5976 mb|
5977 rmb|
Will Deaconad83ec62019-11-07 14:49:00 +00005978 wmb
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005979 }x;
5980 my $barrier_stems = qr{
5981 mb__before_atomic|
5982 mb__after_atomic|
5983 store_release|
5984 load_acquire|
5985 store_mb|
5986 (?:$barriers)
5987 }x;
5988 my $all_barriers = qr{
5989 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005990 smp_(?:$barrier_stems)|
5991 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005992 }x;
5993
5994 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005995 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005996 WARN("MEMORY_BARRIER",
5997 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005998 }
5999 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006000
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02006001 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6002
6003 if ($realfile !~ m@^include/asm-generic/@ &&
6004 $realfile !~ m@/barrier\.h$@ &&
6005 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6006 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6007 WARN("MEMORY_BARRIER",
6008 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6009 }
6010
Joe Perchescb426e92015-06-25 15:02:46 -07006011# check for waitqueue_active without a comment.
6012 if ($line =~ /\bwaitqueue_active\s*\(/) {
6013 if (!ctx_has_comment($first_line, $linenr)) {
6014 WARN("WAITQUEUE_ACTIVE",
6015 "waitqueue_active without comment\n" . $herecurr);
6016 }
6017 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006018
Marco Elver5099a722020-04-01 12:17:14 +02006019# check for data_race without a comment.
6020 if ($line =~ /\bdata_race\s*\(/) {
6021 if (!ctx_has_comment($first_line, $linenr)) {
6022 WARN("DATA_RACE",
6023 "data_race without comment\n" . $herecurr);
6024 }
6025 }
6026
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006027# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006028 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006029 CHK("ARCH_DEFINES",
6030 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006031 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006032
Joe Perches596ed452017-07-12 14:37:02 -07006033# check that the storage class is not after a type
6034 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006035 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07006036 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6037 }
6038# Check that the storage class is at the beginning of a declaration
6039 if ($line =~ /\b$Storage\b/ &&
6040 $line !~ /^.\s*$Storage/ &&
6041 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6042 $1 !~ /[\,\)]\s*$/) {
6043 WARN("STORAGE_CLASS",
6044 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07006045 }
6046
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006047# check the location of the inline attribute, that it is between
6048# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006049 if ($line =~ /\b$Type\s+$Inline\b/ ||
6050 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006051 ERROR("INLINE_LOCATION",
6052 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006053 }
6054
Andy Whitcroft8905a672007-11-28 16:21:06 -08006055# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08006056 if ($realfile !~ m@\binclude/uapi/@ &&
6057 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006058 if (WARN("INLINE",
6059 "plain inline is preferred over $1\n" . $herecurr) &&
6060 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006061 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006062
6063 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006064 }
6065
Joe Perches3d130fd2011-01-12 17:00:00 -08006066# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08006067 if ($realfile !~ m@\binclude/uapi/@ &&
6068 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006069 WARN("PREFER_PACKED",
6070 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08006071 }
6072
Joe Perches39b7e282011-07-25 17:13:24 -07006073# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08006074 if ($realfile !~ m@\binclude/uapi/@ &&
6075 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006076 WARN("PREFER_ALIGNED",
6077 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07006078 }
6079
Joe Perches462811d2019-09-25 16:46:44 -07006080# Check for __attribute__ section, prefer __section
6081 if ($realfile !~ m@\binclude/uapi/@ &&
6082 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
6083 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
6084 my $new = substr($old, 1, -1);
6085 if (WARN("PREFER_SECTION",
6086 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
6087 $fix) {
6088 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6089 }
6090 }
6091
Joe Perches5f14d3b2012-01-10 15:09:52 -08006092# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08006093 if ($realfile !~ m@\binclude/uapi/@ &&
6094 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006095 if (WARN("PREFER_PRINTF",
6096 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6097 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006098 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006099
6100 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08006101 }
6102
Joe Perches6061d942012-03-23 15:02:16 -07006103# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08006104 if ($realfile !~ m@\binclude/uapi/@ &&
6105 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006106 if (WARN("PREFER_SCANF",
6107 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6108 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006109 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006110 }
Joe Perches6061d942012-03-23 15:02:16 -07006111 }
6112
Joe Perches619a9082014-12-10 15:51:35 -08006113# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07006114 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08006115 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6116 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6117 $line =~ /\b__weak\b/)) {
6118 ERROR("WEAK_DECLARATION",
6119 "Using weak declarations can have unintended link defects\n" . $herecurr);
6120 }
6121
Tomas Winklerfd39f902016-12-12 16:46:34 -08006122# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07006123 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08006124 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07006125 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6126 my $type = $1;
6127 if ($type =~ /\b($typeC99Typedefs)\b/) {
6128 $type = $1;
6129 my $kernel_type = 'u';
6130 $kernel_type = 's' if ($type =~ /^_*[si]/);
6131 $type =~ /(\d+)/;
6132 $kernel_type .= $1;
6133 if (CHK("PREFER_KERNEL_TYPES",
6134 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6135 $fix) {
6136 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6137 }
6138 }
6139 }
6140
Joe Perches938224b2016-01-20 14:59:15 -08006141# check for cast of C90 native int or longer types constants
6142 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6143 my $cast = $1;
6144 my $const = $2;
6145 if (WARN("TYPECAST_INT_CONSTANT",
6146 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6147 $fix) {
6148 my $suffix = "";
6149 my $newconst = $const;
6150 $newconst =~ s/${Int_type}$//;
6151 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6152 if ($cast =~ /\blong\s+long\b/) {
6153 $suffix .= 'LL';
6154 } elsif ($cast =~ /\blong\b/) {
6155 $suffix .= 'L';
6156 }
6157 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6158 }
6159 }
6160
Joe Perches8f53a9b2010-03-05 13:43:48 -08006161# check for sizeof(&)
6162 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006163 WARN("SIZEOF_ADDRESS",
6164 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08006165 }
6166
Joe Perches66c80b62012-07-30 14:41:22 -07006167# check for sizeof without parenthesis
6168 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006169 if (WARN("SIZEOF_PARENTHESIS",
6170 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6171 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006172 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006173 }
Joe Perches66c80b62012-07-30 14:41:22 -07006174 }
6175
Joe Perches88982fe2012-12-17 16:02:00 -08006176# check for struct spinlock declarations
6177 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6178 WARN("USE_SPINLOCK_T",
6179 "struct spinlock should be spinlock_t\n" . $herecurr);
6180 }
6181
Joe Perchesa6962d72013-04-29 16:18:13 -07006182# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006183 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006184 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006185 $fmt =~ s/%%//g;
6186 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006187 if (WARN("PREFER_SEQ_PUTS",
6188 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6189 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006190 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006191 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006192 }
6193 }
6194
Joe Perches478b1792018-04-10 16:33:34 -07006195# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006196 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006197 defined $stat &&
6198 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6199 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006200 my $stat_real;
6201
Joe Perches0b523762017-05-08 15:55:36 -07006202 my $lc = $stat =~ tr@\n@@;
6203 $lc = $lc + $linenr;
6204 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006205 my $specifier;
6206 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006207 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006208 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006209 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6210 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006211
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006212 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006213 $specifier = $1;
6214 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006215 $qualifier = $3;
Linus Torvalds361b0d22019-11-26 19:45:12 -08006216 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006217 ($extension eq "f" &&
6218 defined $qualifier && $qualifier !~ /^w/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006219 $bad_specifier = $specifier;
6220 last;
6221 }
6222 if ($extension eq "x" && !defined($stat_real)) {
6223 if (!defined($stat_real)) {
6224 $stat_real = get_stat_real($linenr, $lc);
6225 }
6226 WARN("VSPRINTF_SPECIFIER_PX",
6227 "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");
6228 }
6229 }
6230 if ($bad_specifier ne "") {
6231 my $stat_real = get_stat_real($linenr, $lc);
6232 my $ext_type = "Invalid";
6233 my $use = "";
6234 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006235 $use = " - use %pS instead";
6236 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6237 }
6238
6239 WARN("VSPRINTF_POINTER_EXTENSION",
6240 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6241 }
Joe Perches0b523762017-05-08 15:55:36 -07006242 }
6243 }
6244
Andy Whitcroft554e1652012-01-10 15:09:57 -08006245# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006246 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006247 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006248 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006249
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006250 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006251 my $ms_val = $7;
6252 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006253
Andy Whitcroft554e1652012-01-10 15:09:57 -08006254 if ($ms_size =~ /^(0x|)0$/i) {
6255 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006256 "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 -08006257 } elsif ($ms_size =~ /^(0x|)1$/i) {
6258 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006259 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6260 }
6261 }
6262
Joe Perches98a9bba2014-01-23 15:54:52 -08006263# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006264# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006265# defined $stat &&
6266# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6267# if (WARN("PREFER_ETHER_ADDR_COPY",
6268# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6269# $fix) {
6270# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6271# }
6272# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006273
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006274# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006275# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006276# defined $stat &&
6277# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6278# WARN("PREFER_ETHER_ADDR_EQUAL",
6279# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6280# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006281
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006282# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6283# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006284# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006285# defined $stat &&
6286# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6287#
6288# my $ms_val = $7;
6289#
6290# if ($ms_val =~ /^(?:0x|)0+$/i) {
6291# if (WARN("PREFER_ETH_ZERO_ADDR",
6292# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6293# $fix) {
6294# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6295# }
6296# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6297# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6298# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6299# $fix) {
6300# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6301# }
6302# }
6303# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006304
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006305# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006306 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006307 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006308 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006309 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006310 my $call = $1;
6311 my $cast1 = deparenthesize($2);
6312 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006313 my $cast2 = deparenthesize($7);
6314 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006315 my $cast;
6316
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006317 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006318 $cast = "$cast1 or $cast2";
6319 } elsif ($cast1 ne "") {
6320 $cast = $cast1;
6321 } else {
6322 $cast = $cast2;
6323 }
6324 WARN("MINMAX",
6325 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006326 }
6327 }
6328
Joe Perches4a273192012-07-30 14:41:20 -07006329# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006330 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006331 defined $stat &&
6332 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6333 my $min = $1;
6334 my $max = $7;
6335 if ($min eq $max) {
6336 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006337 "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 -07006338 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6339 $min > $max) {
6340 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006341 "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 -07006342 }
6343 }
6344
Joe Perches823b7942013-11-12 15:10:15 -08006345# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006346 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006347 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006348 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006349 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6350 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6351 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6352 my $lc = $stat =~ tr@\n@@;
6353 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006354 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006355 WARN("NAKED_SSCANF",
6356 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6357 }
6358
Joe Perchesafc819a2014-06-04 16:12:08 -07006359# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006360 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006361 defined $stat &&
6362 $line =~ /\bsscanf\b/) {
6363 my $lc = $stat =~ tr@\n@@;
6364 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006365 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006366 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6367 my $format = $6;
6368 my $count = $format =~ tr@%@%@;
6369 if ($count == 1 &&
6370 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6371 WARN("SSCANF_TO_KSTRTO",
6372 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6373 }
6374 }
6375 }
6376
Joe Perches70dc8a42013-09-11 14:23:58 -07006377# check for new externs in .h files.
6378 if ($realfile =~ /\.h$/ &&
6379 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006380 if (CHK("AVOID_EXTERNS",
6381 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006382 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006383 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006384 }
6385 }
6386
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006387# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006388 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006389 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006390 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006391 my $function_name = $1;
6392 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006393
6394 my $s = $stat;
6395 if (defined $cond) {
6396 substr($s, 0, length($cond), '');
6397 }
Kees Cookd8b44b52020-06-03 14:18:09 -07006398 if ($s =~ /^\s*;/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006399 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006400 WARN("AVOID_EXTERNS",
6401 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006402 }
6403
6404 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006405 WARN("FUNCTION_ARGUMENTS",
6406 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006407 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006408
6409 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6410 $stat =~ /^.\s*extern\s+/)
6411 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006412 WARN("AVOID_EXTERNS",
6413 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006414 }
6415
Joe Perchesa0ad7592017-07-10 15:52:19 -07006416# check for function declarations that have arguments without identifier names
6417 if (defined $stat &&
Kees Cookd8b44b52020-06-03 14:18:09 -07006418 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6419 $1 ne "void") {
6420 my $args = trim($1);
Joe Perchesca0d8922016-10-11 13:52:16 -07006421 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6422 my $arg = trim($1);
Kees Cookd8b44b52020-06-03 14:18:09 -07006423 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
Joe Perchesca0d8922016-10-11 13:52:16 -07006424 WARN("FUNCTION_ARGUMENTS",
6425 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6426 }
6427 }
6428 }
6429
Joe Perchesa0ad7592017-07-10 15:52:19 -07006430# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006431 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006432 defined $stat &&
6433 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6434 $context_function = $1;
6435
6436# check for multiline function definition with misplaced open brace
6437 my $ok = 0;
6438 my $cnt = statement_rawlines($stat);
6439 my $herectx = $here . "\n";
6440 for (my $n = 0; $n < $cnt; $n++) {
6441 my $rl = raw_line($linenr, $n);
6442 $herectx .= $rl . "\n";
6443 $ok = 1 if ($rl =~ /^[ \+]\{/);
6444 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6445 last if $rl =~ /^[ \+].*\{/;
6446 }
6447 if (!$ok) {
6448 ERROR("OPEN_BRACE",
6449 "open brace '{' following function definitions go on the next line\n" . $herectx);
6450 }
6451 }
6452
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006453# checks for new __setup's
6454 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6455 my $name = $1;
6456
6457 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006458 CHK("UNDOCUMENTED_SETUP",
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07006459 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006460 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006461 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006462
Joe Perchese29a70f2019-03-07 16:28:35 -08006463# check for pointless casting of alloc functions
6464 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006465 WARN("UNNECESSARY_CASTS",
6466 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006467 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006468
Joe Perchesa640d252013-07-03 15:05:21 -07006469# alloc style
6470# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006471 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006472 $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 -07006473 CHK("ALLOC_SIZEOF_STRUCT",
6474 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6475 }
6476
Joe Perches60a55362014-06-04 16:12:07 -07006477# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006478 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006479 defined $stat &&
6480 $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 -07006481 my $oldfunc = $3;
6482 my $a1 = $4;
6483 my $a2 = $10;
6484 my $newfunc = "kmalloc_array";
6485 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006486 my $r1 = $a1;
6487 my $r2 = $a2;
6488 if ($a1 =~ /^sizeof\s*\S/) {
6489 $r1 = $a2;
6490 $r2 = $a1;
6491 }
6492 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6493 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006494 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006495 my $herectx = get_stat_here($linenr, $cnt, $here);
6496
Joe Perches60a55362014-06-04 16:12:07 -07006497 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006498 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6499 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006500 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006501 $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 -07006502 }
6503 }
6504 }
6505
Joe Perches972fdea2013-04-29 16:18:12 -07006506# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006507 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006508 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6509 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006510 WARN("KREALLOC_ARG_REUSE",
6511 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6512 }
6513
Joe Perches5ce59ae2013-02-21 16:44:18 -08006514# check for alloc argument mismatch
6515 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6516 WARN("ALLOC_ARRAY_ARGS",
6517 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6518 }
6519
Joe Perchescaf2a542011-01-12 16:59:56 -08006520# check for multiple semicolons
6521 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006522 if (WARN("ONE_SEMICOLON",
6523 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6524 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006525 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006526 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006527 }
6528
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006529# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6530 if ($realfile !~ m@^include/uapi/@ &&
6531 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006532 my $ull = "";
6533 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6534 if (CHK("BIT_MACRO",
6535 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6536 $fix) {
6537 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6538 }
6539 }
6540
Joe Perches50161262020-08-11 18:35:07 -07006541# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006542 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
Joe Perches50161262020-08-11 18:35:07 -07006543 WARN("IS_ENABLED_CONFIG",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006544 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
Joe Perches50161262020-08-11 18:35:07 -07006545 }
6546
Joe Perches2d632742016-05-20 17:04:00 -07006547# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006548 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 -07006549 my $config = $1;
6550 if (WARN("PREFER_IS_ENABLED",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006551 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
Joe Perches2d632742016-05-20 17:04:00 -07006552 $fix) {
6553 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6554 }
6555 }
6556
Joe Perchesf36d3eb2020-04-06 20:10:58 -07006557# check for /* fallthrough */ like comment, prefer fallthrough;
6558 my @fallthroughs = (
6559 'fallthrough',
6560 '@fallthrough@',
6561 'lint -fallthrough[ \t]*',
6562 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6563 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6564 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6565 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6566 );
6567 if ($raw_comment ne '') {
6568 foreach my $ft (@fallthroughs) {
6569 if ($raw_comment =~ /$ft/) {
6570 my $msg_level = \&WARN;
6571 $msg_level = \&CHK if ($file);
6572 &{$msg_level}("PREFER_FALLTHROUGH",
6573 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6574 last;
6575 }
6576 }
6577 }
6578
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006579# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006580 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006581 defined $stat &&
6582 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006583 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006584 my $herectx = get_stat_here($linenr, $cnt, $here);
6585
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006586 WARN("DEFAULT_NO_BREAK",
6587 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006588 }
6589
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006590# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006591 if ($line =~ /\b__FUNCTION__\b/) {
6592 if (WARN("USE_FUNC",
6593 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6594 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006595 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006596 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006597 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006598
Joe Perches62ec8182015-02-13 14:38:18 -08006599# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6600 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6601 ERROR("DATE_TIME",
6602 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6603 }
6604
Joe Perches2c924882012-03-23 15:02:20 -07006605# check for use of yield()
6606 if ($line =~ /\byield\s*\(\s*\)/) {
6607 WARN("YIELD",
6608 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6609 }
6610
Joe Perches179f8f42013-07-03 15:05:30 -07006611# check for comparisons against true and false
6612 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6613 my $lead = $1;
6614 my $arg = $2;
6615 my $test = $3;
6616 my $otype = $4;
6617 my $trail = $5;
6618 my $op = "!";
6619
6620 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6621
6622 my $type = lc($otype);
6623 if ($type =~ /^(?:true|false)$/) {
6624 if (("$test" eq "==" && "$type" eq "true") ||
6625 ("$test" eq "!=" && "$type" eq "false")) {
6626 $op = "";
6627 }
6628
6629 CHK("BOOL_COMPARISON",
6630 "Using comparison to $otype is error prone\n" . $herecurr);
6631
6632## maybe suggesting a correct construct would better
6633## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6634
6635 }
6636 }
6637
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006638# check for semaphores initialized locked
6639 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006640 WARN("CONSIDER_COMPLETION",
6641 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006642 }
Joe Perches6712d852012-03-23 15:02:20 -07006643
Joe Perches67d0a072011-10-31 17:13:10 -07006644# recommend kstrto* over simple_strto* and strict_strto*
6645 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006646 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006647 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006648 }
Joe Perches6712d852012-03-23 15:02:20 -07006649
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006650# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006651 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006652 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006653 "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 -07006654 }
Joe Perches6712d852012-03-23 15:02:20 -07006655
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006656# check for spin_is_locked(), suggest lockdep instead
6657 if ($line =~ /\bspin_is_locked\(/) {
6658 WARN("USE_LOCKDEP",
6659 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6660 }
6661
Joe Perches9189c7e2018-09-07 15:26:18 -07006662# check for deprecated apis
6663 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6664 my $deprecated_api = $1;
6665 my $new_api = $deprecated_apis{$deprecated_api};
6666 WARN("DEPRECATED_API",
6667 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6668 }
6669
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006670# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006671# and avoid what seem like struct definitions 'struct foo {'
Quentin Monnetced69da12020-08-11 18:35:13 -07006672 if (defined($const_structs) &&
6673 $line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006674 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006675 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006676 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006677 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006678
6679# use of NR_CPUS is usually wrong
6680# ignore definitions of NR_CPUS and usage to define arrays as likely right
6681 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006682 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6683 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006684 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6685 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6686 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006687 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006688 WARN("NR_CPUS",
6689 "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 -07006690 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006691
Joe Perches52ea8502013-11-12 15:10:09 -08006692# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6693 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6694 ERROR("DEFINE_ARCH_HAS",
6695 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6696 }
6697
Joe Perchesacd93622015-02-13 14:38:38 -08006698# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07006699 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08006700 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6701 WARN("LIKELY_MISUSE",
6702 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6703 }
6704
Denis Efremovde3f1862019-09-25 16:49:25 -07006705# nested likely/unlikely calls
6706 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6707 WARN("LIKELY_MISUSE",
6708 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6709 }
6710
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006711# whine mightly about in_atomic
6712 if ($line =~ /\bin_atomic\s*\(/) {
6713 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006714 ERROR("IN_ATOMIC",
6715 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006716 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006717 WARN("IN_ATOMIC",
6718 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006719 }
6720 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006721
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006722# check for mutex_trylock_recursive usage
6723 if ($line =~ /mutex_trylock_recursive/) {
6724 ERROR("LOCKING",
6725 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6726 }
6727
Peter Zijlstra1704f472010-03-19 01:37:42 +01006728# check for lockdep_set_novalidate_class
6729 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6730 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6731 if ($realfile !~ m@^kernel/lockdep@ &&
6732 $realfile !~ m@^include/linux/lockdep@ &&
6733 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006734 ERROR("LOCKDEP",
6735 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006736 }
6737 }
Dave Jones88f88312011-01-12 16:59:59 -08006738
Joe Perchesb392c642015-04-16 12:44:16 -07006739 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6740 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006741 WARN("EXPORTED_WORLD_WRITABLE",
6742 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006743 }
Joe Perches24358802014-04-03 14:49:13 -07006744
Joe Perches00180462018-02-06 15:38:55 -08006745# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6746# and whether or not function naming is typical and if
6747# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07006748 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08006749 defined $stat &&
6750 $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*\)/) {
6751 my $var = $1;
6752 my $perms = $2;
6753 my $show = $3;
6754 my $store = $4;
6755 my $octal_perms = perms_to_octal($perms);
6756 if ($show =~ /^${var}_show$/ &&
6757 $store =~ /^${var}_store$/ &&
6758 $octal_perms eq "0644") {
6759 if (WARN("DEVICE_ATTR_RW",
6760 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6761 $fix) {
6762 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6763 }
6764 } elsif ($show =~ /^${var}_show$/ &&
6765 $store =~ /^NULL$/ &&
6766 $octal_perms eq "0444") {
6767 if (WARN("DEVICE_ATTR_RO",
6768 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6769 $fix) {
6770 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6771 }
6772 } elsif ($show =~ /^NULL$/ &&
6773 $store =~ /^${var}_store$/ &&
6774 $octal_perms eq "0200") {
6775 if (WARN("DEVICE_ATTR_WO",
6776 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6777 $fix) {
6778 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6779 }
6780 } elsif ($octal_perms eq "0644" ||
6781 $octal_perms eq "0444" ||
6782 $octal_perms eq "0200") {
6783 my $newshow = "$show";
6784 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6785 my $newstore = $store;
6786 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6787 my $rename = "";
6788 if ($show ne $newshow) {
6789 $rename .= " '$show' to '$newshow'";
6790 }
6791 if ($store ne $newstore) {
6792 $rename .= " '$store' to '$newstore'";
6793 }
6794 WARN("DEVICE_ATTR_FUNCTIONS",
6795 "Consider renaming function(s)$rename\n" . $herecurr);
6796 } else {
6797 WARN("DEVICE_ATTR_PERMS",
6798 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6799 }
6800 }
6801
Joe Perches515a2352014-04-03 14:49:24 -07006802# Mode permission misuses where it seems decimal should be octal
6803# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006804# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6805# specific definition of not visible in sysfs.
6806# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6807# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07006808 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006809 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006810 $line =~ /$mode_perms_search/) {
6811 foreach my $entry (@mode_permission_funcs) {
6812 my $func = $entry->[0];
6813 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006814
Joe Perches459cf0a2016-10-11 13:52:19 -07006815 my $lc = $stat =~ tr@\n@@;
6816 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006817 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006818
Joe Perches515a2352014-04-03 14:49:24 -07006819 my $skip_args = "";
6820 if ($arg_pos > 1) {
6821 $arg_pos--;
6822 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6823 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006824 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006825 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006826 my $val = $1;
6827 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006828 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6829 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6830 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006831 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006832 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006833 }
6834 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006835 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006836 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006837 }
Joe Perches24358802014-04-03 14:49:13 -07006838 }
6839 }
6840 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006841
Joe Perches459cf0a2016-10-11 13:52:19 -07006842# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07006843 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08006844 my $oval = $1;
6845 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006846 if (WARN("SYMBOLIC_PERMS",
6847 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6848 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006849 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006850 }
6851 }
6852
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006853# validate content of MODULE_LICENSE against list from include/linux/module.h
6854 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6855 my $extracted_string = get_quoted_string($line, $rawline);
6856 my $valid_licenses = qr{
6857 GPL|
6858 GPL\ v2|
6859 GPL\ and\ additional\ rights|
6860 Dual\ BSD/GPL|
6861 Dual\ MIT/GPL|
6862 Dual\ MPL/GPL|
6863 Proprietary
6864 }x;
6865 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6866 WARN("MODULE_LICENSE",
6867 "unknown module license " . $extracted_string . "\n" . $herecurr);
6868 }
6869 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07006870
6871# check for sysctl duplicate constants
6872 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6873 WARN("DUPLICATED_SYSCTL_CONST",
6874 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6875 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006876 }
6877
6878 # If we have no input at all, then there is nothing to report on
6879 # so just keep quiet.
6880 if ($#rawlines == -1) {
6881 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006882 }
6883
Andy Whitcroft8905a672007-11-28 16:21:06 -08006884 # In mailback mode only produce a report in the negative, for
6885 # things that appear to be patches.
6886 if ($mailback && ($clean == 1 || !$is_patch)) {
6887 exit(0);
6888 }
6889
6890 # This is not a patch, and we are are in 'no-patch' mode so
6891 # just keep quiet.
6892 if (!$chk_patch && !$is_patch) {
6893 exit(0);
6894 }
6895
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006896 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006897 ERROR("NOT_UNIFIED_DIFF",
6898 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006899 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07006900 if ($is_patch && $has_commit_log && $chk_signoff) {
6901 if ($signoff == 0) {
6902 ERROR("MISSING_SIGN_OFF",
6903 "Missing Signed-off-by: line(s)\n");
6904 } elsif (!$authorsignoff) {
6905 WARN("NO_AUTHOR_SIGN_OFF",
6906 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6907 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006908 }
6909
Andy Whitcroft8905a672007-11-28 16:21:06 -08006910 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006911 if ($summary && !($clean == 1 && $quiet == 1)) {
6912 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006913 print "total: $cnt_error errors, $cnt_warn warnings, " .
6914 (($check)? "$cnt_chk checks, " : "") .
6915 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006916 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006917
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006918 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006919 # If there were any defects found and not already fixing them
6920 if (!$clean and !$fix) {
6921 print << "EOM"
6922
6923NOTE: For some of the reported defects, checkpatch may be able to
6924 mechanically convert to the typical style using --fix or --fix-inplace.
6925EOM
6926 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006927 # If there were whitespace errors which cleanpatch can fix
6928 # then suggest that.
6929 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006930 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006931 print << "EOM"
6932
6933NOTE: Whitespace errors detected.
6934 You may wish to use scripts/cleanpatch or scripts/cleanfile
6935EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006936 }
6937 }
6938
Joe Perchesd752fcc2014-08-06 16:11:05 -07006939 if ($clean == 0 && $fix &&
6940 ("@rawlines" ne "@fixed" ||
6941 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006942 my $newfile = $filename;
6943 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006944 my $linecount = 0;
6945 my $f;
6946
Joe Perchesd752fcc2014-08-06 16:11:05 -07006947 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6948
Joe Perches3705ce52013-07-03 15:05:31 -07006949 open($f, '>', $newfile)
6950 or die "$P: Can't open $newfile for write\n";
6951 foreach my $fixed_line (@fixed) {
6952 $linecount++;
6953 if ($file) {
6954 if ($linecount > 3) {
6955 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006956 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006957 }
6958 } else {
6959 print $f $fixed_line . "\n";
6960 }
6961 }
6962 close($f);
6963
6964 if (!$quiet) {
6965 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006966
Joe Perches3705ce52013-07-03 15:05:31 -07006967Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6968
6969Do _NOT_ trust the results written to this file.
6970Do _NOT_ submit these changes without inspecting them for correctness.
6971
6972This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6973No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006974EOM
6975 }
6976 }
6977
Joe Perchesd8469f12015-06-25 15:03:00 -07006978 if ($quiet == 0) {
6979 print "\n";
6980 if ($clean == 1) {
6981 print "$vname has no obvious style problems and is ready for submission.\n";
6982 } else {
6983 print "$vname has style problems, please review.\n";
6984 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006985 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006986 return $clean;
6987}