blob: 114af54c3194ddb8fedbae3304497794bd790e3e [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;
Hannes Eder77f5b102009-09-21 17:04:37 -070068
69sub help {
70 my ($exitcode) = @_;
71
72 print << "EOM";
73Usage: $P [OPTION]... [FILE]...
74Version: $V
75
76Options:
77 -q, --quiet quiet
78 --no-tree run without a kernel tree
79 --no-signoff do not check for 'Signed-off-by' line
80 --patch treat FILE as patchfile (default)
81 --emacs emacs compile window format
82 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070083 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070084 -g, --git treat FILE as a single commit or git revision range
85 single git commit with:
86 <rev>
87 <rev>^
88 <rev>~n
89 multiple git commits with:
90 <rev1>..<rev2>
91 <rev1>...<rev2>
92 <rev>-<count>
93 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070094 -f, --file treat FILE as regular source file
95 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070096 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070097 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070098 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070099 --show-types show the specific message type in the output
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700100 --max-line-length=n set the maximum line length, (default $max_line_length)
101 if exceeded, warn on patches
102 requires --strict for use with --file
Vadim Bendebury56193272014-10-13 15:51:48 -0700103 --min-conf-desc-length=n set the min description length, if shorter, warn
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700104 --tab-size=n set the number of spaces for tab (default $tabsize)
Hannes Eder77f5b102009-09-21 17:04:37 -0700105 --root=PATH PATH to the kernel tree root
106 --no-summary suppress the per-file summary
107 --mailback only produce a report in case of warnings/errors
108 --summary-file include the filename in summary
109 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
110 'values', 'possible', 'type', and 'attr' (default
111 is all off)
112 --test-only=WORD report only warnings/errors containing WORD
113 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700114 --fix EXPERIMENTAL - may create horrible results
115 If correctable single-line errors exist, create
116 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
117 with potential errors corrected to the preferred
118 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800119 --fix-inplace EXPERIMENTAL - may create horrible results
120 Is the same as --fix, but overwrites the input
121 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700122 --ignore-perl-version override checking of perl version. expect
123 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700124 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700125 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700126 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700127 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700128 --color[=WHEN] Use colors 'always', 'never', or only when output
129 is a terminal ('auto'). Default is 'auto'.
Hannes Eder77f5b102009-09-21 17:04:37 -0700130 -h, --help, --version display this help and exit
131
132When FILE is - read standard input.
133EOM
134
135 exit($exitcode);
136}
137
Joe Perches3beb42e2016-05-20 17:04:14 -0700138sub uniq {
139 my %seen;
140 return grep { !$seen{$_}++ } @_;
141}
142
143sub list_types {
144 my ($exitcode) = @_;
145
146 my $count = 0;
147
148 local $/ = undef;
149
150 open(my $script, '<', abs_path($P)) or
151 die "$P: Can't read '$P' $!\n";
152
153 my $text = <$script>;
154 close($script);
155
156 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700157 # Also catch when type or level is passed through a variable
158 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700159 push (@types, $_);
160 }
161 @types = sort(uniq(@types));
162 print("#\tMessage type\n\n");
163 foreach my $type (@types) {
164 print(++$count . "\t" . $type . "\n");
165 }
166
167 exit($exitcode);
168}
169
Joe Perches000d1cc12011-07-25 17:13:25 -0700170my $conf = which_conf($configuration_file);
171if (-f $conf) {
172 my @conf_args;
173 open(my $conffile, '<', "$conf")
174 or warn "$P: Can't find a readable $configuration_file file $!\n";
175
176 while (<$conffile>) {
177 my $line = $_;
178
179 $line =~ s/\s*\n?$//g;
180 $line =~ s/^\s*//g;
181 $line =~ s/\s+/ /g;
182
183 next if ($line =~ m/^\s*#/);
184 next if ($line =~ m/^\s*$/);
185
186 my @words = split(" ", $line);
187 foreach my $word (@words) {
188 last if ($word =~ m/^#/);
189 push (@conf_args, $word);
190 }
191 }
192 close($conffile);
193 unshift(@ARGV, @conf_args) if @conf_args;
194}
195
John Brooks737c0762017-07-10 15:52:24 -0700196# Perl's Getopt::Long allows options to take optional arguments after a space.
197# Prevent --color by itself from consuming other arguments
198foreach (@ARGV) {
199 if ($_ eq "--color" || $_ eq "-color") {
200 $_ = "--color=$color";
201 }
202}
203
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700204GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700205 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700206 'tree!' => \$tree,
207 'signoff!' => \$chk_signoff,
208 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700209 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800210 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700211 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700212 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700213 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700214 'subjective!' => \$check,
215 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700216 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700217 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700218 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700219 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800220 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700221 'min-conf-desc-length=i' => \$min_conf_desc_length,
Antonio Borneo713a09d2020-04-06 20:11:07 -0700222 'tab-size=i' => \$tabsize,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700223 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800224 'summary!' => \$summary,
225 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800226 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700227 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800228 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700229 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800230 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700231 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700232 'codespell!' => \$codespell,
233 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700234 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700235 'color=s' => \$color,
236 'no-color' => \$color, #keep old behaviors of -nocolor
237 'nocolor' => \$color, #keep old behaviors of -nocolor
Hannes Eder77f5b102009-09-21 17:04:37 -0700238 'h|help' => \$help,
239 'version' => \$help
240) or help(1);
241
242help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700243
Joe Perches3beb42e2016-05-20 17:04:14 -0700244list_types(0) if ($list_types);
245
Joe Perches9624b8d2014-01-23 15:54:44 -0800246$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700247$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800248
Joe Perches32f30ca2020-06-04 16:50:40 -0700249die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
250
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700251my $exit = 0;
252
Joe Perches5b579802018-08-21 21:57:33 -0700253my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700254if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700255 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700256 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700257 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700258}
259
Allen Hubbe45107ff2016-08-02 14:04:47 -0700260#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700261if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700262 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700263}
264
John Brooks737c0762017-07-10 15:52:24 -0700265if ($color =~ /^[01]$/) {
266 $color = !$color;
267} elsif ($color =~ /^always$/i) {
268 $color = 1;
269} elsif ($color =~ /^never$/i) {
270 $color = 0;
271} elsif ($color =~ /^auto$/i) {
272 $color = (-t STDOUT);
273} else {
Joe Perches32f30ca2020-06-04 16:50:40 -0700274 die "$P: Invalid color mode: $color\n";
John Brooks737c0762017-07-10 15:52:24 -0700275}
276
Antonio Borneo713a09d2020-04-06 20:11:07 -0700277# skip TAB size 1 to avoid additional checks on $tabsize - 1
Joe Perches32f30ca2020-06-04 16:50:40 -0700278die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
Antonio Borneo713a09d2020-04-06 20:11:07 -0700279
Joe Perches91bfe482013-09-11 14:23:59 -0700280sub hash_save_array_words {
281 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700282
Joe Perches91bfe482013-09-11 14:23:59 -0700283 my @array = split(/,/, join(',', @$arrayRef));
284 foreach my $word (@array) {
285 $word =~ s/\s*\n?$//g;
286 $word =~ s/^\s*//g;
287 $word =~ s/\s+/ /g;
288 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700289
Joe Perches91bfe482013-09-11 14:23:59 -0700290 next if ($word =~ m/^\s*#/);
291 next if ($word =~ m/^\s*$/);
292
293 $hashRef->{$word}++;
294 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700295}
296
Joe Perches91bfe482013-09-11 14:23:59 -0700297sub hash_show_words {
298 my ($hashRef, $prefix) = @_;
299
Joe Perches3c816e42015-06-25 15:03:29 -0700300 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700301 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700302 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700303 print " $word";
304 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700305 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700306 }
307}
308
309hash_save_array_words(\%ignore_type, \@ignore);
310hash_save_array_words(\%use_type, \@use);
311
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800312my $dbg_values = 0;
313my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700314my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700315my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800316for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800317 ## no critic
318 eval "\${dbg_$key} = '$debug{$key}';";
319 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800320}
321
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700322my $rpt_cleaners = 0;
323
Andy Whitcroft8905a672007-11-28 16:21:06 -0800324if ($terse) {
325 $emacs = 1;
326 $quiet++;
327}
328
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700329if ($tree) {
330 if (defined $root) {
331 if (!top_of_kernel_tree($root)) {
332 die "$P: $root: --root does not point at a valid tree\n";
333 }
334 } else {
335 if (top_of_kernel_tree('.')) {
336 $root = '.';
337 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
338 top_of_kernel_tree($1)) {
339 $root = $1;
340 }
341 }
342
343 if (!defined $root) {
344 print "Must be run from the top-level dir. of a kernel tree\n";
345 exit(2);
346 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700347}
348
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700349my $emitted_corrupt = 0;
350
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700351our $Ident = qr{
352 [A-Za-z_][A-Za-z\d_]*
353 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
354 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700355our $Storage = qr{extern|static|asmlinkage};
356our $Sparse = qr{
357 __user|
358 __kernel|
359 __force|
360 __iomem|
361 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800362 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700363 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700364 __refconst|
365 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800366 __rcu|
367 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700368 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800369our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
370our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
371our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
372our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
373our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700374
Wolfram Sang52131292010-03-05 13:43:51 -0800375# Notes to $Attribute:
376# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700377our $Attribute = qr{
378 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700379 __percpu|
380 __nocast|
381 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200382 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700383 __packed__|
384 __packed2__|
385 __naked|
386 __maybe_unused|
387 __always_unused|
388 __noreturn|
389 __used|
390 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800391 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700392 __noclone|
393 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700394 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700395 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700396 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700397 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700398 ____cacheline_aligned|
399 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800400 ____cacheline_internodealigned_in_smp|
401 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700402 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700403our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700404our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700405our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
406our $Lval = qr{$Ident(?:$Member)*};
407
Joe Perches95e2c602013-07-03 15:05:20 -0700408our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
409our $Binary = qr{(?i)0b[01]+$Int_type?};
410our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
411our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700412our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800413our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800414our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
415our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
416our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800417our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700418our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800419our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700420our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700421our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700422our $Operators = qr{
423 <=|>=|==|!=|
424 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700425 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700426 }x;
427
Joe Perches91cb5192014-04-03 14:49:32 -0700428our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
429
Joe Perchesab7e23f2015-04-16 12:44:22 -0700430our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800431our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700432our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700433our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800434our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700435our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800436our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700437our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800438
Joe Perches15662b32011-10-31 17:13:12 -0700439our $NON_ASCII_UTF8 = qr{
440 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700441 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
442 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
443 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
444 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
445 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
446 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
447}x;
448
Joe Perches15662b32011-10-31 17:13:12 -0700449our $UTF8 = qr{
450 [\x09\x0A\x0D\x20-\x7E] # ASCII
451 | $NON_ASCII_UTF8
452}x;
453
Joe Perchese6176fa2015-06-25 15:02:49 -0700454our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800455our $typeOtherOSTypedefs = qr{(?x:
456 u_(?:char|short|int|long) | # bsd
457 u(?:nchar|short|int|long) # sysv
458)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700459our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700460 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700461 atomic_t
462)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700463our $typeTypedefs = qr{(?x:
464 $typeC99Typedefs\b|
465 $typeOtherOSTypedefs\b|
466 $typeKernelTypedefs\b
467)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700468
Joe Perches6d32f7a2015-11-06 16:31:37 -0800469our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
470
Joe Perches691e6692010-03-05 13:43:51 -0800471our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800472 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700473 (?:[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 -0800474 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700475 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700476 panic|
Joe Perches06668722013-11-12 15:10:07 -0800477 MODULE_[A-Z_]+|
478 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800479)};
480
Joe Perchese29a70f2019-03-07 16:28:35 -0800481our $allocFunctions = qr{(?x:
482 (?:(?:devm_)?
483 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
484 kstrdup(?:_const)? |
485 kmemdup(?:_nul)?) |
Christophe JAILLET461e1562020-04-20 18:13:58 -0700486 (?:\w+)?alloc_skb(?:_ip_align)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800487 # dev_alloc_skb/netdev_alloc_skb, et al
488 dma_alloc_coherent
489)};
490
Joe Perches20112472011-07-25 17:13:23 -0700491our $signature_tags = qr{(?xi:
492 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800493 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700494 Acked-by:|
495 Tested-by:|
496 Reviewed-by:|
497 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700498 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700499 To:|
500 Cc:
501)};
502
Joe Perches18130872014-08-06 16:11:22 -0700503our @typeListMisordered = (
504 qr{char\s+(?:un)?signed},
505 qr{int\s+(?:(?:un)?signed\s+)?short\s},
506 qr{int\s+short(?:\s+(?:un)?signed)},
507 qr{short\s+int(?:\s+(?:un)?signed)},
508 qr{(?:un)?signed\s+int\s+short},
509 qr{short\s+(?:un)?signed},
510 qr{long\s+int\s+(?:un)?signed},
511 qr{int\s+long\s+(?:un)?signed},
512 qr{long\s+(?:un)?signed\s+int},
513 qr{int\s+(?:un)?signed\s+long},
514 qr{int\s+(?:un)?signed},
515 qr{int\s+long\s+long\s+(?:un)?signed},
516 qr{long\s+long\s+int\s+(?:un)?signed},
517 qr{long\s+long\s+(?:un)?signed\s+int},
518 qr{long\s+long\s+(?:un)?signed},
519 qr{long\s+(?:un)?signed},
520);
521
Andy Whitcroft8905a672007-11-28 16:21:06 -0800522our @typeList = (
523 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700524 qr{(?:(?:un)?signed\s+)?char},
525 qr{(?:(?:un)?signed\s+)?short\s+int},
526 qr{(?:(?:un)?signed\s+)?short},
527 qr{(?:(?:un)?signed\s+)?int},
528 qr{(?:(?:un)?signed\s+)?long\s+int},
529 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
530 qr{(?:(?:un)?signed\s+)?long\s+long},
531 qr{(?:(?:un)?signed\s+)?long},
532 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800533 qr{float},
534 qr{double},
535 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800536 qr{struct\s+$Ident},
537 qr{union\s+$Ident},
538 qr{enum\s+$Ident},
539 qr{${Ident}_t},
540 qr{${Ident}_handler},
541 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700542 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800543);
Joe Perches938224b2016-01-20 14:59:15 -0800544
545our $C90_int_types = qr{(?x:
546 long\s+long\s+int\s+(?:un)?signed|
547 long\s+long\s+(?:un)?signed\s+int|
548 long\s+long\s+(?:un)?signed|
549 (?:(?:un)?signed\s+)?long\s+long\s+int|
550 (?:(?:un)?signed\s+)?long\s+long|
551 int\s+long\s+long\s+(?:un)?signed|
552 int\s+(?:(?:un)?signed\s+)?long\s+long|
553
554 long\s+int\s+(?:un)?signed|
555 long\s+(?:un)?signed\s+int|
556 long\s+(?:un)?signed|
557 (?:(?:un)?signed\s+)?long\s+int|
558 (?:(?:un)?signed\s+)?long|
559 int\s+long\s+(?:un)?signed|
560 int\s+(?:(?:un)?signed\s+)?long|
561
562 int\s+(?:un)?signed|
563 (?:(?:un)?signed\s+)?int
564)};
565
Alex Dowad485ff232015-06-25 15:02:52 -0700566our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700567our @typeListWithAttr = (
568 @typeList,
569 qr{struct\s+$InitAttribute\s+$Ident},
570 qr{union\s+$InitAttribute\s+$Ident},
571);
572
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700573our @modifierList = (
574 qr{fastcall},
575);
Alex Dowad485ff232015-06-25 15:02:52 -0700576our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800577
Joe Perches24358802014-04-03 14:49:13 -0700578our @mode_permission_funcs = (
579 ["module_param", 3],
580 ["module_param_(?:array|named|string)", 4],
581 ["module_param_array_named", 5],
582 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
583 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700584 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
585 ["IIO_DEV_ATTR_[A-Z_]+", 1],
586 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
587 ["SENSOR_TEMPLATE(?:_2|)", 3],
588 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700589);
590
Joe Perches1a3dcf22020-08-11 18:35:16 -0700591my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
592
Joe Perches515a2352014-04-03 14:49:24 -0700593#Create a search pattern for all these functions to speed up a loop below
594our $mode_perms_search = "";
595foreach my $entry (@mode_permission_funcs) {
596 $mode_perms_search .= '|' if ($mode_perms_search ne "");
597 $mode_perms_search .= $entry->[0];
598}
Joe Perches00180462018-02-06 15:38:55 -0800599$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700600
Joe Perches9189c7e2018-09-07 15:26:18 -0700601our %deprecated_apis = (
602 "synchronize_rcu_bh" => "synchronize_rcu",
603 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
604 "call_rcu_bh" => "call_rcu",
605 "rcu_barrier_bh" => "rcu_barrier",
606 "synchronize_sched" => "synchronize_rcu",
607 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
608 "call_rcu_sched" => "call_rcu",
609 "rcu_barrier_sched" => "rcu_barrier",
610 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
611 "cond_synchronize_sched" => "cond_synchronize_rcu",
612);
613
614#Create a search pattern for all these strings to speed up a loop below
615our $deprecated_apis_search = "";
616foreach my $entry (keys %deprecated_apis) {
617 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
618 $deprecated_apis_search .= $entry;
619}
620$deprecated_apis_search = "(?:${deprecated_apis_search})";
621
Joe Perchesb392c642015-04-16 12:44:16 -0700622our $mode_perms_world_writable = qr{
623 S_IWUGO |
624 S_IWOTH |
625 S_IRWXUGO |
626 S_IALLUGO |
627 0[0-7][0-7][2367]
628}x;
629
Joe Perchesf90774e2016-10-11 13:51:47 -0700630our %mode_permission_string_types = (
631 "S_IRWXU" => 0700,
632 "S_IRUSR" => 0400,
633 "S_IWUSR" => 0200,
634 "S_IXUSR" => 0100,
635 "S_IRWXG" => 0070,
636 "S_IRGRP" => 0040,
637 "S_IWGRP" => 0020,
638 "S_IXGRP" => 0010,
639 "S_IRWXO" => 0007,
640 "S_IROTH" => 0004,
641 "S_IWOTH" => 0002,
642 "S_IXOTH" => 0001,
643 "S_IRWXUGO" => 0777,
644 "S_IRUGO" => 0444,
645 "S_IWUGO" => 0222,
646 "S_IXUGO" => 0111,
647);
648
649#Create a search pattern for all these strings to speed up a loop below
650our $mode_perms_string_search = "";
651foreach my $entry (keys %mode_permission_string_types) {
652 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
653 $mode_perms_string_search .= $entry;
654}
Joe Perches00180462018-02-06 15:38:55 -0800655our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
656our $multi_mode_perms_string_search = qr{
657 ${single_mode_perms_string_search}
658 (?:\s*\|\s*${single_mode_perms_string_search})*
659}x;
660
661sub perms_to_octal {
662 my ($string) = @_;
663
664 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
665
666 my $val = "";
667 my $oval = "";
668 my $to = 0;
669 my $curpos = 0;
670 my $lastpos = 0;
671 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
672 $curpos = pos($string);
673 my $match = $2;
674 my $omatch = $1;
675 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
676 $lastpos = $curpos;
677 $to |= $mode_permission_string_types{$match};
678 $val .= '\s*\|\s*' if ($val ne "");
679 $val .= $match;
680 $oval .= $omatch;
681 }
682 $oval =~ s/^\s*\|\s*//;
683 $oval =~ s/\s*\|\s*$//;
684 return sprintf("%04o", $to);
685}
Joe Perchesf90774e2016-10-11 13:51:47 -0700686
Wolfram Sang7840a942010-08-09 17:20:57 -0700687our $allowed_asm_includes = qr{(?x:
688 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700689 memory|
690 time|
691 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700692)};
693# memory.h: ARM has a custom one
694
Kees Cook66b47b42014-10-13 15:51:57 -0700695# Load common spelling mistakes and build regular expression list.
696my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700697my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700698
Joe Perches36061e32014-12-10 15:51:43 -0800699if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800700 while (<$spelling>) {
701 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700702
Joe Perches36061e32014-12-10 15:51:43 -0800703 $line =~ s/\s*\n?$//g;
704 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700705
Joe Perches36061e32014-12-10 15:51:43 -0800706 next if ($line =~ m/^\s*#/);
707 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700708
Joe Perches36061e32014-12-10 15:51:43 -0800709 my ($suspect, $fix) = split(/\|\|/, $line);
710
Joe Perches36061e32014-12-10 15:51:43 -0800711 $spelling_fix{$suspect} = $fix;
712 }
713 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800714} else {
715 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700716}
Kees Cook66b47b42014-10-13 15:51:57 -0700717
Joe Perchesebfd7d62015-04-16 12:44:14 -0700718if ($codespell) {
719 if (open(my $spelling, '<', $codespellfile)) {
720 while (<$spelling>) {
721 my $line = $_;
722
723 $line =~ s/\s*\n?$//g;
724 $line =~ s/^\s*//g;
725
726 next if ($line =~ m/^\s*#/);
727 next if ($line =~ m/^\s*$/);
728 next if ($line =~ m/, disabled/i);
729
730 $line =~ s/,.*$//;
731
732 my ($suspect, $fix) = split(/->/, $line);
733
734 $spelling_fix{$suspect} = $fix;
735 }
736 close($spelling);
737 } else {
738 warn "No codespell typos will be found - file '$codespellfile': $!\n";
739 }
740}
741
742$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
743
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700744sub read_words {
745 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700746
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700747 if (open(my $words, '<', $file)) {
748 while (<$words>) {
749 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700750
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700751 $line =~ s/\s*\n?$//g;
752 $line =~ s/^\s*//g;
753
754 next if ($line =~ m/^\s*#/);
755 next if ($line =~ m/^\s*$/);
756 if ($line =~ /\s/) {
757 print("$file: '$line' invalid - ignored\n");
758 next;
759 }
760
Quentin Monnetced69da12020-08-11 18:35:13 -0700761 $$wordsRef .= '|' if (defined $$wordsRef);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700762 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700763 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700764 close($file);
765 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700766 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700767
768 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700769}
770
Quentin Monnetced69da12020-08-11 18:35:13 -0700771my $const_structs;
772if (show_type("CONST_STRUCT")) {
773 read_words(\$const_structs, $conststructsfile)
774 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
775}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700776
Quentin Monnetced69da12020-08-11 18:35:13 -0700777if (defined($typedefsfile)) {
778 my $typeOtherTypedefs;
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700779 read_words(\$typeOtherTypedefs, $typedefsfile)
780 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
Quentin Monnetced69da12020-08-11 18:35:13 -0700781 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700782}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700783
Andy Whitcroft8905a672007-11-28 16:21:06 -0800784sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700785 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
786 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700787 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700788 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700789 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700790 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700791 (?:$typeTypedefs\b)|
792 (?:${all}\b)
793 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800794 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700795 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800796 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800797 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700798 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700799 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800800 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700801 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800802 }x;
Joe Perches18130872014-08-06 16:11:22 -0700803 $NonptrTypeMisordered = qr{
804 (?:$Modifier\s+|const\s+)*
805 (?:
806 (?:${Misordered}\b)
807 )
808 (?:\s+$Modifier|\s+const)*
809 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700810 $NonptrTypeWithAttr = qr{
811 (?:$Modifier\s+|const\s+)*
812 (?:
813 (?:typeof|__typeof__)\s*\([^\)]*\)|
814 (?:$typeTypedefs\b)|
815 (?:${allWithAttr}\b)
816 )
817 (?:\s+$Modifier|\s+const)*
818 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800819 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700820 $NonptrType
Antonio Borneo7b184962020-04-06 20:11:04 -0700821 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700822 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800823 }x;
Joe Perches18130872014-08-06 16:11:22 -0700824 $TypeMisordered = qr{
825 $NonptrTypeMisordered
Antonio Borneo7b184962020-04-06 20:11:04 -0700826 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Joe Perches18130872014-08-06 16:11:22 -0700827 (?:\s+$Inline|\s+$Modifier)*
828 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700829 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700830 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800831}
832build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700833
Joe Perches7d2367a2011-07-25 17:13:22 -0700834our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700835
836# Using $balanced_parens, $LvalOrFunc, or $FuncArg
837# requires at least perl version v5.10.0
838# Any use must be runtime checked with $^V
839
840our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700841our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800842our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700843
Joe Perchesf8422302014-08-06 16:11:31 -0700844our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700845 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700846 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700847 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700848)};
849
Joe Perches7d2367a2011-07-25 17:13:22 -0700850sub deparenthesize {
851 my ($string) = @_;
852 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700853
854 while ($string =~ /^\s*\(.*\)\s*$/) {
855 $string =~ s@^\s*\(\s*@@;
856 $string =~ s@\s*\)\s*$@@;
857 }
858
Joe Perches7d2367a2011-07-25 17:13:22 -0700859 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700860
Joe Perches7d2367a2011-07-25 17:13:22 -0700861 return $string;
862}
863
Joe Perches34456862013-07-03 15:05:34 -0700864sub seed_camelcase_file {
865 my ($file) = @_;
866
867 return if (!(-f $file));
868
869 local $/;
870
871 open(my $include_file, '<', "$file")
872 or warn "$P: Can't read '$file' $!\n";
873 my $text = <$include_file>;
874 close($include_file);
875
876 my @lines = split('\n', $text);
877
878 foreach my $line (@lines) {
879 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
880 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
881 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800882 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
883 $camelcase{$1} = 1;
884 } 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 -0700885 $camelcase{$1} = 1;
886 }
887 }
888}
889
Joe Perchescd28b112019-12-04 16:52:09 -0800890our %maintained_status = ();
891
Joe Perches85b0ee12016-10-11 13:51:44 -0700892sub is_maintained_obsolete {
893 my ($filename) = @_;
894
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800895 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700896
Joe Perchescd28b112019-12-04 16:52:09 -0800897 if (!exists($maintained_status{$filename})) {
898 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
899 }
Joe Perches85b0ee12016-10-11 13:51:44 -0700900
Joe Perchescd28b112019-12-04 16:52:09 -0800901 return $maintained_status{$filename} =~ /obsolete/i;
Joe Perches85b0ee12016-10-11 13:51:44 -0700902}
903
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700904sub is_SPDX_License_valid {
905 my ($license) = @_;
906
Joe Perches56294112018-08-21 21:58:04 -0700907 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700908
Joe Perches56294112018-08-21 21:58:04 -0700909 my $root_path = abs_path($root);
910 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700911 return 0 if ($status ne "");
912 return 1;
913}
914
Joe Perches34456862013-07-03 15:05:34 -0700915my $camelcase_seeded = 0;
916sub seed_camelcase_includes {
917 return if ($camelcase_seeded);
918
919 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700920 my $camelcase_cache = "";
921 my @include_files = ();
922
923 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700924
Richard Genoud3645e322014-02-10 14:25:32 -0800925 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700926 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Joe Perches351b2a12013-07-03 15:05:36 -0700927 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700928 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700929 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700930 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700931 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700932 @include_files = split('\n', $files);
933 foreach my $file (@include_files) {
934 my $date = POSIX::strftime("%Y%m%d%H%M",
935 localtime((stat $file)[9]));
936 $last_mod_date = $date if ($last_mod_date < $date);
937 }
938 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700939 }
Joe Perchesc707a812013-07-08 16:00:43 -0700940
941 if ($camelcase_cache ne "" && -f $camelcase_cache) {
942 open(my $camelcase_file, '<', "$camelcase_cache")
943 or warn "$P: Can't read '$camelcase_cache' $!\n";
944 while (<$camelcase_file>) {
945 chomp;
946 $camelcase{$_} = 1;
947 }
948 close($camelcase_file);
949
950 return;
951 }
952
Richard Genoud3645e322014-02-10 14:25:32 -0800953 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700954 $files = `${git_command} ls-files "include/*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700955 @include_files = split('\n', $files);
956 }
957
Joe Perches34456862013-07-03 15:05:34 -0700958 foreach my $file (@include_files) {
959 seed_camelcase_file($file);
960 }
Joe Perches351b2a12013-07-03 15:05:36 -0700961
Joe Perchesc707a812013-07-08 16:00:43 -0700962 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700963 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700964 open(my $camelcase_file, '>', "$camelcase_cache")
965 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700966 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
967 print $camelcase_file ("$_\n");
968 }
969 close($camelcase_file);
970 }
Joe Perches34456862013-07-03 15:05:34 -0700971}
972
Joe Perchesd311cd42014-08-06 16:10:57 -0700973sub git_commit_info {
974 my ($commit, $id, $desc) = @_;
975
976 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
977
Joe Perchesdbbf8692019-09-25 16:46:52 -0700978 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Joe Perchesd311cd42014-08-06 16:10:57 -0700979 $output =~ s/^\s*//gm;
980 my @lines = split("\n", $output);
981
Joe Perches0d7835f2015-02-13 14:38:35 -0800982 return ($id, $desc) if ($#lines < 0);
983
Sean Christopherson5a7f4452019-09-25 16:46:49 -0700984 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Joe Perchesd311cd42014-08-06 16:10:57 -0700985# Maybe one day convert this block of bash into something that returns
986# all matching commit ids, but it's very slow...
987#
988# echo "checking commits $1..."
989# git rev-list --remotes | grep -i "^$1" |
990# while read line ; do
991# git log --format='%H %s' -1 $line |
992# echo "commit $(cut -c 1-12,41-)"
993# done
994 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700995 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700996 } else {
997 $id = substr($lines[0], 0, 12);
998 $desc = substr($lines[0], 41);
999 }
1000
1001 return ($id, $desc);
1002}
1003
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001004$chk_signoff = 0 if ($file);
1005
Andy Whitcroft00df3442007-06-08 13:47:06 -07001006my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001007my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001008my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001009my @fixed_inserted = ();
1010my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001011my $fixlinenr = -1;
1012
Du, Changbin4a593c32016-05-20 17:04:16 -07001013# If input is git commits, extract all commits from the commit expressions.
1014# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1015die "$P: No git repository found\n" if ($git && !-e ".git");
1016
1017if ($git) {
1018 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001019 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001020 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001021 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1022 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001023 } elsif ($commit_expr =~ m/\.\./) {
1024 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001025 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001026 $git_range = "-1 $commit_expr";
1027 }
Joe Perchesdbbf8692019-09-25 16:46:52 -07001028 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001029 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001030 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1031 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001032 my $sha1 = $1;
1033 my $subject = $2;
1034 unshift(@commits, $sha1);
1035 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001036 }
1037 }
1038 die "$P: no git commits after extraction!\n" if (@commits == 0);
1039 @ARGV = @commits;
1040}
1041
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001042my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001043$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001044for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001045 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -07001046 if ($git) {
1047 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1048 die "$P: $filename: git format-patch failed - $!\n";
1049 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001050 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001051 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001052 } elsif ($filename eq '-') {
1053 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001054 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001055 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001056 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001057 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001058 if ($filename eq '-') {
1059 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001060 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001061 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001062 } else {
1063 $vname = $filename;
1064 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001065 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001066 chomp;
1067 push(@rawlines, $_);
Geert Uytterhoevenc7f574d2020-06-04 16:50:43 -07001068 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001069 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001070 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001071
1072 if ($#ARGV > 0 && $quiet == 0) {
1073 print '-' x length($vname) . "\n";
1074 print "$vname\n";
1075 print '-' x length($vname) . "\n";
1076 }
1077
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001078 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001079 $exit = 1;
1080 }
1081 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001082 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001083 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001084 @fixed_inserted = ();
1085 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001086 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001087 @modifierListFile = ();
1088 @typeListFile = ();
1089 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001090}
1091
Joe Perchesd8469f12015-06-25 15:03:00 -07001092if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001093 hash_show_words(\%use_type, "Used");
1094 hash_show_words(\%ignore_type, "Ignored");
1095
Joe Perches5b579802018-08-21 21:57:33 -07001096 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001097 print << "EOM"
1098
1099NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001100 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001101EOM
1102 }
1103 if ($exit) {
1104 print << "EOM"
1105
1106NOTE: If any of the errors are false positives, please report
1107 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1108EOM
1109 }
1110}
1111
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001112exit($exit);
1113
1114sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001115 my ($root) = @_;
1116
1117 my @tree_check = (
1118 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1119 "README", "Documentation", "arch", "include", "drivers",
1120 "fs", "init", "ipc", "kernel", "lib", "scripts",
1121 );
1122
1123 foreach my $check (@tree_check) {
1124 if (! -e $root . '/' . $check) {
1125 return 0;
1126 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001127 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001128 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001129}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001130
Joe Perches20112472011-07-25 17:13:23 -07001131sub parse_email {
1132 my ($formatted_email) = @_;
1133
1134 my $name = "";
Joe Perchesdfa05c22020-04-06 20:10:48 -07001135 my $name_comment = "";
Joe Perches20112472011-07-25 17:13:23 -07001136 my $address = "";
1137 my $comment = "";
1138
1139 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1140 $name = $1;
1141 $address = $2;
1142 $comment = $3 if defined $3;
1143 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1144 $address = $1;
1145 $comment = $2 if defined $2;
1146 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1147 $address = $1;
1148 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001149 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001150 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001151 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001152 $name =~ s/^\"|\"$//g;
1153 # If there's a name left after stripping spaces and
1154 # leading quotes, and the address doesn't have both
1155 # leading and trailing angle brackets, the address
1156 # is invalid. ie:
1157 # "joe smith joe@smith.com" bad
1158 # "joe smith <joe@smith.com" bad
1159 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1160 $name = "";
1161 $address = "";
1162 $comment = "";
1163 }
1164 }
1165
Joe Perches3705ce52013-07-03 15:05:31 -07001166 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001167 $name =~ s/^\"|\"$//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001168 $name =~ s/(\s*\([^\)]+\))\s*//;
1169 if (defined($1)) {
1170 $name_comment = trim($1);
1171 }
Joe Perches3705ce52013-07-03 15:05:31 -07001172 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001173 $address =~ s/^\<|\>$//g;
1174
1175 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1176 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1177 $name = "\"$name\"";
1178 }
1179
Joe Perchesdfa05c22020-04-06 20:10:48 -07001180 return ($name, $name_comment, $address, $comment);
Joe Perches20112472011-07-25 17:13:23 -07001181}
1182
1183sub format_email {
1184 my ($name, $address) = @_;
1185
1186 my $formatted_email;
1187
Joe Perches3705ce52013-07-03 15:05:31 -07001188 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001189 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001190 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001191
1192 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1193 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1194 $name = "\"$name\"";
1195 }
1196
1197 if ("$name" eq "") {
1198 $formatted_email = "$address";
1199 } else {
1200 $formatted_email = "$name <$address>";
1201 }
1202
1203 return $formatted_email;
1204}
1205
Joe Perchesdfa05c22020-04-06 20:10:48 -07001206sub reformat_email {
1207 my ($email) = @_;
1208
1209 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1210 return format_email($email_name, $email_address);
1211}
1212
1213sub same_email_addresses {
1214 my ($email1, $email2) = @_;
1215
1216 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1217 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1218
1219 return $email1_name eq $email2_name &&
1220 $email1_address eq $email2_address;
1221}
1222
Joe Perchesd311cd42014-08-06 16:10:57 -07001223sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001224 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001225
Joe Perchesbd474ca2014-08-06 16:11:10 -07001226 foreach my $path (split(/:/, $ENV{PATH})) {
1227 if (-e "$path/$bin") {
1228 return "$path/$bin";
1229 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001230 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001231
Joe Perchesbd474ca2014-08-06 16:11:10 -07001232 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001233}
1234
Joe Perches000d1cc12011-07-25 17:13:25 -07001235sub which_conf {
1236 my ($conf) = @_;
1237
1238 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1239 if (-e "$path/$conf") {
1240 return "$path/$conf";
1241 }
1242 }
1243
1244 return "";
1245}
1246
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001247sub expand_tabs {
1248 my ($str) = @_;
1249
1250 my $res = '';
1251 my $n = 0;
1252 for my $c (split(//, $str)) {
1253 if ($c eq "\t") {
1254 $res .= ' ';
1255 $n++;
Antonio Borneo713a09d2020-04-06 20:11:07 -07001256 for (; ($n % $tabsize) != 0; $n++) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001257 $res .= ' ';
1258 }
1259 next;
1260 }
1261 $res .= $c;
1262 $n++;
1263 }
1264
1265 return $res;
1266}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001267sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001268 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001269 return $res;
1270}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001271
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001272sub line_stats {
1273 my ($line) = @_;
1274
1275 # Drop the diff line leader and expand tabs
1276 $line =~ s/^.//;
1277 $line = expand_tabs($line);
1278
1279 # Pick the indent from the front of the line.
1280 my ($white) = ($line =~ /^(\s*)/);
1281
1282 return (length($line), length($white));
1283}
1284
Andy Whitcroft773647a2008-03-28 14:15:58 -07001285my $sanitise_quote = '';
1286
1287sub sanitise_line_reset {
1288 my ($in_comment) = @_;
1289
1290 if ($in_comment) {
1291 $sanitise_quote = '*/';
1292 } else {
1293 $sanitise_quote = '';
1294 }
1295}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001296sub sanitise_line {
1297 my ($line) = @_;
1298
1299 my $res = '';
1300 my $l = '';
1301
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001303 my $off = 0;
1304 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001305
Andy Whitcroft773647a2008-03-28 14:15:58 -07001306 # Always copy over the diff marker.
1307 $res = substr($line, 0, 1);
1308
1309 for ($off = 1; $off < length($line); $off++) {
1310 $c = substr($line, $off, 1);
1311
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001312 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001313 # and end, all to $;.
1314 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1315 $sanitise_quote = '*/';
1316
1317 substr($res, $off, 2, "$;$;");
1318 $off++;
1319 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001320 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001321 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001322 $sanitise_quote = '';
1323 substr($res, $off, 2, "$;$;");
1324 $off++;
1325 next;
1326 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001327 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1328 $sanitise_quote = '//';
1329
1330 substr($res, $off, 2, $sanitise_quote);
1331 $off++;
1332 next;
1333 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001334
1335 # A \ in a string means ignore the next character.
1336 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1337 $c eq "\\") {
1338 substr($res, $off, 2, 'XX');
1339 $off++;
1340 next;
1341 }
1342 # Regular quotes.
1343 if ($c eq "'" || $c eq '"') {
1344 if ($sanitise_quote eq '') {
1345 $sanitise_quote = $c;
1346
1347 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001348 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001349 } elsif ($sanitise_quote eq $c) {
1350 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001351 }
1352 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001353
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001354 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001355 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1356 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001357 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1358 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001359 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1360 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001361 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001362 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001363 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001364 }
1365
Daniel Walker113f04a2009-09-21 17:04:35 -07001366 if ($sanitise_quote eq '//') {
1367 $sanitise_quote = '';
1368 }
1369
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001370 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001371 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001372 my $clean = 'X' x length($1);
1373 $res =~ s@\<.*\>@<$clean>@;
1374
1375 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001376 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001377 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001378 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001379 }
1380
Joe Perchesdadf6802016-08-02 14:04:33 -07001381 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1382 my $match = $1;
1383 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1384 }
1385
Andy Whitcroft00df3442007-06-08 13:47:06 -07001386 return $res;
1387}
1388
Joe Perchesa6962d72013-04-29 16:18:13 -07001389sub get_quoted_string {
1390 my ($line, $rawline) = @_;
1391
Joe Perches478b1792018-04-10 16:33:34 -07001392 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001393 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001394 return substr($rawline, $-[0], $+[0] - $-[0]);
1395}
1396
Andy Whitcroft8905a672007-11-28 16:21:06 -08001397sub ctx_statement_block {
1398 my ($linenr, $remain, $off) = @_;
1399 my $line = $linenr - 1;
1400 my $blk = '';
1401 my $soff = $off;
1402 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001403 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001404
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001405 my $loff = 0;
1406
Andy Whitcroft8905a672007-11-28 16:21:06 -08001407 my $type = '';
1408 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001409 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001410 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001411 my $c;
1412 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001413
1414 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001415 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001416 @stack = (['', 0]) if ($#stack == -1);
1417
Andy Whitcroft773647a2008-03-28 14:15:58 -07001418 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001419 # If we are about to drop off the end, pull in more
1420 # context.
1421 if ($off >= $len) {
1422 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001423 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001424 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001425 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001426 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001427 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001428 $len = length($blk);
1429 $line++;
1430 last;
1431 }
1432 # Bail if there is no further context.
1433 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001434 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001435 last;
1436 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001437 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1438 $level++;
1439 $type = '#';
1440 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001441 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001442 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001443 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001444 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001445
Andy Whitcroft773647a2008-03-28 14:15:58 -07001446 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001447
1448 # Handle nested #if/#else.
1449 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1450 push(@stack, [ $type, $level ]);
1451 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1452 ($type, $level) = @{$stack[$#stack - 1]};
1453 } elsif ($remainder =~ /^#\s*endif\b/) {
1454 ($type, $level) = @{pop(@stack)};
1455 }
1456
Andy Whitcroft8905a672007-11-28 16:21:06 -08001457 # Statement ends at the ';' or a close '}' at the
1458 # outermost level.
1459 if ($level == 0 && $c eq ';') {
1460 last;
1461 }
1462
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001463 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001464 if ($level == 0 && $coff_set == 0 &&
1465 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1466 $remainder =~ /^(else)(?:\s|{)/ &&
1467 $remainder !~ /^else\s+if\b/) {
1468 $coff = $off + length($1) - 1;
1469 $coff_set = 1;
1470 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1471 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001472 }
1473
Andy Whitcroft8905a672007-11-28 16:21:06 -08001474 if (($type eq '' || $type eq '(') && $c eq '(') {
1475 $level++;
1476 $type = '(';
1477 }
1478 if ($type eq '(' && $c eq ')') {
1479 $level--;
1480 $type = ($level != 0)? '(' : '';
1481
1482 if ($level == 0 && $coff < $soff) {
1483 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001484 $coff_set = 1;
1485 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001486 }
1487 }
1488 if (($type eq '' || $type eq '{') && $c eq '{') {
1489 $level++;
1490 $type = '{';
1491 }
1492 if ($type eq '{' && $c eq '}') {
1493 $level--;
1494 $type = ($level != 0)? '{' : '';
1495
1496 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001497 if (substr($blk, $off + 1, 1) eq ';') {
1498 $off++;
1499 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001500 last;
1501 }
1502 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001503 # Preprocessor commands end at the newline unless escaped.
1504 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1505 $level--;
1506 $type = '';
1507 $off++;
1508 last;
1509 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001510 $off++;
1511 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001512 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001513 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001514 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001515 $line++;
1516 $remain--;
1517 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001518
1519 my $statement = substr($blk, $soff, $off - $soff + 1);
1520 my $condition = substr($blk, $soff, $coff - $soff + 1);
1521
1522 #warn "STATEMENT<$statement>\n";
1523 #warn "CONDITION<$condition>\n";
1524
Andy Whitcroft773647a2008-03-28 14:15:58 -07001525 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001526
1527 return ($statement, $condition,
1528 $line, $remain + 1, $off - $loff + 1, $level);
1529}
1530
Andy Whitcroftcf655042008-03-04 14:28:20 -08001531sub statement_lines {
1532 my ($stmt) = @_;
1533
1534 # Strip the diff line prefixes and rip blank lines at start and end.
1535 $stmt =~ s/(^|\n)./$1/g;
1536 $stmt =~ s/^\s*//;
1537 $stmt =~ s/\s*$//;
1538
1539 my @stmt_lines = ($stmt =~ /\n/g);
1540
1541 return $#stmt_lines + 2;
1542}
1543
1544sub statement_rawlines {
1545 my ($stmt) = @_;
1546
1547 my @stmt_lines = ($stmt =~ /\n/g);
1548
1549 return $#stmt_lines + 2;
1550}
1551
1552sub statement_block_size {
1553 my ($stmt) = @_;
1554
1555 $stmt =~ s/(^|\n)./$1/g;
1556 $stmt =~ s/^\s*{//;
1557 $stmt =~ s/}\s*$//;
1558 $stmt =~ s/^\s*//;
1559 $stmt =~ s/\s*$//;
1560
1561 my @stmt_lines = ($stmt =~ /\n/g);
1562 my @stmt_statements = ($stmt =~ /;/g);
1563
1564 my $stmt_lines = $#stmt_lines + 2;
1565 my $stmt_statements = $#stmt_statements + 1;
1566
1567 if ($stmt_lines > $stmt_statements) {
1568 return $stmt_lines;
1569 } else {
1570 return $stmt_statements;
1571 }
1572}
1573
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001574sub ctx_statement_full {
1575 my ($linenr, $remain, $off) = @_;
1576 my ($statement, $condition, $level);
1577
1578 my (@chunks);
1579
Andy Whitcroftcf655042008-03-04 14:28:20 -08001580 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001581 ($statement, $condition, $linenr, $remain, $off, $level) =
1582 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001583 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001584 push(@chunks, [ $condition, $statement ]);
1585 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1586 return ($level, $linenr, @chunks);
1587 }
1588
1589 # Pull in the following conditional/block pairs and see if they
1590 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001591 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001592 ($statement, $condition, $linenr, $remain, $off, $level) =
1593 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001594 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001595 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001596 #print "C: push\n";
1597 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001598 }
1599
1600 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001601}
1602
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001603sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001604 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001605 my $line;
1606 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001607 my $blk = '';
1608 my @o;
1609 my @c;
1610 my @res = ();
1611
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001612 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001613 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001614 for ($line = $start; $remain > 0; $line++) {
1615 next if ($rawlines[$line] =~ /^-/);
1616 $remain--;
1617
1618 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001619
1620 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001621 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001622 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001623 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001624 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001625 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001626 $level = pop(@stack);
1627 }
1628
Andy Whitcroft01464f32010-10-26 14:23:19 -07001629 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001630 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1631 if ($off > 0) {
1632 $off--;
1633 next;
1634 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001635
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001636 if ($c eq $close && $level > 0) {
1637 $level--;
1638 last if ($level == 0);
1639 } elsif ($c eq $open) {
1640 $level++;
1641 }
1642 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001643
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001644 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001645 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001646 }
1647
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001648 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001649 }
1650
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001651 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001652}
1653sub ctx_block_outer {
1654 my ($linenr, $remain) = @_;
1655
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001656 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1657 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001658}
1659sub ctx_block {
1660 my ($linenr, $remain) = @_;
1661
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001662 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1663 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001664}
1665sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001666 my ($linenr, $remain, $off) = @_;
1667
1668 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1669 return @r;
1670}
1671sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001672 my ($linenr, $remain) = @_;
1673
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001674 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001675}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001676sub ctx_statement_level {
1677 my ($linenr, $remain, $off) = @_;
1678
1679 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1680}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001681
1682sub ctx_locate_comment {
1683 my ($first_line, $end_line) = @_;
1684
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001685 # If c99 comment on the current line, or the line before or after
1686 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1687 return $current_comment if (defined $current_comment);
1688 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1689 return $current_comment if (defined $current_comment);
1690 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1691 return $current_comment if (defined $current_comment);
1692
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001693 # Catch a comment on the end of the line itself.
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001694 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001695 return $current_comment if (defined $current_comment);
1696
1697 # Look through the context and try and figure out if there is a
1698 # comment.
1699 my $in_comment = 0;
1700 $current_comment = '';
1701 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001702 my $line = $rawlines[$linenr - 1];
1703 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001704 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1705 $in_comment = 1;
1706 }
1707 if ($line =~ m@/\*@) {
1708 $in_comment = 1;
1709 }
1710 if (!$in_comment && $current_comment ne '') {
1711 $current_comment = '';
1712 }
1713 $current_comment .= $line . "\n" if ($in_comment);
1714 if ($line =~ m@\*/@) {
1715 $in_comment = 0;
1716 }
1717 }
1718
1719 chomp($current_comment);
1720 return($current_comment);
1721}
1722sub ctx_has_comment {
1723 my ($first_line, $end_line) = @_;
1724 my $cmt = ctx_locate_comment($first_line, $end_line);
1725
Andy Whitcroft00df3442007-06-08 13:47:06 -07001726 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001727 ##print "CMMT: $cmt\n";
1728
1729 return ($cmt ne '');
1730}
1731
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001732sub raw_line {
1733 my ($linenr, $cnt) = @_;
1734
1735 my $offset = $linenr - 1;
1736 $cnt++;
1737
1738 my $line;
1739 while ($cnt) {
1740 $line = $rawlines[$offset++];
1741 next if (defined($line) && $line =~ /^-/);
1742 $cnt--;
1743 }
1744
1745 return $line;
1746}
1747
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001748sub get_stat_real {
1749 my ($linenr, $lc) = @_;
1750
1751 my $stat_real = raw_line($linenr, 0);
1752 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1753 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1754 }
1755
1756 return $stat_real;
1757}
1758
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001759sub get_stat_here {
1760 my ($linenr, $cnt, $here) = @_;
1761
1762 my $herectx = $here . "\n";
1763 for (my $n = 0; $n < $cnt; $n++) {
1764 $herectx .= raw_line($linenr, $n) . "\n";
1765 }
1766
1767 return $herectx;
1768}
1769
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001770sub cat_vet {
1771 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001772 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001773
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001774 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001775 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1776 $res .= $1;
1777 if ($2 ne '') {
1778 $coded = sprintf("^%c", unpack('C', $2) + 64);
1779 $res .= $coded;
1780 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001781 }
1782 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001783
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001784 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001785}
1786
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001787my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001788my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001789my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001790my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001791
1792sub annotate_reset {
1793 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001794 $av_pending = '_';
1795 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001796 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001797}
1798
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001799sub annotate_values {
1800 my ($stream, $type) = @_;
1801
1802 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001803 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001804 my $cur = $stream;
1805
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001806 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001807
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001808 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001809 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001810 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001811 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001812 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001813 print "WS($1)\n" if ($dbg_values > 1);
1814 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001815 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001816 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001817 }
1818
Florian Micklerc023e4732011-01-12 16:59:58 -08001819 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001820 print "CAST($1)\n" if ($dbg_values > 1);
1821 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001822 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001823
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001824 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001825 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001826 $type = 'T';
1827
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001828 } elsif ($cur =~ /^($Modifier)\s*/) {
1829 print "MODIFIER($1)\n" if ($dbg_values > 1);
1830 $type = 'T';
1831
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001832 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001833 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001834 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001835 push(@av_paren_type, $type);
1836 if ($2 ne '') {
1837 $av_pending = 'N';
1838 }
1839 $type = 'E';
1840
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001841 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001842 print "UNDEF($1)\n" if ($dbg_values > 1);
1843 $av_preprocessor = 1;
1844 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001845
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001846 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001847 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001848 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001849
1850 push(@av_paren_type, $type);
1851 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001852 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001853
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001854 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001855 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1856 $av_preprocessor = 1;
1857
1858 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1859
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001860 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001861
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001862 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001863 print "PRE_END($1)\n" if ($dbg_values > 1);
1864
1865 $av_preprocessor = 1;
1866
1867 # Assume all arms of the conditional end as this
1868 # one does, and continue as if the #endif was not here.
1869 pop(@av_paren_type);
1870 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001871 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001872
1873 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001874 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001875
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001876 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1877 print "ATTR($1)\n" if ($dbg_values > 1);
1878 $av_pending = $type;
1879 $type = 'N';
1880
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001881 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001882 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001883 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001884 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001885 }
1886 $type = 'N';
1887
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001888 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001889 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001890 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001891 $type = 'N';
1892
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001893 } elsif ($cur =~/^(case)/o) {
1894 print "CASE($1)\n" if ($dbg_values > 1);
1895 $av_pend_colon = 'C';
1896 $type = 'N';
1897
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001898 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001899 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001900 $type = 'N';
1901
1902 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001903 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001904 push(@av_paren_type, $av_pending);
1905 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001906 $type = 'N';
1907
1908 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001909 my $new_type = pop(@av_paren_type);
1910 if ($new_type ne '_') {
1911 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001912 print "PAREN('$1') -> $type\n"
1913 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001914 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001915 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001916 }
1917
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001918 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001919 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001920 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001921 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001922
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001923 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1924 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001925 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001926 } elsif ($type eq 'E') {
1927 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001928 }
1929 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1930 $type = 'V';
1931
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001932 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001933 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001934 $type = 'V';
1935
1936 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001937 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001938 $type = 'N';
1939
Andy Whitcroftcf655042008-03-04 14:28:20 -08001940 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001941 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001942 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001943 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001944
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001945 } elsif ($cur =~/^(,)/) {
1946 print "COMMA($1)\n" if ($dbg_values > 1);
1947 $type = 'C';
1948
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001949 } elsif ($cur =~ /^(\?)/o) {
1950 print "QUESTION($1)\n" if ($dbg_values > 1);
1951 $type = 'N';
1952
1953 } elsif ($cur =~ /^(:)/o) {
1954 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1955
1956 substr($var, length($res), 1, $av_pend_colon);
1957 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1958 $type = 'E';
1959 } else {
1960 $type = 'N';
1961 }
1962 $av_pend_colon = 'O';
1963
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001964 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001965 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001966 $type = 'N';
1967
Andy Whitcroft0d413862008-10-15 22:02:16 -07001968 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001969 my $variant;
1970
1971 print "OPV($1)\n" if ($dbg_values > 1);
1972 if ($type eq 'V') {
1973 $variant = 'B';
1974 } else {
1975 $variant = 'U';
1976 }
1977
1978 substr($var, length($res), 1, $variant);
1979 $type = 'N';
1980
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001981 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001982 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001983 if ($1 ne '++' && $1 ne '--') {
1984 $type = 'N';
1985 }
1986
1987 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001988 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001989 }
1990 if (defined $1) {
1991 $cur = substr($cur, length($1));
1992 $res .= $type x length($1);
1993 }
1994 }
1995
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001996 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001997}
1998
Andy Whitcroft8905a672007-11-28 16:21:06 -08001999sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002000 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002001 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002002 ^(?:
2003 $Modifier|
2004 $Storage|
2005 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002006 DEFINE_\S+
2007 )$|
2008 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002009 goto|
2010 return|
2011 case|
2012 else|
2013 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08002014 do|
2015 \#|
2016 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002017 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07002018 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002019 )}x;
2020 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2021 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002022 # Check for modifiers.
2023 $possible =~ s/\s*$Storage\s*//g;
2024 $possible =~ s/\s*$Sparse\s*//g;
2025 if ($possible =~ /^\s*$/) {
2026
2027 } elsif ($possible =~ /\s/) {
2028 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07002029 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002030 if ($modifier !~ $notPermitted) {
2031 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002032 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002033 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07002034 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002035
2036 } else {
2037 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002038 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002039 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002040 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07002041 } else {
2042 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002043 }
2044}
2045
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002046my $prefix = '';
2047
Joe Perches000d1cc12011-07-25 17:13:25 -07002048sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07002049 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002050
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002051 $type =~ tr/[a-z]/[A-Z]/;
2052
Joe Perchescbec18a2014-04-03 14:49:19 -07002053 return defined $use_type{$type} if (scalar keys %use_type > 0);
2054
2055 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002056}
2057
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002058sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002059 my ($level, $type, $msg) = @_;
2060
2061 if (!show_type($type) ||
2062 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002063 return 0;
2064 }
Joe Perches57230292015-06-25 15:03:03 -07002065 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002066 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002067 if ($level eq 'ERROR') {
2068 $output .= RED;
2069 } elsif ($level eq 'WARNING') {
2070 $output .= YELLOW;
2071 } else {
2072 $output .= GREEN;
2073 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002074 }
Joe Perches57230292015-06-25 15:03:03 -07002075 $output .= $prefix . $level . ':';
2076 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002077 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002078 $output .= "$type:";
2079 }
John Brooks737c0762017-07-10 15:52:24 -07002080 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002081 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002082
2083 if ($showfile) {
2084 my @lines = split("\n", $output, -1);
2085 splice(@lines, 1, 1);
2086 $output = join("\n", @lines);
2087 }
Joe Perches57230292015-06-25 15:03:03 -07002088 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002089
Joe Perches57230292015-06-25 15:03:03 -07002090 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002091
2092 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002093}
Joe Perchescbec18a2014-04-03 14:49:19 -07002094
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002095sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002096 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002097}
Joe Perches000d1cc12011-07-25 17:13:25 -07002098
Joe Perchesd752fcc2014-08-06 16:11:05 -07002099sub fixup_current_range {
2100 my ($lineRef, $offset, $length) = @_;
2101
2102 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2103 my $o = $1;
2104 my $l = $2;
2105 my $no = $o + $offset;
2106 my $nl = $l + $length;
2107 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2108 }
2109}
2110
2111sub fix_inserted_deleted_lines {
2112 my ($linesRef, $insertedRef, $deletedRef) = @_;
2113
2114 my $range_last_linenr = 0;
2115 my $delta_offset = 0;
2116
2117 my $old_linenr = 0;
2118 my $new_linenr = 0;
2119
2120 my $next_insert = 0;
2121 my $next_delete = 0;
2122
2123 my @lines = ();
2124
2125 my $inserted = @{$insertedRef}[$next_insert++];
2126 my $deleted = @{$deletedRef}[$next_delete++];
2127
2128 foreach my $old_line (@{$linesRef}) {
2129 my $save_line = 1;
2130 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002131 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002132 $delta_offset = 0;
2133 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2134 $range_last_linenr = $new_linenr;
2135 fixup_current_range(\$line, $delta_offset, 0);
2136 }
2137
2138 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2139 $deleted = @{$deletedRef}[$next_delete++];
2140 $save_line = 0;
2141 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2142 }
2143
2144 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2145 push(@lines, ${$inserted}{'LINE'});
2146 $inserted = @{$insertedRef}[$next_insert++];
2147 $new_linenr++;
2148 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2149 }
2150
2151 if ($save_line) {
2152 push(@lines, $line);
2153 $new_linenr++;
2154 }
2155
2156 $old_linenr++;
2157 }
2158
2159 return @lines;
2160}
2161
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002162sub fix_insert_line {
2163 my ($linenr, $line) = @_;
2164
2165 my $inserted = {
2166 LINENR => $linenr,
2167 LINE => $line,
2168 };
2169 push(@fixed_inserted, $inserted);
2170}
2171
2172sub fix_delete_line {
2173 my ($linenr, $line) = @_;
2174
2175 my $deleted = {
2176 LINENR => $linenr,
2177 LINE => $line,
2178 };
2179
2180 push(@fixed_deleted, $deleted);
2181}
2182
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002183sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002184 my ($type, $msg) = @_;
2185
2186 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002187 our $clean = 0;
2188 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002189 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002190 }
Joe Perches3705ce52013-07-03 15:05:31 -07002191 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002192}
2193sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002194 my ($type, $msg) = @_;
2195
2196 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002197 our $clean = 0;
2198 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002199 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002200 }
Joe Perches3705ce52013-07-03 15:05:31 -07002201 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002202}
2203sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002204 my ($type, $msg) = @_;
2205
2206 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002207 our $clean = 0;
2208 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002209 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002210 }
Joe Perches3705ce52013-07-03 15:05:31 -07002211 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002212}
2213
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002214sub check_absolute_file {
2215 my ($absolute, $herecurr) = @_;
2216 my $file = $absolute;
2217
2218 ##print "absolute<$absolute>\n";
2219
2220 # See if any suffix of this path is a path within the tree.
2221 while ($file =~ s@^[^/]*/@@) {
2222 if (-f "$root/$file") {
2223 ##print "file<$file>\n";
2224 last;
2225 }
2226 }
2227 if (! -f _) {
2228 return 0;
2229 }
2230
2231 # It is, so see if the prefix is acceptable.
2232 my $prefix = $absolute;
2233 substr($prefix, -length($file)) = '';
2234
2235 ##print "prefix<$prefix>\n";
2236 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002237 WARN("USE_RELATIVE_PATH",
2238 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002239 }
2240}
2241
Joe Perches3705ce52013-07-03 15:05:31 -07002242sub trim {
2243 my ($string) = @_;
2244
Joe Perchesb34c6482013-09-11 14:24:01 -07002245 $string =~ s/^\s+|\s+$//g;
2246
2247 return $string;
2248}
2249
2250sub ltrim {
2251 my ($string) = @_;
2252
2253 $string =~ s/^\s+//;
2254
2255 return $string;
2256}
2257
2258sub rtrim {
2259 my ($string) = @_;
2260
2261 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002262
2263 return $string;
2264}
2265
Joe Perches52ea8502013-11-12 15:10:09 -08002266sub string_find_replace {
2267 my ($string, $find, $replace) = @_;
2268
2269 $string =~ s/$find/$replace/g;
2270
2271 return $string;
2272}
2273
Joe Perches3705ce52013-07-03 15:05:31 -07002274sub tabify {
2275 my ($leading) = @_;
2276
Antonio Borneo713a09d2020-04-06 20:11:07 -07002277 my $source_indent = $tabsize;
Joe Perches3705ce52013-07-03 15:05:31 -07002278 my $max_spaces_before_tab = $source_indent - 1;
2279 my $spaces_to_tab = " " x $source_indent;
2280
2281 #convert leading spaces to tabs
2282 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2283 #Remove spaces before a tab
2284 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2285
2286 return "$leading";
2287}
2288
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002289sub pos_last_openparen {
2290 my ($line) = @_;
2291
2292 my $pos = 0;
2293
2294 my $opens = $line =~ tr/\(/\(/;
2295 my $closes = $line =~ tr/\)/\)/;
2296
2297 my $last_openparen = 0;
2298
2299 if (($opens == 0) || ($closes >= $opens)) {
2300 return -1;
2301 }
2302
2303 my $len = length($line);
2304
2305 for ($pos = 0; $pos < $len; $pos++) {
2306 my $string = substr($line, $pos);
2307 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2308 $pos += length($1) - 1;
2309 } elsif (substr($line, $pos, 1) eq '(') {
2310 $last_openparen = $pos;
2311 } elsif (index($string, '(') == -1) {
2312 last;
2313 }
2314 }
2315
Joe Perches91cb5192014-04-03 14:49:32 -07002316 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002317}
2318
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002319sub get_raw_comment {
2320 my ($line, $rawline) = @_;
2321 my $comment = '';
2322
2323 for my $i (0 .. (length($line) - 1)) {
2324 if (substr($line, $i, 1) eq "$;") {
2325 $comment .= substr($rawline, $i, 1);
2326 }
2327 }
2328
2329 return $comment;
2330}
2331
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002332sub process {
2333 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002334
2335 my $linenr=0;
2336 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002337 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002338 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002339 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002340
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002341 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002342 my $indent;
2343 my $previndent=0;
2344 my $stashindent=0;
2345
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002346 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002347 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002348 my $author = '';
2349 my $authorsignoff = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002350 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002351 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002352 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002353 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches44d303e2020-04-06 20:11:10 -07002354 my $has_patch_separator = 0; #Found a --- line
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002355 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002356 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002357 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002358 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002359 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002360 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002361 my $non_utf8_charset = 0;
2362
Joe Perches365dd4e2014-08-06 16:10:42 -07002363 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002364 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002365
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002366 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002367 our $cnt_lines = 0;
2368 our $cnt_error = 0;
2369 our $cnt_warn = 0;
2370 our $cnt_chk = 0;
2371
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002372 # Trace the real file/line as we go.
2373 my $realfile = '';
2374 my $realline = 0;
2375 my $realcnt = 0;
2376 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002377 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002378 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002379 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002380 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002381 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002382
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002383 my $prev_values = 'E';
2384
2385 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002386 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002387 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002388 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002389 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002390
Joe Perches7e51f192013-09-11 14:23:57 -07002391 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002392
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002393 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002394 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002395 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002396 my @setup_docs = ();
2397 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002398
Joe Perchesd8b07712013-11-12 15:10:06 -08002399 my $camelcase_file_seeded = 0;
2400
Rob Herring9f3a8992018-04-10 16:33:13 -07002401 my $checklicenseline = 1;
2402
Andy Whitcroft773647a2008-03-28 14:15:58 -07002403 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002404 my $line;
2405 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002406 $linenr++;
2407 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002408
Joe Perches3705ce52013-07-03 15:05:31 -07002409 push(@fixed, $rawline) if ($fix);
2410
Andy Whitcroft773647a2008-03-28 14:15:58 -07002411 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002412 $setup_docs = 0;
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07002413 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002414 $setup_docs = 1;
2415 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002416 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002417 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002418 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419 $realline=$1-1;
2420 if (defined $2) {
2421 $realcnt=$3+1;
2422 } else {
2423 $realcnt=1+1;
2424 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002425 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002426
2427 # Guestimate if this is a continuing comment. Run
2428 # the context looking for a comment "edge". If this
2429 # edge is a close comment then we must be in a comment
2430 # at context start.
2431 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002432 my $cnt = $realcnt;
2433 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2434 next if (defined $rawlines[$ln - 1] &&
2435 $rawlines[$ln - 1] =~ /^-/);
2436 $cnt--;
2437 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002438 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002439 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2440 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2441 ($edge) = $1;
2442 last;
2443 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002444 }
2445 if (defined $edge && $edge eq '*/') {
2446 $in_comment = 1;
2447 }
2448
2449 # Guestimate if this is a continuing comment. If this
2450 # is the start of a diff block and this line starts
2451 # ' *' then it is very likely a comment.
2452 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002453 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002454 {
2455 $in_comment = 1;
2456 }
2457
2458 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2459 sanitise_line_reset($in_comment);
2460
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002461 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002462 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002463 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002464 $line = sanitise_line($rawline);
2465 }
2466 push(@lines, $line);
2467
2468 if ($realcnt > 1) {
2469 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2470 } else {
2471 $realcnt = 0;
2472 }
2473
2474 #print "==>$rawline\n";
2475 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002476
2477 if ($setup_docs && $line =~ /^\+/) {
2478 push(@setup_docs, $line);
2479 }
2480 }
2481
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002482 $prefix = '';
2483
Andy Whitcroft773647a2008-03-28 14:15:58 -07002484 $realcnt = 0;
2485 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002486 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002487 foreach my $line (@lines) {
2488 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002489 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002490 my $sline = $line; #copy of $line
2491 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002492
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002493 my $rawline = $rawlines[$linenr - 1];
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002494 my $raw_comment = get_raw_comment($line, $rawline);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002495
Joe Perches12c253a2018-06-07 17:10:58 -07002496# check if it's a mode change, rename or start of a patch
2497 if (!$in_commit_log &&
2498 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2499 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2500 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2501 $is_patch = 1;
2502 }
2503
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002504#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002505 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002506 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2507 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002508 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002509 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002510 $realline=$1-1;
2511 if (defined $2) {
2512 $realcnt=$3+1;
2513 } else {
2514 $realcnt=1+1;
2515 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002516 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002517 $prev_values = 'E';
2518
Andy Whitcroft773647a2008-03-28 14:15:58 -07002519 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002520 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002521 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002522 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002523 if ($context =~ /\b(\w+)\s*\(/) {
2524 $context_function = $1;
2525 } else {
2526 undef $context_function;
2527 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002528 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002529
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002530# track the line number as we move through the hunk, note that
2531# new versions of GNU diff omit the leading space on completely
2532# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002533 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002534 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002535 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002536
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002537 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002538 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002539
2540 # Track the previous line.
2541 ($prevline, $stashline) = ($stashline, $line);
2542 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002543 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2544
Andy Whitcroft773647a2008-03-28 14:15:58 -07002545 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002546
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002547 } elsif ($realcnt == 1) {
2548 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002549 }
2550
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002551 my $hunk_line = ($realcnt != 0);
2552
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002553 $here = "#$linenr: " if (!$file);
2554 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002555
Joe Perches2ac73b42014-06-04 16:12:05 -07002556 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002557 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002558 if ($line =~ /^diff --git.*?(\S+)$/) {
2559 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002560 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002561 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002562 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002563 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002564 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002565 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002566 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002567
2568 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002569 if (!$file && $tree && $p1_prefix ne '' &&
2570 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002571 WARN("PATCH_PREFIX",
2572 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002573 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002574
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002575 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002576 ERROR("MODIFIED_INCLUDE_ASM",
2577 "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 -07002578 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002579 $found_file = 1;
2580 }
2581
Joe Perches34d88152015-06-25 15:03:05 -07002582#make up the handle for any error we report on this line
2583 if ($showfile) {
2584 $prefix = "$realfile:$realline: "
2585 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002586 if ($file) {
2587 $prefix = "$filename:$realline: ";
2588 } else {
2589 $prefix = "$filename:$linenr: ";
2590 }
Joe Perches34d88152015-06-25 15:03:05 -07002591 }
2592
Joe Perches2ac73b42014-06-04 16:12:05 -07002593 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002594 if (is_maintained_obsolete($realfile)) {
2595 WARN("OBSOLETE",
2596 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2597 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002598 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002599 $check = 1;
2600 } else {
2601 $check = $check_orig;
2602 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002603 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002604
2605 if ($realfile !~ /^MAINTAINERS/) {
2606 my $last_binding_patch = $is_binding_patch;
2607
2608 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2609
2610 if (($last_binding_patch != -1) &&
2611 ($last_binding_patch ^ $is_binding_patch)) {
2612 WARN("DT_SPLIT_BINDING_PATCH",
Mauro Carvalho Chehab858e6842020-04-15 16:45:25 +02002613 "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 -07002614 }
2615 }
2616
Andy Whitcroft773647a2008-03-28 14:15:58 -07002617 next;
2618 }
2619
Randy Dunlap389834b2007-06-08 13:47:03 -07002620 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002621
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002622 my $hereline = "$here\n$rawline\n";
2623 my $herecurr = "$here\n$rawline\n";
2624 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002625
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002626 $cnt_lines++ if ($realcnt != 0);
2627
Joe Perches490b2922018-08-21 21:58:01 -07002628# Verify the existence of a commit log if appropriate
2629# 2 is used because a $signature is counted in $commit_log_lines
2630 if ($in_commit_log) {
2631 if ($line !~ /^\s*$/) {
2632 $commit_log_lines++; #could be a $signature
2633 }
2634 } elsif ($has_commit_log && $commit_log_lines < 2) {
2635 WARN("COMMIT_MESSAGE",
2636 "Missing commit description - Add an appropriate one\n");
2637 $commit_log_lines = 2; #warn only once
2638 }
2639
Joe Perchese518e9a2015-06-25 15:03:27 -07002640# Check if the commit log has what seems like a diff which can confuse patch
2641 if ($in_commit_log && !$commit_log_has_diff &&
2642 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2643 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2644 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2645 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2646 ERROR("DIFF_IN_COMMIT_MSG",
2647 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2648 $commit_log_has_diff = 1;
2649 }
2650
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002651# Check for incorrect file permissions
2652 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2653 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002654 if ($realfile !~ m@scripts/@ &&
2655 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002656 ERROR("EXECUTE_PERMISSIONS",
2657 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002658 }
2659 }
2660
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002661# Check the patch for a From:
2662 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2663 $author = $1;
2664 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2665 $author =~ s/"//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07002666 $author = reformat_email($author);
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002667 }
2668
Joe Perches20112472011-07-25 17:13:23 -07002669# Check the patch for a signoff:
Joe Perchesdfa05c22020-04-06 20:10:48 -07002670 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002671 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002672 $in_commit_log = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002673 if ($author ne '') {
Joe Perchesdfa05c22020-04-06 20:10:48 -07002674 if (same_email_addresses($1, $author)) {
2675 $authorsignoff = 1;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002676 }
2677 }
Joe Perches20112472011-07-25 17:13:23 -07002678 }
2679
Joe Perches44d303e2020-04-06 20:11:10 -07002680# Check for patch separator
2681 if ($line =~ /^---$/) {
2682 $has_patch_separator = 1;
2683 $in_commit_log = 0;
2684 }
2685
Joe Perchese0d975b2014-12-10 15:51:49 -08002686# Check if MAINTAINERS is being updated. If so, there's probably no need to
2687# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2688 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2689 $reported_maintainer_file = 1;
2690 }
2691
Joe Perches20112472011-07-25 17:13:23 -07002692# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002693 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002694 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002695 my $space_before = $1;
2696 my $sign_off = $2;
2697 my $space_after = $3;
2698 my $email = $4;
2699 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2700
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002701 if ($sign_off !~ /$signature_tags/) {
2702 WARN("BAD_SIGN_OFF",
2703 "Non-standard signature: $sign_off\n" . $herecurr);
2704 }
Joe Perches20112472011-07-25 17:13:23 -07002705 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002706 if (WARN("BAD_SIGN_OFF",
2707 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2708 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002709 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002710 "$ucfirst_sign_off $email";
2711 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002712 }
Joe Perches20112472011-07-25 17:13:23 -07002713 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002714 if (WARN("BAD_SIGN_OFF",
2715 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2716 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002717 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002718 "$ucfirst_sign_off $email";
2719 }
2720
Joe Perches20112472011-07-25 17:13:23 -07002721 }
2722 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002723 if (WARN("BAD_SIGN_OFF",
2724 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2725 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002726 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002727 "$ucfirst_sign_off $email";
2728 }
Joe Perches20112472011-07-25 17:13:23 -07002729 }
2730
Joe Perchesdfa05c22020-04-06 20:10:48 -07002731 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Joe Perches20112472011-07-25 17:13:23 -07002732 my $suggested_email = format_email(($email_name, $email_address));
2733 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002734 ERROR("BAD_SIGN_OFF",
2735 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002736 } else {
2737 my $dequoted = $suggested_email;
2738 $dequoted =~ s/^"//;
2739 $dequoted =~ s/" </ </;
2740 # Don't force email to have quotes
2741 # Allow just an angle bracketed address
Joe Perchesdfa05c22020-04-06 20:10:48 -07002742 if (!same_email_addresses($email, $suggested_email)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002743 WARN("BAD_SIGN_OFF",
2744 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002745 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002746 }
Joe Perches7e51f192013-09-11 14:23:57 -07002747
2748# Check for duplicate signatures
2749 my $sig_nospace = $line;
2750 $sig_nospace =~ s/\s//g;
2751 $sig_nospace = lc($sig_nospace);
2752 if (defined $signatures{$sig_nospace}) {
2753 WARN("BAD_SIGN_OFF",
2754 "Duplicate signature\n" . $herecurr);
2755 } else {
2756 $signatures{$sig_nospace} = 1;
2757 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07002758
2759# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2760 if ($sign_off =~ /^co-developed-by:$/i) {
2761 if ($email eq $author) {
2762 WARN("BAD_SIGN_OFF",
2763 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2764 }
2765 if (!defined $lines[$linenr]) {
2766 WARN("BAD_SIGN_OFF",
2767 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2768 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2769 WARN("BAD_SIGN_OFF",
2770 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2771 } elsif ($1 ne $email) {
2772 WARN("BAD_SIGN_OFF",
2773 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2774 }
2775 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002776 }
2777
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002778# Check email subject for common tools that don't need to be mentioned
2779 if ($in_header_lines &&
2780 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2781 WARN("EMAIL_SUBJECT",
2782 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2783 }
2784
Joe Perches44d303e2020-04-06 20:11:10 -07002785# Check for Gerrit Change-Ids not in any patch context
2786 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002787 ERROR("GERRIT_CHANGE_ID",
Joe Perches44d303e2020-04-06 20:11:10 -07002788 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002789 }
2790
Joe Perches369c8dd2015-11-06 16:31:34 -08002791# Check if the commit log is in a possible stack dump
2792 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2793 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2794 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2795 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07002796 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2797 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2798 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2799 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08002800 $commit_log_possible_stack_dump = 1;
2801 }
2802
Joe Perches2a076f42015-04-16 12:44:28 -07002803# Check for line lengths > 75 in commit log, warn once
2804 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002805 length($line) > 75 &&
2806 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2807 # file delta changes
2808 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2809 # filename then :
2810 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2811 # A Fixes: or Link: line
2812 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002813 WARN("COMMIT_LOG_LONG_LINE",
2814 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2815 $commit_log_long_line = 1;
2816 }
2817
Joe Perchesbf4daf12015-09-09 15:37:50 -07002818# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002819 if ($in_commit_log && $commit_log_possible_stack_dump &&
2820 $line =~ /^\s*$/) {
2821 $commit_log_possible_stack_dump = 0;
2822 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002823
Joe Perches0d7835f2015-02-13 14:38:35 -08002824# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002825 if ($in_commit_log && !$commit_log_possible_stack_dump &&
John Hubbarda8972572020-04-06 20:10:55 -07002826 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002827 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002828 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002829 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002830 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2831 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002832 my $init_char = "c";
2833 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002834 my $short = 1;
2835 my $long = 0;
2836 my $case = 1;
2837 my $space = 1;
2838 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002839 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002840 my $id = '0123456789ab';
2841 my $orig_desc = "commit description";
2842 my $description = "";
2843
Joe Perchesfe043ea2015-09-09 15:37:25 -07002844 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2845 $init_char = $1;
2846 $orig_commit = lc($2);
2847 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2848 $orig_commit = lc($1);
2849 }
2850
Joe Perches0d7835f2015-02-13 14:38:35 -08002851 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2852 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2853 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2854 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2855 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2856 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002857 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002858 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2859 defined $rawlines[$linenr] &&
2860 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2861 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002862 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002863 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2864 defined $rawlines[$linenr] &&
2865 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2866 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2867 $orig_desc = $1;
2868 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2869 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002870 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002871 }
2872
2873 ($id, $description) = git_commit_info($orig_commit,
2874 $id, $orig_desc);
2875
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002876 if (defined($id) &&
2877 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002878 ERROR("GIT_COMMIT_ID",
2879 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2880 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002881 }
2882
Joe Perches13f19372014-08-06 16:10:59 -07002883# Check for added, moved or deleted files
2884 if (!$reported_maintainer_file && !$in_commit_log &&
2885 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2886 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2887 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2888 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002889 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002890 $reported_maintainer_file = 1;
2891 WARN("FILE_PATH_CHANGES",
2892 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2893 }
2894
Rob Herringe400edb2019-09-12 15:18:20 +01002895# Check for adding new DT bindings not in schema format
2896 if (!$in_commit_log &&
2897 ($line =~ /^new file mode\s*\d+\s*$/) &&
2898 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2899 WARN("DT_SCHEMA_BINDING_PATCH",
2900 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2901 }
2902
Andy Whitcroft00df3442007-06-08 13:47:06 -07002903# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002904 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002905 ERROR("CORRUPTED_PATCH",
2906 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002907 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002908 }
2909
2910# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2911 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002912 $rawline !~ m/^$UTF8*$/) {
2913 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2914
2915 my $blank = copy_spacing($rawline);
2916 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2917 my $hereptr = "$hereline$ptr\n";
2918
Joe Perches34d99212011-07-25 17:13:26 -07002919 CHK("INVALID_UTF8",
2920 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002921 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002922
Joe Perches15662b32011-10-31 17:13:12 -07002923# Check if it's the start of a commit log
2924# (not a header line and we haven't seen the patch filename)
2925 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002926 !($rawline =~ /^\s+(?:\S|$)/ ||
2927 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002928 $in_header_lines = 0;
2929 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002930 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002931 }
2932
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002933# Check if there is UTF-8 in a commit log when a mail header has explicitly
2934# declined it, i.e defined some charset where it is missing.
2935 if ($in_header_lines &&
2936 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2937 $1 !~ /utf-8/i) {
2938 $non_utf8_charset = 1;
2939 }
2940
2941 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002942 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002943 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002944 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2945 }
2946
Joe Perchesd6430f72016-12-12 16:46:28 -08002947# Check for absolute kernel paths in commit message
2948 if ($tree && $in_commit_log) {
2949 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2950 my $file = $1;
2951
2952 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2953 check_absolute_file($1, $herecurr)) {
2954 #
2955 } else {
2956 check_absolute_file($file, $herecurr);
2957 }
2958 }
2959 }
2960
Kees Cook66b47b42014-10-13 15:51:57 -07002961# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002962 if (defined($misspellings) &&
2963 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002964 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002965 my $typo = $1;
2966 my $typo_fix = $spelling_fix{lc($typo)};
2967 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2968 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002969 my $msg_level = \&WARN;
2970 $msg_level = \&CHK if ($file);
2971 if (&{$msg_level}("TYPO_SPELLING",
2972 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002973 $fix) {
2974 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2975 }
2976 }
2977 }
2978
Matteo Crocea8dd86b2019-09-25 16:46:38 -07002979# check for invalid commit id
2980 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2981 my $id;
2982 my $description;
2983 ($id, $description) = git_commit_info($2, undef, undef);
2984 if (!defined($id)) {
2985 WARN("UNKNOWN_COMMIT_ID",
2986 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2987 }
2988 }
2989
Andy Whitcroft306708542008-10-15 22:02:28 -07002990# ignore non-hunk lines and lines being removed
2991 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002992
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002993#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002994 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002995 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002996 if (ERROR("DOS_LINE_ENDINGS",
2997 "DOS line endings\n" . $herevet) &&
2998 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002999 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003000 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003001 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3002 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003003 if (ERROR("TRAILING_WHITESPACE",
3004 "trailing whitespace\n" . $herevet) &&
3005 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003006 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07003007 }
3008
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003009 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003010 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07003011
Josh Triplett4783f892013-11-12 15:10:12 -08003012# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08003013 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08003014 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08003015 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3016 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08003017 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07003018 my $msg_level = \&ERROR;
3019 $msg_level = \&CHK if ($file);
3020 &{$msg_level}("FSF_MAILING_ADDRESS",
3021 "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 -08003022 }
3023
Andi Kleen33549572010-05-24 14:33:29 -07003024# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003025# Only applies when adding the entry originally, after that we do not have
3026# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07003027 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01003028 # 'choice' is usually the last thing on the line (though
3029 # Kconfig supports named choices), so use a word boundary
3030 # (\b) rather than a whitespace character (\s)
3031 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07003032 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003033 my $cnt = $realcnt;
3034 my $ln = $linenr + 1;
3035 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003036 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003037 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003038 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003039 $f = $lines[$ln - 1];
3040 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3041 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003042
3043 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07003044 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08003045
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01003046 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003047 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01003048 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
3049 if ($lines[$ln - 1] =~ "---help---") {
3050 WARN("CONFIG_DESCRIPTION",
3051 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
3052 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003053 $length = -1;
3054 }
3055
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003056 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07003057 $f =~ s/#.*//;
3058 $f =~ s/^\s+//;
3059 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01003060
3061 # This only checks context lines in the patch
3062 # and so hopefully shouldn't trigger false
3063 # positives, even though some of these are
3064 # common words in help texts
3065 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3066 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003067 $is_end = 1;
3068 last;
3069 }
Andi Kleen33549572010-05-24 14:33:29 -07003070 $length++;
3071 }
Vadim Bendebury56193272014-10-13 15:51:48 -07003072 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3073 WARN("CONFIG_DESCRIPTION",
3074 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3075 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003076 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003077 }
3078
Joe Perches7ccf41a2020-06-04 16:50:33 -07003079# check MAINTAINERS entries
3080 if ($realfile =~ /^MAINTAINERS$/) {
3081# check MAINTAINERS entries for the right form
3082 if ($rawline =~ /^\+[A-Z]:/ &&
3083 $rawline !~ /^\+[A-Z]:\t\S/) {
3084 if (WARN("MAINTAINERS_STYLE",
3085 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3086 $fix) {
3087 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3088 }
3089 }
3090# check MAINTAINERS entries for the right ordering too
3091 my $preferred_order = 'MRLSWQBCPTFXNK';
3092 if ($rawline =~ /^\+[A-Z]:/ &&
3093 $prevrawline =~ /^[\+ ][A-Z]:/) {
3094 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3095 my $cur = $1;
3096 my $curval = $2;
3097 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3098 my $prev = $1;
3099 my $prevval = $2;
3100 my $curindex = index($preferred_order, $cur);
3101 my $previndex = index($preferred_order, $prev);
3102 if ($curindex < 0) {
3103 WARN("MAINTAINERS_STYLE",
3104 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3105 } else {
3106 if ($previndex >= 0 && $curindex < $previndex) {
3107 WARN("MAINTAINERS_STYLE",
3108 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3109 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3110 ($prev eq 'X' && $cur eq 'X')) &&
3111 ($prevval cmp $curval) > 0) {
3112 WARN("MAINTAINERS_STYLE",
3113 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3114 }
3115 }
Joe Perches628f91a2017-07-10 15:52:07 -07003116 }
3117 }
3118
Christoph Jaeger327953e2015-02-13 14:38:29 -08003119# discourage the use of boolean for type definition attributes of Kconfig options
3120 if ($realfile =~ /Kconfig/ &&
3121 $line =~ /^\+\s*\bboolean\b/) {
3122 WARN("CONFIG_TYPE_BOOLEAN",
3123 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3124 }
3125
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003126 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3127 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3128 my $flag = $1;
3129 my $replacement = {
3130 'EXTRA_AFLAGS' => 'asflags-y',
3131 'EXTRA_CFLAGS' => 'ccflags-y',
3132 'EXTRA_CPPFLAGS' => 'cppflags-y',
3133 'EXTRA_LDFLAGS' => 'ldflags-y',
3134 };
3135
3136 WARN("DEPRECATED_VARIABLE",
3137 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3138 }
3139
Rob Herringbff5da42014-01-23 15:54:51 -08003140# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003141 if (defined $root &&
3142 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3143 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3144
Rob Herringbff5da42014-01-23 15:54:51 -08003145 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3146
Florian Vaussardcc933192014-04-03 14:49:27 -07003147 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003148 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003149
Rob Herringbff5da42014-01-23 15:54:51 -08003150 foreach my $compat (@compats) {
3151 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003152 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3153 my $compat3 = $compat;
3154 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3155 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003156 if ( $? >> 8 ) {
3157 WARN("UNDOCUMENTED_DT_STRING",
3158 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3159 }
3160
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003161 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3162 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003163 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003164 if ( $? >> 8 ) {
3165 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003166 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003167 }
3168 }
3169 }
3170
Rob Herring9f3a8992018-04-10 16:33:13 -07003171# check for using SPDX license tag at beginning of files
3172 if ($realline == $checklicenseline) {
3173 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3174 $checklicenseline = 2;
3175 } elsif ($rawline =~ /^\+/) {
3176 my $comment = "";
3177 if ($realfile =~ /\.(h|s|S)$/) {
3178 $comment = '/*';
3179 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3180 $comment = '//';
Lubomir Rintelc8df0ab2020-04-06 20:10:51 -07003181 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003182 $comment = '#';
3183 } elsif ($realfile =~ /\.rst$/) {
3184 $comment = '..';
3185 }
3186
Joe Perchesfdf13692019-03-07 16:28:32 -08003187# check SPDX comment style for .[chsS] files
3188 if ($realfile =~ /\.[chsS]$/ &&
3189 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003190 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003191 WARN("SPDX_LICENSE_TAG",
3192 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3193 }
3194
Rob Herring9f3a8992018-04-10 16:33:13 -07003195 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003196 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3197 WARN("SPDX_LICENSE_TAG",
3198 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003199 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003200 my $spdx_license = $1;
3201 if (!is_SPDX_License_valid($spdx_license)) {
3202 WARN("SPDX_LICENSE_TAG",
3203 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3204 }
Lubomir Rintel50c92902020-04-06 20:11:13 -07003205 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3206 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3207 my $msg_level = \&WARN;
3208 $msg_level = \&CHK if ($file);
3209 if (&{$msg_level}("SPDX_LICENSE_TAG",
3210
3211 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3212 $fix) {
3213 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3214 }
3215 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003216 }
3217 }
3218 }
3219
Andy Whitcroft5368df202008-10-15 22:02:27 -07003220# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003221 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003222
Joe Perchesa8da38a2019-03-07 16:28:42 -08003223# check for using SPDX-License-Identifier on the wrong line number
3224 if ($realline != $checklicenseline &&
3225 $rawline =~ /\bSPDX-License-Identifier:/ &&
3226 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3227 WARN("SPDX_LICENSE_TAG",
3228 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3229 }
3230
Joe Perches47e0c882015-06-25 15:02:57 -07003231# line length limit (with some exclusions)
3232#
3233# There are a few types of lines that may extend beyond $max_line_length:
3234# logging functions like pr_info that end in a string
3235# lines with a single string
3236# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003237# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003238#
3239# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003240# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003241# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3242# LONG_LINE all other lines longer than $max_line_length
3243#
3244# if LONG_LINE is ignored, the other 2 types are also ignored
3245#
3246
Joe Perchesb4749e92015-07-17 16:24:01 -07003247 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003248 my $msg_type = "LONG_LINE";
3249
3250 # Check the allowed long line types first
3251
3252 # logging functions that end in a string that starts
3253 # before $max_line_length
3254 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3255 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3256 $msg_type = "";
3257
3258 # lines with only strings (w/ possible termination)
3259 # #defines with only strings
3260 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3261 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3262 $msg_type = "";
3263
Joe Perchescc147502017-11-17 15:28:44 -08003264 # More special cases
3265 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3266 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003267 $msg_type = "";
3268
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003269 # URL ($rawline is used in case the URL is in a comment)
3270 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3271 $msg_type = "";
3272
Joe Perches47e0c882015-06-25 15:02:57 -07003273 # Otherwise set the alternate message types
3274
3275 # a comment starts before $max_line_length
3276 } elsif ($line =~ /($;[\s$;]*)$/ &&
3277 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3278 $msg_type = "LONG_LINE_COMMENT"
3279
3280 # a quoted string starts before $max_line_length
3281 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3282 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3283 $msg_type = "LONG_LINE_STRING"
3284 }
3285
3286 if ($msg_type ne "" &&
3287 (show_type("LONG_LINE") || show_type($msg_type))) {
Joe Perchesbdc48fa2020-05-29 16:12:21 -07003288 my $msg_level = \&WARN;
3289 $msg_level = \&CHK if ($file);
3290 &{$msg_level}($msg_type,
3291 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
Joe Perches47e0c882015-06-25 15:02:57 -07003292 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003293 }
3294
Andy Whitcroft8905a672007-11-28 16:21:06 -08003295# check for adding lines without a newline.
3296 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003297 WARN("MISSING_EOF_NEWLINE",
3298 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003299 }
3300
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003301# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003302 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003303
3304# at the beginning of a line any tabs must come first and anything
Antonio Borneo713a09d2020-04-06 20:11:07 -07003305# more than $tabsize must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003306 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3307 $rawline =~ /^\+\s* \s*/) {
3308 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003309 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003310 if (ERROR("CODE_INDENT",
3311 "code indent should use tabs where possible\n" . $herevet) &&
3312 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003313 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003314 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003315 }
3316
Joe Perches1a3dcf22020-08-11 18:35:16 -07003317# check for repeated words separated by a single space
3318 if ($rawline =~ /^\+/) {
3319 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3320
3321 my $first = $1;
3322 my $second = $2;
3323
3324 if ($first =~ /(?:struct|union|enum)/) {
3325 pos($rawline) += length($first) + length($second) + 1;
3326 next;
3327 }
3328
3329 next if ($first ne $second);
3330 next if ($first eq 'long');
3331
3332 if (WARN("REPEATED_WORD",
3333 "Possible repeated word: '$first'\n" . $herecurr) &&
3334 $fix) {
3335 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3336 }
3337 }
3338
3339 # if it's a repeated word on consecutive lines in a comment block
3340 if ($prevline =~ /$;+\s*$/ &&
3341 $prevrawline =~ /($word_pattern)\s*$/) {
3342 my $last_word = $1;
3343 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3344 if (WARN("REPEATED_WORD",
3345 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3346 $fix) {
3347 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3348 }
3349 }
3350 }
3351 }
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 Perches5b9553a2014-04-03 14:49:21 -07004943# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004944 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004945 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07004946 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004947 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4948 my $value = $1;
4949 $value = deparenthesize($value);
4950 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4951 ERROR("RETURN_PARENTHESES",
4952 "return is not a function, parentheses are not required\n" . $herecurr);
4953 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004954 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004955 ERROR("SPACING",
4956 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004957 }
4958 }
Joe Perches507e5142013-11-12 15:10:13 -08004959
Joe Perchesb43ae212014-06-23 13:22:07 -07004960# unnecessary return in a void function
4961# at end-of-function, with the previous line a single leading tab, then return;
4962# and the line before that not a goto label target like "out:"
4963 if ($sline =~ /^[ \+]}\s*$/ &&
4964 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4965 $linenr >= 3 &&
4966 $lines[$linenr - 3] =~ /^[ +]/ &&
4967 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004968 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004969 "void function return statements are not generally useful\n" . $hereprev);
4970 }
Joe Perches9819cf22014-06-04 16:12:09 -07004971
Joe Perches189248d2014-01-23 15:54:47 -08004972# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07004973 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08004974 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4975 my $openparens = $1;
4976 my $count = $openparens =~ tr@\(@\(@;
4977 my $msg = "";
4978 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4979 my $comp = $4; #Not $1 because of $LvalOrFunc
4980 $msg = " - maybe == should be = ?" if ($comp eq "==");
4981 WARN("UNNECESSARY_PARENTHESES",
4982 "Unnecessary parentheses$msg\n" . $herecurr);
4983 }
4984 }
4985
Joe Perchesc5595fa2015-09-09 15:37:58 -07004986# comparisons with a constant or upper case identifier on the left
4987# avoid cases like "foo + BAR < baz"
4988# only fix matches surrounded by parentheses to avoid incorrect
4989# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07004990 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004991 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4992 my $lead = $1;
4993 my $const = $2;
4994 my $comp = $3;
4995 my $to = $4;
4996 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004997 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004998 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4999 WARN("CONSTANT_COMPARISON",
5000 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5001 $fix) {
5002 if ($comp eq "<") {
5003 $newcomp = ">";
5004 } elsif ($comp eq "<=") {
5005 $newcomp = ">=";
5006 } elsif ($comp eq ">") {
5007 $newcomp = "<";
5008 } elsif ($comp eq ">=") {
5009 $newcomp = "<=";
5010 }
5011 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5012 }
5013 }
5014
Joe Perchesf34e4a42015-04-16 12:44:19 -07005015# Return of what appears to be an errno should normally be negative
5016 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005017 my $name = $1;
5018 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07005019 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07005020 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005021 }
5022 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005023
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005024# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07005025 if ($line =~ /\b(if|while|for|switch)\(/) {
5026 if (ERROR("SPACING",
5027 "space required before the open parenthesis '('\n" . $herecurr) &&
5028 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005029 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005030 s/\b(if|while|for|switch)\(/$1 \(/;
5031 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005032 }
5033
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07005034# Check for illegal assignment in if conditional -- and check for trailing
5035# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005036 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08005037 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5038 ctx_statement_block($linenr, $realcnt, 0)
5039 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005040 my ($stat_next) = ctx_statement_block($line_nr_next,
5041 $remain_next, $off_next);
5042 $stat_next =~ s/\n./\n /g;
5043 ##print "stat<$stat> stat_next<$stat_next>\n";
5044
5045 if ($stat_next =~ /^\s*while\b/) {
5046 # If the statement carries leading newlines,
5047 # then count those as offsets.
5048 my ($whitespace) =
5049 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5050 my $offset =
5051 statement_rawlines($whitespace) - 1;
5052
5053 $suppress_whiletrailers{$line_nr_next +
5054 $offset} = 1;
5055 }
5056 }
5057 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08005058 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005059 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005060 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005061
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08005062 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches65b64b32020-08-11 18:35:10 -07005063 if (ERROR("ASSIGN_IN_IF",
5064 "do not use assignment in if condition\n" . $herecurr) &&
5065 $fix && $perl_version_ok) {
5066 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5067 my $space = $1;
5068 my $not = $2;
5069 my $statement = $3;
5070 my $assigned = $4;
5071 my $test = $8;
5072 my $against = $9;
5073 my $brace = $15;
5074 fix_delete_line($fixlinenr, $rawline);
5075 fix_insert_line($fixlinenr, "$space$statement;");
5076 my $newline = "${space}if (";
5077 $newline .= '!' if defined($not);
5078 $newline .= '(' if (defined $not && defined($test) && defined($against));
5079 $newline .= "$assigned";
5080 $newline .= " $test $against" if (defined($test) && defined($against));
5081 $newline .= ')' if (defined $not && defined($test) && defined($against));
5082 $newline .= ')';
5083 $newline .= " {" if (defined($brace));
5084 fix_insert_line($fixlinenr + 1, $newline);
5085 }
5086 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005087 }
5088
5089 # Find out what is on the end of the line after the
5090 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005091 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08005092 $s =~ s/\n.*//g;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005093 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07005094 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5095 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005096 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005097 # Find out how long the conditional actually is.
5098 my @newlines = ($c =~ /\n/gs);
5099 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005100 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005101
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005102 $stat_real = raw_line($linenr, $cond_lines)
5103 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005104 if (defined($stat_real) && $cond_lines > 1) {
5105 $stat_real = "[...]\n$stat_real";
5106 }
5107
Joe Perches000d1cc12011-07-25 17:13:25 -07005108 ERROR("TRAILING_STATEMENTS",
5109 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005110 }
5111 }
5112
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005113# Check for bitwise tests written as boolean
5114 if ($line =~ /
5115 (?:
5116 (?:\[|\(|\&\&|\|\|)
5117 \s*0[xX][0-9]+\s*
5118 (?:\&\&|\|\|)
5119 |
5120 (?:\&\&|\|\|)
5121 \s*0[xX][0-9]+\s*
5122 (?:\&\&|\|\||\)|\])
5123 )/x)
5124 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005125 WARN("HEXADECIMAL_BOOLEAN_TEST",
5126 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005127 }
5128
Andy Whitcroft8905a672007-11-28 16:21:06 -08005129# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005130 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5131 my $s = $1;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005132 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005133 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005134 ERROR("TRAILING_STATEMENTS",
5135 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005136 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005137 }
Andy Whitcroft39667782009-01-15 13:51:06 -08005138# if should not continue a brace
5139 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005140 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07005141 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08005142 $herecurr);
5143 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005144# case and default should not have general statements after them
5145 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5146 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07005147 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005148 \s*return\s+
5149 )/xg)
5150 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005151 ERROR("TRAILING_STATEMENTS",
5152 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005153 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005154
5155 # Check for }<nl>else {, these must be at the same
5156 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07005157 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5158 $previndent == $indent) {
5159 if (ERROR("ELSE_AFTER_BRACE",
5160 "else should follow close brace '}'\n" . $hereprev) &&
5161 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5162 fix_delete_line($fixlinenr - 1, $prevrawline);
5163 fix_delete_line($fixlinenr, $rawline);
5164 my $fixedline = $prevrawline;
5165 $fixedline =~ s/}\s*$//;
5166 if ($fixedline !~ /^\+\s*$/) {
5167 fix_insert_line($fixlinenr, $fixedline);
5168 }
5169 $fixedline = $rawline;
5170 $fixedline =~ s/^(.\s*)else/$1} else/;
5171 fix_insert_line($fixlinenr, $fixedline);
5172 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005173 }
5174
Joe Perches8b8856f2014-08-06 16:11:14 -07005175 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5176 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005177 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5178
5179 # Find out what is on the end of the line after the
5180 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005181 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005182 $s =~ s/\n.*//g;
5183
5184 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005185 if (ERROR("WHILE_AFTER_BRACE",
5186 "while should follow close brace '}'\n" . $hereprev) &&
5187 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5188 fix_delete_line($fixlinenr - 1, $prevrawline);
5189 fix_delete_line($fixlinenr, $rawline);
5190 my $fixedline = $prevrawline;
5191 my $trailing = $rawline;
5192 $trailing =~ s/^\+//;
5193 $trailing = trim($trailing);
5194 $fixedline =~ s/}\s*$/} $trailing/;
5195 fix_insert_line($fixlinenr, $fixedline);
5196 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005197 }
5198 }
5199
Joe Perches95e2c602013-07-03 15:05:20 -07005200#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005201 while ($line =~ m{($Constant|$Lval)}g) {
5202 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005203
Joe Perches95e2c602013-07-03 15:05:20 -07005204#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005205 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005206 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005207#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005208 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perchesd439e6a2019-12-04 16:52:06 -08005209#Ignore SI style variants like nS, mV and dB
5210#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5211 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Julius Wernerf5123572014-12-10 15:51:54 -08005212#Ignore some three character SI units explicitly, like MiB and KHz
5213 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005214 while ($var =~ m{($Ident)}g) {
5215 my $word = $1;
5216 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005217 if ($check) {
5218 seed_camelcase_includes();
5219 if (!$file && !$camelcase_file_seeded) {
5220 seed_camelcase_file($realfile);
5221 $camelcase_file_seeded = 1;
5222 }
5223 }
Joe Perches7e781f62013-09-11 14:23:55 -07005224 if (!defined $camelcase{$word}) {
5225 $camelcase{$word} = 1;
5226 CHK("CAMELCASE",
5227 "Avoid CamelCase: <$word>\n" . $herecurr);
5228 }
Joe Perches34456862013-07-03 15:05:34 -07005229 }
Joe Perches323c1262012-12-17 16:02:07 -08005230 }
5231 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005232
5233#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005234 if ($line =~ /\#\s*define.*\\\s+$/) {
5235 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5236 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5237 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005238 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005239 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005240 }
5241
Fabian Frederick0e212e02015-04-16 12:44:25 -07005242# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5243# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005244 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005245 my $file = "$1.h";
5246 my $checkfile = "include/linux/$file";
5247 if (-f "$root/$checkfile" &&
5248 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005249 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005250 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005251 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5252 if ($asminclude > 0) {
5253 if ($realfile =~ m{^arch/}) {
5254 CHK("ARCH_INCLUDE_LINUX",
5255 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5256 } else {
5257 WARN("INCLUDE_LINUX",
5258 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5259 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005260 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005261 }
5262 }
5263
Andy Whitcroft653d4872007-06-23 17:16:34 -07005264# multi-statement macros should be enclosed in a do while loop, grab the
5265# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005266# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07005267 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5268 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005269 my $ln = $linenr;
5270 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005271 my ($off, $dstat, $dcond, $rest);
5272 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005273 my $has_flow_statement = 0;
5274 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005275 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005276 ctx_statement_block($linenr, $realcnt, 0);
5277 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005278 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005279 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005280
Joe Perches08a28432014-10-13 15:51:55 -07005281 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005282 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005283
Joe Perchesf59b64b2016-10-11 13:52:08 -07005284 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5285 my $define_args = $1;
5286 my $define_stmt = $dstat;
5287 my @def_args = ();
5288
5289 if (defined $define_args && $define_args ne "") {
5290 $define_args = substr($define_args, 1, length($define_args) - 2);
5291 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005292 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005293 @def_args = split(",", $define_args);
5294 }
5295
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005296 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005297 $dstat =~ s/\\\n.//g;
5298 $dstat =~ s/^\s*//s;
5299 $dstat =~ s/\s*$//s;
5300
5301 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005302 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5303 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005304 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005305 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005306 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005307
Antonio Borneo342d3d22020-04-06 20:11:01 -07005308 # Flatten any obvious string concatenation.
Joe Perches33acb542015-06-25 15:02:54 -07005309 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5310 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005311 {
5312 }
5313
Joe Perches42e15292016-03-15 14:58:01 -07005314 # Make asm volatile uses seem like a generic function
5315 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5316
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005317 my $exceptions = qr{
5318 $Declare|
5319 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005320 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005321 DECLARE_PER_CPU|
5322 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005323 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005324 union|
5325 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005326 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005327 ^\"|\"$|
5328 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005329 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005330 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005331
5332 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005333 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005334 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005335
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005336 if ($dstat ne '' &&
5337 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5338 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005339 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005340 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005341 $dstat !~ /$exceptions/ &&
5342 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005343 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005344 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005345 $dstat !~ /^for\s*$Constant$/ && # for (...)
5346 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5347 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005348 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005349 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005350 {
Joe Perchese7955562017-05-08 15:55:48 -07005351 if ($dstat =~ /^\s*if\b/) {
5352 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5353 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5354 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005355 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5356 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5357 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005358 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005359 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005360 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005361
5362 }
Joe Perches52076492016-10-11 13:52:14 -07005363
5364 # Make $define_stmt single line, comment-free, etc
5365 my @stmt_array = split('\n', $define_stmt);
5366 my $first = 1;
5367 $define_stmt = "";
5368 foreach my $l (@stmt_array) {
5369 $l =~ s/\\$//;
5370 if ($first) {
5371 $define_stmt = $l;
5372 $first = 0;
5373 } elsif ($l =~ /^[\+ ]/) {
5374 $define_stmt .= substr($l, 1);
5375 }
5376 }
5377 $define_stmt =~ s/$;//g;
5378 $define_stmt =~ s/\s+/ /g;
5379 $define_stmt = trim($define_stmt);
5380
Joe Perchesf59b64b2016-10-11 13:52:08 -07005381# check if any macro arguments are reused (ignore '...' and 'type')
5382 foreach my $arg (@def_args) {
5383 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005384 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005385 my $tmp_stmt = $define_stmt;
Brendan Jackman6dba8242019-09-25 16:46:41 -07005386 $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 -07005387 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5388 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005389 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005390 if ($use_cnt > 1) {
5391 CHK("MACRO_ARG_REUSE",
5392 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005393 }
5394# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005395 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005396 ((defined($1) && $1 ne ',') ||
5397 (defined($2) && $2 ne ','))) {
5398 CHK("MACRO_ARG_PRECEDENCE",
5399 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005400 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005401 }
Joe Perches5023d342012-12-17 16:01:47 -08005402
Joe Perches08a28432014-10-13 15:51:55 -07005403# check for macros with flow control, but without ## concatenation
5404# ## concatenation is commonly a macro that defines a function so ignore those
5405 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005406 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005407 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005408
Joe Perches08a28432014-10-13 15:51:55 -07005409 WARN("MACRO_WITH_FLOW_CONTROL",
5410 "Macros with flow control statements should be avoided\n" . "$herectx");
5411 }
5412
Joe Perches481eb482012-12-17 16:01:56 -08005413# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005414
5415 } else {
5416 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005417 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5418 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005419 $line =~ /^\+.*\\$/) {
5420 WARN("LINE_CONTINUATIONS",
5421 "Avoid unnecessary line continuations\n" . $herecurr);
5422 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005423 }
5424
Joe Perchesb13edf72012-07-30 14:41:24 -07005425# do {} while (0) macro tests:
5426# single-statement macros do not need to be enclosed in do while (0) loop,
5427# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005428 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005429 $realfile !~ m@/vmlinux.lds.h$@ &&
5430 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5431 my $ln = $linenr;
5432 my $cnt = $realcnt;
5433 my ($off, $dstat, $dcond, $rest);
5434 my $ctx = '';
5435 ($dstat, $dcond, $ln, $cnt, $off) =
5436 ctx_statement_block($linenr, $realcnt, 0);
5437 $ctx = $dstat;
5438
5439 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005440 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005441
5442 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5443 my $stmts = $2;
5444 my $semis = $3;
5445
5446 $ctx =~ s/\n*$//;
5447 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005448 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005449
Joe Perchesac8e97f2012-08-21 16:15:53 -07005450 if (($stmts =~ tr/;/;/) == 1 &&
5451 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005452 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5453 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5454 }
5455 if (defined $semis && $semis ne "") {
5456 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5457 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5458 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005459 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5460 $ctx =~ s/\n*$//;
5461 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005462 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005463
5464 WARN("TRAILING_SEMICOLON",
5465 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005466 }
5467 }
5468
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005469# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005470 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5471 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005472 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005473 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005474 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5475 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005476 my @allowed = ();
5477 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005478 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005479 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005480 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005481 for my $chunk (@chunks) {
5482 my ($cond, $block) = @{$chunk};
5483
Andy Whitcroft773647a2008-03-28 14:15:58 -07005484 # If the condition carries leading newlines, then count those as offsets.
5485 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5486 my $offset = statement_rawlines($whitespace) - 1;
5487
Joe Perchesaad4f612012-03-23 15:02:19 -07005488 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005489 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5490
5491 # We have looked at and allowed this specific line.
5492 $suppress_ifbraces{$ln + $offset} = 1;
5493
5494 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005495 $ln += statement_rawlines($block) - 1;
5496
Andy Whitcroft773647a2008-03-28 14:15:58 -07005497 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005498
5499 $seen++ if ($block =~ /^\s*{/);
5500
Joe Perchesaad4f612012-03-23 15:02:19 -07005501 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005502 if (statement_lines($cond) > 1) {
5503 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005504 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005505 }
5506 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005507 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005508 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005509 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005510 if (statement_block_size($block) > 1) {
5511 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005512 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005513 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005514 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005515 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005516 if ($seen) {
5517 my $sum_allowed = 0;
5518 foreach (@allowed) {
5519 $sum_allowed += $_;
5520 }
5521 if ($sum_allowed == 0) {
5522 WARN("BRACES",
5523 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5524 } elsif ($sum_allowed != $allow &&
5525 $seen != $allow) {
5526 CHK("BRACES",
5527 "braces {} should be used on all arms of this statement\n" . $herectx);
5528 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005529 }
5530 }
5531 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005532 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005533 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005534 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005535
Andy Whitcroftcf655042008-03-04 14:28:20 -08005536 # Check the pre-context.
5537 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5538 #print "APW: ALLOWED: pre<$1>\n";
5539 $allowed = 1;
5540 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005541
5542 my ($level, $endln, @chunks) =
5543 ctx_statement_full($linenr, $realcnt, $-[0]);
5544
Andy Whitcroftcf655042008-03-04 14:28:20 -08005545 # Check the condition.
5546 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005547 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005548 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005549 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005550 }
5551 if (statement_lines($cond) > 1) {
5552 #print "APW: ALLOWED: cond<$cond>\n";
5553 $allowed = 1;
5554 }
5555 if ($block =~/\b(?:if|for|while)\b/) {
5556 #print "APW: ALLOWED: block<$block>\n";
5557 $allowed = 1;
5558 }
5559 if (statement_block_size($block) > 1) {
5560 #print "APW: ALLOWED: lines block<$block>\n";
5561 $allowed = 1;
5562 }
5563 # Check the post-context.
5564 if (defined $chunks[1]) {
5565 my ($cond, $block) = @{$chunks[1]};
5566 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005567 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005568 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005569 if ($block =~ /^\s*\{/) {
5570 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5571 $allowed = 1;
5572 }
5573 }
5574 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005575 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005576 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005577
Joe Perches000d1cc12011-07-25 17:13:25 -07005578 WARN("BRACES",
5579 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005580 }
5581 }
5582
Joe Perchese4c5bab2017-02-24 15:01:41 -08005583# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005584 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5585 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005586 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5587 }
5588
Joe Perches0979ae62012-12-17 16:01:59 -08005589# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005590 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005591 if (CHK("BRACES",
5592 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5593 $fix && $prevrawline =~ /^\+/) {
5594 fix_delete_line($fixlinenr - 1, $prevrawline);
5595 }
Joe Perches0979ae62012-12-17 16:01:59 -08005596 }
Joe Perches77b9a532013-07-03 15:05:29 -07005597 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005598 if (CHK("BRACES",
5599 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5600 $fix) {
5601 fix_delete_line($fixlinenr, $rawline);
5602 }
Joe Perches0979ae62012-12-17 16:01:59 -08005603 }
5604
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005605# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005606 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5607 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005608 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005609 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005610 }
5611
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005612# Check for user-visible strings broken across lines, which breaks the ability
5613# to grep for the string. Make exceptions when the previous string ends in a
5614# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5615# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005616 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005617 $prevline =~ /"\s*$/ &&
5618 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5619 if (WARN("SPLIT_STRING",
5620 "quoted string split across lines\n" . $hereprev) &&
5621 $fix &&
5622 $prevrawline =~ /^\+.*"\s*$/ &&
5623 $last_coalesced_string_linenr != $linenr - 1) {
5624 my $extracted_string = get_quoted_string($line, $rawline);
5625 my $comma_close = "";
5626 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5627 $comma_close = $1;
5628 }
5629
5630 fix_delete_line($fixlinenr - 1, $prevrawline);
5631 fix_delete_line($fixlinenr, $rawline);
5632 my $fixedline = $prevrawline;
5633 $fixedline =~ s/"\s*$//;
5634 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5635 fix_insert_line($fixlinenr - 1, $fixedline);
5636 $fixedline = $rawline;
5637 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5638 if ($fixedline !~ /\+\s*$/) {
5639 fix_insert_line($fixlinenr, $fixedline);
5640 }
5641 $last_coalesced_string_linenr = $linenr;
5642 }
5643 }
5644
5645# check for missing a space in a string concatenation
5646 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5647 WARN('MISSING_SPACE',
5648 "break quoted strings at a space character\n" . $hereprev);
5649 }
5650
Joe Perchese4b7d302017-05-08 15:55:51 -07005651# check for an embedded function name in a string when the function is known
5652# This does not work very well for -f --file checking as it depends on patch
5653# context providing the function name or a single line form for in-file
5654# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005655 if ($line =~ /^\+.*$String/ &&
5656 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005657 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5658 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005659 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005660 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005661 }
5662
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005663# check for spaces before a quoted newline
5664 if ($rawline =~ /^.*\".*\s\\n/) {
5665 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5666 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5667 $fix) {
5668 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5669 }
5670
5671 }
5672
Joe Perchesf17dba42014-10-13 15:51:51 -07005673# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005674 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5675 if (CHK("CONCATENATED_STRING",
5676 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5677 $fix) {
5678 while ($line =~ /($String)/g) {
5679 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5680 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5681 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5682 }
5683 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005684 }
5685
Joe Perches90ad30e2014-12-10 15:51:59 -08005686# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005687 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005688 if (WARN("STRING_FRAGMENTS",
5689 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5690 $fix) {
5691 while ($line =~ /($String)(?=\s*")/g) {
5692 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5693 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5694 }
5695 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005696 }
5697
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005698# check for non-standard and hex prefixed decimal printf formats
5699 my $show_L = 1; #don't show the same defect twice
5700 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005701 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005702 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005703 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005704 # check for %L
5705 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005706 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005707 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5708 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005709 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005710 # check for %Z
5711 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5712 WARN("PRINTF_Z",
5713 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5714 $show_Z = 0;
5715 }
5716 # check for 0x<decimal>
5717 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5718 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005719 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5720 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005721 }
5722
5723# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005724 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005725 WARN("LINE_CONTINUATIONS",
5726 "Avoid line continuations in quoted strings\n" . $herecurr);
5727 }
5728
Andy Whitcroft00df3442007-06-08 13:47:06 -07005729# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005730 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07005731 WARN("IF_0",
5732 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5733 }
5734
5735# warn about #if 1
5736 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5737 WARN("IF_1",
5738 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005739 }
5740
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005741# check for needless "if (<foo>) fn(<foo>)" uses
5742 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005743 my $tested = quotemeta($1);
5744 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5745 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5746 my $func = $1;
5747 if (WARN('NEEDLESS_IF',
5748 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5749 $fix) {
5750 my $do_fix = 1;
5751 my $leading_tabs = "";
5752 my $new_leading_tabs = "";
5753 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5754 $leading_tabs = $1;
5755 } else {
5756 $do_fix = 0;
5757 }
5758 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5759 $new_leading_tabs = $1;
5760 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5761 $do_fix = 0;
5762 }
5763 } else {
5764 $do_fix = 0;
5765 }
5766 if ($do_fix) {
5767 fix_delete_line($fixlinenr - 1, $prevrawline);
5768 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5769 }
5770 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005771 }
5772 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005773
Joe Perchesebfdc402014-08-06 16:10:27 -07005774# check for unnecessary "Out of Memory" messages
5775 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5776 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5777 (defined $1 || defined $3) &&
5778 $linenr > 3) {
5779 my $testval = $2;
5780 my $testline = $lines[$linenr - 3];
5781
5782 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5783# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5784
Joe Perchese29a70f2019-03-07 16:28:35 -08005785 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5786 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005787 WARN("OOM_MESSAGE",
5788 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5789 }
5790 }
5791
Joe Perchesf78d98f2014-10-13 15:52:01 -07005792# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005793 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005794 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5795 my $level = $1;
5796 if (WARN("UNNECESSARY_KERN_LEVEL",
5797 "Possible unnecessary $level\n" . $herecurr) &&
5798 $fix) {
5799 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5800 }
5801 }
5802
Joe Perches45c55e92017-02-24 15:01:31 -08005803# check for logging continuations
5804 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5805 WARN("LOGGING_CONTINUATION",
5806 "Avoid logging continuation uses where feasible\n" . $herecurr);
5807 }
5808
Joe Perchesabb08a52014-12-10 15:51:46 -08005809# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07005810 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08005811 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5812 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5813 WARN("MASK_THEN_SHIFT",
5814 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5815 }
5816
Joe Perchesb75ac612014-12-10 15:52:02 -08005817# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07005818 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08005819 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5820 my $val = $1;
5821 my $equal = "!";
5822 $equal = "" if ($4 eq "!=");
5823 if (CHK("COMPARISON_TO_NULL",
5824 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5825 $fix) {
5826 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5827 }
5828 }
5829 }
5830
Joe Perches8716de32013-09-11 14:24:05 -07005831# check for bad placement of section $InitAttribute (e.g.: __initdata)
5832 if ($line =~ /(\b$InitAttribute\b)/) {
5833 my $attr = $1;
5834 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5835 my $ptr = $1;
5836 my $var = $2;
5837 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5838 ERROR("MISPLACED_INIT",
5839 "$attr should be placed after $var\n" . $herecurr)) ||
5840 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5841 WARN("MISPLACED_INIT",
5842 "$attr should be placed after $var\n" . $herecurr))) &&
5843 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005844 $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 -07005845 }
5846 }
5847 }
5848
Joe Perchese970b8842013-11-12 15:10:10 -08005849# check for $InitAttributeData (ie: __initdata) with const
5850 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5851 my $attr = $1;
5852 $attr =~ /($InitAttributePrefix)(.*)/;
5853 my $attr_prefix = $1;
5854 my $attr_type = $2;
5855 if (ERROR("INIT_ATTRIBUTE",
5856 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5857 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005858 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005859 s/$InitAttributeData/${attr_prefix}initconst/;
5860 }
5861 }
5862
5863# check for $InitAttributeConst (ie: __initconst) without const
5864 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5865 my $attr = $1;
5866 if (ERROR("INIT_ATTRIBUTE",
5867 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5868 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005869 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005870 /(^\+\s*(?:static\s+))/;
5871 $lead = rtrim($1);
5872 $lead = "$lead " if ($lead !~ /^\+$/);
5873 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005874 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005875 }
5876 }
5877
Joe Perchesc17893c2015-04-16 12:44:42 -07005878# check for __read_mostly with const non-pointer (should just be const)
5879 if ($line =~ /\b__read_mostly\b/ &&
5880 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5881 if (ERROR("CONST_READ_MOSTLY",
5882 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5883 $fix) {
5884 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5885 }
5886 }
5887
Joe Perchesfbdb8132014-04-03 14:49:14 -07005888# don't use __constant_<foo> functions outside of include/uapi/
5889 if ($realfile !~ m@^include/uapi/@ &&
5890 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5891 my $constant_func = $1;
5892 my $func = $constant_func;
5893 $func =~ s/^__constant_//;
5894 if (WARN("CONSTANT_CONVERSION",
5895 "$constant_func should be $func\n" . $herecurr) &&
5896 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005897 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005898 }
5899 }
5900
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005901# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005902 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005903 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005904 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005905 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005906 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005907 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07005908 }
5909 if ($delay > 2000) {
5910 WARN("LONG_UDELAY",
5911 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005912 }
5913 }
5914
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005915# warn about unexpectedly long msleep's
5916 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5917 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005918 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005919 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005920 }
5921 }
5922
Joe Perches36ec1932013-07-03 15:05:25 -07005923# check for comparisons of jiffies
5924 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5925 WARN("JIFFIES_COMPARISON",
5926 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5927 }
5928
Joe Perches9d7a34a2013-07-03 15:05:26 -07005929# check for comparisons of get_jiffies_64()
5930 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5931 WARN("JIFFIES_COMPARISON",
5932 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5933 }
5934
Andy Whitcroft00df3442007-06-08 13:47:06 -07005935# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005936# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005937# print "#ifdef in C files should be avoided\n";
5938# print "$herecurr";
5939# $clean = 0;
5940# }
5941
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005942# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005943 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005944 if (ERROR("SPACING",
5945 "exactly one space required after that #$1\n" . $herecurr) &&
5946 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005947 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005948 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5949 }
5950
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005951 }
5952
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005953# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005954 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5955 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005956 my $which = $1;
5957 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005958 CHK("UNCOMMENTED_DEFINITION",
5959 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005960 }
5961 }
5962# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005963
5964 my $barriers = qr{
5965 mb|
5966 rmb|
Will Deaconad83ec62019-11-07 14:49:00 +00005967 wmb
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005968 }x;
5969 my $barrier_stems = qr{
5970 mb__before_atomic|
5971 mb__after_atomic|
5972 store_release|
5973 load_acquire|
5974 store_mb|
5975 (?:$barriers)
5976 }x;
5977 my $all_barriers = qr{
5978 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005979 smp_(?:$barrier_stems)|
5980 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005981 }x;
5982
5983 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005984 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005985 WARN("MEMORY_BARRIER",
5986 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005987 }
5988 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005989
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005990 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5991
5992 if ($realfile !~ m@^include/asm-generic/@ &&
5993 $realfile !~ m@/barrier\.h$@ &&
5994 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5995 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5996 WARN("MEMORY_BARRIER",
5997 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5998 }
5999
Joe Perchescb426e92015-06-25 15:02:46 -07006000# check for waitqueue_active without a comment.
6001 if ($line =~ /\bwaitqueue_active\s*\(/) {
6002 if (!ctx_has_comment($first_line, $linenr)) {
6003 WARN("WAITQUEUE_ACTIVE",
6004 "waitqueue_active without comment\n" . $herecurr);
6005 }
6006 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006007
Marco Elver5099a722020-04-01 12:17:14 +02006008# check for data_race without a comment.
6009 if ($line =~ /\bdata_race\s*\(/) {
6010 if (!ctx_has_comment($first_line, $linenr)) {
6011 WARN("DATA_RACE",
6012 "data_race without comment\n" . $herecurr);
6013 }
6014 }
6015
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006016# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006017 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006018 CHK("ARCH_DEFINES",
6019 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006020 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006021
Joe Perches596ed452017-07-12 14:37:02 -07006022# check that the storage class is not after a type
6023 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006024 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07006025 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6026 }
6027# Check that the storage class is at the beginning of a declaration
6028 if ($line =~ /\b$Storage\b/ &&
6029 $line !~ /^.\s*$Storage/ &&
6030 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6031 $1 !~ /[\,\)]\s*$/) {
6032 WARN("STORAGE_CLASS",
6033 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07006034 }
6035
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006036# check the location of the inline attribute, that it is between
6037# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006038 if ($line =~ /\b$Type\s+$Inline\b/ ||
6039 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006040 ERROR("INLINE_LOCATION",
6041 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006042 }
6043
Andy Whitcroft8905a672007-11-28 16:21:06 -08006044# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08006045 if ($realfile !~ m@\binclude/uapi/@ &&
6046 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006047 if (WARN("INLINE",
6048 "plain inline is preferred over $1\n" . $herecurr) &&
6049 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006050 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006051
6052 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006053 }
6054
Joe Perches3d130fd2011-01-12 17:00:00 -08006055# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08006056 if ($realfile !~ m@\binclude/uapi/@ &&
6057 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006058 WARN("PREFER_PACKED",
6059 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08006060 }
6061
Joe Perches39b7e282011-07-25 17:13:24 -07006062# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08006063 if ($realfile !~ m@\binclude/uapi/@ &&
6064 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006065 WARN("PREFER_ALIGNED",
6066 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07006067 }
6068
Joe Perches462811d2019-09-25 16:46:44 -07006069# Check for __attribute__ section, prefer __section
6070 if ($realfile !~ m@\binclude/uapi/@ &&
6071 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
6072 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
6073 my $new = substr($old, 1, -1);
6074 if (WARN("PREFER_SECTION",
6075 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
6076 $fix) {
6077 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6078 }
6079 }
6080
Joe Perches5f14d3b2012-01-10 15:09:52 -08006081# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08006082 if ($realfile !~ m@\binclude/uapi/@ &&
6083 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006084 if (WARN("PREFER_PRINTF",
6085 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6086 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006087 $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 -07006088
6089 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08006090 }
6091
Joe Perches6061d942012-03-23 15:02:16 -07006092# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08006093 if ($realfile !~ m@\binclude/uapi/@ &&
6094 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006095 if (WARN("PREFER_SCANF",
6096 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, 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*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006099 }
Joe Perches6061d942012-03-23 15:02:16 -07006100 }
6101
Joe Perches619a9082014-12-10 15:51:35 -08006102# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07006103 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08006104 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6105 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6106 $line =~ /\b__weak\b/)) {
6107 ERROR("WEAK_DECLARATION",
6108 "Using weak declarations can have unintended link defects\n" . $herecurr);
6109 }
6110
Tomas Winklerfd39f902016-12-12 16:46:34 -08006111# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07006112 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08006113 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07006114 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6115 my $type = $1;
6116 if ($type =~ /\b($typeC99Typedefs)\b/) {
6117 $type = $1;
6118 my $kernel_type = 'u';
6119 $kernel_type = 's' if ($type =~ /^_*[si]/);
6120 $type =~ /(\d+)/;
6121 $kernel_type .= $1;
6122 if (CHK("PREFER_KERNEL_TYPES",
6123 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6124 $fix) {
6125 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6126 }
6127 }
6128 }
6129
Joe Perches938224b2016-01-20 14:59:15 -08006130# check for cast of C90 native int or longer types constants
6131 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6132 my $cast = $1;
6133 my $const = $2;
6134 if (WARN("TYPECAST_INT_CONSTANT",
6135 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6136 $fix) {
6137 my $suffix = "";
6138 my $newconst = $const;
6139 $newconst =~ s/${Int_type}$//;
6140 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6141 if ($cast =~ /\blong\s+long\b/) {
6142 $suffix .= 'LL';
6143 } elsif ($cast =~ /\blong\b/) {
6144 $suffix .= 'L';
6145 }
6146 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6147 }
6148 }
6149
Joe Perches8f53a9b2010-03-05 13:43:48 -08006150# check for sizeof(&)
6151 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006152 WARN("SIZEOF_ADDRESS",
6153 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08006154 }
6155
Joe Perches66c80b62012-07-30 14:41:22 -07006156# check for sizeof without parenthesis
6157 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006158 if (WARN("SIZEOF_PARENTHESIS",
6159 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6160 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006161 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006162 }
Joe Perches66c80b62012-07-30 14:41:22 -07006163 }
6164
Joe Perches88982fe2012-12-17 16:02:00 -08006165# check for struct spinlock declarations
6166 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6167 WARN("USE_SPINLOCK_T",
6168 "struct spinlock should be spinlock_t\n" . $herecurr);
6169 }
6170
Joe Perchesa6962d72013-04-29 16:18:13 -07006171# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006172 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006173 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006174 $fmt =~ s/%%//g;
6175 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006176 if (WARN("PREFER_SEQ_PUTS",
6177 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6178 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006179 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006180 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006181 }
6182 }
6183
Joe Perches478b1792018-04-10 16:33:34 -07006184# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006185 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006186 defined $stat &&
6187 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6188 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006189 my $stat_real;
6190
Joe Perches0b523762017-05-08 15:55:36 -07006191 my $lc = $stat =~ tr@\n@@;
6192 $lc = $lc + $linenr;
6193 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006194 my $specifier;
6195 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006196 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006197 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006198 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6199 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006200
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006201 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006202 $specifier = $1;
6203 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006204 $qualifier = $3;
Linus Torvalds361b0d22019-11-26 19:45:12 -08006205 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006206 ($extension eq "f" &&
6207 defined $qualifier && $qualifier !~ /^w/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006208 $bad_specifier = $specifier;
6209 last;
6210 }
6211 if ($extension eq "x" && !defined($stat_real)) {
6212 if (!defined($stat_real)) {
6213 $stat_real = get_stat_real($linenr, $lc);
6214 }
6215 WARN("VSPRINTF_SPECIFIER_PX",
6216 "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");
6217 }
6218 }
6219 if ($bad_specifier ne "") {
6220 my $stat_real = get_stat_real($linenr, $lc);
6221 my $ext_type = "Invalid";
6222 my $use = "";
6223 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006224 $use = " - use %pS instead";
6225 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6226 }
6227
6228 WARN("VSPRINTF_POINTER_EXTENSION",
6229 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6230 }
Joe Perches0b523762017-05-08 15:55:36 -07006231 }
6232 }
6233
Andy Whitcroft554e1652012-01-10 15:09:57 -08006234# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006235 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006236 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006237 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006238
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006239 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006240 my $ms_val = $7;
6241 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006242
Andy Whitcroft554e1652012-01-10 15:09:57 -08006243 if ($ms_size =~ /^(0x|)0$/i) {
6244 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006245 "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 -08006246 } elsif ($ms_size =~ /^(0x|)1$/i) {
6247 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006248 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6249 }
6250 }
6251
Joe Perches98a9bba2014-01-23 15:54:52 -08006252# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006253# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006254# defined $stat &&
6255# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6256# if (WARN("PREFER_ETHER_ADDR_COPY",
6257# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6258# $fix) {
6259# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6260# }
6261# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006262
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006263# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(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 =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6267# WARN("PREFER_ETHER_ADDR_EQUAL",
6268# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6269# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006270
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006271# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6272# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006273# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006274# defined $stat &&
6275# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6276#
6277# my $ms_val = $7;
6278#
6279# if ($ms_val =~ /^(?:0x|)0+$/i) {
6280# if (WARN("PREFER_ETH_ZERO_ADDR",
6281# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6282# $fix) {
6283# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6284# }
6285# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6286# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6287# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6288# $fix) {
6289# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6290# }
6291# }
6292# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006293
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006294# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006295 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006296 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006297 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006298 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006299 my $call = $1;
6300 my $cast1 = deparenthesize($2);
6301 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006302 my $cast2 = deparenthesize($7);
6303 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006304 my $cast;
6305
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006306 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006307 $cast = "$cast1 or $cast2";
6308 } elsif ($cast1 ne "") {
6309 $cast = $cast1;
6310 } else {
6311 $cast = $cast2;
6312 }
6313 WARN("MINMAX",
6314 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006315 }
6316 }
6317
Joe Perches4a273192012-07-30 14:41:20 -07006318# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006319 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006320 defined $stat &&
6321 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6322 my $min = $1;
6323 my $max = $7;
6324 if ($min eq $max) {
6325 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006326 "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 -07006327 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6328 $min > $max) {
6329 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006330 "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 -07006331 }
6332 }
6333
Joe Perches823b7942013-11-12 15:10:15 -08006334# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006335 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006336 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006337 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006338 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6339 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6340 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6341 my $lc = $stat =~ tr@\n@@;
6342 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006343 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006344 WARN("NAKED_SSCANF",
6345 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6346 }
6347
Joe Perchesafc819a2014-06-04 16:12:08 -07006348# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006349 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006350 defined $stat &&
6351 $line =~ /\bsscanf\b/) {
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 Perchesafc819a2014-06-04 16:12:08 -07006355 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6356 my $format = $6;
6357 my $count = $format =~ tr@%@%@;
6358 if ($count == 1 &&
6359 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6360 WARN("SSCANF_TO_KSTRTO",
6361 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6362 }
6363 }
6364 }
6365
Joe Perches70dc8a42013-09-11 14:23:58 -07006366# check for new externs in .h files.
6367 if ($realfile =~ /\.h$/ &&
6368 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006369 if (CHK("AVOID_EXTERNS",
6370 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006371 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006372 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006373 }
6374 }
6375
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006376# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006377 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006378 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006379 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006380 my $function_name = $1;
6381 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006382
6383 my $s = $stat;
6384 if (defined $cond) {
6385 substr($s, 0, length($cond), '');
6386 }
Kees Cookd8b44b52020-06-03 14:18:09 -07006387 if ($s =~ /^\s*;/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006388 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006389 WARN("AVOID_EXTERNS",
6390 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006391 }
6392
6393 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006394 WARN("FUNCTION_ARGUMENTS",
6395 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006396 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006397
6398 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6399 $stat =~ /^.\s*extern\s+/)
6400 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006401 WARN("AVOID_EXTERNS",
6402 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006403 }
6404
Joe Perchesa0ad7592017-07-10 15:52:19 -07006405# check for function declarations that have arguments without identifier names
6406 if (defined $stat &&
Kees Cookd8b44b52020-06-03 14:18:09 -07006407 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6408 $1 ne "void") {
6409 my $args = trim($1);
Joe Perchesca0d8922016-10-11 13:52:16 -07006410 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6411 my $arg = trim($1);
Kees Cookd8b44b52020-06-03 14:18:09 -07006412 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
Joe Perchesca0d8922016-10-11 13:52:16 -07006413 WARN("FUNCTION_ARGUMENTS",
6414 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6415 }
6416 }
6417 }
6418
Joe Perchesa0ad7592017-07-10 15:52:19 -07006419# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006420 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006421 defined $stat &&
6422 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6423 $context_function = $1;
6424
6425# check for multiline function definition with misplaced open brace
6426 my $ok = 0;
6427 my $cnt = statement_rawlines($stat);
6428 my $herectx = $here . "\n";
6429 for (my $n = 0; $n < $cnt; $n++) {
6430 my $rl = raw_line($linenr, $n);
6431 $herectx .= $rl . "\n";
6432 $ok = 1 if ($rl =~ /^[ \+]\{/);
6433 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6434 last if $rl =~ /^[ \+].*\{/;
6435 }
6436 if (!$ok) {
6437 ERROR("OPEN_BRACE",
6438 "open brace '{' following function definitions go on the next line\n" . $herectx);
6439 }
6440 }
6441
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006442# checks for new __setup's
6443 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6444 my $name = $1;
6445
6446 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006447 CHK("UNDOCUMENTED_SETUP",
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07006448 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006449 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006450 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006451
Joe Perchese29a70f2019-03-07 16:28:35 -08006452# check for pointless casting of alloc functions
6453 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006454 WARN("UNNECESSARY_CASTS",
6455 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006456 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006457
Joe Perchesa640d252013-07-03 15:05:21 -07006458# alloc style
6459# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006460 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006461 $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 -07006462 CHK("ALLOC_SIZEOF_STRUCT",
6463 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6464 }
6465
Joe Perches60a55362014-06-04 16:12:07 -07006466# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006467 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006468 defined $stat &&
6469 $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 -07006470 my $oldfunc = $3;
6471 my $a1 = $4;
6472 my $a2 = $10;
6473 my $newfunc = "kmalloc_array";
6474 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006475 my $r1 = $a1;
6476 my $r2 = $a2;
6477 if ($a1 =~ /^sizeof\s*\S/) {
6478 $r1 = $a2;
6479 $r2 = $a1;
6480 }
6481 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6482 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006483 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006484 my $herectx = get_stat_here($linenr, $cnt, $here);
6485
Joe Perches60a55362014-06-04 16:12:07 -07006486 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006487 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6488 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006489 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006490 $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 -07006491 }
6492 }
6493 }
6494
Joe Perches972fdea2013-04-29 16:18:12 -07006495# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006496 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006497 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6498 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006499 WARN("KREALLOC_ARG_REUSE",
6500 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6501 }
6502
Joe Perches5ce59ae2013-02-21 16:44:18 -08006503# check for alloc argument mismatch
6504 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6505 WARN("ALLOC_ARRAY_ARGS",
6506 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6507 }
6508
Joe Perchescaf2a542011-01-12 16:59:56 -08006509# check for multiple semicolons
6510 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006511 if (WARN("ONE_SEMICOLON",
6512 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6513 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006514 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006515 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006516 }
6517
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006518# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6519 if ($realfile !~ m@^include/uapi/@ &&
6520 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006521 my $ull = "";
6522 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6523 if (CHK("BIT_MACRO",
6524 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6525 $fix) {
6526 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6527 }
6528 }
6529
Joe Perches50161262020-08-11 18:35:07 -07006530# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
6531 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^CONFIG_/) {
6532 WARN("IS_ENABLED_CONFIG",
6533 "IS_ENABLED($1) is normally used as IS_ENABLED(CONFIG_$1)\n" . $herecurr);
6534 }
6535
Joe Perches2d632742016-05-20 17:04:00 -07006536# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6537 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6538 my $config = $1;
6539 if (WARN("PREFER_IS_ENABLED",
6540 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6541 $fix) {
6542 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6543 }
6544 }
6545
Joe Perchese81f2392014-08-06 16:11:25 -07006546# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006547 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6548 my $has_break = 0;
6549 my $has_statement = 0;
6550 my $count = 0;
6551 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006552 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006553 $prevline--;
6554 my $rline = $rawlines[$prevline - 1];
6555 my $fline = $lines[$prevline - 1];
6556 last if ($fline =~ /^\@\@/);
6557 next if ($fline =~ /^\-/);
6558 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6559 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6560 next if ($fline =~ /^.[\s$;]*$/);
6561 $has_statement = 1;
6562 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006563 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006564 }
6565 if (!$has_break && $has_statement) {
6566 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006567 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006568 }
6569 }
6570
Joe Perchesf36d3eb2020-04-06 20:10:58 -07006571# check for /* fallthrough */ like comment, prefer fallthrough;
6572 my @fallthroughs = (
6573 'fallthrough',
6574 '@fallthrough@',
6575 'lint -fallthrough[ \t]*',
6576 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6577 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6578 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6579 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6580 );
6581 if ($raw_comment ne '') {
6582 foreach my $ft (@fallthroughs) {
6583 if ($raw_comment =~ /$ft/) {
6584 my $msg_level = \&WARN;
6585 $msg_level = \&CHK if ($file);
6586 &{$msg_level}("PREFER_FALLTHROUGH",
6587 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6588 last;
6589 }
6590 }
6591 }
6592
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006593# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006594 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006595 defined $stat &&
6596 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006597 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006598 my $herectx = get_stat_here($linenr, $cnt, $here);
6599
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006600 WARN("DEFAULT_NO_BREAK",
6601 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006602 }
6603
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006604# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006605 if ($line =~ /\b__FUNCTION__\b/) {
6606 if (WARN("USE_FUNC",
6607 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6608 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006609 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006610 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006611 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006612
Joe Perches62ec8182015-02-13 14:38:18 -08006613# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6614 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6615 ERROR("DATE_TIME",
6616 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6617 }
6618
Joe Perches2c924882012-03-23 15:02:20 -07006619# check for use of yield()
6620 if ($line =~ /\byield\s*\(\s*\)/) {
6621 WARN("YIELD",
6622 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6623 }
6624
Joe Perches179f8f42013-07-03 15:05:30 -07006625# check for comparisons against true and false
6626 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6627 my $lead = $1;
6628 my $arg = $2;
6629 my $test = $3;
6630 my $otype = $4;
6631 my $trail = $5;
6632 my $op = "!";
6633
6634 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6635
6636 my $type = lc($otype);
6637 if ($type =~ /^(?:true|false)$/) {
6638 if (("$test" eq "==" && "$type" eq "true") ||
6639 ("$test" eq "!=" && "$type" eq "false")) {
6640 $op = "";
6641 }
6642
6643 CHK("BOOL_COMPARISON",
6644 "Using comparison to $otype is error prone\n" . $herecurr);
6645
6646## maybe suggesting a correct construct would better
6647## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6648
6649 }
6650 }
6651
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006652# check for semaphores initialized locked
6653 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006654 WARN("CONSIDER_COMPLETION",
6655 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006656 }
Joe Perches6712d852012-03-23 15:02:20 -07006657
Joe Perches67d0a072011-10-31 17:13:10 -07006658# recommend kstrto* over simple_strto* and strict_strto*
6659 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006660 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006661 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006662 }
Joe Perches6712d852012-03-23 15:02:20 -07006663
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006664# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006665 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006666 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006667 "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 -07006668 }
Joe Perches6712d852012-03-23 15:02:20 -07006669
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006670# check for spin_is_locked(), suggest lockdep instead
6671 if ($line =~ /\bspin_is_locked\(/) {
6672 WARN("USE_LOCKDEP",
6673 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6674 }
6675
Joe Perches9189c7e2018-09-07 15:26:18 -07006676# check for deprecated apis
6677 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6678 my $deprecated_api = $1;
6679 my $new_api = $deprecated_apis{$deprecated_api};
6680 WARN("DEPRECATED_API",
6681 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6682 }
6683
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006684# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006685# and avoid what seem like struct definitions 'struct foo {'
Quentin Monnetced69da12020-08-11 18:35:13 -07006686 if (defined($const_structs) &&
6687 $line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006688 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006689 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006690 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006691 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006692
6693# use of NR_CPUS is usually wrong
6694# ignore definitions of NR_CPUS and usage to define arrays as likely right
6695 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006696 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6697 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006698 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6699 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6700 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006701 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006702 WARN("NR_CPUS",
6703 "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 -07006704 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006705
Joe Perches52ea8502013-11-12 15:10:09 -08006706# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6707 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6708 ERROR("DEFINE_ARCH_HAS",
6709 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6710 }
6711
Joe Perchesacd93622015-02-13 14:38:38 -08006712# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07006713 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08006714 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6715 WARN("LIKELY_MISUSE",
6716 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6717 }
6718
Denis Efremovde3f1862019-09-25 16:49:25 -07006719# nested likely/unlikely calls
6720 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6721 WARN("LIKELY_MISUSE",
6722 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6723 }
6724
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006725# whine mightly about in_atomic
6726 if ($line =~ /\bin_atomic\s*\(/) {
6727 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006728 ERROR("IN_ATOMIC",
6729 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006730 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006731 WARN("IN_ATOMIC",
6732 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006733 }
6734 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006735
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006736# check for mutex_trylock_recursive usage
6737 if ($line =~ /mutex_trylock_recursive/) {
6738 ERROR("LOCKING",
6739 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6740 }
6741
Peter Zijlstra1704f472010-03-19 01:37:42 +01006742# check for lockdep_set_novalidate_class
6743 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6744 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6745 if ($realfile !~ m@^kernel/lockdep@ &&
6746 $realfile !~ m@^include/linux/lockdep@ &&
6747 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006748 ERROR("LOCKDEP",
6749 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006750 }
6751 }
Dave Jones88f88312011-01-12 16:59:59 -08006752
Joe Perchesb392c642015-04-16 12:44:16 -07006753 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6754 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006755 WARN("EXPORTED_WORLD_WRITABLE",
6756 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006757 }
Joe Perches24358802014-04-03 14:49:13 -07006758
Joe Perches00180462018-02-06 15:38:55 -08006759# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6760# and whether or not function naming is typical and if
6761# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07006762 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08006763 defined $stat &&
6764 $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*\)/) {
6765 my $var = $1;
6766 my $perms = $2;
6767 my $show = $3;
6768 my $store = $4;
6769 my $octal_perms = perms_to_octal($perms);
6770 if ($show =~ /^${var}_show$/ &&
6771 $store =~ /^${var}_store$/ &&
6772 $octal_perms eq "0644") {
6773 if (WARN("DEVICE_ATTR_RW",
6774 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6775 $fix) {
6776 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6777 }
6778 } elsif ($show =~ /^${var}_show$/ &&
6779 $store =~ /^NULL$/ &&
6780 $octal_perms eq "0444") {
6781 if (WARN("DEVICE_ATTR_RO",
6782 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6783 $fix) {
6784 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6785 }
6786 } elsif ($show =~ /^NULL$/ &&
6787 $store =~ /^${var}_store$/ &&
6788 $octal_perms eq "0200") {
6789 if (WARN("DEVICE_ATTR_WO",
6790 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6791 $fix) {
6792 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6793 }
6794 } elsif ($octal_perms eq "0644" ||
6795 $octal_perms eq "0444" ||
6796 $octal_perms eq "0200") {
6797 my $newshow = "$show";
6798 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6799 my $newstore = $store;
6800 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6801 my $rename = "";
6802 if ($show ne $newshow) {
6803 $rename .= " '$show' to '$newshow'";
6804 }
6805 if ($store ne $newstore) {
6806 $rename .= " '$store' to '$newstore'";
6807 }
6808 WARN("DEVICE_ATTR_FUNCTIONS",
6809 "Consider renaming function(s)$rename\n" . $herecurr);
6810 } else {
6811 WARN("DEVICE_ATTR_PERMS",
6812 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6813 }
6814 }
6815
Joe Perches515a2352014-04-03 14:49:24 -07006816# Mode permission misuses where it seems decimal should be octal
6817# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006818# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6819# specific definition of not visible in sysfs.
6820# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6821# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07006822 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006823 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006824 $line =~ /$mode_perms_search/) {
6825 foreach my $entry (@mode_permission_funcs) {
6826 my $func = $entry->[0];
6827 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006828
Joe Perches459cf0a2016-10-11 13:52:19 -07006829 my $lc = $stat =~ tr@\n@@;
6830 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006831 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006832
Joe Perches515a2352014-04-03 14:49:24 -07006833 my $skip_args = "";
6834 if ($arg_pos > 1) {
6835 $arg_pos--;
6836 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6837 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006838 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006839 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006840 my $val = $1;
6841 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006842 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6843 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6844 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006845 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006846 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006847 }
6848 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006849 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006850 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006851 }
Joe Perches24358802014-04-03 14:49:13 -07006852 }
6853 }
6854 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006855
Joe Perches459cf0a2016-10-11 13:52:19 -07006856# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07006857 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08006858 my $oval = $1;
6859 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006860 if (WARN("SYMBOLIC_PERMS",
6861 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6862 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006863 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006864 }
6865 }
6866
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006867# validate content of MODULE_LICENSE against list from include/linux/module.h
6868 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6869 my $extracted_string = get_quoted_string($line, $rawline);
6870 my $valid_licenses = qr{
6871 GPL|
6872 GPL\ v2|
6873 GPL\ and\ additional\ rights|
6874 Dual\ BSD/GPL|
6875 Dual\ MIT/GPL|
6876 Dual\ MPL/GPL|
6877 Proprietary
6878 }x;
6879 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6880 WARN("MODULE_LICENSE",
6881 "unknown module license " . $extracted_string . "\n" . $herecurr);
6882 }
6883 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07006884
6885# check for sysctl duplicate constants
6886 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6887 WARN("DUPLICATED_SYSCTL_CONST",
6888 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6889 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006890 }
6891
6892 # If we have no input at all, then there is nothing to report on
6893 # so just keep quiet.
6894 if ($#rawlines == -1) {
6895 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006896 }
6897
Andy Whitcroft8905a672007-11-28 16:21:06 -08006898 # In mailback mode only produce a report in the negative, for
6899 # things that appear to be patches.
6900 if ($mailback && ($clean == 1 || !$is_patch)) {
6901 exit(0);
6902 }
6903
6904 # This is not a patch, and we are are in 'no-patch' mode so
6905 # just keep quiet.
6906 if (!$chk_patch && !$is_patch) {
6907 exit(0);
6908 }
6909
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006910 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006911 ERROR("NOT_UNIFIED_DIFF",
6912 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006913 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07006914 if ($is_patch && $has_commit_log && $chk_signoff) {
6915 if ($signoff == 0) {
6916 ERROR("MISSING_SIGN_OFF",
6917 "Missing Signed-off-by: line(s)\n");
6918 } elsif (!$authorsignoff) {
6919 WARN("NO_AUTHOR_SIGN_OFF",
6920 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6921 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006922 }
6923
Andy Whitcroft8905a672007-11-28 16:21:06 -08006924 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006925 if ($summary && !($clean == 1 && $quiet == 1)) {
6926 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006927 print "total: $cnt_error errors, $cnt_warn warnings, " .
6928 (($check)? "$cnt_chk checks, " : "") .
6929 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006930 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006931
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006932 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006933 # If there were any defects found and not already fixing them
6934 if (!$clean and !$fix) {
6935 print << "EOM"
6936
6937NOTE: For some of the reported defects, checkpatch may be able to
6938 mechanically convert to the typical style using --fix or --fix-inplace.
6939EOM
6940 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006941 # If there were whitespace errors which cleanpatch can fix
6942 # then suggest that.
6943 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006944 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006945 print << "EOM"
6946
6947NOTE: Whitespace errors detected.
6948 You may wish to use scripts/cleanpatch or scripts/cleanfile
6949EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006950 }
6951 }
6952
Joe Perchesd752fcc2014-08-06 16:11:05 -07006953 if ($clean == 0 && $fix &&
6954 ("@rawlines" ne "@fixed" ||
6955 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006956 my $newfile = $filename;
6957 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006958 my $linecount = 0;
6959 my $f;
6960
Joe Perchesd752fcc2014-08-06 16:11:05 -07006961 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6962
Joe Perches3705ce52013-07-03 15:05:31 -07006963 open($f, '>', $newfile)
6964 or die "$P: Can't open $newfile for write\n";
6965 foreach my $fixed_line (@fixed) {
6966 $linecount++;
6967 if ($file) {
6968 if ($linecount > 3) {
6969 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006970 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006971 }
6972 } else {
6973 print $f $fixed_line . "\n";
6974 }
6975 }
6976 close($f);
6977
6978 if (!$quiet) {
6979 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006980
Joe Perches3705ce52013-07-03 15:05:31 -07006981Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6982
6983Do _NOT_ trust the results written to this file.
6984Do _NOT_ submit these changes without inspecting them for correctness.
6985
6986This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6987No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006988EOM
6989 }
6990 }
6991
Joe Perchesd8469f12015-06-25 15:03:00 -07006992 if ($quiet == 0) {
6993 print "\n";
6994 if ($clean == 1) {
6995 print "$vname has no obvious style problems and is ready for submission.\n";
6996 } else {
6997 print "$vname has style problems, please review.\n";
6998 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006999 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007000 return $clean;
7001}