blob: eac40f0abd56a9f4700423664824da8a537bfd61 [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 Perches6cd7f382012-12-17 16:01:54 -080054my $max_line_length = 80;
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";
Jerome Forissier75ad8c52017-05-08 15:56:00 -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 Perches6cd7f382012-12-17 16:01:54 -0800100 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -0700101 --min-conf-desc-length=n set the min description length, if shorter, warn
Antonio Borneo713a09d2020-04-06 20:11:07 -0700102 --tab-size=n set the number of spaces for tab (default 8)
Hannes Eder77f5b102009-09-21 17:04:37 -0700103 --root=PATH PATH to the kernel tree root
104 --no-summary suppress the per-file summary
105 --mailback only produce a report in case of warnings/errors
106 --summary-file include the filename in summary
107 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
108 'values', 'possible', 'type', and 'attr' (default
109 is all off)
110 --test-only=WORD report only warnings/errors containing WORD
111 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700112 --fix EXPERIMENTAL - may create horrible results
113 If correctable single-line errors exist, create
114 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
115 with potential errors corrected to the preferred
116 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800117 --fix-inplace EXPERIMENTAL - may create horrible results
118 Is the same as --fix, but overwrites the input
119 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700120 --ignore-perl-version override checking of perl version. expect
121 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700122 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700123 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700124 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700125 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700126 --color[=WHEN] Use colors 'always', 'never', or only when output
127 is a terminal ('auto'). Default is 'auto'.
Hannes Eder77f5b102009-09-21 17:04:37 -0700128 -h, --help, --version display this help and exit
129
130When FILE is - read standard input.
131EOM
132
133 exit($exitcode);
134}
135
Joe Perches3beb42e2016-05-20 17:04:14 -0700136sub uniq {
137 my %seen;
138 return grep { !$seen{$_}++ } @_;
139}
140
141sub list_types {
142 my ($exitcode) = @_;
143
144 my $count = 0;
145
146 local $/ = undef;
147
148 open(my $script, '<', abs_path($P)) or
149 die "$P: Can't read '$P' $!\n";
150
151 my $text = <$script>;
152 close($script);
153
154 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700155 # Also catch when type or level is passed through a variable
156 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700157 push (@types, $_);
158 }
159 @types = sort(uniq(@types));
160 print("#\tMessage type\n\n");
161 foreach my $type (@types) {
162 print(++$count . "\t" . $type . "\n");
163 }
164
165 exit($exitcode);
166}
167
Joe Perches000d1cc12011-07-25 17:13:25 -0700168my $conf = which_conf($configuration_file);
169if (-f $conf) {
170 my @conf_args;
171 open(my $conffile, '<', "$conf")
172 or warn "$P: Can't find a readable $configuration_file file $!\n";
173
174 while (<$conffile>) {
175 my $line = $_;
176
177 $line =~ s/\s*\n?$//g;
178 $line =~ s/^\s*//g;
179 $line =~ s/\s+/ /g;
180
181 next if ($line =~ m/^\s*#/);
182 next if ($line =~ m/^\s*$/);
183
184 my @words = split(" ", $line);
185 foreach my $word (@words) {
186 last if ($word =~ m/^#/);
187 push (@conf_args, $word);
188 }
189 }
190 close($conffile);
191 unshift(@ARGV, @conf_args) if @conf_args;
192}
193
John Brooks737c0762017-07-10 15:52:24 -0700194# Perl's Getopt::Long allows options to take optional arguments after a space.
195# Prevent --color by itself from consuming other arguments
196foreach (@ARGV) {
197 if ($_ eq "--color" || $_ eq "-color") {
198 $_ = "--color=$color";
199 }
200}
201
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700202GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700203 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700204 'tree!' => \$tree,
205 'signoff!' => \$chk_signoff,
206 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700207 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800208 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700209 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700210 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700211 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700212 'subjective!' => \$check,
213 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700214 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700215 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700216 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700217 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800218 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700219 'min-conf-desc-length=i' => \$min_conf_desc_length,
Antonio Borneo713a09d2020-04-06 20:11:07 -0700220 'tab-size=i' => \$tabsize,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700221 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800222 'summary!' => \$summary,
223 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800224 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700225 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800226 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700227 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800228 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700229 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700230 'codespell!' => \$codespell,
231 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700232 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700233 'color=s' => \$color,
234 'no-color' => \$color, #keep old behaviors of -nocolor
235 'nocolor' => \$color, #keep old behaviors of -nocolor
Hannes Eder77f5b102009-09-21 17:04:37 -0700236 'h|help' => \$help,
237 'version' => \$help
238) or help(1);
239
240help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700241
Joe Perches3beb42e2016-05-20 17:04:14 -0700242list_types(0) if ($list_types);
243
Joe Perches9624b8d2014-01-23 15:54:44 -0800244$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700245$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800246
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700247my $exit = 0;
248
Joe Perches5b579802018-08-21 21:57:33 -0700249my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700250if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700251 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700252 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700253 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700254}
255
Allen Hubbe45107ff2016-08-02 14:04:47 -0700256#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700257if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700258 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700259}
260
John Brooks737c0762017-07-10 15:52:24 -0700261if ($color =~ /^[01]$/) {
262 $color = !$color;
263} elsif ($color =~ /^always$/i) {
264 $color = 1;
265} elsif ($color =~ /^never$/i) {
266 $color = 0;
267} elsif ($color =~ /^auto$/i) {
268 $color = (-t STDOUT);
269} else {
270 die "Invalid color mode: $color\n";
271}
272
Antonio Borneo713a09d2020-04-06 20:11:07 -0700273# skip TAB size 1 to avoid additional checks on $tabsize - 1
274die "Invalid TAB size: $tabsize\n" if ($tabsize < 2);
275
Joe Perches91bfe482013-09-11 14:23:59 -0700276sub hash_save_array_words {
277 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700278
Joe Perches91bfe482013-09-11 14:23:59 -0700279 my @array = split(/,/, join(',', @$arrayRef));
280 foreach my $word (@array) {
281 $word =~ s/\s*\n?$//g;
282 $word =~ s/^\s*//g;
283 $word =~ s/\s+/ /g;
284 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700285
Joe Perches91bfe482013-09-11 14:23:59 -0700286 next if ($word =~ m/^\s*#/);
287 next if ($word =~ m/^\s*$/);
288
289 $hashRef->{$word}++;
290 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700291}
292
Joe Perches91bfe482013-09-11 14:23:59 -0700293sub hash_show_words {
294 my ($hashRef, $prefix) = @_;
295
Joe Perches3c816e42015-06-25 15:03:29 -0700296 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700297 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700298 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700299 print " $word";
300 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700301 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700302 }
303}
304
305hash_save_array_words(\%ignore_type, \@ignore);
306hash_save_array_words(\%use_type, \@use);
307
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800308my $dbg_values = 0;
309my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700310my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700311my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800312for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800313 ## no critic
314 eval "\${dbg_$key} = '$debug{$key}';";
315 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800316}
317
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700318my $rpt_cleaners = 0;
319
Andy Whitcroft8905a672007-11-28 16:21:06 -0800320if ($terse) {
321 $emacs = 1;
322 $quiet++;
323}
324
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700325if ($tree) {
326 if (defined $root) {
327 if (!top_of_kernel_tree($root)) {
328 die "$P: $root: --root does not point at a valid tree\n";
329 }
330 } else {
331 if (top_of_kernel_tree('.')) {
332 $root = '.';
333 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
334 top_of_kernel_tree($1)) {
335 $root = $1;
336 }
337 }
338
339 if (!defined $root) {
340 print "Must be run from the top-level dir. of a kernel tree\n";
341 exit(2);
342 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700343}
344
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700345my $emitted_corrupt = 0;
346
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700347our $Ident = qr{
348 [A-Za-z_][A-Za-z\d_]*
349 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
350 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700351our $Storage = qr{extern|static|asmlinkage};
352our $Sparse = qr{
353 __user|
354 __kernel|
355 __force|
356 __iomem|
357 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800358 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700359 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700360 __refconst|
361 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800362 __rcu|
363 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700364 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800365our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
366our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
367our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
368our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
369our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700370
Wolfram Sang52131292010-03-05 13:43:51 -0800371# Notes to $Attribute:
372# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700373our $Attribute = qr{
374 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700375 __percpu|
376 __nocast|
377 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200378 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700379 __packed__|
380 __packed2__|
381 __naked|
382 __maybe_unused|
383 __always_unused|
384 __noreturn|
385 __used|
386 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800387 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700388 __noclone|
389 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700390 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700391 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700392 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700393 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700394 ____cacheline_aligned|
395 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800396 ____cacheline_internodealigned_in_smp|
397 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700398 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700399our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700400our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700401our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
402our $Lval = qr{$Ident(?:$Member)*};
403
Joe Perches95e2c602013-07-03 15:05:20 -0700404our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
405our $Binary = qr{(?i)0b[01]+$Int_type?};
406our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
407our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700408our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800409our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800410our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
411our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
412our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800413our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700414our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800415our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700416our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700417our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700418our $Operators = qr{
419 <=|>=|==|!=|
420 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700421 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700422 }x;
423
Joe Perches91cb5192014-04-03 14:49:32 -0700424our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
425
Joe Perchesab7e23f2015-04-16 12:44:22 -0700426our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800427our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700428our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700429our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800430our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700431our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800432our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700433our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800434
Joe Perches15662b32011-10-31 17:13:12 -0700435our $NON_ASCII_UTF8 = qr{
436 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700437 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
438 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
439 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
440 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
441 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
442 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
443}x;
444
Joe Perches15662b32011-10-31 17:13:12 -0700445our $UTF8 = qr{
446 [\x09\x0A\x0D\x20-\x7E] # ASCII
447 | $NON_ASCII_UTF8
448}x;
449
Joe Perchese6176fa2015-06-25 15:02:49 -0700450our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800451our $typeOtherOSTypedefs = qr{(?x:
452 u_(?:char|short|int|long) | # bsd
453 u(?:nchar|short|int|long) # sysv
454)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700455our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700456 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700457 atomic_t
458)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700459our $typeTypedefs = qr{(?x:
460 $typeC99Typedefs\b|
461 $typeOtherOSTypedefs\b|
462 $typeKernelTypedefs\b
463)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700464
Joe Perches6d32f7a2015-11-06 16:31:37 -0800465our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
466
Joe Perches691e6692010-03-05 13:43:51 -0800467our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800468 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700469 (?:[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 -0800470 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700471 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700472 panic|
Joe Perches06668722013-11-12 15:10:07 -0800473 MODULE_[A-Z_]+|
474 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800475)};
476
Joe Perchese29a70f2019-03-07 16:28:35 -0800477our $allocFunctions = qr{(?x:
478 (?:(?:devm_)?
479 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
480 kstrdup(?:_const)? |
481 kmemdup(?:_nul)?) |
Christophe JAILLET461e1562020-04-20 18:13:58 -0700482 (?:\w+)?alloc_skb(?:_ip_align)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800483 # dev_alloc_skb/netdev_alloc_skb, et al
484 dma_alloc_coherent
485)};
486
Joe Perches20112472011-07-25 17:13:23 -0700487our $signature_tags = qr{(?xi:
488 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800489 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700490 Acked-by:|
491 Tested-by:|
492 Reviewed-by:|
493 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700494 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700495 To:|
496 Cc:
497)};
498
Joe Perches18130872014-08-06 16:11:22 -0700499our @typeListMisordered = (
500 qr{char\s+(?:un)?signed},
501 qr{int\s+(?:(?:un)?signed\s+)?short\s},
502 qr{int\s+short(?:\s+(?:un)?signed)},
503 qr{short\s+int(?:\s+(?:un)?signed)},
504 qr{(?:un)?signed\s+int\s+short},
505 qr{short\s+(?:un)?signed},
506 qr{long\s+int\s+(?:un)?signed},
507 qr{int\s+long\s+(?:un)?signed},
508 qr{long\s+(?:un)?signed\s+int},
509 qr{int\s+(?:un)?signed\s+long},
510 qr{int\s+(?:un)?signed},
511 qr{int\s+long\s+long\s+(?:un)?signed},
512 qr{long\s+long\s+int\s+(?:un)?signed},
513 qr{long\s+long\s+(?:un)?signed\s+int},
514 qr{long\s+long\s+(?:un)?signed},
515 qr{long\s+(?:un)?signed},
516);
517
Andy Whitcroft8905a672007-11-28 16:21:06 -0800518our @typeList = (
519 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700520 qr{(?:(?:un)?signed\s+)?char},
521 qr{(?:(?:un)?signed\s+)?short\s+int},
522 qr{(?:(?:un)?signed\s+)?short},
523 qr{(?:(?:un)?signed\s+)?int},
524 qr{(?:(?:un)?signed\s+)?long\s+int},
525 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
526 qr{(?:(?:un)?signed\s+)?long\s+long},
527 qr{(?:(?:un)?signed\s+)?long},
528 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800529 qr{float},
530 qr{double},
531 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800532 qr{struct\s+$Ident},
533 qr{union\s+$Ident},
534 qr{enum\s+$Ident},
535 qr{${Ident}_t},
536 qr{${Ident}_handler},
537 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700538 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800539);
Joe Perches938224b2016-01-20 14:59:15 -0800540
541our $C90_int_types = qr{(?x:
542 long\s+long\s+int\s+(?:un)?signed|
543 long\s+long\s+(?:un)?signed\s+int|
544 long\s+long\s+(?:un)?signed|
545 (?:(?:un)?signed\s+)?long\s+long\s+int|
546 (?:(?:un)?signed\s+)?long\s+long|
547 int\s+long\s+long\s+(?:un)?signed|
548 int\s+(?:(?:un)?signed\s+)?long\s+long|
549
550 long\s+int\s+(?:un)?signed|
551 long\s+(?:un)?signed\s+int|
552 long\s+(?:un)?signed|
553 (?:(?:un)?signed\s+)?long\s+int|
554 (?:(?:un)?signed\s+)?long|
555 int\s+long\s+(?:un)?signed|
556 int\s+(?:(?:un)?signed\s+)?long|
557
558 int\s+(?:un)?signed|
559 (?:(?:un)?signed\s+)?int
560)};
561
Alex Dowad485ff232015-06-25 15:02:52 -0700562our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700563our @typeListWithAttr = (
564 @typeList,
565 qr{struct\s+$InitAttribute\s+$Ident},
566 qr{union\s+$InitAttribute\s+$Ident},
567);
568
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700569our @modifierList = (
570 qr{fastcall},
571);
Alex Dowad485ff232015-06-25 15:02:52 -0700572our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800573
Joe Perches24358802014-04-03 14:49:13 -0700574our @mode_permission_funcs = (
575 ["module_param", 3],
576 ["module_param_(?:array|named|string)", 4],
577 ["module_param_array_named", 5],
578 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
579 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700580 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
581 ["IIO_DEV_ATTR_[A-Z_]+", 1],
582 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
583 ["SENSOR_TEMPLATE(?:_2|)", 3],
584 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700585);
586
Joe Perches515a2352014-04-03 14:49:24 -0700587#Create a search pattern for all these functions to speed up a loop below
588our $mode_perms_search = "";
589foreach my $entry (@mode_permission_funcs) {
590 $mode_perms_search .= '|' if ($mode_perms_search ne "");
591 $mode_perms_search .= $entry->[0];
592}
Joe Perches00180462018-02-06 15:38:55 -0800593$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700594
Joe Perches9189c7e2018-09-07 15:26:18 -0700595our %deprecated_apis = (
596 "synchronize_rcu_bh" => "synchronize_rcu",
597 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
598 "call_rcu_bh" => "call_rcu",
599 "rcu_barrier_bh" => "rcu_barrier",
600 "synchronize_sched" => "synchronize_rcu",
601 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
602 "call_rcu_sched" => "call_rcu",
603 "rcu_barrier_sched" => "rcu_barrier",
604 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
605 "cond_synchronize_sched" => "cond_synchronize_rcu",
606);
607
608#Create a search pattern for all these strings to speed up a loop below
609our $deprecated_apis_search = "";
610foreach my $entry (keys %deprecated_apis) {
611 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
612 $deprecated_apis_search .= $entry;
613}
614$deprecated_apis_search = "(?:${deprecated_apis_search})";
615
Joe Perchesb392c642015-04-16 12:44:16 -0700616our $mode_perms_world_writable = qr{
617 S_IWUGO |
618 S_IWOTH |
619 S_IRWXUGO |
620 S_IALLUGO |
621 0[0-7][0-7][2367]
622}x;
623
Joe Perchesf90774e2016-10-11 13:51:47 -0700624our %mode_permission_string_types = (
625 "S_IRWXU" => 0700,
626 "S_IRUSR" => 0400,
627 "S_IWUSR" => 0200,
628 "S_IXUSR" => 0100,
629 "S_IRWXG" => 0070,
630 "S_IRGRP" => 0040,
631 "S_IWGRP" => 0020,
632 "S_IXGRP" => 0010,
633 "S_IRWXO" => 0007,
634 "S_IROTH" => 0004,
635 "S_IWOTH" => 0002,
636 "S_IXOTH" => 0001,
637 "S_IRWXUGO" => 0777,
638 "S_IRUGO" => 0444,
639 "S_IWUGO" => 0222,
640 "S_IXUGO" => 0111,
641);
642
643#Create a search pattern for all these strings to speed up a loop below
644our $mode_perms_string_search = "";
645foreach my $entry (keys %mode_permission_string_types) {
646 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
647 $mode_perms_string_search .= $entry;
648}
Joe Perches00180462018-02-06 15:38:55 -0800649our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
650our $multi_mode_perms_string_search = qr{
651 ${single_mode_perms_string_search}
652 (?:\s*\|\s*${single_mode_perms_string_search})*
653}x;
654
655sub perms_to_octal {
656 my ($string) = @_;
657
658 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
659
660 my $val = "";
661 my $oval = "";
662 my $to = 0;
663 my $curpos = 0;
664 my $lastpos = 0;
665 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
666 $curpos = pos($string);
667 my $match = $2;
668 my $omatch = $1;
669 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
670 $lastpos = $curpos;
671 $to |= $mode_permission_string_types{$match};
672 $val .= '\s*\|\s*' if ($val ne "");
673 $val .= $match;
674 $oval .= $omatch;
675 }
676 $oval =~ s/^\s*\|\s*//;
677 $oval =~ s/\s*\|\s*$//;
678 return sprintf("%04o", $to);
679}
Joe Perchesf90774e2016-10-11 13:51:47 -0700680
Wolfram Sang7840a942010-08-09 17:20:57 -0700681our $allowed_asm_includes = qr{(?x:
682 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700683 memory|
684 time|
685 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700686)};
687# memory.h: ARM has a custom one
688
Kees Cook66b47b42014-10-13 15:51:57 -0700689# Load common spelling mistakes and build regular expression list.
690my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700691my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700692
Joe Perches36061e32014-12-10 15:51:43 -0800693if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800694 while (<$spelling>) {
695 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700696
Joe Perches36061e32014-12-10 15:51:43 -0800697 $line =~ s/\s*\n?$//g;
698 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700699
Joe Perches36061e32014-12-10 15:51:43 -0800700 next if ($line =~ m/^\s*#/);
701 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700702
Joe Perches36061e32014-12-10 15:51:43 -0800703 my ($suspect, $fix) = split(/\|\|/, $line);
704
Joe Perches36061e32014-12-10 15:51:43 -0800705 $spelling_fix{$suspect} = $fix;
706 }
707 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800708} else {
709 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700710}
Kees Cook66b47b42014-10-13 15:51:57 -0700711
Joe Perchesebfd7d62015-04-16 12:44:14 -0700712if ($codespell) {
713 if (open(my $spelling, '<', $codespellfile)) {
714 while (<$spelling>) {
715 my $line = $_;
716
717 $line =~ s/\s*\n?$//g;
718 $line =~ s/^\s*//g;
719
720 next if ($line =~ m/^\s*#/);
721 next if ($line =~ m/^\s*$/);
722 next if ($line =~ m/, disabled/i);
723
724 $line =~ s/,.*$//;
725
726 my ($suspect, $fix) = split(/->/, $line);
727
728 $spelling_fix{$suspect} = $fix;
729 }
730 close($spelling);
731 } else {
732 warn "No codespell typos will be found - file '$codespellfile': $!\n";
733 }
734}
735
736$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
737
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700738sub read_words {
739 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700740
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700741 if (open(my $words, '<', $file)) {
742 while (<$words>) {
743 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700744
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700745 $line =~ s/\s*\n?$//g;
746 $line =~ s/^\s*//g;
747
748 next if ($line =~ m/^\s*#/);
749 next if ($line =~ m/^\s*$/);
750 if ($line =~ /\s/) {
751 print("$file: '$line' invalid - ignored\n");
752 next;
753 }
754
755 $$wordsRef .= '|' if ($$wordsRef ne "");
756 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700757 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700758 close($file);
759 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700760 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700761
762 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700763}
764
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700765my $const_structs = "";
766read_words(\$const_structs, $conststructsfile)
767 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
768
769my $typeOtherTypedefs = "";
770if (length($typedefsfile)) {
771 read_words(\$typeOtherTypedefs, $typedefsfile)
772 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
773}
774$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
775
Andy Whitcroft8905a672007-11-28 16:21:06 -0800776sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700777 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
778 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700779 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700780 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700781 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700782 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700783 (?:$typeTypedefs\b)|
784 (?:${all}\b)
785 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800786 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700787 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800788 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800789 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700790 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700791 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800792 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700793 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800794 }x;
Joe Perches18130872014-08-06 16:11:22 -0700795 $NonptrTypeMisordered = qr{
796 (?:$Modifier\s+|const\s+)*
797 (?:
798 (?:${Misordered}\b)
799 )
800 (?:\s+$Modifier|\s+const)*
801 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700802 $NonptrTypeWithAttr = qr{
803 (?:$Modifier\s+|const\s+)*
804 (?:
805 (?:typeof|__typeof__)\s*\([^\)]*\)|
806 (?:$typeTypedefs\b)|
807 (?:${allWithAttr}\b)
808 )
809 (?:\s+$Modifier|\s+const)*
810 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800811 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700812 $NonptrType
Antonio Borneo7b184962020-04-06 20:11:04 -0700813 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700814 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800815 }x;
Joe Perches18130872014-08-06 16:11:22 -0700816 $TypeMisordered = qr{
817 $NonptrTypeMisordered
Antonio Borneo7b184962020-04-06 20:11:04 -0700818 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Joe Perches18130872014-08-06 16:11:22 -0700819 (?:\s+$Inline|\s+$Modifier)*
820 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700821 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700822 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800823}
824build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700825
Joe Perches7d2367a2011-07-25 17:13:22 -0700826our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700827
828# Using $balanced_parens, $LvalOrFunc, or $FuncArg
829# requires at least perl version v5.10.0
830# Any use must be runtime checked with $^V
831
832our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700833our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800834our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700835
Joe Perchesf8422302014-08-06 16:11:31 -0700836our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700837 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700838 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700839 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
840 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700841)};
842
Joe Perches7d2367a2011-07-25 17:13:22 -0700843sub deparenthesize {
844 my ($string) = @_;
845 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700846
847 while ($string =~ /^\s*\(.*\)\s*$/) {
848 $string =~ s@^\s*\(\s*@@;
849 $string =~ s@\s*\)\s*$@@;
850 }
851
Joe Perches7d2367a2011-07-25 17:13:22 -0700852 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700853
Joe Perches7d2367a2011-07-25 17:13:22 -0700854 return $string;
855}
856
Joe Perches34456862013-07-03 15:05:34 -0700857sub seed_camelcase_file {
858 my ($file) = @_;
859
860 return if (!(-f $file));
861
862 local $/;
863
864 open(my $include_file, '<', "$file")
865 or warn "$P: Can't read '$file' $!\n";
866 my $text = <$include_file>;
867 close($include_file);
868
869 my @lines = split('\n', $text);
870
871 foreach my $line (@lines) {
872 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
873 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
874 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800875 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
876 $camelcase{$1} = 1;
877 } 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 -0700878 $camelcase{$1} = 1;
879 }
880 }
881}
882
Joe Perchescd28b112019-12-04 16:52:09 -0800883our %maintained_status = ();
884
Joe Perches85b0ee12016-10-11 13:51:44 -0700885sub is_maintained_obsolete {
886 my ($filename) = @_;
887
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800888 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700889
Joe Perchescd28b112019-12-04 16:52:09 -0800890 if (!exists($maintained_status{$filename})) {
891 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
892 }
Joe Perches85b0ee12016-10-11 13:51:44 -0700893
Joe Perchescd28b112019-12-04 16:52:09 -0800894 return $maintained_status{$filename} =~ /obsolete/i;
Joe Perches85b0ee12016-10-11 13:51:44 -0700895}
896
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700897sub is_SPDX_License_valid {
898 my ($license) = @_;
899
Joe Perches56294112018-08-21 21:58:04 -0700900 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700901
Joe Perches56294112018-08-21 21:58:04 -0700902 my $root_path = abs_path($root);
903 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700904 return 0 if ($status ne "");
905 return 1;
906}
907
Joe Perches34456862013-07-03 15:05:34 -0700908my $camelcase_seeded = 0;
909sub seed_camelcase_includes {
910 return if ($camelcase_seeded);
911
912 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700913 my $camelcase_cache = "";
914 my @include_files = ();
915
916 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700917
Richard Genoud3645e322014-02-10 14:25:32 -0800918 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700919 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Joe Perches351b2a12013-07-03 15:05:36 -0700920 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700921 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700922 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700923 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700924 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700925 @include_files = split('\n', $files);
926 foreach my $file (@include_files) {
927 my $date = POSIX::strftime("%Y%m%d%H%M",
928 localtime((stat $file)[9]));
929 $last_mod_date = $date if ($last_mod_date < $date);
930 }
931 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700932 }
Joe Perchesc707a812013-07-08 16:00:43 -0700933
934 if ($camelcase_cache ne "" && -f $camelcase_cache) {
935 open(my $camelcase_file, '<', "$camelcase_cache")
936 or warn "$P: Can't read '$camelcase_cache' $!\n";
937 while (<$camelcase_file>) {
938 chomp;
939 $camelcase{$_} = 1;
940 }
941 close($camelcase_file);
942
943 return;
944 }
945
Richard Genoud3645e322014-02-10 14:25:32 -0800946 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700947 $files = `${git_command} ls-files "include/*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700948 @include_files = split('\n', $files);
949 }
950
Joe Perches34456862013-07-03 15:05:34 -0700951 foreach my $file (@include_files) {
952 seed_camelcase_file($file);
953 }
Joe Perches351b2a12013-07-03 15:05:36 -0700954
Joe Perchesc707a812013-07-08 16:00:43 -0700955 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700956 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700957 open(my $camelcase_file, '>', "$camelcase_cache")
958 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700959 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
960 print $camelcase_file ("$_\n");
961 }
962 close($camelcase_file);
963 }
Joe Perches34456862013-07-03 15:05:34 -0700964}
965
Joe Perchesd311cd42014-08-06 16:10:57 -0700966sub git_commit_info {
967 my ($commit, $id, $desc) = @_;
968
969 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
970
Joe Perchesdbbf8692019-09-25 16:46:52 -0700971 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Joe Perchesd311cd42014-08-06 16:10:57 -0700972 $output =~ s/^\s*//gm;
973 my @lines = split("\n", $output);
974
Joe Perches0d7835f2015-02-13 14:38:35 -0800975 return ($id, $desc) if ($#lines < 0);
976
Sean Christopherson5a7f4452019-09-25 16:46:49 -0700977 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Joe Perchesd311cd42014-08-06 16:10:57 -0700978# Maybe one day convert this block of bash into something that returns
979# all matching commit ids, but it's very slow...
980#
981# echo "checking commits $1..."
982# git rev-list --remotes | grep -i "^$1" |
983# while read line ; do
984# git log --format='%H %s' -1 $line |
985# echo "commit $(cut -c 1-12,41-)"
986# done
987 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700988 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700989 } else {
990 $id = substr($lines[0], 0, 12);
991 $desc = substr($lines[0], 41);
992 }
993
994 return ($id, $desc);
995}
996
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700997$chk_signoff = 0 if ($file);
998
Andy Whitcroft00df3442007-06-08 13:47:06 -0700999my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001000my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001001my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001002my @fixed_inserted = ();
1003my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001004my $fixlinenr = -1;
1005
Du, Changbin4a593c32016-05-20 17:04:16 -07001006# If input is git commits, extract all commits from the commit expressions.
1007# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1008die "$P: No git repository found\n" if ($git && !-e ".git");
1009
1010if ($git) {
1011 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001012 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001013 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001014 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1015 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001016 } elsif ($commit_expr =~ m/\.\./) {
1017 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001018 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001019 $git_range = "-1 $commit_expr";
1020 }
Joe Perchesdbbf8692019-09-25 16:46:52 -07001021 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001022 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001023 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1024 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001025 my $sha1 = $1;
1026 my $subject = $2;
1027 unshift(@commits, $sha1);
1028 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001029 }
1030 }
1031 die "$P: no git commits after extraction!\n" if (@commits == 0);
1032 @ARGV = @commits;
1033}
1034
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001035my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001036$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001037for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001038 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -07001039 if ($git) {
1040 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1041 die "$P: $filename: git format-patch failed - $!\n";
1042 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001043 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001044 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001045 } elsif ($filename eq '-') {
1046 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001047 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001048 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001049 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001050 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001051 if ($filename eq '-') {
1052 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001053 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001054 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001055 } else {
1056 $vname = $filename;
1057 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001058 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001059 chomp;
1060 push(@rawlines, $_);
1061 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001062 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001063
1064 if ($#ARGV > 0 && $quiet == 0) {
1065 print '-' x length($vname) . "\n";
1066 print "$vname\n";
1067 print '-' x length($vname) . "\n";
1068 }
1069
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001070 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001071 $exit = 1;
1072 }
1073 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001074 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001075 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001076 @fixed_inserted = ();
1077 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001078 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001079 @modifierListFile = ();
1080 @typeListFile = ();
1081 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001082}
1083
Joe Perchesd8469f12015-06-25 15:03:00 -07001084if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001085 hash_show_words(\%use_type, "Used");
1086 hash_show_words(\%ignore_type, "Ignored");
1087
Joe Perches5b579802018-08-21 21:57:33 -07001088 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001089 print << "EOM"
1090
1091NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001092 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001093EOM
1094 }
1095 if ($exit) {
1096 print << "EOM"
1097
1098NOTE: If any of the errors are false positives, please report
1099 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1100EOM
1101 }
1102}
1103
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001104exit($exit);
1105
1106sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001107 my ($root) = @_;
1108
1109 my @tree_check = (
1110 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1111 "README", "Documentation", "arch", "include", "drivers",
1112 "fs", "init", "ipc", "kernel", "lib", "scripts",
1113 );
1114
1115 foreach my $check (@tree_check) {
1116 if (! -e $root . '/' . $check) {
1117 return 0;
1118 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001119 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001120 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001121}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001122
Joe Perches20112472011-07-25 17:13:23 -07001123sub parse_email {
1124 my ($formatted_email) = @_;
1125
1126 my $name = "";
Joe Perchesdfa05c22020-04-06 20:10:48 -07001127 my $name_comment = "";
Joe Perches20112472011-07-25 17:13:23 -07001128 my $address = "";
1129 my $comment = "";
1130
1131 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1132 $name = $1;
1133 $address = $2;
1134 $comment = $3 if defined $3;
1135 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1136 $address = $1;
1137 $comment = $2 if defined $2;
1138 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1139 $address = $1;
1140 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001141 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001142 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001143 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001144 $name =~ s/^\"|\"$//g;
1145 # If there's a name left after stripping spaces and
1146 # leading quotes, and the address doesn't have both
1147 # leading and trailing angle brackets, the address
1148 # is invalid. ie:
1149 # "joe smith joe@smith.com" bad
1150 # "joe smith <joe@smith.com" bad
1151 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1152 $name = "";
1153 $address = "";
1154 $comment = "";
1155 }
1156 }
1157
Joe Perches3705ce52013-07-03 15:05:31 -07001158 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001159 $name =~ s/^\"|\"$//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001160 $name =~ s/(\s*\([^\)]+\))\s*//;
1161 if (defined($1)) {
1162 $name_comment = trim($1);
1163 }
Joe Perches3705ce52013-07-03 15:05:31 -07001164 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001165 $address =~ s/^\<|\>$//g;
1166
1167 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1168 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1169 $name = "\"$name\"";
1170 }
1171
Joe Perchesdfa05c22020-04-06 20:10:48 -07001172 return ($name, $name_comment, $address, $comment);
Joe Perches20112472011-07-25 17:13:23 -07001173}
1174
1175sub format_email {
1176 my ($name, $address) = @_;
1177
1178 my $formatted_email;
1179
Joe Perches3705ce52013-07-03 15:05:31 -07001180 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001181 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001182 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001183
1184 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1185 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1186 $name = "\"$name\"";
1187 }
1188
1189 if ("$name" eq "") {
1190 $formatted_email = "$address";
1191 } else {
1192 $formatted_email = "$name <$address>";
1193 }
1194
1195 return $formatted_email;
1196}
1197
Joe Perchesdfa05c22020-04-06 20:10:48 -07001198sub reformat_email {
1199 my ($email) = @_;
1200
1201 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1202 return format_email($email_name, $email_address);
1203}
1204
1205sub same_email_addresses {
1206 my ($email1, $email2) = @_;
1207
1208 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1209 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1210
1211 return $email1_name eq $email2_name &&
1212 $email1_address eq $email2_address;
1213}
1214
Joe Perchesd311cd42014-08-06 16:10:57 -07001215sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001216 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001217
Joe Perchesbd474ca2014-08-06 16:11:10 -07001218 foreach my $path (split(/:/, $ENV{PATH})) {
1219 if (-e "$path/$bin") {
1220 return "$path/$bin";
1221 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001222 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001223
Joe Perchesbd474ca2014-08-06 16:11:10 -07001224 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001225}
1226
Joe Perches000d1cc12011-07-25 17:13:25 -07001227sub which_conf {
1228 my ($conf) = @_;
1229
1230 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1231 if (-e "$path/$conf") {
1232 return "$path/$conf";
1233 }
1234 }
1235
1236 return "";
1237}
1238
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001239sub expand_tabs {
1240 my ($str) = @_;
1241
1242 my $res = '';
1243 my $n = 0;
1244 for my $c (split(//, $str)) {
1245 if ($c eq "\t") {
1246 $res .= ' ';
1247 $n++;
Antonio Borneo713a09d2020-04-06 20:11:07 -07001248 for (; ($n % $tabsize) != 0; $n++) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001249 $res .= ' ';
1250 }
1251 next;
1252 }
1253 $res .= $c;
1254 $n++;
1255 }
1256
1257 return $res;
1258}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001259sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001260 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001261 return $res;
1262}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001263
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001264sub line_stats {
1265 my ($line) = @_;
1266
1267 # Drop the diff line leader and expand tabs
1268 $line =~ s/^.//;
1269 $line = expand_tabs($line);
1270
1271 # Pick the indent from the front of the line.
1272 my ($white) = ($line =~ /^(\s*)/);
1273
1274 return (length($line), length($white));
1275}
1276
Andy Whitcroft773647a2008-03-28 14:15:58 -07001277my $sanitise_quote = '';
1278
1279sub sanitise_line_reset {
1280 my ($in_comment) = @_;
1281
1282 if ($in_comment) {
1283 $sanitise_quote = '*/';
1284 } else {
1285 $sanitise_quote = '';
1286 }
1287}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001288sub sanitise_line {
1289 my ($line) = @_;
1290
1291 my $res = '';
1292 my $l = '';
1293
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001294 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001295 my $off = 0;
1296 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001297
Andy Whitcroft773647a2008-03-28 14:15:58 -07001298 # Always copy over the diff marker.
1299 $res = substr($line, 0, 1);
1300
1301 for ($off = 1; $off < length($line); $off++) {
1302 $c = substr($line, $off, 1);
1303
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001304 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001305 # and end, all to $;.
1306 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1307 $sanitise_quote = '*/';
1308
1309 substr($res, $off, 2, "$;$;");
1310 $off++;
1311 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001312 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001313 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001314 $sanitise_quote = '';
1315 substr($res, $off, 2, "$;$;");
1316 $off++;
1317 next;
1318 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001319 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1320 $sanitise_quote = '//';
1321
1322 substr($res, $off, 2, $sanitise_quote);
1323 $off++;
1324 next;
1325 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001326
1327 # A \ in a string means ignore the next character.
1328 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1329 $c eq "\\") {
1330 substr($res, $off, 2, 'XX');
1331 $off++;
1332 next;
1333 }
1334 # Regular quotes.
1335 if ($c eq "'" || $c eq '"') {
1336 if ($sanitise_quote eq '') {
1337 $sanitise_quote = $c;
1338
1339 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001340 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001341 } elsif ($sanitise_quote eq $c) {
1342 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001343 }
1344 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001345
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001346 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001347 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1348 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001349 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1350 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001351 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1352 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001353 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001354 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001355 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001356 }
1357
Daniel Walker113f04a2009-09-21 17:04:35 -07001358 if ($sanitise_quote eq '//') {
1359 $sanitise_quote = '';
1360 }
1361
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001362 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001363 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001364 my $clean = 'X' x length($1);
1365 $res =~ s@\<.*\>@<$clean>@;
1366
1367 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001368 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001369 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001370 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001371 }
1372
Joe Perchesdadf6802016-08-02 14:04:33 -07001373 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1374 my $match = $1;
1375 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1376 }
1377
Andy Whitcroft00df3442007-06-08 13:47:06 -07001378 return $res;
1379}
1380
Joe Perchesa6962d72013-04-29 16:18:13 -07001381sub get_quoted_string {
1382 my ($line, $rawline) = @_;
1383
Joe Perches478b1792018-04-10 16:33:34 -07001384 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001385 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001386 return substr($rawline, $-[0], $+[0] - $-[0]);
1387}
1388
Andy Whitcroft8905a672007-11-28 16:21:06 -08001389sub ctx_statement_block {
1390 my ($linenr, $remain, $off) = @_;
1391 my $line = $linenr - 1;
1392 my $blk = '';
1393 my $soff = $off;
1394 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001395 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001396
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001397 my $loff = 0;
1398
Andy Whitcroft8905a672007-11-28 16:21:06 -08001399 my $type = '';
1400 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001401 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001402 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001403 my $c;
1404 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001405
1406 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001407 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001408 @stack = (['', 0]) if ($#stack == -1);
1409
Andy Whitcroft773647a2008-03-28 14:15:58 -07001410 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001411 # If we are about to drop off the end, pull in more
1412 # context.
1413 if ($off >= $len) {
1414 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001415 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001416 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001417 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001418 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001419 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001420 $len = length($blk);
1421 $line++;
1422 last;
1423 }
1424 # Bail if there is no further context.
1425 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001426 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001427 last;
1428 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001429 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1430 $level++;
1431 $type = '#';
1432 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001433 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001434 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001435 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001436 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001437
Andy Whitcroft773647a2008-03-28 14:15:58 -07001438 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001439
1440 # Handle nested #if/#else.
1441 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1442 push(@stack, [ $type, $level ]);
1443 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1444 ($type, $level) = @{$stack[$#stack - 1]};
1445 } elsif ($remainder =~ /^#\s*endif\b/) {
1446 ($type, $level) = @{pop(@stack)};
1447 }
1448
Andy Whitcroft8905a672007-11-28 16:21:06 -08001449 # Statement ends at the ';' or a close '}' at the
1450 # outermost level.
1451 if ($level == 0 && $c eq ';') {
1452 last;
1453 }
1454
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001455 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001456 if ($level == 0 && $coff_set == 0 &&
1457 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1458 $remainder =~ /^(else)(?:\s|{)/ &&
1459 $remainder !~ /^else\s+if\b/) {
1460 $coff = $off + length($1) - 1;
1461 $coff_set = 1;
1462 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1463 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001464 }
1465
Andy Whitcroft8905a672007-11-28 16:21:06 -08001466 if (($type eq '' || $type eq '(') && $c eq '(') {
1467 $level++;
1468 $type = '(';
1469 }
1470 if ($type eq '(' && $c eq ')') {
1471 $level--;
1472 $type = ($level != 0)? '(' : '';
1473
1474 if ($level == 0 && $coff < $soff) {
1475 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001476 $coff_set = 1;
1477 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001478 }
1479 }
1480 if (($type eq '' || $type eq '{') && $c eq '{') {
1481 $level++;
1482 $type = '{';
1483 }
1484 if ($type eq '{' && $c eq '}') {
1485 $level--;
1486 $type = ($level != 0)? '{' : '';
1487
1488 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001489 if (substr($blk, $off + 1, 1) eq ';') {
1490 $off++;
1491 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001492 last;
1493 }
1494 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001495 # Preprocessor commands end at the newline unless escaped.
1496 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1497 $level--;
1498 $type = '';
1499 $off++;
1500 last;
1501 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001502 $off++;
1503 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001504 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001505 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001506 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001507 $line++;
1508 $remain--;
1509 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001510
1511 my $statement = substr($blk, $soff, $off - $soff + 1);
1512 my $condition = substr($blk, $soff, $coff - $soff + 1);
1513
1514 #warn "STATEMENT<$statement>\n";
1515 #warn "CONDITION<$condition>\n";
1516
Andy Whitcroft773647a2008-03-28 14:15:58 -07001517 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001518
1519 return ($statement, $condition,
1520 $line, $remain + 1, $off - $loff + 1, $level);
1521}
1522
Andy Whitcroftcf655042008-03-04 14:28:20 -08001523sub statement_lines {
1524 my ($stmt) = @_;
1525
1526 # Strip the diff line prefixes and rip blank lines at start and end.
1527 $stmt =~ s/(^|\n)./$1/g;
1528 $stmt =~ s/^\s*//;
1529 $stmt =~ s/\s*$//;
1530
1531 my @stmt_lines = ($stmt =~ /\n/g);
1532
1533 return $#stmt_lines + 2;
1534}
1535
1536sub statement_rawlines {
1537 my ($stmt) = @_;
1538
1539 my @stmt_lines = ($stmt =~ /\n/g);
1540
1541 return $#stmt_lines + 2;
1542}
1543
1544sub statement_block_size {
1545 my ($stmt) = @_;
1546
1547 $stmt =~ s/(^|\n)./$1/g;
1548 $stmt =~ s/^\s*{//;
1549 $stmt =~ s/}\s*$//;
1550 $stmt =~ s/^\s*//;
1551 $stmt =~ s/\s*$//;
1552
1553 my @stmt_lines = ($stmt =~ /\n/g);
1554 my @stmt_statements = ($stmt =~ /;/g);
1555
1556 my $stmt_lines = $#stmt_lines + 2;
1557 my $stmt_statements = $#stmt_statements + 1;
1558
1559 if ($stmt_lines > $stmt_statements) {
1560 return $stmt_lines;
1561 } else {
1562 return $stmt_statements;
1563 }
1564}
1565
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001566sub ctx_statement_full {
1567 my ($linenr, $remain, $off) = @_;
1568 my ($statement, $condition, $level);
1569
1570 my (@chunks);
1571
Andy Whitcroftcf655042008-03-04 14:28:20 -08001572 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001573 ($statement, $condition, $linenr, $remain, $off, $level) =
1574 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001575 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001576 push(@chunks, [ $condition, $statement ]);
1577 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1578 return ($level, $linenr, @chunks);
1579 }
1580
1581 # Pull in the following conditional/block pairs and see if they
1582 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001583 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001584 ($statement, $condition, $linenr, $remain, $off, $level) =
1585 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001586 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001587 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001588 #print "C: push\n";
1589 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001590 }
1591
1592 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001593}
1594
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001595sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001596 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001597 my $line;
1598 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001599 my $blk = '';
1600 my @o;
1601 my @c;
1602 my @res = ();
1603
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001604 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001605 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001606 for ($line = $start; $remain > 0; $line++) {
1607 next if ($rawlines[$line] =~ /^-/);
1608 $remain--;
1609
1610 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001611
1612 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001613 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001614 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001615 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001616 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001617 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001618 $level = pop(@stack);
1619 }
1620
Andy Whitcroft01464f32010-10-26 14:23:19 -07001621 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001622 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1623 if ($off > 0) {
1624 $off--;
1625 next;
1626 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001627
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001628 if ($c eq $close && $level > 0) {
1629 $level--;
1630 last if ($level == 0);
1631 } elsif ($c eq $open) {
1632 $level++;
1633 }
1634 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001635
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001636 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001637 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001638 }
1639
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001640 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001641 }
1642
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001643 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001644}
1645sub ctx_block_outer {
1646 my ($linenr, $remain) = @_;
1647
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001648 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1649 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001650}
1651sub ctx_block {
1652 my ($linenr, $remain) = @_;
1653
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001654 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1655 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001656}
1657sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001658 my ($linenr, $remain, $off) = @_;
1659
1660 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1661 return @r;
1662}
1663sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001664 my ($linenr, $remain) = @_;
1665
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001666 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001667}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001668sub ctx_statement_level {
1669 my ($linenr, $remain, $off) = @_;
1670
1671 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1672}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001673
1674sub ctx_locate_comment {
1675 my ($first_line, $end_line) = @_;
1676
1677 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001678 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001679 return $current_comment if (defined $current_comment);
1680
1681 # Look through the context and try and figure out if there is a
1682 # comment.
1683 my $in_comment = 0;
1684 $current_comment = '';
1685 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001686 my $line = $rawlines[$linenr - 1];
1687 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001688 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1689 $in_comment = 1;
1690 }
1691 if ($line =~ m@/\*@) {
1692 $in_comment = 1;
1693 }
1694 if (!$in_comment && $current_comment ne '') {
1695 $current_comment = '';
1696 }
1697 $current_comment .= $line . "\n" if ($in_comment);
1698 if ($line =~ m@\*/@) {
1699 $in_comment = 0;
1700 }
1701 }
1702
1703 chomp($current_comment);
1704 return($current_comment);
1705}
1706sub ctx_has_comment {
1707 my ($first_line, $end_line) = @_;
1708 my $cmt = ctx_locate_comment($first_line, $end_line);
1709
Andy Whitcroft00df3442007-06-08 13:47:06 -07001710 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001711 ##print "CMMT: $cmt\n";
1712
1713 return ($cmt ne '');
1714}
1715
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001716sub raw_line {
1717 my ($linenr, $cnt) = @_;
1718
1719 my $offset = $linenr - 1;
1720 $cnt++;
1721
1722 my $line;
1723 while ($cnt) {
1724 $line = $rawlines[$offset++];
1725 next if (defined($line) && $line =~ /^-/);
1726 $cnt--;
1727 }
1728
1729 return $line;
1730}
1731
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001732sub get_stat_real {
1733 my ($linenr, $lc) = @_;
1734
1735 my $stat_real = raw_line($linenr, 0);
1736 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1737 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1738 }
1739
1740 return $stat_real;
1741}
1742
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001743sub get_stat_here {
1744 my ($linenr, $cnt, $here) = @_;
1745
1746 my $herectx = $here . "\n";
1747 for (my $n = 0; $n < $cnt; $n++) {
1748 $herectx .= raw_line($linenr, $n) . "\n";
1749 }
1750
1751 return $herectx;
1752}
1753
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001754sub cat_vet {
1755 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001756 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001757
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001758 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001759 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1760 $res .= $1;
1761 if ($2 ne '') {
1762 $coded = sprintf("^%c", unpack('C', $2) + 64);
1763 $res .= $coded;
1764 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001765 }
1766 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001767
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001768 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001769}
1770
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001771my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001772my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001773my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001774my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001775
1776sub annotate_reset {
1777 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001778 $av_pending = '_';
1779 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001780 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001781}
1782
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001783sub annotate_values {
1784 my ($stream, $type) = @_;
1785
1786 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001787 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001788 my $cur = $stream;
1789
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001790 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001791
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001792 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001793 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001794 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001795 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001796 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001797 print "WS($1)\n" if ($dbg_values > 1);
1798 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001799 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001800 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001801 }
1802
Florian Micklerc023e4732011-01-12 16:59:58 -08001803 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001804 print "CAST($1)\n" if ($dbg_values > 1);
1805 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001806 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001807
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001808 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001809 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001810 $type = 'T';
1811
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001812 } elsif ($cur =~ /^($Modifier)\s*/) {
1813 print "MODIFIER($1)\n" if ($dbg_values > 1);
1814 $type = 'T';
1815
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001816 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001817 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001818 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001819 push(@av_paren_type, $type);
1820 if ($2 ne '') {
1821 $av_pending = 'N';
1822 }
1823 $type = 'E';
1824
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001825 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001826 print "UNDEF($1)\n" if ($dbg_values > 1);
1827 $av_preprocessor = 1;
1828 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001829
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001830 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001831 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001832 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001833
1834 push(@av_paren_type, $type);
1835 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001836 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001837
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001838 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001839 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1840 $av_preprocessor = 1;
1841
1842 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1843
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001844 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001845
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001846 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001847 print "PRE_END($1)\n" if ($dbg_values > 1);
1848
1849 $av_preprocessor = 1;
1850
1851 # Assume all arms of the conditional end as this
1852 # one does, and continue as if the #endif was not here.
1853 pop(@av_paren_type);
1854 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001855 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001856
1857 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001858 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001859
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001860 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1861 print "ATTR($1)\n" if ($dbg_values > 1);
1862 $av_pending = $type;
1863 $type = 'N';
1864
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001865 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001866 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001867 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001868 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001869 }
1870 $type = 'N';
1871
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001872 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001873 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001874 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001875 $type = 'N';
1876
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001877 } elsif ($cur =~/^(case)/o) {
1878 print "CASE($1)\n" if ($dbg_values > 1);
1879 $av_pend_colon = 'C';
1880 $type = 'N';
1881
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001882 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001883 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001884 $type = 'N';
1885
1886 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001887 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001888 push(@av_paren_type, $av_pending);
1889 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001890 $type = 'N';
1891
1892 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001893 my $new_type = pop(@av_paren_type);
1894 if ($new_type ne '_') {
1895 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001896 print "PAREN('$1') -> $type\n"
1897 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001898 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001899 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001900 }
1901
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001902 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001903 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001904 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001905 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001906
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001907 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1908 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001909 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001910 } elsif ($type eq 'E') {
1911 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001912 }
1913 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1914 $type = 'V';
1915
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001916 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001917 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001918 $type = 'V';
1919
1920 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001921 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001922 $type = 'N';
1923
Andy Whitcroftcf655042008-03-04 14:28:20 -08001924 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001925 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001926 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001927 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001928
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001929 } elsif ($cur =~/^(,)/) {
1930 print "COMMA($1)\n" if ($dbg_values > 1);
1931 $type = 'C';
1932
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001933 } elsif ($cur =~ /^(\?)/o) {
1934 print "QUESTION($1)\n" if ($dbg_values > 1);
1935 $type = 'N';
1936
1937 } elsif ($cur =~ /^(:)/o) {
1938 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1939
1940 substr($var, length($res), 1, $av_pend_colon);
1941 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1942 $type = 'E';
1943 } else {
1944 $type = 'N';
1945 }
1946 $av_pend_colon = 'O';
1947
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001948 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001949 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001950 $type = 'N';
1951
Andy Whitcroft0d413862008-10-15 22:02:16 -07001952 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001953 my $variant;
1954
1955 print "OPV($1)\n" if ($dbg_values > 1);
1956 if ($type eq 'V') {
1957 $variant = 'B';
1958 } else {
1959 $variant = 'U';
1960 }
1961
1962 substr($var, length($res), 1, $variant);
1963 $type = 'N';
1964
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001965 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001966 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001967 if ($1 ne '++' && $1 ne '--') {
1968 $type = 'N';
1969 }
1970
1971 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001972 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001973 }
1974 if (defined $1) {
1975 $cur = substr($cur, length($1));
1976 $res .= $type x length($1);
1977 }
1978 }
1979
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001980 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001981}
1982
Andy Whitcroft8905a672007-11-28 16:21:06 -08001983sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001984 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001985 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001986 ^(?:
1987 $Modifier|
1988 $Storage|
1989 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001990 DEFINE_\S+
1991 )$|
1992 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001993 goto|
1994 return|
1995 case|
1996 else|
1997 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001998 do|
1999 \#|
2000 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002001 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07002002 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002003 )}x;
2004 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2005 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002006 # Check for modifiers.
2007 $possible =~ s/\s*$Storage\s*//g;
2008 $possible =~ s/\s*$Sparse\s*//g;
2009 if ($possible =~ /^\s*$/) {
2010
2011 } elsif ($possible =~ /\s/) {
2012 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07002013 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002014 if ($modifier !~ $notPermitted) {
2015 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002016 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002017 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07002018 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002019
2020 } else {
2021 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002022 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002023 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002024 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07002025 } else {
2026 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002027 }
2028}
2029
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002030my $prefix = '';
2031
Joe Perches000d1cc12011-07-25 17:13:25 -07002032sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07002033 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002034
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002035 $type =~ tr/[a-z]/[A-Z]/;
2036
Joe Perchescbec18a2014-04-03 14:49:19 -07002037 return defined $use_type{$type} if (scalar keys %use_type > 0);
2038
2039 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002040}
2041
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002042sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002043 my ($level, $type, $msg) = @_;
2044
2045 if (!show_type($type) ||
2046 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002047 return 0;
2048 }
Joe Perches57230292015-06-25 15:03:03 -07002049 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002050 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002051 if ($level eq 'ERROR') {
2052 $output .= RED;
2053 } elsif ($level eq 'WARNING') {
2054 $output .= YELLOW;
2055 } else {
2056 $output .= GREEN;
2057 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002058 }
Joe Perches57230292015-06-25 15:03:03 -07002059 $output .= $prefix . $level . ':';
2060 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002061 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002062 $output .= "$type:";
2063 }
John Brooks737c0762017-07-10 15:52:24 -07002064 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002065 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002066
2067 if ($showfile) {
2068 my @lines = split("\n", $output, -1);
2069 splice(@lines, 1, 1);
2070 $output = join("\n", @lines);
2071 }
Joe Perches57230292015-06-25 15:03:03 -07002072 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002073
Joe Perches57230292015-06-25 15:03:03 -07002074 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002075
2076 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002077}
Joe Perchescbec18a2014-04-03 14:49:19 -07002078
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002079sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002080 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002081}
Joe Perches000d1cc12011-07-25 17:13:25 -07002082
Joe Perchesd752fcc2014-08-06 16:11:05 -07002083sub fixup_current_range {
2084 my ($lineRef, $offset, $length) = @_;
2085
2086 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2087 my $o = $1;
2088 my $l = $2;
2089 my $no = $o + $offset;
2090 my $nl = $l + $length;
2091 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2092 }
2093}
2094
2095sub fix_inserted_deleted_lines {
2096 my ($linesRef, $insertedRef, $deletedRef) = @_;
2097
2098 my $range_last_linenr = 0;
2099 my $delta_offset = 0;
2100
2101 my $old_linenr = 0;
2102 my $new_linenr = 0;
2103
2104 my $next_insert = 0;
2105 my $next_delete = 0;
2106
2107 my @lines = ();
2108
2109 my $inserted = @{$insertedRef}[$next_insert++];
2110 my $deleted = @{$deletedRef}[$next_delete++];
2111
2112 foreach my $old_line (@{$linesRef}) {
2113 my $save_line = 1;
2114 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002115 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002116 $delta_offset = 0;
2117 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2118 $range_last_linenr = $new_linenr;
2119 fixup_current_range(\$line, $delta_offset, 0);
2120 }
2121
2122 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2123 $deleted = @{$deletedRef}[$next_delete++];
2124 $save_line = 0;
2125 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2126 }
2127
2128 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2129 push(@lines, ${$inserted}{'LINE'});
2130 $inserted = @{$insertedRef}[$next_insert++];
2131 $new_linenr++;
2132 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2133 }
2134
2135 if ($save_line) {
2136 push(@lines, $line);
2137 $new_linenr++;
2138 }
2139
2140 $old_linenr++;
2141 }
2142
2143 return @lines;
2144}
2145
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002146sub fix_insert_line {
2147 my ($linenr, $line) = @_;
2148
2149 my $inserted = {
2150 LINENR => $linenr,
2151 LINE => $line,
2152 };
2153 push(@fixed_inserted, $inserted);
2154}
2155
2156sub fix_delete_line {
2157 my ($linenr, $line) = @_;
2158
2159 my $deleted = {
2160 LINENR => $linenr,
2161 LINE => $line,
2162 };
2163
2164 push(@fixed_deleted, $deleted);
2165}
2166
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002167sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002168 my ($type, $msg) = @_;
2169
2170 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002171 our $clean = 0;
2172 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002173 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002174 }
Joe Perches3705ce52013-07-03 15:05:31 -07002175 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002176}
2177sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002178 my ($type, $msg) = @_;
2179
2180 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002181 our $clean = 0;
2182 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002183 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002184 }
Joe Perches3705ce52013-07-03 15:05:31 -07002185 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002186}
2187sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002188 my ($type, $msg) = @_;
2189
2190 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002191 our $clean = 0;
2192 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002193 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002194 }
Joe Perches3705ce52013-07-03 15:05:31 -07002195 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002196}
2197
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002198sub check_absolute_file {
2199 my ($absolute, $herecurr) = @_;
2200 my $file = $absolute;
2201
2202 ##print "absolute<$absolute>\n";
2203
2204 # See if any suffix of this path is a path within the tree.
2205 while ($file =~ s@^[^/]*/@@) {
2206 if (-f "$root/$file") {
2207 ##print "file<$file>\n";
2208 last;
2209 }
2210 }
2211 if (! -f _) {
2212 return 0;
2213 }
2214
2215 # It is, so see if the prefix is acceptable.
2216 my $prefix = $absolute;
2217 substr($prefix, -length($file)) = '';
2218
2219 ##print "prefix<$prefix>\n";
2220 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002221 WARN("USE_RELATIVE_PATH",
2222 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002223 }
2224}
2225
Joe Perches3705ce52013-07-03 15:05:31 -07002226sub trim {
2227 my ($string) = @_;
2228
Joe Perchesb34c6482013-09-11 14:24:01 -07002229 $string =~ s/^\s+|\s+$//g;
2230
2231 return $string;
2232}
2233
2234sub ltrim {
2235 my ($string) = @_;
2236
2237 $string =~ s/^\s+//;
2238
2239 return $string;
2240}
2241
2242sub rtrim {
2243 my ($string) = @_;
2244
2245 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002246
2247 return $string;
2248}
2249
Joe Perches52ea8502013-11-12 15:10:09 -08002250sub string_find_replace {
2251 my ($string, $find, $replace) = @_;
2252
2253 $string =~ s/$find/$replace/g;
2254
2255 return $string;
2256}
2257
Joe Perches3705ce52013-07-03 15:05:31 -07002258sub tabify {
2259 my ($leading) = @_;
2260
Antonio Borneo713a09d2020-04-06 20:11:07 -07002261 my $source_indent = $tabsize;
Joe Perches3705ce52013-07-03 15:05:31 -07002262 my $max_spaces_before_tab = $source_indent - 1;
2263 my $spaces_to_tab = " " x $source_indent;
2264
2265 #convert leading spaces to tabs
2266 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2267 #Remove spaces before a tab
2268 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2269
2270 return "$leading";
2271}
2272
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002273sub pos_last_openparen {
2274 my ($line) = @_;
2275
2276 my $pos = 0;
2277
2278 my $opens = $line =~ tr/\(/\(/;
2279 my $closes = $line =~ tr/\)/\)/;
2280
2281 my $last_openparen = 0;
2282
2283 if (($opens == 0) || ($closes >= $opens)) {
2284 return -1;
2285 }
2286
2287 my $len = length($line);
2288
2289 for ($pos = 0; $pos < $len; $pos++) {
2290 my $string = substr($line, $pos);
2291 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2292 $pos += length($1) - 1;
2293 } elsif (substr($line, $pos, 1) eq '(') {
2294 $last_openparen = $pos;
2295 } elsif (index($string, '(') == -1) {
2296 last;
2297 }
2298 }
2299
Joe Perches91cb5192014-04-03 14:49:32 -07002300 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002301}
2302
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002303sub get_raw_comment {
2304 my ($line, $rawline) = @_;
2305 my $comment = '';
2306
2307 for my $i (0 .. (length($line) - 1)) {
2308 if (substr($line, $i, 1) eq "$;") {
2309 $comment .= substr($rawline, $i, 1);
2310 }
2311 }
2312
2313 return $comment;
2314}
2315
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002316sub process {
2317 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002318
2319 my $linenr=0;
2320 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002321 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002322 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002323 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002324
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002325 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002326 my $indent;
2327 my $previndent=0;
2328 my $stashindent=0;
2329
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002330 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002331 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002332 my $author = '';
2333 my $authorsignoff = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002334 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002335 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002336 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002337 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches44d303e2020-04-06 20:11:10 -07002338 my $has_patch_separator = 0; #Found a --- line
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002339 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002340 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002341 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002342 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002343 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002344 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002345 my $non_utf8_charset = 0;
2346
Joe Perches365dd4e2014-08-06 16:10:42 -07002347 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002348 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002349
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002350 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002351 our $cnt_lines = 0;
2352 our $cnt_error = 0;
2353 our $cnt_warn = 0;
2354 our $cnt_chk = 0;
2355
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002356 # Trace the real file/line as we go.
2357 my $realfile = '';
2358 my $realline = 0;
2359 my $realcnt = 0;
2360 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002361 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002362 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002363 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002364 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002365 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002366
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002367 my $prev_values = 'E';
2368
2369 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002370 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002371 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002372 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002373 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002374
Joe Perches7e51f192013-09-11 14:23:57 -07002375 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002376
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002377 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002378 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002379 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002380 my @setup_docs = ();
2381 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002382
Joe Perchesd8b07712013-11-12 15:10:06 -08002383 my $camelcase_file_seeded = 0;
2384
Rob Herring9f3a8992018-04-10 16:33:13 -07002385 my $checklicenseline = 1;
2386
Andy Whitcroft773647a2008-03-28 14:15:58 -07002387 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002388 my $line;
2389 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002390 $linenr++;
2391 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002392
Joe Perches3705ce52013-07-03 15:05:31 -07002393 push(@fixed, $rawline) if ($fix);
2394
Andy Whitcroft773647a2008-03-28 14:15:58 -07002395 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002396 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002397 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002398 $setup_docs = 1;
2399 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002400 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002401 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002402 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002403 $realline=$1-1;
2404 if (defined $2) {
2405 $realcnt=$3+1;
2406 } else {
2407 $realcnt=1+1;
2408 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002409 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002410
2411 # Guestimate if this is a continuing comment. Run
2412 # the context looking for a comment "edge". If this
2413 # edge is a close comment then we must be in a comment
2414 # at context start.
2415 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002416 my $cnt = $realcnt;
2417 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2418 next if (defined $rawlines[$ln - 1] &&
2419 $rawlines[$ln - 1] =~ /^-/);
2420 $cnt--;
2421 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002422 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002423 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2424 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2425 ($edge) = $1;
2426 last;
2427 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002428 }
2429 if (defined $edge && $edge eq '*/') {
2430 $in_comment = 1;
2431 }
2432
2433 # Guestimate if this is a continuing comment. If this
2434 # is the start of a diff block and this line starts
2435 # ' *' then it is very likely a comment.
2436 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002437 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002438 {
2439 $in_comment = 1;
2440 }
2441
2442 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2443 sanitise_line_reset($in_comment);
2444
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002445 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002446 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002447 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002448 $line = sanitise_line($rawline);
2449 }
2450 push(@lines, $line);
2451
2452 if ($realcnt > 1) {
2453 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2454 } else {
2455 $realcnt = 0;
2456 }
2457
2458 #print "==>$rawline\n";
2459 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002460
2461 if ($setup_docs && $line =~ /^\+/) {
2462 push(@setup_docs, $line);
2463 }
2464 }
2465
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002466 $prefix = '';
2467
Andy Whitcroft773647a2008-03-28 14:15:58 -07002468 $realcnt = 0;
2469 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002470 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002471 foreach my $line (@lines) {
2472 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002473 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002474 my $sline = $line; #copy of $line
2475 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002476
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002477 my $rawline = $rawlines[$linenr - 1];
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002478 my $raw_comment = get_raw_comment($line, $rawline);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002479
Joe Perches12c253a2018-06-07 17:10:58 -07002480# check if it's a mode change, rename or start of a patch
2481 if (!$in_commit_log &&
2482 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2483 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2484 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2485 $is_patch = 1;
2486 }
2487
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002488#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002489 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002490 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2491 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002492 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002493 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002494 $realline=$1-1;
2495 if (defined $2) {
2496 $realcnt=$3+1;
2497 } else {
2498 $realcnt=1+1;
2499 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002500 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002501 $prev_values = 'E';
2502
Andy Whitcroft773647a2008-03-28 14:15:58 -07002503 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002504 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002505 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002506 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002507 if ($context =~ /\b(\w+)\s*\(/) {
2508 $context_function = $1;
2509 } else {
2510 undef $context_function;
2511 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002512 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002513
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002514# track the line number as we move through the hunk, note that
2515# new versions of GNU diff omit the leading space on completely
2516# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002517 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002518 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002519 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002520
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002521 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002522 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002523
2524 # Track the previous line.
2525 ($prevline, $stashline) = ($stashline, $line);
2526 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002527 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2528
Andy Whitcroft773647a2008-03-28 14:15:58 -07002529 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002530
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002531 } elsif ($realcnt == 1) {
2532 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002533 }
2534
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002535 my $hunk_line = ($realcnt != 0);
2536
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002537 $here = "#$linenr: " if (!$file);
2538 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002539
Joe Perches2ac73b42014-06-04 16:12:05 -07002540 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002541 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002542 if ($line =~ /^diff --git.*?(\S+)$/) {
2543 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002544 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002545 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002546 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002547 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002548 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002549 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002550 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002551
2552 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002553 if (!$file && $tree && $p1_prefix ne '' &&
2554 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002555 WARN("PATCH_PREFIX",
2556 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002557 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002558
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002559 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002560 ERROR("MODIFIED_INCLUDE_ASM",
2561 "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 -07002562 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002563 $found_file = 1;
2564 }
2565
Joe Perches34d88152015-06-25 15:03:05 -07002566#make up the handle for any error we report on this line
2567 if ($showfile) {
2568 $prefix = "$realfile:$realline: "
2569 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002570 if ($file) {
2571 $prefix = "$filename:$realline: ";
2572 } else {
2573 $prefix = "$filename:$linenr: ";
2574 }
Joe Perches34d88152015-06-25 15:03:05 -07002575 }
2576
Joe Perches2ac73b42014-06-04 16:12:05 -07002577 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002578 if (is_maintained_obsolete($realfile)) {
2579 WARN("OBSOLETE",
2580 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2581 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002582 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002583 $check = 1;
2584 } else {
2585 $check = $check_orig;
2586 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002587 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002588
2589 if ($realfile !~ /^MAINTAINERS/) {
2590 my $last_binding_patch = $is_binding_patch;
2591
2592 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2593
2594 if (($last_binding_patch != -1) &&
2595 ($last_binding_patch ^ $is_binding_patch)) {
2596 WARN("DT_SPLIT_BINDING_PATCH",
2597 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2598 }
2599 }
2600
Andy Whitcroft773647a2008-03-28 14:15:58 -07002601 next;
2602 }
2603
Randy Dunlap389834b2007-06-08 13:47:03 -07002604 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002605
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002606 my $hereline = "$here\n$rawline\n";
2607 my $herecurr = "$here\n$rawline\n";
2608 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002609
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002610 $cnt_lines++ if ($realcnt != 0);
2611
Joe Perches490b2922018-08-21 21:58:01 -07002612# Verify the existence of a commit log if appropriate
2613# 2 is used because a $signature is counted in $commit_log_lines
2614 if ($in_commit_log) {
2615 if ($line !~ /^\s*$/) {
2616 $commit_log_lines++; #could be a $signature
2617 }
2618 } elsif ($has_commit_log && $commit_log_lines < 2) {
2619 WARN("COMMIT_MESSAGE",
2620 "Missing commit description - Add an appropriate one\n");
2621 $commit_log_lines = 2; #warn only once
2622 }
2623
Joe Perchese518e9a2015-06-25 15:03:27 -07002624# Check if the commit log has what seems like a diff which can confuse patch
2625 if ($in_commit_log && !$commit_log_has_diff &&
2626 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2627 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2628 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2629 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2630 ERROR("DIFF_IN_COMMIT_MSG",
2631 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2632 $commit_log_has_diff = 1;
2633 }
2634
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002635# Check for incorrect file permissions
2636 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2637 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002638 if ($realfile !~ m@scripts/@ &&
2639 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002640 ERROR("EXECUTE_PERMISSIONS",
2641 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002642 }
2643 }
2644
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002645# Check the patch for a From:
2646 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2647 $author = $1;
2648 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2649 $author =~ s/"//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07002650 $author = reformat_email($author);
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002651 }
2652
Joe Perches20112472011-07-25 17:13:23 -07002653# Check the patch for a signoff:
Joe Perchesdfa05c22020-04-06 20:10:48 -07002654 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002655 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002656 $in_commit_log = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002657 if ($author ne '') {
Joe Perchesdfa05c22020-04-06 20:10:48 -07002658 if (same_email_addresses($1, $author)) {
2659 $authorsignoff = 1;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002660 }
2661 }
Joe Perches20112472011-07-25 17:13:23 -07002662 }
2663
Joe Perches44d303e2020-04-06 20:11:10 -07002664# Check for patch separator
2665 if ($line =~ /^---$/) {
2666 $has_patch_separator = 1;
2667 $in_commit_log = 0;
2668 }
2669
Joe Perchese0d975b2014-12-10 15:51:49 -08002670# Check if MAINTAINERS is being updated. If so, there's probably no need to
2671# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2672 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2673 $reported_maintainer_file = 1;
2674 }
2675
Joe Perches20112472011-07-25 17:13:23 -07002676# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002677 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002678 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002679 my $space_before = $1;
2680 my $sign_off = $2;
2681 my $space_after = $3;
2682 my $email = $4;
2683 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2684
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002685 if ($sign_off !~ /$signature_tags/) {
2686 WARN("BAD_SIGN_OFF",
2687 "Non-standard signature: $sign_off\n" . $herecurr);
2688 }
Joe Perches20112472011-07-25 17:13:23 -07002689 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002690 if (WARN("BAD_SIGN_OFF",
2691 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2692 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002693 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002694 "$ucfirst_sign_off $email";
2695 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002696 }
Joe Perches20112472011-07-25 17:13:23 -07002697 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002698 if (WARN("BAD_SIGN_OFF",
2699 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2700 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002701 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002702 "$ucfirst_sign_off $email";
2703 }
2704
Joe Perches20112472011-07-25 17:13:23 -07002705 }
2706 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002707 if (WARN("BAD_SIGN_OFF",
2708 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2709 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002710 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002711 "$ucfirst_sign_off $email";
2712 }
Joe Perches20112472011-07-25 17:13:23 -07002713 }
2714
Joe Perchesdfa05c22020-04-06 20:10:48 -07002715 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Joe Perches20112472011-07-25 17:13:23 -07002716 my $suggested_email = format_email(($email_name, $email_address));
2717 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002718 ERROR("BAD_SIGN_OFF",
2719 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002720 } else {
2721 my $dequoted = $suggested_email;
2722 $dequoted =~ s/^"//;
2723 $dequoted =~ s/" </ </;
2724 # Don't force email to have quotes
2725 # Allow just an angle bracketed address
Joe Perchesdfa05c22020-04-06 20:10:48 -07002726 if (!same_email_addresses($email, $suggested_email)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002727 WARN("BAD_SIGN_OFF",
2728 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002729 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002730 }
Joe Perches7e51f192013-09-11 14:23:57 -07002731
2732# Check for duplicate signatures
2733 my $sig_nospace = $line;
2734 $sig_nospace =~ s/\s//g;
2735 $sig_nospace = lc($sig_nospace);
2736 if (defined $signatures{$sig_nospace}) {
2737 WARN("BAD_SIGN_OFF",
2738 "Duplicate signature\n" . $herecurr);
2739 } else {
2740 $signatures{$sig_nospace} = 1;
2741 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07002742
2743# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2744 if ($sign_off =~ /^co-developed-by:$/i) {
2745 if ($email eq $author) {
2746 WARN("BAD_SIGN_OFF",
2747 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2748 }
2749 if (!defined $lines[$linenr]) {
2750 WARN("BAD_SIGN_OFF",
2751 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2752 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2753 WARN("BAD_SIGN_OFF",
2754 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2755 } elsif ($1 ne $email) {
2756 WARN("BAD_SIGN_OFF",
2757 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2758 }
2759 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002760 }
2761
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002762# Check email subject for common tools that don't need to be mentioned
2763 if ($in_header_lines &&
2764 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2765 WARN("EMAIL_SUBJECT",
2766 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2767 }
2768
Joe Perches44d303e2020-04-06 20:11:10 -07002769# Check for Gerrit Change-Ids not in any patch context
2770 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002771 ERROR("GERRIT_CHANGE_ID",
Joe Perches44d303e2020-04-06 20:11:10 -07002772 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002773 }
2774
Joe Perches369c8dd2015-11-06 16:31:34 -08002775# Check if the commit log is in a possible stack dump
2776 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2777 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2778 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2779 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07002780 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2781 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2782 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2783 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08002784 $commit_log_possible_stack_dump = 1;
2785 }
2786
Joe Perches2a076f42015-04-16 12:44:28 -07002787# Check for line lengths > 75 in commit log, warn once
2788 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002789 length($line) > 75 &&
2790 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2791 # file delta changes
2792 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2793 # filename then :
2794 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2795 # A Fixes: or Link: line
2796 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002797 WARN("COMMIT_LOG_LONG_LINE",
2798 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2799 $commit_log_long_line = 1;
2800 }
2801
Joe Perchesbf4daf12015-09-09 15:37:50 -07002802# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002803 if ($in_commit_log && $commit_log_possible_stack_dump &&
2804 $line =~ /^\s*$/) {
2805 $commit_log_possible_stack_dump = 0;
2806 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002807
Joe Perches0d7835f2015-02-13 14:38:35 -08002808# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002809 if ($in_commit_log && !$commit_log_possible_stack_dump &&
John Hubbarda8972572020-04-06 20:10:55 -07002810 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002811 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002812 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002813 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002814 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2815 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002816 my $init_char = "c";
2817 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002818 my $short = 1;
2819 my $long = 0;
2820 my $case = 1;
2821 my $space = 1;
2822 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002823 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002824 my $id = '0123456789ab';
2825 my $orig_desc = "commit description";
2826 my $description = "";
2827
Joe Perchesfe043ea2015-09-09 15:37:25 -07002828 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2829 $init_char = $1;
2830 $orig_commit = lc($2);
2831 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2832 $orig_commit = lc($1);
2833 }
2834
Joe Perches0d7835f2015-02-13 14:38:35 -08002835 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2836 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2837 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2838 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2839 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2840 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002841 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002842 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2843 defined $rawlines[$linenr] &&
2844 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2845 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002846 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002847 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2848 defined $rawlines[$linenr] &&
2849 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2850 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2851 $orig_desc = $1;
2852 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2853 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002854 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002855 }
2856
2857 ($id, $description) = git_commit_info($orig_commit,
2858 $id, $orig_desc);
2859
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002860 if (defined($id) &&
2861 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002862 ERROR("GIT_COMMIT_ID",
2863 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2864 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002865 }
2866
Joe Perches13f19372014-08-06 16:10:59 -07002867# Check for added, moved or deleted files
2868 if (!$reported_maintainer_file && !$in_commit_log &&
2869 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2870 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2871 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2872 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002873 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002874 $reported_maintainer_file = 1;
2875 WARN("FILE_PATH_CHANGES",
2876 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2877 }
2878
Rob Herringe400edb2019-09-12 15:18:20 +01002879# Check for adding new DT bindings not in schema format
2880 if (!$in_commit_log &&
2881 ($line =~ /^new file mode\s*\d+\s*$/) &&
2882 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2883 WARN("DT_SCHEMA_BINDING_PATCH",
2884 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2885 }
2886
Andy Whitcroft00df3442007-06-08 13:47:06 -07002887# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002888 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002889 ERROR("CORRUPTED_PATCH",
2890 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002891 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002892 }
2893
2894# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2895 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002896 $rawline !~ m/^$UTF8*$/) {
2897 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2898
2899 my $blank = copy_spacing($rawline);
2900 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2901 my $hereptr = "$hereline$ptr\n";
2902
Joe Perches34d99212011-07-25 17:13:26 -07002903 CHK("INVALID_UTF8",
2904 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002905 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002906
Joe Perches15662b32011-10-31 17:13:12 -07002907# Check if it's the start of a commit log
2908# (not a header line and we haven't seen the patch filename)
2909 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002910 !($rawline =~ /^\s+(?:\S|$)/ ||
2911 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002912 $in_header_lines = 0;
2913 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002914 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002915 }
2916
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002917# Check if there is UTF-8 in a commit log when a mail header has explicitly
2918# declined it, i.e defined some charset where it is missing.
2919 if ($in_header_lines &&
2920 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2921 $1 !~ /utf-8/i) {
2922 $non_utf8_charset = 1;
2923 }
2924
2925 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002926 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002927 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002928 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2929 }
2930
Joe Perchesd6430f72016-12-12 16:46:28 -08002931# Check for absolute kernel paths in commit message
2932 if ($tree && $in_commit_log) {
2933 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2934 my $file = $1;
2935
2936 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2937 check_absolute_file($1, $herecurr)) {
2938 #
2939 } else {
2940 check_absolute_file($file, $herecurr);
2941 }
2942 }
2943 }
2944
Kees Cook66b47b42014-10-13 15:51:57 -07002945# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002946 if (defined($misspellings) &&
2947 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002948 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002949 my $typo = $1;
2950 my $typo_fix = $spelling_fix{lc($typo)};
2951 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2952 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002953 my $msg_level = \&WARN;
2954 $msg_level = \&CHK if ($file);
2955 if (&{$msg_level}("TYPO_SPELLING",
2956 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002957 $fix) {
2958 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2959 }
2960 }
2961 }
2962
Matteo Crocea8dd86b2019-09-25 16:46:38 -07002963# check for invalid commit id
2964 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2965 my $id;
2966 my $description;
2967 ($id, $description) = git_commit_info($2, undef, undef);
2968 if (!defined($id)) {
2969 WARN("UNKNOWN_COMMIT_ID",
2970 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2971 }
2972 }
2973
Andy Whitcroft306708542008-10-15 22:02:28 -07002974# ignore non-hunk lines and lines being removed
2975 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002976
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002977#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002978 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002979 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002980 if (ERROR("DOS_LINE_ENDINGS",
2981 "DOS line endings\n" . $herevet) &&
2982 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002983 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002984 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002985 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2986 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002987 if (ERROR("TRAILING_WHITESPACE",
2988 "trailing whitespace\n" . $herevet) &&
2989 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002990 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002991 }
2992
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002993 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002994 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002995
Josh Triplett4783f892013-11-12 15:10:12 -08002996# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002997 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002998 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002999 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3000 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08003001 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07003002 my $msg_level = \&ERROR;
3003 $msg_level = \&CHK if ($file);
3004 &{$msg_level}("FSF_MAILING_ADDRESS",
3005 "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 -08003006 }
3007
Andi Kleen33549572010-05-24 14:33:29 -07003008# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003009# Only applies when adding the entry originally, after that we do not have
3010# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07003011 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01003012 # 'choice' is usually the last thing on the line (though
3013 # Kconfig supports named choices), so use a word boundary
3014 # (\b) rather than a whitespace character (\s)
3015 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07003016 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003017 my $cnt = $realcnt;
3018 my $ln = $linenr + 1;
3019 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003020 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003021 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003022 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003023 $f = $lines[$ln - 1];
3024 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3025 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003026
3027 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07003028 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08003029
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01003030 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003031 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01003032 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
3033 if ($lines[$ln - 1] =~ "---help---") {
3034 WARN("CONFIG_DESCRIPTION",
3035 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
3036 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003037 $length = -1;
3038 }
3039
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003040 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07003041 $f =~ s/#.*//;
3042 $f =~ s/^\s+//;
3043 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01003044
3045 # This only checks context lines in the patch
3046 # and so hopefully shouldn't trigger false
3047 # positives, even though some of these are
3048 # common words in help texts
3049 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3050 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003051 $is_end = 1;
3052 last;
3053 }
Andi Kleen33549572010-05-24 14:33:29 -07003054 $length++;
3055 }
Vadim Bendebury56193272014-10-13 15:51:48 -07003056 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3057 WARN("CONFIG_DESCRIPTION",
3058 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3059 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003060 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003061 }
3062
Joe Perches628f91a2017-07-10 15:52:07 -07003063# check for MAINTAINERS entries that don't have the right form
3064 if ($realfile =~ /^MAINTAINERS$/ &&
3065 $rawline =~ /^\+[A-Z]:/ &&
3066 $rawline !~ /^\+[A-Z]:\t\S/) {
3067 if (WARN("MAINTAINERS_STYLE",
3068 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3069 $fix) {
3070 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3071 }
3072 }
3073
Christoph Jaeger327953e2015-02-13 14:38:29 -08003074# discourage the use of boolean for type definition attributes of Kconfig options
3075 if ($realfile =~ /Kconfig/ &&
3076 $line =~ /^\+\s*\bboolean\b/) {
3077 WARN("CONFIG_TYPE_BOOLEAN",
3078 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3079 }
3080
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003081 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3082 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3083 my $flag = $1;
3084 my $replacement = {
3085 'EXTRA_AFLAGS' => 'asflags-y',
3086 'EXTRA_CFLAGS' => 'ccflags-y',
3087 'EXTRA_CPPFLAGS' => 'cppflags-y',
3088 'EXTRA_LDFLAGS' => 'ldflags-y',
3089 };
3090
3091 WARN("DEPRECATED_VARIABLE",
3092 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3093 }
3094
Rob Herringbff5da42014-01-23 15:54:51 -08003095# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003096 if (defined $root &&
3097 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3098 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3099
Rob Herringbff5da42014-01-23 15:54:51 -08003100 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3101
Florian Vaussardcc933192014-04-03 14:49:27 -07003102 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003103 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003104
Rob Herringbff5da42014-01-23 15:54:51 -08003105 foreach my $compat (@compats) {
3106 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003107 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3108 my $compat3 = $compat;
3109 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3110 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003111 if ( $? >> 8 ) {
3112 WARN("UNDOCUMENTED_DT_STRING",
3113 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3114 }
3115
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003116 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3117 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003118 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003119 if ( $? >> 8 ) {
3120 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003121 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003122 }
3123 }
3124 }
3125
Rob Herring9f3a8992018-04-10 16:33:13 -07003126# check for using SPDX license tag at beginning of files
3127 if ($realline == $checklicenseline) {
3128 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3129 $checklicenseline = 2;
3130 } elsif ($rawline =~ /^\+/) {
3131 my $comment = "";
3132 if ($realfile =~ /\.(h|s|S)$/) {
3133 $comment = '/*';
3134 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3135 $comment = '//';
Lubomir Rintelc8df0ab2020-04-06 20:10:51 -07003136 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003137 $comment = '#';
3138 } elsif ($realfile =~ /\.rst$/) {
3139 $comment = '..';
3140 }
3141
Joe Perchesfdf13692019-03-07 16:28:32 -08003142# check SPDX comment style for .[chsS] files
3143 if ($realfile =~ /\.[chsS]$/ &&
3144 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003145 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003146 WARN("SPDX_LICENSE_TAG",
3147 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3148 }
3149
Rob Herring9f3a8992018-04-10 16:33:13 -07003150 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003151 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3152 WARN("SPDX_LICENSE_TAG",
3153 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003154 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003155 my $spdx_license = $1;
3156 if (!is_SPDX_License_valid($spdx_license)) {
3157 WARN("SPDX_LICENSE_TAG",
3158 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3159 }
Lubomir Rintel50c92902020-04-06 20:11:13 -07003160 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3161 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3162 my $msg_level = \&WARN;
3163 $msg_level = \&CHK if ($file);
3164 if (&{$msg_level}("SPDX_LICENSE_TAG",
3165
3166 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3167 $fix) {
3168 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3169 }
3170 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003171 }
3172 }
3173 }
3174
Andy Whitcroft5368df202008-10-15 22:02:27 -07003175# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003176 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003177
Joe Perchesa8da38a2019-03-07 16:28:42 -08003178# check for using SPDX-License-Identifier on the wrong line number
3179 if ($realline != $checklicenseline &&
3180 $rawline =~ /\bSPDX-License-Identifier:/ &&
3181 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3182 WARN("SPDX_LICENSE_TAG",
3183 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3184 }
3185
Joe Perches47e0c882015-06-25 15:02:57 -07003186# line length limit (with some exclusions)
3187#
3188# There are a few types of lines that may extend beyond $max_line_length:
3189# logging functions like pr_info that end in a string
3190# lines with a single string
3191# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003192# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003193#
3194# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003195# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003196# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3197# LONG_LINE all other lines longer than $max_line_length
3198#
3199# if LONG_LINE is ignored, the other 2 types are also ignored
3200#
3201
Joe Perchesb4749e92015-07-17 16:24:01 -07003202 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003203 my $msg_type = "LONG_LINE";
3204
3205 # Check the allowed long line types first
3206
3207 # logging functions that end in a string that starts
3208 # before $max_line_length
3209 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3210 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3211 $msg_type = "";
3212
3213 # lines with only strings (w/ possible termination)
3214 # #defines with only strings
3215 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3216 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3217 $msg_type = "";
3218
Joe Perchescc147502017-11-17 15:28:44 -08003219 # More special cases
3220 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3221 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003222 $msg_type = "";
3223
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003224 # URL ($rawline is used in case the URL is in a comment)
3225 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3226 $msg_type = "";
3227
Joe Perches47e0c882015-06-25 15:02:57 -07003228 # Otherwise set the alternate message types
3229
3230 # a comment starts before $max_line_length
3231 } elsif ($line =~ /($;[\s$;]*)$/ &&
3232 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3233 $msg_type = "LONG_LINE_COMMENT"
3234
3235 # a quoted string starts before $max_line_length
3236 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3237 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3238 $msg_type = "LONG_LINE_STRING"
3239 }
3240
3241 if ($msg_type ne "" &&
3242 (show_type("LONG_LINE") || show_type($msg_type))) {
3243 WARN($msg_type,
3244 "line over $max_line_length characters\n" . $herecurr);
3245 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003246 }
3247
Andy Whitcroft8905a672007-11-28 16:21:06 -08003248# check for adding lines without a newline.
3249 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003250 WARN("MISSING_EOF_NEWLINE",
3251 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003252 }
3253
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003254# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003255 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003256
3257# at the beginning of a line any tabs must come first and anything
Antonio Borneo713a09d2020-04-06 20:11:07 -07003258# more than $tabsize must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003259 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3260 $rawline =~ /^\+\s* \s*/) {
3261 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003262 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003263 if (ERROR("CODE_INDENT",
3264 "code indent should use tabs where possible\n" . $herevet) &&
3265 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003266 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003267 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003268 }
3269
Alberto Panizzo08e44362010-03-05 13:43:54 -08003270# check for space before tabs.
3271 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3272 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003273 if (WARN("SPACE_BEFORE_TAB",
3274 "please, no space before tabs\n" . $herevet) &&
3275 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003276 while ($fixed[$fixlinenr] =~
Antonio Borneo713a09d2020-04-06 20:11:07 -07003277 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003278 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003279 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003280 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003281 }
3282
Joe Perches6a487212018-04-10 16:34:04 -07003283# check for assignments on the start of a line
3284 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3285 CHK("ASSIGNMENT_CONTINUATIONS",
3286 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3287 }
3288
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003289# check for && or || at the start of a line
3290 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3291 CHK("LOGICAL_CONTINUATIONS",
3292 "Logical continuations should be on the previous line\n" . $hereprev);
3293 }
3294
Joe Perchesa91e8992016-05-20 17:04:05 -07003295# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003296 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003297 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003298 my $indent = length($1);
Antonio Borneo713a09d2020-04-06 20:11:07 -07003299 if ($indent % $tabsize) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003300 if (WARN("TABSTOP",
3301 "Statements should start on a tabstop\n" . $herecurr) &&
3302 $fix) {
Antonio Borneo713a09d2020-04-06 20:11:07 -07003303 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
Joe Perchesa91e8992016-05-20 17:04:05 -07003304 }
3305 }
3306 }
3307
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003308# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003309 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003310 $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 -07003311 $prevline =~ /^\+(\t*)(.*)$/;
3312 my $oldindent = $1;
3313 my $rest = $2;
3314
3315 my $pos = pos_last_openparen($rest);
3316 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003317 $line =~ /^(\+| )([ \t]*)/;
3318 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003319
3320 my $goodtabindent = $oldindent .
Antonio Borneo713a09d2020-04-06 20:11:07 -07003321 "\t" x ($pos / $tabsize) .
3322 " " x ($pos % $tabsize);
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003323 my $goodspaceindent = $oldindent . " " x $pos;
3324
3325 if ($newindent ne $goodtabindent &&
3326 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003327
3328 if (CHK("PARENTHESIS_ALIGNMENT",
3329 "Alignment should match open parenthesis\n" . $hereprev) &&
3330 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003331 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003332 s/^\+[ \t]*/\+$goodtabindent/;
3333 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003334 }
3335 }
3336 }
3337
Joe Perches6ab3a972015-04-16 12:44:05 -07003338# check for space after cast like "(int) foo" or "(struct foo) bar"
3339# avoid checking a few false positives:
3340# "sizeof(<type>)" or "__alignof__(<type>)"
3341# function pointer declarations like "(*foo)(int) = bar;"
3342# structure definitions like "(struct foo) { 0 };"
3343# multiline macros that define functions
3344# known attributes or the __attribute__ keyword
3345 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3346 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003347 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003348 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003349 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003350 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003351 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003352 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003353 }
3354
Joe Perches86406b12015-09-09 15:37:41 -07003355# Block comment styles
3356# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003357 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003358 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003359 $rawline =~ /^\+[ \t]*\*/ &&
3360 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003361 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3362 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3363 }
3364
Joe Perches86406b12015-09-09 15:37:41 -07003365# Block comments use * on subsequent lines
3366 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3367 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003368 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003369 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003370 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003371 WARN("BLOCK_COMMENT_STYLE",
3372 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003373 }
3374
Joe Perches86406b12015-09-09 15:37:41 -07003375# Block comments use */ on trailing lines
3376 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003377 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3378 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3379 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003380 WARN("BLOCK_COMMENT_STYLE",
3381 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003382 }
3383
Joe Perches08eb9b82016-10-11 13:51:50 -07003384# Block comment * alignment
3385 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003386 $line =~ /^\+[ \t]*$;/ && #leading comment
3387 $rawline =~ /^\+[ \t]*\*/ && #leading *
3388 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003389 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003390 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3391 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003392 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003393 if (defined($1)) {
3394 $oldindent = expand_tabs($1);
3395 } else {
3396 $prevrawline =~ m@^\+(.*/?)\*@;
3397 $oldindent = expand_tabs($1);
3398 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003399 $rawline =~ m@^\+([ \t]*)\*@;
3400 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003401 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003402 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003403 WARN("BLOCK_COMMENT_STYLE",
3404 "Block comments should align the * on each line\n" . $hereprev);
3405 }
3406 }
3407
Joe Perches7f619192014-08-06 16:10:39 -07003408# check for missing blank lines after struct/union declarations
3409# with exceptions for various attributes and macros
3410 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3411 $line =~ /^\+/ &&
3412 !($line =~ /^\+\s*$/ ||
3413 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3414 $line =~ /^\+\s*MODULE_/i ||
3415 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3416 $line =~ /^\+[a-z_]*init/ ||
3417 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3418 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003419 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003420 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003421 if (CHK("LINE_SPACING",
3422 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3423 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003424 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003425 }
Joe Perches7f619192014-08-06 16:10:39 -07003426 }
3427
Joe Perches365dd4e2014-08-06 16:10:42 -07003428# check for multiple consecutive blank lines
3429 if ($prevline =~ /^[\+ ]\s*$/ &&
3430 $line =~ /^\+\s*$/ &&
3431 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003432 if (CHK("LINE_SPACING",
3433 "Please don't use multiple blank lines\n" . $hereprev) &&
3434 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003435 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003436 }
3437
Joe Perches365dd4e2014-08-06 16:10:42 -07003438 $last_blank_line = $linenr;
3439 }
3440
Joe Perches3b617e32014-04-03 14:49:28 -07003441# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003442 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3443 # actual declarations
3444 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003445 # function pointer declarations
3446 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003447 # foo bar; where foo is some local typedef or #define
3448 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3449 # known declaration macros
3450 $prevline =~ /^\+\s+$declaration_macros/) &&
3451 # for "else if" which can look like "$Ident $Ident"
3452 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3453 # other possible extensions of declaration lines
3454 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3455 # not starting a section or a macro "\" extended line
3456 $prevline =~ /(?:\{\s*|\\)$/) &&
3457 # looks like a declaration
3458 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003459 # function pointer declarations
3460 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003461 # foo bar; where foo is some local typedef or #define
3462 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3463 # known declaration macros
3464 $sline =~ /^\+\s+$declaration_macros/ ||
3465 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003466 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003467 # start or end of block or continuation of declaration
3468 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3469 # bitfield continuation
3470 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3471 # other possible extensions of declaration lines
3472 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3473 # indentation of previous and current line are the same
3474 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003475 if (WARN("LINE_SPACING",
3476 "Missing a blank line after declarations\n" . $hereprev) &&
3477 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003478 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003479 }
Joe Perches3b617e32014-04-03 14:49:28 -07003480 }
3481
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003482# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003483# Exceptions:
3484# 1) within comments
3485# 2) indented preprocessor commands
3486# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003487 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003488 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003489 if (WARN("LEADING_SPACE",
3490 "please, no spaces at the start of a line\n" . $herevet) &&
3491 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003492 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003493 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003494 }
3495
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003496# check we are in a valid C source file if not then ignore this hunk
3497 next if ($realfile !~ /\.(h|c)$/);
3498
Joe Perches5751a242017-11-17 15:28:52 -08003499# check for unusual line ending [ or (
3500 if ($line =~ /^\+.*([\[\(])\s*$/) {
3501 CHK("OPEN_ENDED_LINE",
3502 "Lines should not end with a '$1'\n" . $herecurr);
3503 }
3504
Joe Perches4dbed762017-05-08 15:55:39 -07003505# check if this appears to be the start function declaration, save the name
3506 if ($sline =~ /^\+\{\s*$/ &&
3507 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3508 $context_function = $1;
3509 }
3510
3511# check if this appears to be the end of function declaration
3512 if ($sline =~ /^\+\}\s*$/) {
3513 undef $context_function;
3514 }
3515
Joe Perches032a4c02014-08-06 16:10:29 -07003516# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003517# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003518# if the previous line is a break or return and is indented 1 tab more...
3519 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3520 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003521 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3522 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3523 defined $lines[$linenr] &&
3524 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003525 WARN("UNNECESSARY_ELSE",
3526 "else is not generally useful after a break or return\n" . $hereprev);
3527 }
3528 }
3529
Joe Perchesc00df192014-08-06 16:11:01 -07003530# check indentation of a line with a break;
3531# if the previous line is a goto or return and is indented the same # of tabs
3532 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3533 my $tabs = $1;
3534 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3535 WARN("UNNECESSARY_BREAK",
3536 "break is not useful after a goto or return\n" . $hereprev);
3537 }
3538 }
3539
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003540# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003541 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003542 WARN("CVS_KEYWORD",
3543 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003544 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003545
Joe Perches56e77d72013-02-21 16:44:14 -08003546# check for old HOTPLUG __dev<foo> section markings
3547 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3548 WARN("HOTPLUG_SECTION",
3549 "Using $1 is unnecessary\n" . $herecurr);
3550 }
3551
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003552# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003553 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3554 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003555#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003556 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003557 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003558 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003559 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003560 $stat =~ s/\n./\n /g;
3561 $cond =~ s/\n./\n /g;
3562
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003563#print "linenr<$linenr> <$stat>\n";
3564 # If this statement has no statement boundaries within
3565 # it there is no point in retrying a statement scan
3566 # until we hit end of it.
3567 my $frag = $stat; $frag =~ s/;+\s*$//;
3568 if ($frag !~ /(?:{|;)/) {
3569#print "skip<$line_nr_next>\n";
3570 $suppress_statement = $line_nr_next;
3571 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003572
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003573 # Find the real next line.
3574 $realline_next = $line_nr_next;
3575 if (defined $realline_next &&
3576 (!defined $lines[$realline_next - 1] ||
3577 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3578 $realline_next++;
3579 }
3580
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003581 my $s = $stat;
3582 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003583
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003584 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003585 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003586
3587 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003588 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003589
Andy Whitcroft463f2862009-09-21 17:04:34 -07003590 } elsif ($s =~ /^.\s*else\b/s) {
3591
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003592 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003593 } 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 -07003594 my $type = $1;
3595 $type =~ s/\s+/ /g;
3596 possible($type, "A:" . $s);
3597
Andy Whitcroft8905a672007-11-28 16:21:06 -08003598 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003599 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003600 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003601 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003602
3603 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003604 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003605 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003606 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003607
3608 # Check for any sort of function declaration.
3609 # int foo(something bar, other baz);
3610 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003611 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 -08003612 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003613
Andy Whitcroftcf655042008-03-04 14:28:20 -08003614 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003615 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003616 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003617
Andy Whitcroft8905a672007-11-28 16:21:06 -08003618 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003619 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003620
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003621 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003622 }
3623 }
3624 }
3625
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003626 }
3627
Andy Whitcroft653d4872007-06-23 17:16:34 -07003628#
3629# Checks which may be anchored in the context.
3630#
3631
3632# Check for switch () and associated case and default
3633# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003634 if ($line=~/\bswitch\s*\(.*\)/) {
3635 my $err = '';
3636 my $sep = '';
3637 my @ctx = ctx_block_outer($linenr, $realcnt);
3638 shift(@ctx);
3639 for my $ctx (@ctx) {
3640 my ($clen, $cindent) = line_stats($ctx);
3641 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3642 $indent != $cindent) {
3643 $err .= "$sep$ctx\n";
3644 $sep = '';
3645 } else {
3646 $sep = "[...]\n";
3647 }
3648 }
3649 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003650 ERROR("SWITCH_CASE_INDENT_LEVEL",
3651 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003652 }
3653 }
3654
3655# if/while/etc brace do not go on next line, unless defining a do while loop,
3656# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003657 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 -07003658 my $pre_ctx = "$1$2";
3659
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003660 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003661
3662 if ($line =~ /^\+\t{6,}/) {
3663 WARN("DEEP_INDENTATION",
3664 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3665 }
3666
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003667 my $ctx_cnt = $realcnt - $#ctx - 1;
3668 my $ctx = join("\n", @ctx);
3669
Andy Whitcroft548596d2008-07-23 21:29:01 -07003670 my $ctx_ln = $linenr;
3671 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003672
Andy Whitcroft548596d2008-07-23 21:29:01 -07003673 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3674 defined $lines[$ctx_ln - 1] &&
3675 $lines[$ctx_ln - 1] =~ /^-/)) {
3676 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3677 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003678 $ctx_ln++;
3679 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003680
Andy Whitcroft53210162008-07-23 21:29:03 -07003681 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3682 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003683
Joe Perchesd752fcc2014-08-06 16:11:05 -07003684 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003685 ERROR("OPEN_BRACE",
3686 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003687 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003688 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003689 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3690 $ctx =~ /\)\s*\;\s*$/ &&
3691 defined $lines[$ctx_ln - 1])
3692 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003693 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3694 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003695 WARN("TRAILING_SEMICOLON",
3696 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003697 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003698 }
3699 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003700 }
3701
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003702# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003703 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 -08003704 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3705 ctx_statement_block($linenr, $realcnt, 0)
3706 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003707 my ($s, $c) = ($stat, $cond);
3708
3709 substr($s, 0, length($c), '');
3710
Joe Perches9f5af482015-09-09 15:37:30 -07003711 # remove inline comments
3712 $s =~ s/$;/ /g;
3713 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003714
3715 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003716 my @newlines = ($c =~ /\n/gs);
3717 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003718
Joe Perches9f5af482015-09-09 15:37:30 -07003719 # Make sure we remove the line prefixes as we have
3720 # none on the first line, and are going to readd them
3721 # where necessary.
3722 $s =~ s/\n./\n/gs;
3723 while ($s =~ /\n\s+\\\n/) {
3724 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3725 }
3726
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003727 # We want to check the first line inside the block
3728 # starting at the end of the conditional, so remove:
3729 # 1) any blank line termination
3730 # 2) any opening brace { on end of the line
3731 # 3) any do (...) {
3732 my $continuation = 0;
3733 my $check = 0;
3734 $s =~ s/^.*\bdo\b//;
3735 $s =~ s/^\s*{//;
3736 if ($s =~ s/^\s*\\//) {
3737 $continuation = 1;
3738 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003739 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003740 $check = 1;
3741 $cond_lines++;
3742 }
3743
3744 # Also ignore a loop construct at the end of a
3745 # preprocessor statement.
3746 if (($prevline =~ /^.\s*#\s*define\s/ ||
3747 $prevline =~ /\\\s*$/) && $continuation == 0) {
3748 $check = 0;
3749 }
3750
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003751 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003752 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003753 while ($cond_ptr != $cond_lines) {
3754 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003755
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003756 # If we see an #else/#elif then the code
3757 # is not linear.
3758 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3759 $check = 0;
3760 }
3761
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003762 # Ignore:
3763 # 1) blank lines, they should be at 0,
3764 # 2) preprocessor lines, and
3765 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003766 if ($continuation ||
3767 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003768 $s =~ /^\s*#\s*?/ ||
3769 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003770 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003771 if ($s =~ s/^.*?\n//) {
3772 $cond_lines++;
3773 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003774 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003775 }
3776
3777 my (undef, $sindent) = line_stats("+" . $s);
3778 my $stat_real = raw_line($linenr, $cond_lines);
3779
3780 # Check if either of these lines are modified, else
3781 # this is not this patch's fault.
3782 if (!defined($stat_real) ||
3783 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3784 $check = 0;
3785 }
3786 if (defined($stat_real) && $cond_lines > 1) {
3787 $stat_real = "[...]\n$stat_real";
3788 }
3789
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003790 #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 -07003791
Joe Perches9f5af482015-09-09 15:37:30 -07003792 if ($check && $s ne '' &&
Antonio Borneo713a09d2020-04-06 20:11:07 -07003793 (($sindent % $tabsize) != 0 ||
Joe Perches9f5af482015-09-09 15:37:30 -07003794 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003795 ($sindent == $indent &&
3796 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Antonio Borneo713a09d2020-04-06 20:11:07 -07003797 ($sindent > $indent + $tabsize))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003798 WARN("SUSPECT_CODE_INDENT",
3799 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003800 }
3801 }
3802
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003803 # Track the 'values' across context and added lines.
3804 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003805 my ($curr_values, $curr_vars) =
3806 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003807 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003808 if ($dbg_values) {
3809 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003810 print "$linenr > .$outline\n";
3811 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003812 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003813 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003814 $prev_values = substr($curr_values, -1);
3815
Andy Whitcroft00df3442007-06-08 13:47:06 -07003816#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003817 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003818
Joe Perches11ca40a2016-12-12 16:46:31 -08003819# check for dereferences that span multiple lines
3820 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3821 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3822 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3823 my $ref = $1;
3824 $line =~ /^.\s*($Lval)/;
3825 $ref .= $1;
3826 $ref =~ s/\s//g;
3827 WARN("MULTILINE_DEREFERENCE",
3828 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3829 }
3830
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003831# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003832 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 -07003833 my $type = $1;
3834 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003835 $var = "" if (!defined $var);
3836 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003837 my $sign = $1;
3838 my $pointer = $2;
3839
3840 $pointer = "" if (!defined $pointer);
3841
3842 if (WARN("UNSPECIFIED_INT",
3843 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3844 $fix) {
3845 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003846 my $comp_pointer = $pointer;
3847 $comp_pointer =~ s/\s//g;
3848 $decl .= $comp_pointer;
3849 $decl = rtrim($decl) if ($var eq "");
3850 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003851 }
3852 }
3853 }
3854
Andy Whitcroft653d4872007-06-23 17:16:34 -07003855# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003856 if ($dbg_type) {
3857 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003858 ERROR("TEST_TYPE",
3859 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003860 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003861 ERROR("TEST_NOT_TYPE",
3862 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003863 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003864 next;
3865 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003866# TEST: allow direct testing of the attribute matcher.
3867 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003868 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003869 ERROR("TEST_ATTR",
3870 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003871 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003872 ERROR("TEST_NOT_ATTR",
3873 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003874 }
3875 next;
3876 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003877
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003878# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003879 if ($line =~ /^.\s*{/ &&
3880 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003881 if (ERROR("OPEN_BRACE",
3882 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003883 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3884 fix_delete_line($fixlinenr - 1, $prevrawline);
3885 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003886 my $fixedline = $prevrawline;
3887 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003888 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003889 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003890 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003891 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003892 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003893 }
3894
Andy Whitcroft653d4872007-06-23 17:16:34 -07003895#
3896# Checks which are anchored on the added line.
3897#
3898
3899# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003900 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003901 my $path = $1;
3902 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003903 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003904 "malformed #include filename\n" . $herecurr);
3905 }
3906 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3907 ERROR("UAPI_INCLUDE",
3908 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003909 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003910 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003911
3912# no C99 // comments
3913 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003914 if (ERROR("C99_COMMENTS",
3915 "do not use C99 // comments\n" . $herecurr) &&
3916 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003917 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003918 if ($line =~ /\/\/(.*)$/) {
3919 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003920 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003921 }
3922 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003923 }
3924 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003925 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003926 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003927
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003928# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3929# the whole statement.
3930#print "APW <$lines[$realline_next - 1]>\n";
3931 if (defined $realline_next &&
3932 exists $lines[$realline_next - 1] &&
3933 !defined $suppress_export{$realline_next} &&
3934 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3935 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003936 # Handle definitions which produce identifiers with
3937 # a prefix:
3938 # XXX(foo);
3939 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003940 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003941 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003942 $name =~ /^${Ident}_$2/) {
3943#print "FOO C name<$name>\n";
3944 $suppress_export{$realline_next} = 1;
3945
3946 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003947 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003948 ^.DEFINE_$Ident\(\Q$name\E\)|
3949 ^.DECLARE_$Ident\(\Q$name\E\)|
3950 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003951 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3952 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003953 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003954#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3955 $suppress_export{$realline_next} = 2;
3956 } else {
3957 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003958 }
3959 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003960 if (!defined $suppress_export{$linenr} &&
3961 $prevline =~ /^.\s*$/ &&
3962 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3963 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3964#print "FOO B <$lines[$linenr - 1]>\n";
3965 $suppress_export{$linenr} = 2;
3966 }
3967 if (defined $suppress_export{$linenr} &&
3968 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003969 WARN("EXPORT_SYMBOL",
3970 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003971 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003972
Joe Eloff5150bda2010-08-09 17:21:00 -07003973# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003974 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003975 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003976 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003977 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003978 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003979 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003980 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003981# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003982 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003983 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003984 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003985 $herecurr) &&
3986 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003987 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003988 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003989 }
3990
Joe Perches18130872014-08-06 16:11:22 -07003991# check for misordered declarations of char/short/int/long with signed/unsigned
3992 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3993 my $tmp = trim($1);
3994 WARN("MISORDERED_TYPE",
3995 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3996 }
3997
Joe Perches809e0822018-08-21 21:58:12 -07003998# check for unnecessary <signed> int declarations of short/long/long long
3999 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4000 my $type = trim($1);
4001 next if ($type !~ /\bint\b/);
4002 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4003 my $new_type = $type;
4004 $new_type =~ s/\b\s*int\s*\b/ /;
4005 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4006 $new_type =~ s/^const\s+//;
4007 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4008 $new_type = "const $new_type" if ($type =~ /^const\b/);
4009 $new_type =~ s/\s+/ /g;
4010 $new_type = trim($new_type);
4011 if (WARN("UNNECESSARY_INT",
4012 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4013 $fix) {
4014 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4015 }
4016 }
4017
Joe Perchescb710ec2010-10-26 14:23:20 -07004018# check for static const char * arrays.
4019 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004020 WARN("STATIC_CONST_CHAR_ARRAY",
4021 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004022 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004023 }
4024
4025# check for initialized const char arrays that should be static const
4026 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4027 if (WARN("STATIC_CONST_CHAR_ARRAY",
4028 "const array should probably be static const\n" . $herecurr) &&
4029 $fix) {
4030 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4031 }
4032 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004033
4034# check for static char foo[] = "bar" declarations.
4035 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004036 WARN("STATIC_CONST_CHAR_ARRAY",
4037 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004038 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004039 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004040
Joe Perchesab7e23f2015-04-16 12:44:22 -07004041# check for const <foo> const where <foo> is not a pointer or array type
4042 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4043 my $found = $1;
4044 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4045 WARN("CONST_CONST",
4046 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4047 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4048 WARN("CONST_CONST",
4049 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4050 }
4051 }
4052
Joe Perches9b0fa602014-04-03 14:49:18 -07004053# check for non-global char *foo[] = {"bar", ...} declarations.
4054 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4055 WARN("STATIC_CONST_CHAR_ARRAY",
4056 "char * array declaration might be better as static const\n" .
4057 $herecurr);
4058 }
4059
Joe Perchesb598b672015-04-16 12:44:36 -07004060# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4061 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4062 my $array = $1;
4063 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4064 my $array_div = $1;
4065 if (WARN("ARRAY_SIZE",
4066 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4067 $fix) {
4068 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4069 }
4070 }
4071 }
4072
Joe Perchesb36190c2014-01-27 17:07:18 -08004073# check for function declarations without arguments like "int foo()"
Joe Perches16b7f3c2020-04-06 20:11:17 -07004074 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
Joe Perchesb36190c2014-01-27 17:07:18 -08004075 if (ERROR("FUNCTION_WITHOUT_ARGS",
4076 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4077 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004078 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004079 }
4080 }
4081
Andy Whitcroft653d4872007-06-23 17:16:34 -07004082# check for new typedefs, only function parameters and sparse annotations
4083# make sense.
4084 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004085 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004086 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004087 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004088 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004089 WARN("NEW_TYPEDEFS",
4090 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004091 }
4092
4093# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004094 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004095 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4096 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004097 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004098
Andy Whitcroft65863862009-01-06 14:41:21 -08004099 # Should start with a space.
4100 $to =~ s/^(\S)/ $1/;
4101 # Should not end with a space.
4102 $to =~ s/\s+$//;
4103 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004104 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004105 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004106
Joe Perches3705ce52013-07-03 15:05:31 -07004107## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004108 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004109 if (ERROR("POINTER_LOCATION",
4110 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4111 $fix) {
4112 my $sub_from = $ident;
4113 my $sub_to = $ident;
4114 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004115 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004116 s@\Q$sub_from\E@$sub_to@;
4117 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004118 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004119 }
4120 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4121 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004122 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004123
Andy Whitcroft65863862009-01-06 14:41:21 -08004124 # Should start with a space.
4125 $to =~ s/^(\S)/ $1/;
4126 # Should not end with a space.
4127 $to =~ s/\s+$//;
4128 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004129 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004130 }
4131 # Modifiers should have spaces.
4132 $to =~ s/(\b$Modifier$)/$1 /;
4133
Joe Perches3705ce52013-07-03 15:05:31 -07004134## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004135 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004136 if (ERROR("POINTER_LOCATION",
4137 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4138 $fix) {
4139
4140 my $sub_from = $match;
4141 my $sub_to = $match;
4142 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004143 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004144 s@\Q$sub_from\E@$sub_to@;
4145 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004146 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004147 }
4148
Joe Perches9d3e3c72015-09-09 15:37:27 -07004149# avoid BUG() or BUG_ON()
4150 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004151 my $msg_level = \&WARN;
4152 $msg_level = \&CHK if ($file);
4153 &{$msg_level}("AVOID_BUG",
4154 "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 -07004155 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004156
Joe Perches9d3e3c72015-09-09 15:37:27 -07004157# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004158 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004159 WARN("LINUX_VERSION_CODE",
4160 "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 -08004161 }
4162
Joe Perches17441222011-06-15 15:08:17 -07004163# check for uses of printk_ratelimit
4164 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004165 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004166 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004167 }
4168
Joe Percheseeef5732017-11-17 15:28:41 -08004169# printk should use KERN_* levels
4170 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4171 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4172 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004173 }
4174
Joe Perches243f3802012-05-31 16:26:09 -07004175 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4176 my $orig = $1;
4177 my $level = lc($orig);
4178 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004179 my $level2 = $level;
4180 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004181 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004182 "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 -07004183 }
4184
Joe Perchesdc139312013-02-21 16:44:13 -08004185 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4186 my $orig = $1;
4187 my $level = lc($orig);
4188 $level = "warn" if ($level eq "warning");
4189 $level = "dbg" if ($level eq "debug");
4190 WARN("PREFER_DEV_LEVEL",
4191 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4192 }
4193
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004194# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4195# number of false positives, but assembly files are not checked, so at
4196# least the arch entry code will not trigger this warning.
4197 if ($line =~ /\bENOSYS\b/) {
4198 WARN("ENOSYS",
4199 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4200 }
4201
Andy Whitcroft653d4872007-06-23 17:16:34 -07004202# function brace can't be on same line, except for #defines of do while,
4203# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004204 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004205 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4206 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4207 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004208 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004209 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004210 $fix) {
4211 fix_delete_line($fixlinenr, $rawline);
4212 my $fixed_line = $rawline;
4213 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4214 my $line1 = $1;
4215 my $line2 = $2;
4216 fix_insert_line($fixlinenr, ltrim($line1));
4217 fix_insert_line($fixlinenr, "\+{");
4218 if ($line2 !~ /^\s*$/) {
4219 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4220 }
4221 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004222 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004223
Andy Whitcroft8905a672007-11-28 16:21:06 -08004224# open braces for enum, union and struct go on the same line.
4225 if ($line =~ /^.\s*{/ &&
4226 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004227 if (ERROR("OPEN_BRACE",
4228 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4229 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4230 fix_delete_line($fixlinenr - 1, $prevrawline);
4231 fix_delete_line($fixlinenr, $rawline);
4232 my $fixedline = rtrim($prevrawline) . " {";
4233 fix_insert_line($fixlinenr, $fixedline);
4234 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004235 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004236 if ($fixedline !~ /^\+\s*$/) {
4237 fix_insert_line($fixlinenr, $fixedline);
4238 }
4239 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004240 }
4241
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004242# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004243 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4244 if (WARN("SPACING",
4245 "missing space after $1 definition\n" . $herecurr) &&
4246 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004247 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004248 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4249 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004250 }
4251
Joe Perches31070b52014-01-23 15:54:49 -08004252# Function pointer declarations
4253# check spacing between type, funcptr, and args
4254# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004255 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004256 my $declare = $1;
4257 my $pre_pointer_space = $2;
4258 my $post_pointer_space = $3;
4259 my $funcname = $4;
4260 my $post_funcname_space = $5;
4261 my $pre_args_space = $6;
4262
Joe Perches91f72e92014-04-03 14:49:12 -07004263# the $Declare variable will capture all spaces after the type
4264# so check it for a missing trailing missing space but pointer return types
4265# don't need a space so don't warn for those.
4266 my $post_declare_space = "";
4267 if ($declare =~ /(\s+)$/) {
4268 $post_declare_space = $1;
4269 $declare = rtrim($declare);
4270 }
4271 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004272 WARN("SPACING",
4273 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004274 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004275 }
4276
4277# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004278# This test is not currently implemented because these declarations are
4279# equivalent to
4280# int foo(int bar, ...)
4281# and this is form shouldn't/doesn't generate a checkpatch warning.
4282#
4283# elsif ($declare =~ /\s{2,}$/) {
4284# WARN("SPACING",
4285# "Multiple spaces after return type\n" . $herecurr);
4286# }
Joe Perches31070b52014-01-23 15:54:49 -08004287
4288# unnecessary space "type ( *funcptr)(args...)"
4289 if (defined $pre_pointer_space &&
4290 $pre_pointer_space =~ /^\s/) {
4291 WARN("SPACING",
4292 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4293 }
4294
4295# unnecessary space "type (* funcptr)(args...)"
4296 if (defined $post_pointer_space &&
4297 $post_pointer_space =~ /^\s/) {
4298 WARN("SPACING",
4299 "Unnecessary space before function pointer name\n" . $herecurr);
4300 }
4301
4302# unnecessary space "type (*funcptr )(args...)"
4303 if (defined $post_funcname_space &&
4304 $post_funcname_space =~ /^\s/) {
4305 WARN("SPACING",
4306 "Unnecessary space after function pointer name\n" . $herecurr);
4307 }
4308
4309# unnecessary space "type (*funcptr) (args...)"
4310 if (defined $pre_args_space &&
4311 $pre_args_space =~ /^\s/) {
4312 WARN("SPACING",
4313 "Unnecessary space before function pointer arguments\n" . $herecurr);
4314 }
4315
4316 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004317 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004318 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004319 }
4320 }
4321
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004322# check for spacing round square brackets; allowed:
4323# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004324# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4325# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004326 while ($line =~ /(.*?\s)\[/g) {
4327 my ($where, $prefix) = ($-[1], $1);
4328 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004329 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004330 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004331 if (ERROR("BRACKET_SPACE",
4332 "space prohibited before open square bracket '['\n" . $herecurr) &&
4333 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004334 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004335 s/^(\+.*?)\s+\[/$1\[/;
4336 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004337 }
4338 }
4339
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004340# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004341 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004342 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004343 my $ctx_before = substr($line, 0, $-[1]);
4344 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004345
4346 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004347 if ($name =~ /^(?:
4348 if|for|while|switch|return|case|
4349 volatile|__volatile__|
4350 __attribute__|format|__extension__|
4351 asm|__asm__)$/x)
4352 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004353 # cpp #define statements have non-optional spaces, ie
4354 # if there is a space between the name and the open
4355 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004356 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004357
4358 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004359 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004360
4361 # If this whole things ends with a type its most
4362 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004363 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004364
4365 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004366 if (WARN("SPACING",
4367 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4368 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004369 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004370 s/\b$name\s+\(/$name\(/;
4371 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004372 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004373 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004374
Andy Whitcroft653d4872007-06-23 17:16:34 -07004375# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004376 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004377 my $fixed_line = "";
4378 my $line_fixed = 0;
4379
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004380 my $ops = qr{
4381 <<=|>>=|<=|>=|==|!=|
4382 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4383 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004384 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004385 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004386 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004387 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004388
4389## print("element count: <" . $#elements . ">\n");
4390## foreach my $el (@elements) {
4391## print("el: <$el>\n");
4392## }
4393
4394 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004395 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004396
Joe Perches3705ce52013-07-03 15:05:31 -07004397 foreach my $el (@elements) {
4398 push(@fix_elements, substr($rawline, $off, length($el)));
4399 $off += length($el);
4400 }
4401
4402 $off = 0;
4403
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004404 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004405 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004406
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004407 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004408
4409 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4410
4411## print("n: <$n> good: <$good>\n");
4412
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004413 $off += length($elements[$n]);
4414
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004415 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004416 my $ca = substr($opline, 0, $off);
4417 my $cc = '';
4418 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4419 $cc = substr($opline, $off + length($elements[$n + 1]));
4420 }
4421 my $cb = "$ca$;$cc";
4422
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004423 my $a = '';
4424 $a = 'V' if ($elements[$n] ne '');
4425 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004426 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004427 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4428 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004429 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004430
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004431 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004432
4433 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004434 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004435 $c = 'V' if ($elements[$n + 2] ne '');
4436 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004437 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004438 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4439 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004440 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004441 } else {
4442 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004443 }
4444
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004445 my $ctx = "${a}x${c}";
4446
4447 my $at = "(ctx:$ctx)";
4448
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004449 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004450 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004451
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004452 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004453 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004454
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004455 # Get the full operator variant.
4456 my $opv = $op . substr($curr_vars, $off, 1);
4457
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004458 # Ignore operators passed as parameters.
4459 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004460 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004461
Andy Whitcroftcf655042008-03-04 14:28:20 -08004462# # Ignore comments
4463# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004464
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004465 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004466 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004467 if ($ctx !~ /.x[WEBC]/ &&
4468 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004469 if (ERROR("SPACING",
4470 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004471 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004472 $line_fixed = 1;
4473 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004474 }
4475
4476 # // is a comment
4477 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004478
Joe Perchesb00e4812014-04-03 14:49:33 -07004479 # : when part of a bitfield
4480 } elsif ($opv eq ':B') {
4481 # skip the bitfield test for now
4482
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004483 # No spaces for:
4484 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004485 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004486 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004487 if (ERROR("SPACING",
4488 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004489 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004490 if (defined $fix_elements[$n + 2]) {
4491 $fix_elements[$n + 2] =~ s/^\s+//;
4492 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004493 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004494 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004495 }
4496
Joe Perches23810972014-12-10 15:51:32 -08004497 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004498 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004499 my $rtrim_before = 0;
4500 my $space_after = 0;
4501 if ($ctx =~ /Wx./) {
4502 if (ERROR("SPACING",
4503 "space prohibited before that '$op' $at\n" . $hereptr)) {
4504 $line_fixed = 1;
4505 $rtrim_before = 1;
4506 }
4507 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004508 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004509 if (ERROR("SPACING",
4510 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004511 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004512 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004513 $space_after = 1;
4514 }
4515 }
4516 if ($rtrim_before || $space_after) {
4517 if ($rtrim_before) {
4518 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4519 } else {
4520 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4521 }
4522 if ($space_after) {
4523 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004524 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004525 }
4526
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004527 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004528 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004529 #warn "'*' is part of type\n";
4530
4531 # unary operators should have a space before and
4532 # none after. May be left adjacent to another
4533 # unary operator, or a cast
4534 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004535 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004536 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004537 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004538 if (ERROR("SPACING",
4539 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004540 if ($n != $last_after + 2) {
4541 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4542 $line_fixed = 1;
4543 }
Joe Perches3705ce52013-07-03 15:05:31 -07004544 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004545 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004546 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004547 # A unary '*' may be const
4548
4549 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004550 if (ERROR("SPACING",
4551 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004552 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004553 if (defined $fix_elements[$n + 2]) {
4554 $fix_elements[$n + 2] =~ s/^\s+//;
4555 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004556 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004557 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004558 }
4559
4560 # unary ++ and unary -- are allowed no space on one side.
4561 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004562 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004563 if (ERROR("SPACING",
4564 "space required one side of 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 Whitcroft0a920b5b2007-06-01 00:46:48 -07004568 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004569 if ($ctx =~ /Wx[BE]/ ||
4570 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004571 if (ERROR("SPACING",
4572 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004573 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004574 $line_fixed = 1;
4575 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004576 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004577 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004578 if (ERROR("SPACING",
4579 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004580 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004581 if (defined $fix_elements[$n + 2]) {
4582 $fix_elements[$n + 2] =~ s/^\s+//;
4583 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004584 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004585 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004586 }
4587
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004588 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004589 } elsif ($op eq '<<' or $op eq '>>' or
4590 $op eq '&' or $op eq '^' or $op eq '|' or
4591 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004592 $op eq '*' or $op eq '/' or
4593 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004594 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004595 if ($check) {
4596 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4597 if (CHK("SPACING",
4598 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4599 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4600 $fix_elements[$n + 2] =~ s/^\s+//;
4601 $line_fixed = 1;
4602 }
4603 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4604 if (CHK("SPACING",
4605 "space preferred before that '$op' $at\n" . $hereptr)) {
4606 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4607 $line_fixed = 1;
4608 }
4609 }
4610 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004611 if (ERROR("SPACING",
4612 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004613 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4614 if (defined $fix_elements[$n + 2]) {
4615 $fix_elements[$n + 2] =~ s/^\s+//;
4616 }
Joe Perches3705ce52013-07-03 15:05:31 -07004617 $line_fixed = 1;
4618 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004619 }
4620
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004621 # A colon needs no spaces before when it is
4622 # terminating a case value or a label.
4623 } elsif ($opv eq ':C' || $opv eq ':L') {
4624 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004625 if (ERROR("SPACING",
4626 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004627 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004628 $line_fixed = 1;
4629 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004630 }
4631
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004632 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004633 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004634 my $ok = 0;
4635
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004636 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004637 if (($op eq '<' &&
4638 $cc =~ /^\S+\@\S+>/) ||
4639 ($op eq '>' &&
4640 $ca =~ /<\S+\@\S+$/))
4641 {
Antonio Borneo342d3d22020-04-06 20:11:01 -07004642 $ok = 1;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004643 }
4644
Joe Perchese0df7e12015-04-16 12:44:53 -07004645 # for asm volatile statements
4646 # ignore a colon with another
4647 # colon immediately before or after
4648 if (($op eq ':') &&
4649 ($ca =~ /:$/ || $cc =~ /^:/)) {
4650 $ok = 1;
4651 }
4652
Joe Perches84731622013-11-12 15:10:05 -08004653 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004654 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004655 my $msg_level = \&ERROR;
4656 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004657
Jean Delvare0675a8f2017-09-08 16:16:07 -07004658 if (&{$msg_level}("SPACING",
4659 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004660 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4661 if (defined $fix_elements[$n + 2]) {
4662 $fix_elements[$n + 2] =~ s/^\s+//;
4663 }
Joe Perches3705ce52013-07-03 15:05:31 -07004664 $line_fixed = 1;
4665 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004666 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004667 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004668 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004669
4670## print("n: <$n> GOOD: <$good>\n");
4671
4672 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004673 }
Joe Perches3705ce52013-07-03 15:05:31 -07004674
4675 if (($#elements % 2) == 0) {
4676 $fixed_line = $fixed_line . $fix_elements[$#elements];
4677 }
4678
Joe Perches194f66f2014-08-06 16:11:03 -07004679 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4680 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004681 }
4682
4683
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004684 }
4685
Joe Perches786b6322013-07-03 15:05:32 -07004686# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004687 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004688 if (WARN("SPACING",
4689 "space prohibited before semicolon\n" . $herecurr) &&
4690 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004691 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004692 s/^(\+.*\S)\s+;/$1;/;
4693 }
4694 }
4695
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004696# check for multiple assignments
4697 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004698 CHK("MULTIPLE_ASSIGNMENTS",
4699 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004700 }
4701
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004702## # check for multiple declarations, allowing for a function declaration
4703## # continuation.
4704## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4705## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4706##
4707## # Remove any bracketed sections to ensure we do not
4708## # falsly report the parameters of functions.
4709## my $ln = $line;
4710## while ($ln =~ s/\([^\(\)]*\)//g) {
4711## }
4712## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004713## WARN("MULTIPLE_DECLARATION",
4714## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004715## }
4716## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004717
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004718#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004719 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004720 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004721 if (ERROR("SPACING",
4722 "space required before the open brace '{'\n" . $herecurr) &&
4723 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004724 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004725 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004726 }
4727
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004728## # check for blank lines before declarations
4729## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4730## $prevrawline =~ /^.\s*$/) {
4731## WARN("SPACING",
4732## "No blank lines before declarations\n" . $hereprev);
4733## }
4734##
4735
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004736# closing brace should have a space following it when it has anything
4737# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07004738 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004739 if (ERROR("SPACING",
4740 "space required after that close brace '}'\n" . $herecurr) &&
4741 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004742 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004743 s/}((?!(?:,|;|\)))\S)/} $1/;
4744 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004745 }
4746
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004747# check spacing on square brackets
4748 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004749 if (ERROR("SPACING",
4750 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4751 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004752 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004753 s/\[\s+/\[/;
4754 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004755 }
4756 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004757 if (ERROR("SPACING",
4758 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4759 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004760 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004761 s/\s+\]/\]/;
4762 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004763 }
4764
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004765# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004766 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4767 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004768 if (ERROR("SPACING",
4769 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4770 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004771 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004772 s/\(\s+/\(/;
4773 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004774 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004775 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004776 $line !~ /for\s*\(.*;\s+\)/ &&
4777 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004778 if (ERROR("SPACING",
4779 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4780 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004781 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004782 s/\s+\)/\)/;
4783 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004784 }
4785
Joe Perchese2826fd2014-08-06 16:10:48 -07004786# check unnecessary parentheses around addressof/dereference single $Lvals
4787# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4788
4789 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004790 my $var = $1;
4791 if (CHK("UNNECESSARY_PARENTHESES",
4792 "Unnecessary parentheses around $var\n" . $herecurr) &&
4793 $fix) {
4794 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4795 }
4796 }
4797
4798# check for unnecessary parentheses around function pointer uses
4799# ie: (foo->bar)(); should be foo->bar();
4800# but not "if (foo->bar) (" to avoid some false positives
4801 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4802 my $var = $2;
4803 if (CHK("UNNECESSARY_PARENTHESES",
4804 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4805 $fix) {
4806 my $var2 = deparenthesize($var);
4807 $var2 =~ s/\s//g;
4808 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4809 }
4810 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004811
Joe Perches63b7c732017-09-08 16:16:01 -07004812# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004813# when !drivers/staging or command-line uses --strict
4814 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07004815 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004816 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4817 my $if_stat = $1;
4818 my $test = substr($2, 1, -1);
4819 my $herectx;
4820 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4821 my $match = $1;
4822 # avoid parentheses around potential macro args
4823 next if ($match =~ /^\s*\w+\s*$/);
4824 if (!defined($herectx)) {
4825 $herectx = $here . "\n";
4826 my $cnt = statement_rawlines($if_stat);
4827 for (my $n = 0; $n < $cnt; $n++) {
4828 my $rl = raw_line($linenr, $n);
4829 $herectx .= $rl . "\n";
4830 last if $rl =~ /^[ \+].*\{/;
4831 }
4832 }
4833 CHK("UNNECESSARY_PARENTHESES",
4834 "Unnecessary parentheses around '$match'\n" . $herectx);
4835 }
4836 }
4837
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004838#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004839 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004840 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004841 if (WARN("INDENTED_LABEL",
4842 "labels should not be indented\n" . $herecurr) &&
4843 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004844 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004845 s/^(.)\s+/$1/;
4846 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004847 }
4848
Joe Perches5b9553a2014-04-03 14:49:21 -07004849# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004850 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004851 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07004852 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004853 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4854 my $value = $1;
4855 $value = deparenthesize($value);
4856 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4857 ERROR("RETURN_PARENTHESES",
4858 "return is not a function, parentheses are not required\n" . $herecurr);
4859 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004860 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004861 ERROR("SPACING",
4862 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004863 }
4864 }
Joe Perches507e5142013-11-12 15:10:13 -08004865
Joe Perchesb43ae212014-06-23 13:22:07 -07004866# unnecessary return in a void function
4867# at end-of-function, with the previous line a single leading tab, then return;
4868# and the line before that not a goto label target like "out:"
4869 if ($sline =~ /^[ \+]}\s*$/ &&
4870 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4871 $linenr >= 3 &&
4872 $lines[$linenr - 3] =~ /^[ +]/ &&
4873 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004874 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004875 "void function return statements are not generally useful\n" . $hereprev);
4876 }
Joe Perches9819cf22014-06-04 16:12:09 -07004877
Joe Perches189248d2014-01-23 15:54:47 -08004878# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07004879 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08004880 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4881 my $openparens = $1;
4882 my $count = $openparens =~ tr@\(@\(@;
4883 my $msg = "";
4884 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4885 my $comp = $4; #Not $1 because of $LvalOrFunc
4886 $msg = " - maybe == should be = ?" if ($comp eq "==");
4887 WARN("UNNECESSARY_PARENTHESES",
4888 "Unnecessary parentheses$msg\n" . $herecurr);
4889 }
4890 }
4891
Joe Perchesc5595fa2015-09-09 15:37:58 -07004892# comparisons with a constant or upper case identifier on the left
4893# avoid cases like "foo + BAR < baz"
4894# only fix matches surrounded by parentheses to avoid incorrect
4895# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07004896 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004897 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4898 my $lead = $1;
4899 my $const = $2;
4900 my $comp = $3;
4901 my $to = $4;
4902 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004903 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004904 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4905 WARN("CONSTANT_COMPARISON",
4906 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4907 $fix) {
4908 if ($comp eq "<") {
4909 $newcomp = ">";
4910 } elsif ($comp eq "<=") {
4911 $newcomp = ">=";
4912 } elsif ($comp eq ">") {
4913 $newcomp = "<";
4914 } elsif ($comp eq ">=") {
4915 $newcomp = "<=";
4916 }
4917 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4918 }
4919 }
4920
Joe Perchesf34e4a42015-04-16 12:44:19 -07004921# Return of what appears to be an errno should normally be negative
4922 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004923 my $name = $1;
4924 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004925 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004926 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004927 }
4928 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004929
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004930# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004931 if ($line =~ /\b(if|while|for|switch)\(/) {
4932 if (ERROR("SPACING",
4933 "space required before the open parenthesis '('\n" . $herecurr) &&
4934 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004935 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004936 s/\b(if|while|for|switch)\(/$1 \(/;
4937 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004938 }
4939
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004940# Check for illegal assignment in if conditional -- and check for trailing
4941# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004942 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004943 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4944 ctx_statement_block($linenr, $realcnt, 0)
4945 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004946 my ($stat_next) = ctx_statement_block($line_nr_next,
4947 $remain_next, $off_next);
4948 $stat_next =~ s/\n./\n /g;
4949 ##print "stat<$stat> stat_next<$stat_next>\n";
4950
4951 if ($stat_next =~ /^\s*while\b/) {
4952 # If the statement carries leading newlines,
4953 # then count those as offsets.
4954 my ($whitespace) =
4955 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4956 my $offset =
4957 statement_rawlines($whitespace) - 1;
4958
4959 $suppress_whiletrailers{$line_nr_next +
4960 $offset} = 1;
4961 }
4962 }
4963 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004964 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004965 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004966 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004967
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004968 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004969 ERROR("ASSIGN_IN_IF",
4970 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004971 }
4972
4973 # Find out what is on the end of the line after the
4974 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004975 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004976 $s =~ s/\n.*//g;
Antonio Borneo342d3d22020-04-06 20:11:01 -07004977 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004978 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4979 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004980 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004981 # Find out how long the conditional actually is.
4982 my @newlines = ($c =~ /\n/gs);
4983 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004984 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004985
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004986 $stat_real = raw_line($linenr, $cond_lines)
4987 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004988 if (defined($stat_real) && $cond_lines > 1) {
4989 $stat_real = "[...]\n$stat_real";
4990 }
4991
Joe Perches000d1cc12011-07-25 17:13:25 -07004992 ERROR("TRAILING_STATEMENTS",
4993 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004994 }
4995 }
4996
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004997# Check for bitwise tests written as boolean
4998 if ($line =~ /
4999 (?:
5000 (?:\[|\(|\&\&|\|\|)
5001 \s*0[xX][0-9]+\s*
5002 (?:\&\&|\|\|)
5003 |
5004 (?:\&\&|\|\|)
5005 \s*0[xX][0-9]+\s*
5006 (?:\&\&|\|\||\)|\])
5007 )/x)
5008 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005009 WARN("HEXADECIMAL_BOOLEAN_TEST",
5010 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005011 }
5012
Andy Whitcroft8905a672007-11-28 16:21:06 -08005013# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005014 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5015 my $s = $1;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005016 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005017 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005018 ERROR("TRAILING_STATEMENTS",
5019 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005020 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005021 }
Andy Whitcroft39667782009-01-15 13:51:06 -08005022# if should not continue a brace
5023 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005024 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07005025 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08005026 $herecurr);
5027 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005028# case and default should not have general statements after them
5029 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5030 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07005031 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005032 \s*return\s+
5033 )/xg)
5034 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005035 ERROR("TRAILING_STATEMENTS",
5036 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005037 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005038
5039 # Check for }<nl>else {, these must be at the same
5040 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07005041 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5042 $previndent == $indent) {
5043 if (ERROR("ELSE_AFTER_BRACE",
5044 "else should follow close brace '}'\n" . $hereprev) &&
5045 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5046 fix_delete_line($fixlinenr - 1, $prevrawline);
5047 fix_delete_line($fixlinenr, $rawline);
5048 my $fixedline = $prevrawline;
5049 $fixedline =~ s/}\s*$//;
5050 if ($fixedline !~ /^\+\s*$/) {
5051 fix_insert_line($fixlinenr, $fixedline);
5052 }
5053 $fixedline = $rawline;
5054 $fixedline =~ s/^(.\s*)else/$1} else/;
5055 fix_insert_line($fixlinenr, $fixedline);
5056 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005057 }
5058
Joe Perches8b8856f2014-08-06 16:11:14 -07005059 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5060 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005061 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5062
5063 # Find out what is on the end of the line after the
5064 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005065 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005066 $s =~ s/\n.*//g;
5067
5068 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005069 if (ERROR("WHILE_AFTER_BRACE",
5070 "while should follow close brace '}'\n" . $hereprev) &&
5071 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5072 fix_delete_line($fixlinenr - 1, $prevrawline);
5073 fix_delete_line($fixlinenr, $rawline);
5074 my $fixedline = $prevrawline;
5075 my $trailing = $rawline;
5076 $trailing =~ s/^\+//;
5077 $trailing = trim($trailing);
5078 $fixedline =~ s/}\s*$/} $trailing/;
5079 fix_insert_line($fixlinenr, $fixedline);
5080 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005081 }
5082 }
5083
Joe Perches95e2c602013-07-03 15:05:20 -07005084#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005085 while ($line =~ m{($Constant|$Lval)}g) {
5086 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005087
Joe Perches95e2c602013-07-03 15:05:20 -07005088#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005089 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005090 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005091#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005092 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perchesd439e6a2019-12-04 16:52:06 -08005093#Ignore SI style variants like nS, mV and dB
5094#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5095 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Julius Wernerf5123572014-12-10 15:51:54 -08005096#Ignore some three character SI units explicitly, like MiB and KHz
5097 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005098 while ($var =~ m{($Ident)}g) {
5099 my $word = $1;
5100 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005101 if ($check) {
5102 seed_camelcase_includes();
5103 if (!$file && !$camelcase_file_seeded) {
5104 seed_camelcase_file($realfile);
5105 $camelcase_file_seeded = 1;
5106 }
5107 }
Joe Perches7e781f62013-09-11 14:23:55 -07005108 if (!defined $camelcase{$word}) {
5109 $camelcase{$word} = 1;
5110 CHK("CAMELCASE",
5111 "Avoid CamelCase: <$word>\n" . $herecurr);
5112 }
Joe Perches34456862013-07-03 15:05:34 -07005113 }
Joe Perches323c1262012-12-17 16:02:07 -08005114 }
5115 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005116
5117#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005118 if ($line =~ /\#\s*define.*\\\s+$/) {
5119 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5120 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5121 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005122 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005123 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005124 }
5125
Fabian Frederick0e212e02015-04-16 12:44:25 -07005126# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5127# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005128 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005129 my $file = "$1.h";
5130 my $checkfile = "include/linux/$file";
5131 if (-f "$root/$checkfile" &&
5132 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005133 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005134 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005135 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5136 if ($asminclude > 0) {
5137 if ($realfile =~ m{^arch/}) {
5138 CHK("ARCH_INCLUDE_LINUX",
5139 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5140 } else {
5141 WARN("INCLUDE_LINUX",
5142 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5143 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005144 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005145 }
5146 }
5147
Andy Whitcroft653d4872007-06-23 17:16:34 -07005148# multi-statement macros should be enclosed in a do while loop, grab the
5149# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005150# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07005151 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5152 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005153 my $ln = $linenr;
5154 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005155 my ($off, $dstat, $dcond, $rest);
5156 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005157 my $has_flow_statement = 0;
5158 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005159 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005160 ctx_statement_block($linenr, $realcnt, 0);
5161 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005162 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005163 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005164
Joe Perches08a28432014-10-13 15:51:55 -07005165 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005166 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005167
Joe Perchesf59b64b2016-10-11 13:52:08 -07005168 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5169 my $define_args = $1;
5170 my $define_stmt = $dstat;
5171 my @def_args = ();
5172
5173 if (defined $define_args && $define_args ne "") {
5174 $define_args = substr($define_args, 1, length($define_args) - 2);
5175 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005176 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005177 @def_args = split(",", $define_args);
5178 }
5179
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005180 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005181 $dstat =~ s/\\\n.//g;
5182 $dstat =~ s/^\s*//s;
5183 $dstat =~ s/\s*$//s;
5184
5185 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005186 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5187 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005188 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005189 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005190 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005191
Antonio Borneo342d3d22020-04-06 20:11:01 -07005192 # Flatten any obvious string concatenation.
Joe Perches33acb542015-06-25 15:02:54 -07005193 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5194 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005195 {
5196 }
5197
Joe Perches42e15292016-03-15 14:58:01 -07005198 # Make asm volatile uses seem like a generic function
5199 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5200
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005201 my $exceptions = qr{
5202 $Declare|
5203 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005204 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005205 DECLARE_PER_CPU|
5206 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005207 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005208 union|
5209 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005210 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005211 ^\"|\"$|
5212 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005213 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005214 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005215
5216 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005217 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005218 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005219
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005220 if ($dstat ne '' &&
5221 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5222 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005223 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005224 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005225 $dstat !~ /$exceptions/ &&
5226 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005227 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005228 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005229 $dstat !~ /^for\s*$Constant$/ && # for (...)
5230 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5231 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005232 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005233 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005234 {
Joe Perchese7955562017-05-08 15:55:48 -07005235 if ($dstat =~ /^\s*if\b/) {
5236 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5237 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5238 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005239 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5240 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5241 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005242 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005243 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005244 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005245
5246 }
Joe Perches52076492016-10-11 13:52:14 -07005247
5248 # Make $define_stmt single line, comment-free, etc
5249 my @stmt_array = split('\n', $define_stmt);
5250 my $first = 1;
5251 $define_stmt = "";
5252 foreach my $l (@stmt_array) {
5253 $l =~ s/\\$//;
5254 if ($first) {
5255 $define_stmt = $l;
5256 $first = 0;
5257 } elsif ($l =~ /^[\+ ]/) {
5258 $define_stmt .= substr($l, 1);
5259 }
5260 }
5261 $define_stmt =~ s/$;//g;
5262 $define_stmt =~ s/\s+/ /g;
5263 $define_stmt = trim($define_stmt);
5264
Joe Perchesf59b64b2016-10-11 13:52:08 -07005265# check if any macro arguments are reused (ignore '...' and 'type')
5266 foreach my $arg (@def_args) {
5267 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005268 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005269 my $tmp_stmt = $define_stmt;
Brendan Jackman6dba8242019-09-25 16:46:41 -07005270 $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 -07005271 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5272 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005273 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005274 if ($use_cnt > 1) {
5275 CHK("MACRO_ARG_REUSE",
5276 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005277 }
5278# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005279 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005280 ((defined($1) && $1 ne ',') ||
5281 (defined($2) && $2 ne ','))) {
5282 CHK("MACRO_ARG_PRECEDENCE",
5283 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005284 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005285 }
Joe Perches5023d342012-12-17 16:01:47 -08005286
Joe Perches08a28432014-10-13 15:51:55 -07005287# check for macros with flow control, but without ## concatenation
5288# ## concatenation is commonly a macro that defines a function so ignore those
5289 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005290 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005291 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005292
Joe Perches08a28432014-10-13 15:51:55 -07005293 WARN("MACRO_WITH_FLOW_CONTROL",
5294 "Macros with flow control statements should be avoided\n" . "$herectx");
5295 }
5296
Joe Perches481eb482012-12-17 16:01:56 -08005297# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005298
5299 } else {
5300 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005301 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5302 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005303 $line =~ /^\+.*\\$/) {
5304 WARN("LINE_CONTINUATIONS",
5305 "Avoid unnecessary line continuations\n" . $herecurr);
5306 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005307 }
5308
Joe Perchesb13edf72012-07-30 14:41:24 -07005309# do {} while (0) macro tests:
5310# single-statement macros do not need to be enclosed in do while (0) loop,
5311# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005312 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005313 $realfile !~ m@/vmlinux.lds.h$@ &&
5314 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5315 my $ln = $linenr;
5316 my $cnt = $realcnt;
5317 my ($off, $dstat, $dcond, $rest);
5318 my $ctx = '';
5319 ($dstat, $dcond, $ln, $cnt, $off) =
5320 ctx_statement_block($linenr, $realcnt, 0);
5321 $ctx = $dstat;
5322
5323 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005324 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005325
5326 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5327 my $stmts = $2;
5328 my $semis = $3;
5329
5330 $ctx =~ s/\n*$//;
5331 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005332 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005333
Joe Perchesac8e97f2012-08-21 16:15:53 -07005334 if (($stmts =~ tr/;/;/) == 1 &&
5335 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005336 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5337 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5338 }
5339 if (defined $semis && $semis ne "") {
5340 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5341 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5342 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005343 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5344 $ctx =~ s/\n*$//;
5345 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005346 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005347
5348 WARN("TRAILING_SEMICOLON",
5349 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005350 }
5351 }
5352
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005353# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005354 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5355 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005356 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005357 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005358 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5359 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005360 my @allowed = ();
5361 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005362 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005363 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005364 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005365 for my $chunk (@chunks) {
5366 my ($cond, $block) = @{$chunk};
5367
Andy Whitcroft773647a2008-03-28 14:15:58 -07005368 # If the condition carries leading newlines, then count those as offsets.
5369 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5370 my $offset = statement_rawlines($whitespace) - 1;
5371
Joe Perchesaad4f612012-03-23 15:02:19 -07005372 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005373 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5374
5375 # We have looked at and allowed this specific line.
5376 $suppress_ifbraces{$ln + $offset} = 1;
5377
5378 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005379 $ln += statement_rawlines($block) - 1;
5380
Andy Whitcroft773647a2008-03-28 14:15:58 -07005381 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005382
5383 $seen++ if ($block =~ /^\s*{/);
5384
Joe Perchesaad4f612012-03-23 15:02:19 -07005385 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005386 if (statement_lines($cond) > 1) {
5387 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005388 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005389 }
5390 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005391 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005392 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005393 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005394 if (statement_block_size($block) > 1) {
5395 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005396 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005397 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005398 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005399 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005400 if ($seen) {
5401 my $sum_allowed = 0;
5402 foreach (@allowed) {
5403 $sum_allowed += $_;
5404 }
5405 if ($sum_allowed == 0) {
5406 WARN("BRACES",
5407 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5408 } elsif ($sum_allowed != $allow &&
5409 $seen != $allow) {
5410 CHK("BRACES",
5411 "braces {} should be used on all arms of this statement\n" . $herectx);
5412 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005413 }
5414 }
5415 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005416 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005417 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005418 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005419
Andy Whitcroftcf655042008-03-04 14:28:20 -08005420 # Check the pre-context.
5421 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5422 #print "APW: ALLOWED: pre<$1>\n";
5423 $allowed = 1;
5424 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005425
5426 my ($level, $endln, @chunks) =
5427 ctx_statement_full($linenr, $realcnt, $-[0]);
5428
Andy Whitcroftcf655042008-03-04 14:28:20 -08005429 # Check the condition.
5430 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005431 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005432 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005433 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005434 }
5435 if (statement_lines($cond) > 1) {
5436 #print "APW: ALLOWED: cond<$cond>\n";
5437 $allowed = 1;
5438 }
5439 if ($block =~/\b(?:if|for|while)\b/) {
5440 #print "APW: ALLOWED: block<$block>\n";
5441 $allowed = 1;
5442 }
5443 if (statement_block_size($block) > 1) {
5444 #print "APW: ALLOWED: lines block<$block>\n";
5445 $allowed = 1;
5446 }
5447 # Check the post-context.
5448 if (defined $chunks[1]) {
5449 my ($cond, $block) = @{$chunks[1]};
5450 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005451 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005452 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005453 if ($block =~ /^\s*\{/) {
5454 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5455 $allowed = 1;
5456 }
5457 }
5458 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005459 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005460 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005461
Joe Perches000d1cc12011-07-25 17:13:25 -07005462 WARN("BRACES",
5463 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005464 }
5465 }
5466
Joe Perchese4c5bab2017-02-24 15:01:41 -08005467# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005468 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5469 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005470 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5471 }
5472
Joe Perches0979ae62012-12-17 16:01:59 -08005473# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005474 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005475 if (CHK("BRACES",
5476 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5477 $fix && $prevrawline =~ /^\+/) {
5478 fix_delete_line($fixlinenr - 1, $prevrawline);
5479 }
Joe Perches0979ae62012-12-17 16:01:59 -08005480 }
Joe Perches77b9a532013-07-03 15:05:29 -07005481 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005482 if (CHK("BRACES",
5483 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5484 $fix) {
5485 fix_delete_line($fixlinenr, $rawline);
5486 }
Joe Perches0979ae62012-12-17 16:01:59 -08005487 }
5488
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005489# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005490 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5491 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005492 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005493 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005494 }
5495
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005496# Check for user-visible strings broken across lines, which breaks the ability
5497# to grep for the string. Make exceptions when the previous string ends in a
5498# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5499# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005500 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005501 $prevline =~ /"\s*$/ &&
5502 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5503 if (WARN("SPLIT_STRING",
5504 "quoted string split across lines\n" . $hereprev) &&
5505 $fix &&
5506 $prevrawline =~ /^\+.*"\s*$/ &&
5507 $last_coalesced_string_linenr != $linenr - 1) {
5508 my $extracted_string = get_quoted_string($line, $rawline);
5509 my $comma_close = "";
5510 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5511 $comma_close = $1;
5512 }
5513
5514 fix_delete_line($fixlinenr - 1, $prevrawline);
5515 fix_delete_line($fixlinenr, $rawline);
5516 my $fixedline = $prevrawline;
5517 $fixedline =~ s/"\s*$//;
5518 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5519 fix_insert_line($fixlinenr - 1, $fixedline);
5520 $fixedline = $rawline;
5521 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5522 if ($fixedline !~ /\+\s*$/) {
5523 fix_insert_line($fixlinenr, $fixedline);
5524 }
5525 $last_coalesced_string_linenr = $linenr;
5526 }
5527 }
5528
5529# check for missing a space in a string concatenation
5530 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5531 WARN('MISSING_SPACE',
5532 "break quoted strings at a space character\n" . $hereprev);
5533 }
5534
Joe Perchese4b7d302017-05-08 15:55:51 -07005535# check for an embedded function name in a string when the function is known
5536# This does not work very well for -f --file checking as it depends on patch
5537# context providing the function name or a single line form for in-file
5538# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005539 if ($line =~ /^\+.*$String/ &&
5540 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005541 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5542 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005543 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005544 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005545 }
5546
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005547# check for spaces before a quoted newline
5548 if ($rawline =~ /^.*\".*\s\\n/) {
5549 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5550 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5551 $fix) {
5552 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5553 }
5554
5555 }
5556
Joe Perchesf17dba42014-10-13 15:51:51 -07005557# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005558 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5559 if (CHK("CONCATENATED_STRING",
5560 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5561 $fix) {
5562 while ($line =~ /($String)/g) {
5563 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5564 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5565 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5566 }
5567 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005568 }
5569
Joe Perches90ad30e2014-12-10 15:51:59 -08005570# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005571 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005572 if (WARN("STRING_FRAGMENTS",
5573 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5574 $fix) {
5575 while ($line =~ /($String)(?=\s*")/g) {
5576 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5577 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5578 }
5579 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005580 }
5581
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005582# check for non-standard and hex prefixed decimal printf formats
5583 my $show_L = 1; #don't show the same defect twice
5584 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005585 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005586 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005587 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005588 # check for %L
5589 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005590 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005591 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5592 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005593 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005594 # check for %Z
5595 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5596 WARN("PRINTF_Z",
5597 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5598 $show_Z = 0;
5599 }
5600 # check for 0x<decimal>
5601 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5602 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005603 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5604 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005605 }
5606
5607# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005608 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005609 WARN("LINE_CONTINUATIONS",
5610 "Avoid line continuations in quoted strings\n" . $herecurr);
5611 }
5612
Andy Whitcroft00df3442007-06-08 13:47:06 -07005613# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005614 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07005615 WARN("IF_0",
5616 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5617 }
5618
5619# warn about #if 1
5620 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5621 WARN("IF_1",
5622 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005623 }
5624
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005625# check for needless "if (<foo>) fn(<foo>)" uses
5626 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005627 my $tested = quotemeta($1);
5628 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5629 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5630 my $func = $1;
5631 if (WARN('NEEDLESS_IF',
5632 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5633 $fix) {
5634 my $do_fix = 1;
5635 my $leading_tabs = "";
5636 my $new_leading_tabs = "";
5637 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5638 $leading_tabs = $1;
5639 } else {
5640 $do_fix = 0;
5641 }
5642 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5643 $new_leading_tabs = $1;
5644 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5645 $do_fix = 0;
5646 }
5647 } else {
5648 $do_fix = 0;
5649 }
5650 if ($do_fix) {
5651 fix_delete_line($fixlinenr - 1, $prevrawline);
5652 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5653 }
5654 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005655 }
5656 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005657
Joe Perchesebfdc402014-08-06 16:10:27 -07005658# check for unnecessary "Out of Memory" messages
5659 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5660 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5661 (defined $1 || defined $3) &&
5662 $linenr > 3) {
5663 my $testval = $2;
5664 my $testline = $lines[$linenr - 3];
5665
5666 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5667# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5668
Joe Perchese29a70f2019-03-07 16:28:35 -08005669 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5670 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005671 WARN("OOM_MESSAGE",
5672 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5673 }
5674 }
5675
Joe Perchesf78d98f2014-10-13 15:52:01 -07005676# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005677 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005678 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5679 my $level = $1;
5680 if (WARN("UNNECESSARY_KERN_LEVEL",
5681 "Possible unnecessary $level\n" . $herecurr) &&
5682 $fix) {
5683 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5684 }
5685 }
5686
Joe Perches45c55e92017-02-24 15:01:31 -08005687# check for logging continuations
5688 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5689 WARN("LOGGING_CONTINUATION",
5690 "Avoid logging continuation uses where feasible\n" . $herecurr);
5691 }
5692
Joe Perchesabb08a52014-12-10 15:51:46 -08005693# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07005694 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08005695 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5696 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5697 WARN("MASK_THEN_SHIFT",
5698 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5699 }
5700
Joe Perchesb75ac612014-12-10 15:52:02 -08005701# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07005702 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08005703 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5704 my $val = $1;
5705 my $equal = "!";
5706 $equal = "" if ($4 eq "!=");
5707 if (CHK("COMPARISON_TO_NULL",
5708 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5709 $fix) {
5710 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5711 }
5712 }
5713 }
5714
Joe Perches8716de32013-09-11 14:24:05 -07005715# check for bad placement of section $InitAttribute (e.g.: __initdata)
5716 if ($line =~ /(\b$InitAttribute\b)/) {
5717 my $attr = $1;
5718 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5719 my $ptr = $1;
5720 my $var = $2;
5721 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5722 ERROR("MISPLACED_INIT",
5723 "$attr should be placed after $var\n" . $herecurr)) ||
5724 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5725 WARN("MISPLACED_INIT",
5726 "$attr should be placed after $var\n" . $herecurr))) &&
5727 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005728 $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 -07005729 }
5730 }
5731 }
5732
Joe Perchese970b8842013-11-12 15:10:10 -08005733# check for $InitAttributeData (ie: __initdata) with const
5734 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5735 my $attr = $1;
5736 $attr =~ /($InitAttributePrefix)(.*)/;
5737 my $attr_prefix = $1;
5738 my $attr_type = $2;
5739 if (ERROR("INIT_ATTRIBUTE",
5740 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5741 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005742 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005743 s/$InitAttributeData/${attr_prefix}initconst/;
5744 }
5745 }
5746
5747# check for $InitAttributeConst (ie: __initconst) without const
5748 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5749 my $attr = $1;
5750 if (ERROR("INIT_ATTRIBUTE",
5751 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5752 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005753 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005754 /(^\+\s*(?:static\s+))/;
5755 $lead = rtrim($1);
5756 $lead = "$lead " if ($lead !~ /^\+$/);
5757 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005758 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005759 }
5760 }
5761
Joe Perchesc17893c2015-04-16 12:44:42 -07005762# check for __read_mostly with const non-pointer (should just be const)
5763 if ($line =~ /\b__read_mostly\b/ &&
5764 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5765 if (ERROR("CONST_READ_MOSTLY",
5766 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5767 $fix) {
5768 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5769 }
5770 }
5771
Joe Perchesfbdb8132014-04-03 14:49:14 -07005772# don't use __constant_<foo> functions outside of include/uapi/
5773 if ($realfile !~ m@^include/uapi/@ &&
5774 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5775 my $constant_func = $1;
5776 my $func = $constant_func;
5777 $func =~ s/^__constant_//;
5778 if (WARN("CONSTANT_CONVERSION",
5779 "$constant_func should be $func\n" . $herecurr) &&
5780 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005781 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005782 }
5783 }
5784
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005785# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005786 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005787 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005788 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005789 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005790 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005791 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07005792 }
5793 if ($delay > 2000) {
5794 WARN("LONG_UDELAY",
5795 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005796 }
5797 }
5798
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005799# warn about unexpectedly long msleep's
5800 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5801 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005802 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005803 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005804 }
5805 }
5806
Joe Perches36ec1932013-07-03 15:05:25 -07005807# check for comparisons of jiffies
5808 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5809 WARN("JIFFIES_COMPARISON",
5810 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5811 }
5812
Joe Perches9d7a34a2013-07-03 15:05:26 -07005813# check for comparisons of get_jiffies_64()
5814 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5815 WARN("JIFFIES_COMPARISON",
5816 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5817 }
5818
Andy Whitcroft00df3442007-06-08 13:47:06 -07005819# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005820# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005821# print "#ifdef in C files should be avoided\n";
5822# print "$herecurr";
5823# $clean = 0;
5824# }
5825
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005826# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005827 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005828 if (ERROR("SPACING",
5829 "exactly one space required after that #$1\n" . $herecurr) &&
5830 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005831 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005832 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5833 }
5834
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005835 }
5836
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005837# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005838 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5839 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005840 my $which = $1;
5841 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005842 CHK("UNCOMMENTED_DEFINITION",
5843 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005844 }
5845 }
5846# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005847
5848 my $barriers = qr{
5849 mb|
5850 rmb|
5851 wmb|
5852 read_barrier_depends
5853 }x;
5854 my $barrier_stems = qr{
5855 mb__before_atomic|
5856 mb__after_atomic|
5857 store_release|
5858 load_acquire|
5859 store_mb|
5860 (?:$barriers)
5861 }x;
5862 my $all_barriers = qr{
5863 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005864 smp_(?:$barrier_stems)|
5865 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005866 }x;
5867
5868 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005869 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005870 WARN("MEMORY_BARRIER",
5871 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005872 }
5873 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005874
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005875 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5876
5877 if ($realfile !~ m@^include/asm-generic/@ &&
5878 $realfile !~ m@/barrier\.h$@ &&
5879 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5880 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5881 WARN("MEMORY_BARRIER",
5882 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5883 }
5884
Joe Perchescb426e92015-06-25 15:02:46 -07005885# check for waitqueue_active without a comment.
5886 if ($line =~ /\bwaitqueue_active\s*\(/) {
5887 if (!ctx_has_comment($first_line, $linenr)) {
5888 WARN("WAITQUEUE_ACTIVE",
5889 "waitqueue_active without comment\n" . $herecurr);
5890 }
5891 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005892
Paul E. McKenney91db2592017-11-27 09:37:35 -08005893# check for smp_read_barrier_depends and read_barrier_depends
5894 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5895 WARN("READ_BARRIER_DEPENDS",
5896 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5897 }
5898
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005899# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005900 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005901 CHK("ARCH_DEFINES",
5902 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005903 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005904
Joe Perches596ed452017-07-12 14:37:02 -07005905# check that the storage class is not after a type
5906 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005907 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005908 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5909 }
5910# Check that the storage class is at the beginning of a declaration
5911 if ($line =~ /\b$Storage\b/ &&
5912 $line !~ /^.\s*$Storage/ &&
5913 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5914 $1 !~ /[\,\)]\s*$/) {
5915 WARN("STORAGE_CLASS",
5916 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005917 }
5918
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005919# check the location of the inline attribute, that it is between
5920# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005921 if ($line =~ /\b$Type\s+$Inline\b/ ||
5922 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005923 ERROR("INLINE_LOCATION",
5924 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005925 }
5926
Andy Whitcroft8905a672007-11-28 16:21:06 -08005927# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005928 if ($realfile !~ m@\binclude/uapi/@ &&
5929 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005930 if (WARN("INLINE",
5931 "plain inline is preferred over $1\n" . $herecurr) &&
5932 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005933 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005934
5935 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005936 }
5937
Joe Perches3d130fd2011-01-12 17:00:00 -08005938# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005939 if ($realfile !~ m@\binclude/uapi/@ &&
5940 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005941 WARN("PREFER_PACKED",
5942 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005943 }
5944
Joe Perches39b7e282011-07-25 17:13:24 -07005945# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005946 if ($realfile !~ m@\binclude/uapi/@ &&
5947 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005948 WARN("PREFER_ALIGNED",
5949 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005950 }
5951
Joe Perches462811d2019-09-25 16:46:44 -07005952# Check for __attribute__ section, prefer __section
5953 if ($realfile !~ m@\binclude/uapi/@ &&
5954 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
5955 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
5956 my $new = substr($old, 1, -1);
5957 if (WARN("PREFER_SECTION",
5958 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
5959 $fix) {
5960 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
5961 }
5962 }
5963
Joe Perches5f14d3b2012-01-10 15:09:52 -08005964# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005965 if ($realfile !~ m@\binclude/uapi/@ &&
5966 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005967 if (WARN("PREFER_PRINTF",
5968 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5969 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005970 $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 -07005971
5972 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005973 }
5974
Joe Perches6061d942012-03-23 15:02:16 -07005975# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005976 if ($realfile !~ m@\binclude/uapi/@ &&
5977 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005978 if (WARN("PREFER_SCANF",
5979 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5980 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005981 $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 -07005982 }
Joe Perches6061d942012-03-23 15:02:16 -07005983 }
5984
Joe Perches619a9082014-12-10 15:51:35 -08005985# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07005986 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08005987 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5988 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5989 $line =~ /\b__weak\b/)) {
5990 ERROR("WEAK_DECLARATION",
5991 "Using weak declarations can have unintended link defects\n" . $herecurr);
5992 }
5993
Tomas Winklerfd39f902016-12-12 16:46:34 -08005994# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005995 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005996 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005997 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5998 my $type = $1;
5999 if ($type =~ /\b($typeC99Typedefs)\b/) {
6000 $type = $1;
6001 my $kernel_type = 'u';
6002 $kernel_type = 's' if ($type =~ /^_*[si]/);
6003 $type =~ /(\d+)/;
6004 $kernel_type .= $1;
6005 if (CHK("PREFER_KERNEL_TYPES",
6006 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6007 $fix) {
6008 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6009 }
6010 }
6011 }
6012
Joe Perches938224b2016-01-20 14:59:15 -08006013# check for cast of C90 native int or longer types constants
6014 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6015 my $cast = $1;
6016 my $const = $2;
6017 if (WARN("TYPECAST_INT_CONSTANT",
6018 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6019 $fix) {
6020 my $suffix = "";
6021 my $newconst = $const;
6022 $newconst =~ s/${Int_type}$//;
6023 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6024 if ($cast =~ /\blong\s+long\b/) {
6025 $suffix .= 'LL';
6026 } elsif ($cast =~ /\blong\b/) {
6027 $suffix .= 'L';
6028 }
6029 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6030 }
6031 }
6032
Joe Perches8f53a9b2010-03-05 13:43:48 -08006033# check for sizeof(&)
6034 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006035 WARN("SIZEOF_ADDRESS",
6036 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08006037 }
6038
Joe Perches66c80b62012-07-30 14:41:22 -07006039# check for sizeof without parenthesis
6040 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006041 if (WARN("SIZEOF_PARENTHESIS",
6042 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6043 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006044 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006045 }
Joe Perches66c80b62012-07-30 14:41:22 -07006046 }
6047
Joe Perches88982fe2012-12-17 16:02:00 -08006048# check for struct spinlock declarations
6049 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6050 WARN("USE_SPINLOCK_T",
6051 "struct spinlock should be spinlock_t\n" . $herecurr);
6052 }
6053
Joe Perchesa6962d72013-04-29 16:18:13 -07006054# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006055 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006056 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006057 $fmt =~ s/%%//g;
6058 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006059 if (WARN("PREFER_SEQ_PUTS",
6060 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6061 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006062 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006063 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006064 }
6065 }
6066
Joe Perches478b1792018-04-10 16:33:34 -07006067# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006068 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006069 defined $stat &&
6070 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6071 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006072 my $stat_real;
6073
Joe Perches0b523762017-05-08 15:55:36 -07006074 my $lc = $stat =~ tr@\n@@;
6075 $lc = $lc + $linenr;
6076 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006077 my $specifier;
6078 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006079 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006080 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006081 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6082 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006083
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006084 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006085 $specifier = $1;
6086 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006087 $qualifier = $3;
Linus Torvalds361b0d22019-11-26 19:45:12 -08006088 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006089 ($extension eq "f" &&
6090 defined $qualifier && $qualifier !~ /^w/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006091 $bad_specifier = $specifier;
6092 last;
6093 }
6094 if ($extension eq "x" && !defined($stat_real)) {
6095 if (!defined($stat_real)) {
6096 $stat_real = get_stat_real($linenr, $lc);
6097 }
6098 WARN("VSPRINTF_SPECIFIER_PX",
6099 "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");
6100 }
6101 }
6102 if ($bad_specifier ne "") {
6103 my $stat_real = get_stat_real($linenr, $lc);
6104 my $ext_type = "Invalid";
6105 my $use = "";
6106 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006107 $use = " - use %pS instead";
6108 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6109 }
6110
6111 WARN("VSPRINTF_POINTER_EXTENSION",
6112 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6113 }
Joe Perches0b523762017-05-08 15:55:36 -07006114 }
6115 }
6116
Andy Whitcroft554e1652012-01-10 15:09:57 -08006117# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006118 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006119 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006120 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006121
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006122 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006123 my $ms_val = $7;
6124 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006125
Andy Whitcroft554e1652012-01-10 15:09:57 -08006126 if ($ms_size =~ /^(0x|)0$/i) {
6127 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006128 "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 -08006129 } elsif ($ms_size =~ /^(0x|)1$/i) {
6130 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006131 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6132 }
6133 }
6134
Joe Perches98a9bba2014-01-23 15:54:52 -08006135# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006136# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006137# defined $stat &&
6138# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6139# if (WARN("PREFER_ETHER_ADDR_COPY",
6140# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6141# $fix) {
6142# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6143# }
6144# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006145
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006146# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006147# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006148# defined $stat &&
6149# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6150# WARN("PREFER_ETHER_ADDR_EQUAL",
6151# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6152# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006153
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006154# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6155# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006156# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006157# defined $stat &&
6158# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6159#
6160# my $ms_val = $7;
6161#
6162# if ($ms_val =~ /^(?:0x|)0+$/i) {
6163# if (WARN("PREFER_ETH_ZERO_ADDR",
6164# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6165# $fix) {
6166# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6167# }
6168# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6169# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6170# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6171# $fix) {
6172# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6173# }
6174# }
6175# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006176
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006177# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006178 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006179 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006180 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006181 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006182 my $call = $1;
6183 my $cast1 = deparenthesize($2);
6184 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006185 my $cast2 = deparenthesize($7);
6186 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006187 my $cast;
6188
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006189 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006190 $cast = "$cast1 or $cast2";
6191 } elsif ($cast1 ne "") {
6192 $cast = $cast1;
6193 } else {
6194 $cast = $cast2;
6195 }
6196 WARN("MINMAX",
6197 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006198 }
6199 }
6200
Joe Perches4a273192012-07-30 14:41:20 -07006201# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006202 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006203 defined $stat &&
6204 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6205 my $min = $1;
6206 my $max = $7;
6207 if ($min eq $max) {
6208 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006209 "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 -07006210 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6211 $min > $max) {
6212 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006213 "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 -07006214 }
6215 }
6216
Joe Perches823b7942013-11-12 15:10:15 -08006217# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006218 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006219 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006220 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006221 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6222 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6223 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6224 my $lc = $stat =~ tr@\n@@;
6225 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006226 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006227 WARN("NAKED_SSCANF",
6228 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6229 }
6230
Joe Perchesafc819a2014-06-04 16:12:08 -07006231# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006232 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006233 defined $stat &&
6234 $line =~ /\bsscanf\b/) {
6235 my $lc = $stat =~ tr@\n@@;
6236 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006237 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006238 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6239 my $format = $6;
6240 my $count = $format =~ tr@%@%@;
6241 if ($count == 1 &&
6242 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6243 WARN("SSCANF_TO_KSTRTO",
6244 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6245 }
6246 }
6247 }
6248
Joe Perches70dc8a42013-09-11 14:23:58 -07006249# check for new externs in .h files.
6250 if ($realfile =~ /\.h$/ &&
6251 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006252 if (CHK("AVOID_EXTERNS",
6253 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006254 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006255 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006256 }
6257 }
6258
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006259# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006260 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006261 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006262 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006263 my $function_name = $1;
6264 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006265
6266 my $s = $stat;
6267 if (defined $cond) {
6268 substr($s, 0, length($cond), '');
6269 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006270 if ($s =~ /^\s*;/ &&
6271 $function_name ne 'uninitialized_var')
6272 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006273 WARN("AVOID_EXTERNS",
6274 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006275 }
6276
6277 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006278 WARN("FUNCTION_ARGUMENTS",
6279 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006280 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006281
6282 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6283 $stat =~ /^.\s*extern\s+/)
6284 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006285 WARN("AVOID_EXTERNS",
6286 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006287 }
6288
Joe Perchesa0ad7592017-07-10 15:52:19 -07006289# check for function declarations that have arguments without identifier names
Joe Perches16b7f3c2020-04-06 20:11:17 -07006290# while avoiding uninitialized_var(x)
Joe Perchesa0ad7592017-07-10 15:52:19 -07006291 if (defined $stat &&
Joe Perches16b7f3c2020-04-06 20:11:17 -07006292 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:($Ident)|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6293 (!defined($1) ||
6294 (defined($1) && $1 ne "uninitialized_var")) &&
6295 $2 ne "void") {
6296 my $args = trim($2);
Joe Perchesca0d8922016-10-11 13:52:16 -07006297 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6298 my $arg = trim($1);
Joe Perches16b7f3c2020-04-06 20:11:17 -07006299 if ($arg =~ /^$Type$/ &&
6300 $arg !~ /enum\s+$Ident$/) {
Joe Perchesca0d8922016-10-11 13:52:16 -07006301 WARN("FUNCTION_ARGUMENTS",
6302 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6303 }
6304 }
6305 }
6306
Joe Perchesa0ad7592017-07-10 15:52:19 -07006307# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006308 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006309 defined $stat &&
6310 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6311 $context_function = $1;
6312
6313# check for multiline function definition with misplaced open brace
6314 my $ok = 0;
6315 my $cnt = statement_rawlines($stat);
6316 my $herectx = $here . "\n";
6317 for (my $n = 0; $n < $cnt; $n++) {
6318 my $rl = raw_line($linenr, $n);
6319 $herectx .= $rl . "\n";
6320 $ok = 1 if ($rl =~ /^[ \+]\{/);
6321 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6322 last if $rl =~ /^[ \+].*\{/;
6323 }
6324 if (!$ok) {
6325 ERROR("OPEN_BRACE",
6326 "open brace '{' following function definitions go on the next line\n" . $herectx);
6327 }
6328 }
6329
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006330# checks for new __setup's
6331 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6332 my $name = $1;
6333
6334 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006335 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006336 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006337 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006338 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006339
Joe Perchese29a70f2019-03-07 16:28:35 -08006340# check for pointless casting of alloc functions
6341 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006342 WARN("UNNECESSARY_CASTS",
6343 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006344 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006345
Joe Perchesa640d252013-07-03 15:05:21 -07006346# alloc style
6347# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006348 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006349 $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 -07006350 CHK("ALLOC_SIZEOF_STRUCT",
6351 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6352 }
6353
Joe Perches60a55362014-06-04 16:12:07 -07006354# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006355 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006356 defined $stat &&
6357 $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 -07006358 my $oldfunc = $3;
6359 my $a1 = $4;
6360 my $a2 = $10;
6361 my $newfunc = "kmalloc_array";
6362 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006363 my $r1 = $a1;
6364 my $r2 = $a2;
6365 if ($a1 =~ /^sizeof\s*\S/) {
6366 $r1 = $a2;
6367 $r2 = $a1;
6368 }
6369 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6370 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006371 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006372 my $herectx = get_stat_here($linenr, $cnt, $here);
6373
Joe Perches60a55362014-06-04 16:12:07 -07006374 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006375 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6376 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006377 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006378 $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 -07006379 }
6380 }
6381 }
6382
Joe Perches972fdea2013-04-29 16:18:12 -07006383# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006384 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006385 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6386 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006387 WARN("KREALLOC_ARG_REUSE",
6388 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6389 }
6390
Joe Perches5ce59ae2013-02-21 16:44:18 -08006391# check for alloc argument mismatch
6392 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6393 WARN("ALLOC_ARRAY_ARGS",
6394 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6395 }
6396
Joe Perchescaf2a542011-01-12 16:59:56 -08006397# check for multiple semicolons
6398 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006399 if (WARN("ONE_SEMICOLON",
6400 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6401 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006402 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006403 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006404 }
6405
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006406# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6407 if ($realfile !~ m@^include/uapi/@ &&
6408 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006409 my $ull = "";
6410 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6411 if (CHK("BIT_MACRO",
6412 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6413 $fix) {
6414 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6415 }
6416 }
6417
Joe Perches2d632742016-05-20 17:04:00 -07006418# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6419 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6420 my $config = $1;
6421 if (WARN("PREFER_IS_ENABLED",
6422 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6423 $fix) {
6424 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6425 }
6426 }
6427
Joe Perchese81f2392014-08-06 16:11:25 -07006428# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006429 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6430 my $has_break = 0;
6431 my $has_statement = 0;
6432 my $count = 0;
6433 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006434 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006435 $prevline--;
6436 my $rline = $rawlines[$prevline - 1];
6437 my $fline = $lines[$prevline - 1];
6438 last if ($fline =~ /^\@\@/);
6439 next if ($fline =~ /^\-/);
6440 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6441 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6442 next if ($fline =~ /^.[\s$;]*$/);
6443 $has_statement = 1;
6444 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006445 $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 -08006446 }
6447 if (!$has_break && $has_statement) {
6448 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006449 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006450 }
6451 }
6452
Joe Perchesf36d3eb2020-04-06 20:10:58 -07006453# check for /* fallthrough */ like comment, prefer fallthrough;
6454 my @fallthroughs = (
6455 'fallthrough',
6456 '@fallthrough@',
6457 'lint -fallthrough[ \t]*',
6458 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6459 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6460 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6461 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6462 );
6463 if ($raw_comment ne '') {
6464 foreach my $ft (@fallthroughs) {
6465 if ($raw_comment =~ /$ft/) {
6466 my $msg_level = \&WARN;
6467 $msg_level = \&CHK if ($file);
6468 &{$msg_level}("PREFER_FALLTHROUGH",
6469 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6470 last;
6471 }
6472 }
6473 }
6474
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006475# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006476 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006477 defined $stat &&
6478 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006479 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006480 my $herectx = get_stat_here($linenr, $cnt, $here);
6481
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006482 WARN("DEFAULT_NO_BREAK",
6483 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006484 }
6485
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006486# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006487 if ($line =~ /\b__FUNCTION__\b/) {
6488 if (WARN("USE_FUNC",
6489 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6490 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006491 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006492 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006493 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006494
Joe Perches62ec8182015-02-13 14:38:18 -08006495# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6496 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6497 ERROR("DATE_TIME",
6498 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6499 }
6500
Joe Perches2c924882012-03-23 15:02:20 -07006501# check for use of yield()
6502 if ($line =~ /\byield\s*\(\s*\)/) {
6503 WARN("YIELD",
6504 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6505 }
6506
Joe Perches179f8f42013-07-03 15:05:30 -07006507# check for comparisons against true and false
6508 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6509 my $lead = $1;
6510 my $arg = $2;
6511 my $test = $3;
6512 my $otype = $4;
6513 my $trail = $5;
6514 my $op = "!";
6515
6516 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6517
6518 my $type = lc($otype);
6519 if ($type =~ /^(?:true|false)$/) {
6520 if (("$test" eq "==" && "$type" eq "true") ||
6521 ("$test" eq "!=" && "$type" eq "false")) {
6522 $op = "";
6523 }
6524
6525 CHK("BOOL_COMPARISON",
6526 "Using comparison to $otype is error prone\n" . $herecurr);
6527
6528## maybe suggesting a correct construct would better
6529## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6530
6531 }
6532 }
6533
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006534# check for semaphores initialized locked
6535 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006536 WARN("CONSIDER_COMPLETION",
6537 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006538 }
Joe Perches6712d852012-03-23 15:02:20 -07006539
Joe Perches67d0a072011-10-31 17:13:10 -07006540# recommend kstrto* over simple_strto* and strict_strto*
6541 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006542 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006543 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006544 }
Joe Perches6712d852012-03-23 15:02:20 -07006545
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006546# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006547 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006548 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006549 "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 -07006550 }
Joe Perches6712d852012-03-23 15:02:20 -07006551
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006552# check for spin_is_locked(), suggest lockdep instead
6553 if ($line =~ /\bspin_is_locked\(/) {
6554 WARN("USE_LOCKDEP",
6555 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6556 }
6557
Joe Perches9189c7e2018-09-07 15:26:18 -07006558# check for deprecated apis
6559 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6560 my $deprecated_api = $1;
6561 my $new_api = $deprecated_apis{$deprecated_api};
6562 WARN("DEPRECATED_API",
6563 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6564 }
6565
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006566# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006567# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006568 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006569 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006570 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006571 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006572 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006573
6574# use of NR_CPUS is usually wrong
6575# ignore definitions of NR_CPUS and usage to define arrays as likely right
6576 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006577 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6578 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006579 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6580 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6581 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006582 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006583 WARN("NR_CPUS",
6584 "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 -07006585 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006586
Joe Perches52ea8502013-11-12 15:10:09 -08006587# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6588 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6589 ERROR("DEFINE_ARCH_HAS",
6590 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6591 }
6592
Joe Perchesacd93622015-02-13 14:38:38 -08006593# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07006594 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08006595 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6596 WARN("LIKELY_MISUSE",
6597 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6598 }
6599
Denis Efremovde3f1862019-09-25 16:49:25 -07006600# nested likely/unlikely calls
6601 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6602 WARN("LIKELY_MISUSE",
6603 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6604 }
6605
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006606# whine mightly about in_atomic
6607 if ($line =~ /\bin_atomic\s*\(/) {
6608 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006609 ERROR("IN_ATOMIC",
6610 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006611 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006612 WARN("IN_ATOMIC",
6613 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006614 }
6615 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006616
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006617# check for mutex_trylock_recursive usage
6618 if ($line =~ /mutex_trylock_recursive/) {
6619 ERROR("LOCKING",
6620 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6621 }
6622
Peter Zijlstra1704f472010-03-19 01:37:42 +01006623# check for lockdep_set_novalidate_class
6624 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6625 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6626 if ($realfile !~ m@^kernel/lockdep@ &&
6627 $realfile !~ m@^include/linux/lockdep@ &&
6628 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006629 ERROR("LOCKDEP",
6630 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006631 }
6632 }
Dave Jones88f88312011-01-12 16:59:59 -08006633
Joe Perchesb392c642015-04-16 12:44:16 -07006634 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6635 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006636 WARN("EXPORTED_WORLD_WRITABLE",
6637 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006638 }
Joe Perches24358802014-04-03 14:49:13 -07006639
Joe Perches00180462018-02-06 15:38:55 -08006640# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6641# and whether or not function naming is typical and if
6642# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07006643 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08006644 defined $stat &&
6645 $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*\)/) {
6646 my $var = $1;
6647 my $perms = $2;
6648 my $show = $3;
6649 my $store = $4;
6650 my $octal_perms = perms_to_octal($perms);
6651 if ($show =~ /^${var}_show$/ &&
6652 $store =~ /^${var}_store$/ &&
6653 $octal_perms eq "0644") {
6654 if (WARN("DEVICE_ATTR_RW",
6655 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6656 $fix) {
6657 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6658 }
6659 } elsif ($show =~ /^${var}_show$/ &&
6660 $store =~ /^NULL$/ &&
6661 $octal_perms eq "0444") {
6662 if (WARN("DEVICE_ATTR_RO",
6663 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6664 $fix) {
6665 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6666 }
6667 } elsif ($show =~ /^NULL$/ &&
6668 $store =~ /^${var}_store$/ &&
6669 $octal_perms eq "0200") {
6670 if (WARN("DEVICE_ATTR_WO",
6671 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6672 $fix) {
6673 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6674 }
6675 } elsif ($octal_perms eq "0644" ||
6676 $octal_perms eq "0444" ||
6677 $octal_perms eq "0200") {
6678 my $newshow = "$show";
6679 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6680 my $newstore = $store;
6681 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6682 my $rename = "";
6683 if ($show ne $newshow) {
6684 $rename .= " '$show' to '$newshow'";
6685 }
6686 if ($store ne $newstore) {
6687 $rename .= " '$store' to '$newstore'";
6688 }
6689 WARN("DEVICE_ATTR_FUNCTIONS",
6690 "Consider renaming function(s)$rename\n" . $herecurr);
6691 } else {
6692 WARN("DEVICE_ATTR_PERMS",
6693 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6694 }
6695 }
6696
Joe Perches515a2352014-04-03 14:49:24 -07006697# Mode permission misuses where it seems decimal should be octal
6698# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006699# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6700# specific definition of not visible in sysfs.
6701# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6702# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07006703 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006704 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006705 $line =~ /$mode_perms_search/) {
6706 foreach my $entry (@mode_permission_funcs) {
6707 my $func = $entry->[0];
6708 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006709
Joe Perches459cf0a2016-10-11 13:52:19 -07006710 my $lc = $stat =~ tr@\n@@;
6711 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006712 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006713
Joe Perches515a2352014-04-03 14:49:24 -07006714 my $skip_args = "";
6715 if ($arg_pos > 1) {
6716 $arg_pos--;
6717 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6718 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006719 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006720 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006721 my $val = $1;
6722 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006723 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6724 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6725 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006726 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006727 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006728 }
6729 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006730 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006731 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006732 }
Joe Perches24358802014-04-03 14:49:13 -07006733 }
6734 }
6735 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006736
Joe Perches459cf0a2016-10-11 13:52:19 -07006737# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07006738 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08006739 my $oval = $1;
6740 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006741 if (WARN("SYMBOLIC_PERMS",
6742 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6743 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006744 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006745 }
6746 }
6747
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006748# validate content of MODULE_LICENSE against list from include/linux/module.h
6749 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6750 my $extracted_string = get_quoted_string($line, $rawline);
6751 my $valid_licenses = qr{
6752 GPL|
6753 GPL\ v2|
6754 GPL\ and\ additional\ rights|
6755 Dual\ BSD/GPL|
6756 Dual\ MIT/GPL|
6757 Dual\ MPL/GPL|
6758 Proprietary
6759 }x;
6760 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6761 WARN("MODULE_LICENSE",
6762 "unknown module license " . $extracted_string . "\n" . $herecurr);
6763 }
6764 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07006765
6766# check for sysctl duplicate constants
6767 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6768 WARN("DUPLICATED_SYSCTL_CONST",
6769 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6770 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006771 }
6772
6773 # If we have no input at all, then there is nothing to report on
6774 # so just keep quiet.
6775 if ($#rawlines == -1) {
6776 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006777 }
6778
Andy Whitcroft8905a672007-11-28 16:21:06 -08006779 # In mailback mode only produce a report in the negative, for
6780 # things that appear to be patches.
6781 if ($mailback && ($clean == 1 || !$is_patch)) {
6782 exit(0);
6783 }
6784
6785 # This is not a patch, and we are are in 'no-patch' mode so
6786 # just keep quiet.
6787 if (!$chk_patch && !$is_patch) {
6788 exit(0);
6789 }
6790
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006791 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006792 ERROR("NOT_UNIFIED_DIFF",
6793 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006794 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07006795 if ($is_patch && $has_commit_log && $chk_signoff) {
6796 if ($signoff == 0) {
6797 ERROR("MISSING_SIGN_OFF",
6798 "Missing Signed-off-by: line(s)\n");
6799 } elsif (!$authorsignoff) {
6800 WARN("NO_AUTHOR_SIGN_OFF",
6801 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6802 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006803 }
6804
Andy Whitcroft8905a672007-11-28 16:21:06 -08006805 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006806 if ($summary && !($clean == 1 && $quiet == 1)) {
6807 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006808 print "total: $cnt_error errors, $cnt_warn warnings, " .
6809 (($check)? "$cnt_chk checks, " : "") .
6810 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006811 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006812
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006813 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006814 # If there were any defects found and not already fixing them
6815 if (!$clean and !$fix) {
6816 print << "EOM"
6817
6818NOTE: For some of the reported defects, checkpatch may be able to
6819 mechanically convert to the typical style using --fix or --fix-inplace.
6820EOM
6821 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006822 # If there were whitespace errors which cleanpatch can fix
6823 # then suggest that.
6824 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006825 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006826 print << "EOM"
6827
6828NOTE: Whitespace errors detected.
6829 You may wish to use scripts/cleanpatch or scripts/cleanfile
6830EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006831 }
6832 }
6833
Joe Perchesd752fcc2014-08-06 16:11:05 -07006834 if ($clean == 0 && $fix &&
6835 ("@rawlines" ne "@fixed" ||
6836 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006837 my $newfile = $filename;
6838 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006839 my $linecount = 0;
6840 my $f;
6841
Joe Perchesd752fcc2014-08-06 16:11:05 -07006842 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6843
Joe Perches3705ce52013-07-03 15:05:31 -07006844 open($f, '>', $newfile)
6845 or die "$P: Can't open $newfile for write\n";
6846 foreach my $fixed_line (@fixed) {
6847 $linecount++;
6848 if ($file) {
6849 if ($linecount > 3) {
6850 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006851 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006852 }
6853 } else {
6854 print $f $fixed_line . "\n";
6855 }
6856 }
6857 close($f);
6858
6859 if (!$quiet) {
6860 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006861
Joe Perches3705ce52013-07-03 15:05:31 -07006862Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6863
6864Do _NOT_ trust the results written to this file.
6865Do _NOT_ submit these changes without inspecting them for correctness.
6866
6867This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6868No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006869EOM
6870 }
6871 }
6872
Joe Perchesd8469f12015-06-25 15:03:00 -07006873 if ($quiet == 0) {
6874 print "\n";
6875 if ($clean == 1) {
6876 print "$vname has no obvious style problems and is ready for submission.\n";
6877 } else {
6878 print "$vname has style problems, please review.\n";
6879 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006880 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006881 return $clean;
6882}