blob: 360ae4b84ee3e1b2e5946d8f15d7b93aa70e4de4 [file] [log] [blame]
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02001#!/usr/bin/env perl
Joe Perches882ea1d2018-06-07 17:04:33 -07002# SPDX-License-Identifier: GPL-2.0
3#
Dave Jonesdbf004d2010-01-12 16:59:52 -05004# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07005# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08006# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07007# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Joe Perches882ea1d2018-06-07 17:04:33 -07008# (c) 2010-2018 Joe Perches <joe@perches.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07009
10use strict;
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +020011use warnings;
Joe Perchesc707a812013-07-08 16:00:43 -070012use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080013use File::Basename;
14use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070015use Term::ANSIColor qw(:constants);
Geert Uytterhoevencd261492018-08-21 21:57:40 -070016use Encode qw(decode encode);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070017
18my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080019my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070020
Joe Perches000d1cc12011-07-25 17:13:25 -070021my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070022
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
26my $tree = 1;
27my $chk_signoff = 1;
28my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070029my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080031my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070032my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070034my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070035my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070036my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070037my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080038my $summary = 1;
39my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080040my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070041my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070042my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070043my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080044my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070045my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080046my %debug;
Joe Perches34456862013-07-03 15:05:34 -070047my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070048my %use_type = ();
49my @use = ();
50my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070051my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070052my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070053my $configuration_file = ".checkpatch.conf";
Joe Perchesbdc48fa2020-05-29 16:12:21 -070054my $max_line_length = 100;
Dave Hansend62a2012013-09-11 14:23:56 -070055my $ignore_perl_version = 0;
56my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070057my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070058my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070059my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070060my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070061my $conststructsfile = "$D/const_structs.checkpatch";
Quentin Monnetced69da12020-08-11 18:35:13 -070062my $typedefsfile;
John Brooks737c0762017-07-10 15:52:24 -070063my $color = "auto";
Vadim Bendebury98005e82019-03-07 16:28:38 -080064my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
Joe Perchesdbbf8692019-09-25 16:46:52 -070065# git output parsing needs US English output, so first set backtick child process LANGUAGE
66my $git_command ='export LANGUAGE=en_US.UTF-8; git';
Antonio Borneo713a09d2020-04-06 20:11:07 -070067my $tabsize = 8;
Jerome Forissier3e89ad82020-10-15 20:11:49 -070068my ${CONFIG_} = "CONFIG_";
Hannes Eder77f5b102009-09-21 17:04:37 -070069
70sub help {
71 my ($exitcode) = @_;
72
73 print << "EOM";
74Usage: $P [OPTION]... [FILE]...
75Version: $V
76
77Options:
78 -q, --quiet quiet
79 --no-tree run without a kernel tree
80 --no-signoff do not check for 'Signed-off-by' line
81 --patch treat FILE as patchfile (default)
82 --emacs emacs compile window format
83 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070084 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070085 -g, --git treat FILE as a single commit or git revision range
86 single git commit with:
87 <rev>
88 <rev>^
89 <rev>~n
90 multiple git commits with:
91 <rev1>..<rev2>
92 <rev1>...<rev2>
93 <rev>-<count>
94 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070095 -f, --file treat FILE as regular source file
96 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070097 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070098 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070099 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -0700100 --show-types show the specific message type in the output
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700101 --max-line-length=n set the maximum line length, (default $max_line_length)
102 if exceeded, warn on patches
103 requires --strict for use with --file
Vadim Bendebury56193272014-10-13 15:51:48 -0700104 --min-conf-desc-length=n set the min description length, if shorter, warn
Joe Perchesbdc48fa2020-05-29 16:12:21 -0700105 --tab-size=n set the number of spaces for tab (default $tabsize)
Hannes Eder77f5b102009-09-21 17:04:37 -0700106 --root=PATH PATH to the kernel tree root
107 --no-summary suppress the per-file summary
108 --mailback only produce a report in case of warnings/errors
109 --summary-file include the filename in summary
110 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
111 'values', 'possible', 'type', and 'attr' (default
112 is all off)
113 --test-only=WORD report only warnings/errors containing WORD
114 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700115 --fix EXPERIMENTAL - may create horrible results
116 If correctable single-line errors exist, create
117 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
118 with potential errors corrected to the preferred
119 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800120 --fix-inplace EXPERIMENTAL - may create horrible results
121 Is the same as --fix, but overwrites the input
122 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700123 --ignore-perl-version override checking of perl version. expect
124 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700125 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700126 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700127 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700128 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700129 --color[=WHEN] Use colors 'always', 'never', or only when output
130 is a terminal ('auto'). Default is 'auto'.
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700131 --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default
132 ${CONFIG_})
Hannes Eder77f5b102009-09-21 17:04:37 -0700133 -h, --help, --version display this help and exit
134
135When FILE is - read standard input.
136EOM
137
138 exit($exitcode);
139}
140
Joe Perches3beb42e2016-05-20 17:04:14 -0700141sub uniq {
142 my %seen;
143 return grep { !$seen{$_}++ } @_;
144}
145
146sub list_types {
147 my ($exitcode) = @_;
148
149 my $count = 0;
150
151 local $/ = undef;
152
153 open(my $script, '<', abs_path($P)) or
154 die "$P: Can't read '$P' $!\n";
155
156 my $text = <$script>;
157 close($script);
158
159 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700160 # Also catch when type or level is passed through a variable
161 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700162 push (@types, $_);
163 }
164 @types = sort(uniq(@types));
165 print("#\tMessage type\n\n");
166 foreach my $type (@types) {
167 print(++$count . "\t" . $type . "\n");
168 }
169
170 exit($exitcode);
171}
172
Joe Perches000d1cc12011-07-25 17:13:25 -0700173my $conf = which_conf($configuration_file);
174if (-f $conf) {
175 my @conf_args;
176 open(my $conffile, '<', "$conf")
177 or warn "$P: Can't find a readable $configuration_file file $!\n";
178
179 while (<$conffile>) {
180 my $line = $_;
181
182 $line =~ s/\s*\n?$//g;
183 $line =~ s/^\s*//g;
184 $line =~ s/\s+/ /g;
185
186 next if ($line =~ m/^\s*#/);
187 next if ($line =~ m/^\s*$/);
188
189 my @words = split(" ", $line);
190 foreach my $word (@words) {
191 last if ($word =~ m/^#/);
192 push (@conf_args, $word);
193 }
194 }
195 close($conffile);
196 unshift(@ARGV, @conf_args) if @conf_args;
197}
198
John Brooks737c0762017-07-10 15:52:24 -0700199# Perl's Getopt::Long allows options to take optional arguments after a space.
200# Prevent --color by itself from consuming other arguments
201foreach (@ARGV) {
202 if ($_ eq "--color" || $_ eq "-color") {
203 $_ = "--color=$color";
204 }
205}
206
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700207GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700208 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700209 'tree!' => \$tree,
210 'signoff!' => \$chk_signoff,
211 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700212 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800213 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700214 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700215 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700216 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700217 'subjective!' => \$check,
218 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700219 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700220 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700221 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700222 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800223 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700224 'min-conf-desc-length=i' => \$min_conf_desc_length,
Antonio Borneo713a09d2020-04-06 20:11:07 -0700225 'tab-size=i' => \$tabsize,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700226 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800227 'summary!' => \$summary,
228 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800229 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700230 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800231 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700232 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800233 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700234 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700235 'codespell!' => \$codespell,
236 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700237 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700238 'color=s' => \$color,
239 'no-color' => \$color, #keep old behaviors of -nocolor
240 'nocolor' => \$color, #keep old behaviors of -nocolor
Jerome Forissier3e89ad82020-10-15 20:11:49 -0700241 'kconfig-prefix=s' => \${CONFIG_},
Hannes Eder77f5b102009-09-21 17:04:37 -0700242 'h|help' => \$help,
243 'version' => \$help
244) or help(1);
245
246help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700247
Joe Perches3beb42e2016-05-20 17:04:14 -0700248list_types(0) if ($list_types);
249
Joe Perches9624b8d2014-01-23 15:54:44 -0800250$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700251$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800252
Joe Perches32f30ca2020-06-04 16:50:40 -0700253die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix));
254
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700255my $exit = 0;
256
Joe Perches5b579802018-08-21 21:57:33 -0700257my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700258if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700259 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700260 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700261 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700262}
263
Allen Hubbe45107ff2016-08-02 14:04:47 -0700264#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700265if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700266 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700267}
268
John Brooks737c0762017-07-10 15:52:24 -0700269if ($color =~ /^[01]$/) {
270 $color = !$color;
271} elsif ($color =~ /^always$/i) {
272 $color = 1;
273} elsif ($color =~ /^never$/i) {
274 $color = 0;
275} elsif ($color =~ /^auto$/i) {
276 $color = (-t STDOUT);
277} else {
Joe Perches32f30ca2020-06-04 16:50:40 -0700278 die "$P: Invalid color mode: $color\n";
John Brooks737c0762017-07-10 15:52:24 -0700279}
280
Antonio Borneo713a09d2020-04-06 20:11:07 -0700281# skip TAB size 1 to avoid additional checks on $tabsize - 1
Joe Perches32f30ca2020-06-04 16:50:40 -0700282die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2);
Antonio Borneo713a09d2020-04-06 20:11:07 -0700283
Joe Perches91bfe482013-09-11 14:23:59 -0700284sub hash_save_array_words {
285 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700286
Joe Perches91bfe482013-09-11 14:23:59 -0700287 my @array = split(/,/, join(',', @$arrayRef));
288 foreach my $word (@array) {
289 $word =~ s/\s*\n?$//g;
290 $word =~ s/^\s*//g;
291 $word =~ s/\s+/ /g;
292 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700293
Joe Perches91bfe482013-09-11 14:23:59 -0700294 next if ($word =~ m/^\s*#/);
295 next if ($word =~ m/^\s*$/);
296
297 $hashRef->{$word}++;
298 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700299}
300
Joe Perches91bfe482013-09-11 14:23:59 -0700301sub hash_show_words {
302 my ($hashRef, $prefix) = @_;
303
Joe Perches3c816e42015-06-25 15:03:29 -0700304 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700305 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700306 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700307 print " $word";
308 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700309 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700310 }
311}
312
313hash_save_array_words(\%ignore_type, \@ignore);
314hash_save_array_words(\%use_type, \@use);
315
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800316my $dbg_values = 0;
317my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700318my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700319my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800320for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800321 ## no critic
322 eval "\${dbg_$key} = '$debug{$key}';";
323 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800324}
325
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700326my $rpt_cleaners = 0;
327
Andy Whitcroft8905a672007-11-28 16:21:06 -0800328if ($terse) {
329 $emacs = 1;
330 $quiet++;
331}
332
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700333if ($tree) {
334 if (defined $root) {
335 if (!top_of_kernel_tree($root)) {
336 die "$P: $root: --root does not point at a valid tree\n";
337 }
338 } else {
339 if (top_of_kernel_tree('.')) {
340 $root = '.';
341 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
342 top_of_kernel_tree($1)) {
343 $root = $1;
344 }
345 }
346
347 if (!defined $root) {
348 print "Must be run from the top-level dir. of a kernel tree\n";
349 exit(2);
350 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700351}
352
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700353my $emitted_corrupt = 0;
354
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700355our $Ident = qr{
356 [A-Za-z_][A-Za-z\d_]*
357 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
358 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700359our $Storage = qr{extern|static|asmlinkage};
360our $Sparse = qr{
361 __user|
362 __kernel|
363 __force|
364 __iomem|
365 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800366 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700367 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700368 __refconst|
369 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800370 __rcu|
371 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700372 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800373our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
374our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
375our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
376our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
377our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700378
Wolfram Sang52131292010-03-05 13:43:51 -0800379# Notes to $Attribute:
380# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700381our $Attribute = qr{
382 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700383 __percpu|
384 __nocast|
385 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200386 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700387 __packed__|
388 __packed2__|
389 __naked|
390 __maybe_unused|
391 __always_unused|
392 __noreturn|
393 __used|
394 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800395 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700396 __noclone|
397 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700398 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700399 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700400 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700401 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700402 ____cacheline_aligned|
403 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800404 ____cacheline_internodealigned_in_smp|
405 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700406 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700407our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700408our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700409our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
410our $Lval = qr{$Ident(?:$Member)*};
411
Joe Perches95e2c602013-07-03 15:05:20 -0700412our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
413our $Binary = qr{(?i)0b[01]+$Int_type?};
414our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
415our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700416our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800417our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800418our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
419our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
420our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800421our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700422our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800423our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700424our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700425our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700426our $Operators = qr{
427 <=|>=|==|!=|
428 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700429 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700430 }x;
431
Joe Perches91cb5192014-04-03 14:49:32 -0700432our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
433
Joe Perchesab7e23f2015-04-16 12:44:22 -0700434our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800435our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700436our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700437our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800438our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700439our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800440our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700441our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800442
Joe Perches15662b32011-10-31 17:13:12 -0700443our $NON_ASCII_UTF8 = qr{
444 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700445 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
446 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
447 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
448 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
449 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
450 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
451}x;
452
Joe Perches15662b32011-10-31 17:13:12 -0700453our $UTF8 = qr{
454 [\x09\x0A\x0D\x20-\x7E] # ASCII
455 | $NON_ASCII_UTF8
456}x;
457
Joe Perchese6176fa2015-06-25 15:02:49 -0700458our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800459our $typeOtherOSTypedefs = qr{(?x:
460 u_(?:char|short|int|long) | # bsd
461 u(?:nchar|short|int|long) # sysv
462)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700463our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700464 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700465 atomic_t
466)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700467our $typeTypedefs = qr{(?x:
468 $typeC99Typedefs\b|
469 $typeOtherOSTypedefs\b|
470 $typeKernelTypedefs\b
471)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700472
Joe Perches6d32f7a2015-11-06 16:31:37 -0800473our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
474
Joe Perches691e6692010-03-05 13:43:51 -0800475our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800476 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700477 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches87bd4992017-11-17 15:28:48 -0800478 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700479 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700480 panic|
Joe Perches06668722013-11-12 15:10:07 -0800481 MODULE_[A-Z_]+|
482 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800483)};
484
Joe Perchese29a70f2019-03-07 16:28:35 -0800485our $allocFunctions = qr{(?x:
486 (?:(?:devm_)?
487 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
488 kstrdup(?:_const)? |
489 kmemdup(?:_nul)?) |
Christophe JAILLET461e1562020-04-20 18:13:58 -0700490 (?:\w+)?alloc_skb(?:_ip_align)? |
Joe Perchese29a70f2019-03-07 16:28:35 -0800491 # dev_alloc_skb/netdev_alloc_skb, et al
492 dma_alloc_coherent
493)};
494
Joe Perches20112472011-07-25 17:13:23 -0700495our $signature_tags = qr{(?xi:
496 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800497 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700498 Acked-by:|
499 Tested-by:|
500 Reviewed-by:|
501 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700502 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700503 To:|
504 Cc:
505)};
506
Joe Perches18130872014-08-06 16:11:22 -0700507our @typeListMisordered = (
508 qr{char\s+(?:un)?signed},
509 qr{int\s+(?:(?:un)?signed\s+)?short\s},
510 qr{int\s+short(?:\s+(?:un)?signed)},
511 qr{short\s+int(?:\s+(?:un)?signed)},
512 qr{(?:un)?signed\s+int\s+short},
513 qr{short\s+(?:un)?signed},
514 qr{long\s+int\s+(?:un)?signed},
515 qr{int\s+long\s+(?:un)?signed},
516 qr{long\s+(?:un)?signed\s+int},
517 qr{int\s+(?:un)?signed\s+long},
518 qr{int\s+(?:un)?signed},
519 qr{int\s+long\s+long\s+(?:un)?signed},
520 qr{long\s+long\s+int\s+(?:un)?signed},
521 qr{long\s+long\s+(?:un)?signed\s+int},
522 qr{long\s+long\s+(?:un)?signed},
523 qr{long\s+(?:un)?signed},
524);
525
Andy Whitcroft8905a672007-11-28 16:21:06 -0800526our @typeList = (
527 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700528 qr{(?:(?:un)?signed\s+)?char},
529 qr{(?:(?:un)?signed\s+)?short\s+int},
530 qr{(?:(?:un)?signed\s+)?short},
531 qr{(?:(?:un)?signed\s+)?int},
532 qr{(?:(?:un)?signed\s+)?long\s+int},
533 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
534 qr{(?:(?:un)?signed\s+)?long\s+long},
535 qr{(?:(?:un)?signed\s+)?long},
536 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800537 qr{float},
538 qr{double},
539 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800540 qr{struct\s+$Ident},
541 qr{union\s+$Ident},
542 qr{enum\s+$Ident},
543 qr{${Ident}_t},
544 qr{${Ident}_handler},
545 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700546 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800547);
Joe Perches938224b2016-01-20 14:59:15 -0800548
549our $C90_int_types = qr{(?x:
550 long\s+long\s+int\s+(?:un)?signed|
551 long\s+long\s+(?:un)?signed\s+int|
552 long\s+long\s+(?:un)?signed|
553 (?:(?:un)?signed\s+)?long\s+long\s+int|
554 (?:(?:un)?signed\s+)?long\s+long|
555 int\s+long\s+long\s+(?:un)?signed|
556 int\s+(?:(?:un)?signed\s+)?long\s+long|
557
558 long\s+int\s+(?:un)?signed|
559 long\s+(?:un)?signed\s+int|
560 long\s+(?:un)?signed|
561 (?:(?:un)?signed\s+)?long\s+int|
562 (?:(?:un)?signed\s+)?long|
563 int\s+long\s+(?:un)?signed|
564 int\s+(?:(?:un)?signed\s+)?long|
565
566 int\s+(?:un)?signed|
567 (?:(?:un)?signed\s+)?int
568)};
569
Alex Dowad485ff232015-06-25 15:02:52 -0700570our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700571our @typeListWithAttr = (
572 @typeList,
573 qr{struct\s+$InitAttribute\s+$Ident},
574 qr{union\s+$InitAttribute\s+$Ident},
575);
576
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700577our @modifierList = (
578 qr{fastcall},
579);
Alex Dowad485ff232015-06-25 15:02:52 -0700580our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800581
Joe Perches24358802014-04-03 14:49:13 -0700582our @mode_permission_funcs = (
583 ["module_param", 3],
584 ["module_param_(?:array|named|string)", 4],
585 ["module_param_array_named", 5],
586 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
587 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700588 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
589 ["IIO_DEV_ATTR_[A-Z_]+", 1],
590 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
591 ["SENSOR_TEMPLATE(?:_2|)", 3],
592 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700593);
594
Joe Perches1a3dcf22020-08-11 18:35:16 -0700595my $word_pattern = '\b[A-Z]?[a-z]{2,}\b';
596
Joe Perches515a2352014-04-03 14:49:24 -0700597#Create a search pattern for all these functions to speed up a loop below
598our $mode_perms_search = "";
599foreach my $entry (@mode_permission_funcs) {
600 $mode_perms_search .= '|' if ($mode_perms_search ne "");
601 $mode_perms_search .= $entry->[0];
602}
Joe Perches00180462018-02-06 15:38:55 -0800603$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700604
Joe Perches9189c7e2018-09-07 15:26:18 -0700605our %deprecated_apis = (
606 "synchronize_rcu_bh" => "synchronize_rcu",
607 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
608 "call_rcu_bh" => "call_rcu",
609 "rcu_barrier_bh" => "rcu_barrier",
610 "synchronize_sched" => "synchronize_rcu",
611 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
612 "call_rcu_sched" => "call_rcu",
613 "rcu_barrier_sched" => "rcu_barrier",
614 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
615 "cond_synchronize_sched" => "cond_synchronize_rcu",
616);
617
618#Create a search pattern for all these strings to speed up a loop below
619our $deprecated_apis_search = "";
620foreach my $entry (keys %deprecated_apis) {
621 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
622 $deprecated_apis_search .= $entry;
623}
624$deprecated_apis_search = "(?:${deprecated_apis_search})";
625
Joe Perchesb392c642015-04-16 12:44:16 -0700626our $mode_perms_world_writable = qr{
627 S_IWUGO |
628 S_IWOTH |
629 S_IRWXUGO |
630 S_IALLUGO |
631 0[0-7][0-7][2367]
632}x;
633
Joe Perchesf90774e2016-10-11 13:51:47 -0700634our %mode_permission_string_types = (
635 "S_IRWXU" => 0700,
636 "S_IRUSR" => 0400,
637 "S_IWUSR" => 0200,
638 "S_IXUSR" => 0100,
639 "S_IRWXG" => 0070,
640 "S_IRGRP" => 0040,
641 "S_IWGRP" => 0020,
642 "S_IXGRP" => 0010,
643 "S_IRWXO" => 0007,
644 "S_IROTH" => 0004,
645 "S_IWOTH" => 0002,
646 "S_IXOTH" => 0001,
647 "S_IRWXUGO" => 0777,
648 "S_IRUGO" => 0444,
649 "S_IWUGO" => 0222,
650 "S_IXUGO" => 0111,
651);
652
653#Create a search pattern for all these strings to speed up a loop below
654our $mode_perms_string_search = "";
655foreach my $entry (keys %mode_permission_string_types) {
656 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
657 $mode_perms_string_search .= $entry;
658}
Joe Perches00180462018-02-06 15:38:55 -0800659our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
660our $multi_mode_perms_string_search = qr{
661 ${single_mode_perms_string_search}
662 (?:\s*\|\s*${single_mode_perms_string_search})*
663}x;
664
665sub perms_to_octal {
666 my ($string) = @_;
667
668 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
669
670 my $val = "";
671 my $oval = "";
672 my $to = 0;
673 my $curpos = 0;
674 my $lastpos = 0;
675 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
676 $curpos = pos($string);
677 my $match = $2;
678 my $omatch = $1;
679 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
680 $lastpos = $curpos;
681 $to |= $mode_permission_string_types{$match};
682 $val .= '\s*\|\s*' if ($val ne "");
683 $val .= $match;
684 $oval .= $omatch;
685 }
686 $oval =~ s/^\s*\|\s*//;
687 $oval =~ s/\s*\|\s*$//;
688 return sprintf("%04o", $to);
689}
Joe Perchesf90774e2016-10-11 13:51:47 -0700690
Wolfram Sang7840a942010-08-09 17:20:57 -0700691our $allowed_asm_includes = qr{(?x:
692 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700693 memory|
694 time|
695 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700696)};
697# memory.h: ARM has a custom one
698
Kees Cook66b47b42014-10-13 15:51:57 -0700699# Load common spelling mistakes and build regular expression list.
700my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700701my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700702
Joe Perches36061e32014-12-10 15:51:43 -0800703if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800704 while (<$spelling>) {
705 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700706
Joe Perches36061e32014-12-10 15:51:43 -0800707 $line =~ s/\s*\n?$//g;
708 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700709
Joe Perches36061e32014-12-10 15:51:43 -0800710 next if ($line =~ m/^\s*#/);
711 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700712
Joe Perches36061e32014-12-10 15:51:43 -0800713 my ($suspect, $fix) = split(/\|\|/, $line);
714
Joe Perches36061e32014-12-10 15:51:43 -0800715 $spelling_fix{$suspect} = $fix;
716 }
717 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800718} else {
719 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700720}
Kees Cook66b47b42014-10-13 15:51:57 -0700721
Joe Perchesebfd7d62015-04-16 12:44:14 -0700722if ($codespell) {
723 if (open(my $spelling, '<', $codespellfile)) {
724 while (<$spelling>) {
725 my $line = $_;
726
727 $line =~ s/\s*\n?$//g;
728 $line =~ s/^\s*//g;
729
730 next if ($line =~ m/^\s*#/);
731 next if ($line =~ m/^\s*$/);
732 next if ($line =~ m/, disabled/i);
733
734 $line =~ s/,.*$//;
735
736 my ($suspect, $fix) = split(/->/, $line);
737
738 $spelling_fix{$suspect} = $fix;
739 }
740 close($spelling);
741 } else {
742 warn "No codespell typos will be found - file '$codespellfile': $!\n";
743 }
744}
745
746$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
747
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700748sub read_words {
749 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700750
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700751 if (open(my $words, '<', $file)) {
752 while (<$words>) {
753 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700754
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700755 $line =~ s/\s*\n?$//g;
756 $line =~ s/^\s*//g;
757
758 next if ($line =~ m/^\s*#/);
759 next if ($line =~ m/^\s*$/);
760 if ($line =~ /\s/) {
761 print("$file: '$line' invalid - ignored\n");
762 next;
763 }
764
Quentin Monnetced69da12020-08-11 18:35:13 -0700765 $$wordsRef .= '|' if (defined $$wordsRef);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700766 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700767 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700768 close($file);
769 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700770 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700771
772 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700773}
774
Quentin Monnetced69da12020-08-11 18:35:13 -0700775my $const_structs;
776if (show_type("CONST_STRUCT")) {
777 read_words(\$const_structs, $conststructsfile)
778 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
779}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700780
Quentin Monnetced69da12020-08-11 18:35:13 -0700781if (defined($typedefsfile)) {
782 my $typeOtherTypedefs;
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700783 read_words(\$typeOtherTypedefs, $typedefsfile)
784 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
Quentin Monnetced69da12020-08-11 18:35:13 -0700785 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs);
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700786}
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700787
Andy Whitcroft8905a672007-11-28 16:21:06 -0800788sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700789 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
790 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700791 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700792 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700793 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700794 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700795 (?:$typeTypedefs\b)|
796 (?:${all}\b)
797 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800798 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700799 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800800 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800801 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700802 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700803 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800804 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700805 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800806 }x;
Joe Perches18130872014-08-06 16:11:22 -0700807 $NonptrTypeMisordered = qr{
808 (?:$Modifier\s+|const\s+)*
809 (?:
810 (?:${Misordered}\b)
811 )
812 (?:\s+$Modifier|\s+const)*
813 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700814 $NonptrTypeWithAttr = qr{
815 (?:$Modifier\s+|const\s+)*
816 (?:
817 (?:typeof|__typeof__)\s*\([^\)]*\)|
818 (?:$typeTypedefs\b)|
819 (?:${allWithAttr}\b)
820 )
821 (?:\s+$Modifier|\s+const)*
822 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800823 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700824 $NonptrType
Antonio Borneo7b184962020-04-06 20:11:04 -0700825 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700826 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800827 }x;
Joe Perches18130872014-08-06 16:11:22 -0700828 $TypeMisordered = qr{
829 $NonptrTypeMisordered
Antonio Borneo7b184962020-04-06 20:11:04 -0700830 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4}
Joe Perches18130872014-08-06 16:11:22 -0700831 (?:\s+$Inline|\s+$Modifier)*
832 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700833 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700834 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800835}
836build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700837
Joe Perches7d2367a2011-07-25 17:13:22 -0700838our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700839
840# Using $balanced_parens, $LvalOrFunc, or $FuncArg
841# requires at least perl version v5.10.0
842# Any use must be runtime checked with $^V
843
844our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700845our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800846our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700847
Joe Perchesf8422302014-08-06 16:11:31 -0700848our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700849 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700850 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700851 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700852)};
853
Joe Perches7d2367a2011-07-25 17:13:22 -0700854sub deparenthesize {
855 my ($string) = @_;
856 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700857
858 while ($string =~ /^\s*\(.*\)\s*$/) {
859 $string =~ s@^\s*\(\s*@@;
860 $string =~ s@\s*\)\s*$@@;
861 }
862
Joe Perches7d2367a2011-07-25 17:13:22 -0700863 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700864
Joe Perches7d2367a2011-07-25 17:13:22 -0700865 return $string;
866}
867
Joe Perches34456862013-07-03 15:05:34 -0700868sub seed_camelcase_file {
869 my ($file) = @_;
870
871 return if (!(-f $file));
872
873 local $/;
874
875 open(my $include_file, '<', "$file")
876 or warn "$P: Can't read '$file' $!\n";
877 my $text = <$include_file>;
878 close($include_file);
879
880 my @lines = split('\n', $text);
881
882 foreach my $line (@lines) {
883 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
884 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
885 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800886 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
887 $camelcase{$1} = 1;
888 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700889 $camelcase{$1} = 1;
890 }
891 }
892}
893
Joe Perchescd28b112019-12-04 16:52:09 -0800894our %maintained_status = ();
895
Joe Perches85b0ee12016-10-11 13:51:44 -0700896sub is_maintained_obsolete {
897 my ($filename) = @_;
898
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800899 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700900
Joe Perchescd28b112019-12-04 16:52:09 -0800901 if (!exists($maintained_status{$filename})) {
902 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
903 }
Joe Perches85b0ee12016-10-11 13:51:44 -0700904
Joe Perchescd28b112019-12-04 16:52:09 -0800905 return $maintained_status{$filename} =~ /obsolete/i;
Joe Perches85b0ee12016-10-11 13:51:44 -0700906}
907
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700908sub is_SPDX_License_valid {
909 my ($license) = @_;
910
Joe Perches56294112018-08-21 21:58:04 -0700911 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700912
Joe Perches56294112018-08-21 21:58:04 -0700913 my $root_path = abs_path($root);
914 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700915 return 0 if ($status ne "");
916 return 1;
917}
918
Joe Perches34456862013-07-03 15:05:34 -0700919my $camelcase_seeded = 0;
920sub seed_camelcase_includes {
921 return if ($camelcase_seeded);
922
923 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700924 my $camelcase_cache = "";
925 my @include_files = ();
926
927 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700928
Richard Genoud3645e322014-02-10 14:25:32 -0800929 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700930 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Joe Perches351b2a12013-07-03 15:05:36 -0700931 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700932 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700933 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700934 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700935 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700936 @include_files = split('\n', $files);
937 foreach my $file (@include_files) {
938 my $date = POSIX::strftime("%Y%m%d%H%M",
939 localtime((stat $file)[9]));
940 $last_mod_date = $date if ($last_mod_date < $date);
941 }
942 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700943 }
Joe Perchesc707a812013-07-08 16:00:43 -0700944
945 if ($camelcase_cache ne "" && -f $camelcase_cache) {
946 open(my $camelcase_file, '<', "$camelcase_cache")
947 or warn "$P: Can't read '$camelcase_cache' $!\n";
948 while (<$camelcase_file>) {
949 chomp;
950 $camelcase{$_} = 1;
951 }
952 close($camelcase_file);
953
954 return;
955 }
956
Richard Genoud3645e322014-02-10 14:25:32 -0800957 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700958 $files = `${git_command} ls-files "include/*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700959 @include_files = split('\n', $files);
960 }
961
Joe Perches34456862013-07-03 15:05:34 -0700962 foreach my $file (@include_files) {
963 seed_camelcase_file($file);
964 }
Joe Perches351b2a12013-07-03 15:05:36 -0700965
Joe Perchesc707a812013-07-08 16:00:43 -0700966 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700967 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700968 open(my $camelcase_file, '>', "$camelcase_cache")
969 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700970 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
971 print $camelcase_file ("$_\n");
972 }
973 close($camelcase_file);
974 }
Joe Perches34456862013-07-03 15:05:34 -0700975}
976
Joe Perchesf5f61322020-10-15 20:12:12 -0700977sub git_is_single_file {
978 my ($filename) = @_;
979
980 return 0 if ((which("git") eq "") || !(-e "$gitroot"));
981
982 my $output = `${git_command} ls-files -- $filename 2>/dev/null`;
983 my $count = $output =~ tr/\n//;
984 return $count eq 1 && $output =~ m{^${filename}$};
985}
986
Joe Perchesd311cd42014-08-06 16:10:57 -0700987sub git_commit_info {
988 my ($commit, $id, $desc) = @_;
989
990 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
991
Joe Perchesdbbf8692019-09-25 16:46:52 -0700992 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Joe Perchesd311cd42014-08-06 16:10:57 -0700993 $output =~ s/^\s*//gm;
994 my @lines = split("\n", $output);
995
Joe Perches0d7835f2015-02-13 14:38:35 -0800996 return ($id, $desc) if ($#lines < 0);
997
Sean Christopherson5a7f4452019-09-25 16:46:49 -0700998 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Joe Perchesd311cd42014-08-06 16:10:57 -0700999# Maybe one day convert this block of bash into something that returns
1000# all matching commit ids, but it's very slow...
1001#
1002# echo "checking commits $1..."
1003# git rev-list --remotes | grep -i "^$1" |
1004# while read line ; do
1005# git log --format='%H %s' -1 $line |
1006# echo "commit $(cut -c 1-12,41-)"
1007# done
1008 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07001009 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -07001010 } else {
1011 $id = substr($lines[0], 0, 12);
1012 $desc = substr($lines[0], 41);
1013 }
1014
1015 return ($id, $desc);
1016}
1017
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001018$chk_signoff = 0 if ($file);
1019
Andy Whitcroft00df3442007-06-08 13:47:06 -07001020my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001021my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001022my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001023my @fixed_inserted = ();
1024my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001025my $fixlinenr = -1;
1026
Du, Changbin4a593c32016-05-20 17:04:16 -07001027# If input is git commits, extract all commits from the commit expressions.
1028# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1029die "$P: No git repository found\n" if ($git && !-e ".git");
1030
1031if ($git) {
1032 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001033 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001034 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001035 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1036 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001037 } elsif ($commit_expr =~ m/\.\./) {
1038 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001039 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001040 $git_range = "-1 $commit_expr";
1041 }
Joe Perchesdbbf8692019-09-25 16:46:52 -07001042 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001043 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001044 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1045 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001046 my $sha1 = $1;
1047 my $subject = $2;
1048 unshift(@commits, $sha1);
1049 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001050 }
1051 }
1052 die "$P: no git commits after extraction!\n" if (@commits == 0);
1053 @ARGV = @commits;
1054}
1055
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001056my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001057$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001058for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001059 my $FILE;
Joe Perchesf5f61322020-10-15 20:12:12 -07001060 my $is_git_file = git_is_single_file($filename);
1061 my $oldfile = $file;
1062 $file = 1 if ($is_git_file);
Du, Changbin4a593c32016-05-20 17:04:16 -07001063 if ($git) {
1064 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1065 die "$P: $filename: git format-patch failed - $!\n";
1066 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001067 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001068 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001069 } elsif ($filename eq '-') {
1070 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001071 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001072 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001073 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001074 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001075 if ($filename eq '-') {
1076 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001077 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001078 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001079 } else {
1080 $vname = $filename;
1081 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001082 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001083 chomp;
1084 push(@rawlines, $_);
Geert Uytterhoevenc7f574d2020-06-04 16:50:43 -07001085 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001086 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001087 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001088
1089 if ($#ARGV > 0 && $quiet == 0) {
1090 print '-' x length($vname) . "\n";
1091 print "$vname\n";
1092 print '-' x length($vname) . "\n";
1093 }
1094
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001095 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001096 $exit = 1;
1097 }
1098 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001099 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001100 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001101 @fixed_inserted = ();
1102 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001103 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001104 @modifierListFile = ();
1105 @typeListFile = ();
1106 build_types();
Joe Perchesf5f61322020-10-15 20:12:12 -07001107 $file = $oldfile if ($is_git_file);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001108}
1109
Joe Perchesd8469f12015-06-25 15:03:00 -07001110if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001111 hash_show_words(\%use_type, "Used");
1112 hash_show_words(\%ignore_type, "Ignored");
1113
Joe Perches5b579802018-08-21 21:57:33 -07001114 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001115 print << "EOM"
1116
1117NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001118 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001119EOM
1120 }
1121 if ($exit) {
1122 print << "EOM"
1123
1124NOTE: If any of the errors are false positives, please report
1125 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1126EOM
1127 }
1128}
1129
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001130exit($exit);
1131
1132sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001133 my ($root) = @_;
1134
1135 my @tree_check = (
1136 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1137 "README", "Documentation", "arch", "include", "drivers",
1138 "fs", "init", "ipc", "kernel", "lib", "scripts",
1139 );
1140
1141 foreach my $check (@tree_check) {
1142 if (! -e $root . '/' . $check) {
1143 return 0;
1144 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001145 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001146 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001147}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001148
Joe Perches20112472011-07-25 17:13:23 -07001149sub parse_email {
1150 my ($formatted_email) = @_;
1151
1152 my $name = "";
Joe Perchesdfa05c22020-04-06 20:10:48 -07001153 my $name_comment = "";
Joe Perches20112472011-07-25 17:13:23 -07001154 my $address = "";
1155 my $comment = "";
1156
1157 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1158 $name = $1;
1159 $address = $2;
1160 $comment = $3 if defined $3;
1161 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1162 $address = $1;
1163 $comment = $2 if defined $2;
1164 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1165 $address = $1;
1166 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001167 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001168 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001169 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001170 $name =~ s/^\"|\"$//g;
1171 # If there's a name left after stripping spaces and
1172 # leading quotes, and the address doesn't have both
1173 # leading and trailing angle brackets, the address
1174 # is invalid. ie:
1175 # "joe smith joe@smith.com" bad
1176 # "joe smith <joe@smith.com" bad
1177 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1178 $name = "";
1179 $address = "";
1180 $comment = "";
1181 }
1182 }
1183
Joe Perches3705ce52013-07-03 15:05:31 -07001184 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001185 $name =~ s/^\"|\"$//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07001186 $name =~ s/(\s*\([^\)]+\))\s*//;
1187 if (defined($1)) {
1188 $name_comment = trim($1);
1189 }
Joe Perches3705ce52013-07-03 15:05:31 -07001190 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001191 $address =~ s/^\<|\>$//g;
1192
1193 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1194 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1195 $name = "\"$name\"";
1196 }
1197
Joe Perchesdfa05c22020-04-06 20:10:48 -07001198 return ($name, $name_comment, $address, $comment);
Joe Perches20112472011-07-25 17:13:23 -07001199}
1200
1201sub format_email {
1202 my ($name, $address) = @_;
1203
1204 my $formatted_email;
1205
Joe Perches3705ce52013-07-03 15:05:31 -07001206 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001207 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001208 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001209
1210 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1211 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1212 $name = "\"$name\"";
1213 }
1214
1215 if ("$name" eq "") {
1216 $formatted_email = "$address";
1217 } else {
1218 $formatted_email = "$name <$address>";
1219 }
1220
1221 return $formatted_email;
1222}
1223
Joe Perchesdfa05c22020-04-06 20:10:48 -07001224sub reformat_email {
1225 my ($email) = @_;
1226
1227 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
1228 return format_email($email_name, $email_address);
1229}
1230
1231sub same_email_addresses {
1232 my ($email1, $email2) = @_;
1233
1234 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1);
1235 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2);
1236
1237 return $email1_name eq $email2_name &&
1238 $email1_address eq $email2_address;
1239}
1240
Joe Perchesd311cd42014-08-06 16:10:57 -07001241sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001242 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001243
Joe Perchesbd474ca2014-08-06 16:11:10 -07001244 foreach my $path (split(/:/, $ENV{PATH})) {
1245 if (-e "$path/$bin") {
1246 return "$path/$bin";
1247 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001248 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001249
Joe Perchesbd474ca2014-08-06 16:11:10 -07001250 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001251}
1252
Joe Perches000d1cc12011-07-25 17:13:25 -07001253sub which_conf {
1254 my ($conf) = @_;
1255
1256 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1257 if (-e "$path/$conf") {
1258 return "$path/$conf";
1259 }
1260 }
1261
1262 return "";
1263}
1264
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001265sub expand_tabs {
1266 my ($str) = @_;
1267
1268 my $res = '';
1269 my $n = 0;
1270 for my $c (split(//, $str)) {
1271 if ($c eq "\t") {
1272 $res .= ' ';
1273 $n++;
Antonio Borneo713a09d2020-04-06 20:11:07 -07001274 for (; ($n % $tabsize) != 0; $n++) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001275 $res .= ' ';
1276 }
1277 next;
1278 }
1279 $res .= $c;
1280 $n++;
1281 }
1282
1283 return $res;
1284}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001285sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001286 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001287 return $res;
1288}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001289
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001290sub line_stats {
1291 my ($line) = @_;
1292
1293 # Drop the diff line leader and expand tabs
1294 $line =~ s/^.//;
1295 $line = expand_tabs($line);
1296
1297 # Pick the indent from the front of the line.
1298 my ($white) = ($line =~ /^(\s*)/);
1299
1300 return (length($line), length($white));
1301}
1302
Andy Whitcroft773647a2008-03-28 14:15:58 -07001303my $sanitise_quote = '';
1304
1305sub sanitise_line_reset {
1306 my ($in_comment) = @_;
1307
1308 if ($in_comment) {
1309 $sanitise_quote = '*/';
1310 } else {
1311 $sanitise_quote = '';
1312 }
1313}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001314sub sanitise_line {
1315 my ($line) = @_;
1316
1317 my $res = '';
1318 my $l = '';
1319
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001320 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001321 my $off = 0;
1322 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001323
Andy Whitcroft773647a2008-03-28 14:15:58 -07001324 # Always copy over the diff marker.
1325 $res = substr($line, 0, 1);
1326
1327 for ($off = 1; $off < length($line); $off++) {
1328 $c = substr($line, $off, 1);
1329
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001330 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001331 # and end, all to $;.
1332 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1333 $sanitise_quote = '*/';
1334
1335 substr($res, $off, 2, "$;$;");
1336 $off++;
1337 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001338 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001339 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001340 $sanitise_quote = '';
1341 substr($res, $off, 2, "$;$;");
1342 $off++;
1343 next;
1344 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001345 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1346 $sanitise_quote = '//';
1347
1348 substr($res, $off, 2, $sanitise_quote);
1349 $off++;
1350 next;
1351 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001352
1353 # A \ in a string means ignore the next character.
1354 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1355 $c eq "\\") {
1356 substr($res, $off, 2, 'XX');
1357 $off++;
1358 next;
1359 }
1360 # Regular quotes.
1361 if ($c eq "'" || $c eq '"') {
1362 if ($sanitise_quote eq '') {
1363 $sanitise_quote = $c;
1364
1365 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001366 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001367 } elsif ($sanitise_quote eq $c) {
1368 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001369 }
1370 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001371
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001372 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001373 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1374 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001375 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1376 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001377 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1378 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001379 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001380 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001381 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001382 }
1383
Daniel Walker113f04a2009-09-21 17:04:35 -07001384 if ($sanitise_quote eq '//') {
1385 $sanitise_quote = '';
1386 }
1387
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001388 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001389 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001390 my $clean = 'X' x length($1);
1391 $res =~ s@\<.*\>@<$clean>@;
1392
1393 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001394 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001395 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001396 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001397 }
1398
Joe Perchesdadf6802016-08-02 14:04:33 -07001399 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1400 my $match = $1;
1401 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1402 }
1403
Andy Whitcroft00df3442007-06-08 13:47:06 -07001404 return $res;
1405}
1406
Joe Perchesa6962d72013-04-29 16:18:13 -07001407sub get_quoted_string {
1408 my ($line, $rawline) = @_;
1409
Joe Perches478b1792018-04-10 16:33:34 -07001410 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001411 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001412 return substr($rawline, $-[0], $+[0] - $-[0]);
1413}
1414
Andy Whitcroft8905a672007-11-28 16:21:06 -08001415sub ctx_statement_block {
1416 my ($linenr, $remain, $off) = @_;
1417 my $line = $linenr - 1;
1418 my $blk = '';
1419 my $soff = $off;
1420 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001421 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001422
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001423 my $loff = 0;
1424
Andy Whitcroft8905a672007-11-28 16:21:06 -08001425 my $type = '';
1426 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001427 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001428 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001429 my $c;
1430 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001431
1432 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001433 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001434 @stack = (['', 0]) if ($#stack == -1);
1435
Andy Whitcroft773647a2008-03-28 14:15:58 -07001436 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001437 # If we are about to drop off the end, pull in more
1438 # context.
1439 if ($off >= $len) {
1440 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001441 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001442 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001443 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001444 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001445 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001446 $len = length($blk);
1447 $line++;
1448 last;
1449 }
1450 # Bail if there is no further context.
1451 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001452 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001453 last;
1454 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001455 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1456 $level++;
1457 $type = '#';
1458 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001459 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001460 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001461 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001462 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001463
Andy Whitcroft773647a2008-03-28 14:15:58 -07001464 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001465
1466 # Handle nested #if/#else.
1467 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1468 push(@stack, [ $type, $level ]);
1469 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1470 ($type, $level) = @{$stack[$#stack - 1]};
1471 } elsif ($remainder =~ /^#\s*endif\b/) {
1472 ($type, $level) = @{pop(@stack)};
1473 }
1474
Andy Whitcroft8905a672007-11-28 16:21:06 -08001475 # Statement ends at the ';' or a close '}' at the
1476 # outermost level.
1477 if ($level == 0 && $c eq ';') {
1478 last;
1479 }
1480
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001481 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001482 if ($level == 0 && $coff_set == 0 &&
1483 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1484 $remainder =~ /^(else)(?:\s|{)/ &&
1485 $remainder !~ /^else\s+if\b/) {
1486 $coff = $off + length($1) - 1;
1487 $coff_set = 1;
1488 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1489 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001490 }
1491
Andy Whitcroft8905a672007-11-28 16:21:06 -08001492 if (($type eq '' || $type eq '(') && $c eq '(') {
1493 $level++;
1494 $type = '(';
1495 }
1496 if ($type eq '(' && $c eq ')') {
1497 $level--;
1498 $type = ($level != 0)? '(' : '';
1499
1500 if ($level == 0 && $coff < $soff) {
1501 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001502 $coff_set = 1;
1503 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001504 }
1505 }
1506 if (($type eq '' || $type eq '{') && $c eq '{') {
1507 $level++;
1508 $type = '{';
1509 }
1510 if ($type eq '{' && $c eq '}') {
1511 $level--;
1512 $type = ($level != 0)? '{' : '';
1513
1514 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001515 if (substr($blk, $off + 1, 1) eq ';') {
1516 $off++;
1517 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001518 last;
1519 }
1520 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001521 # Preprocessor commands end at the newline unless escaped.
1522 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1523 $level--;
1524 $type = '';
1525 $off++;
1526 last;
1527 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001528 $off++;
1529 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001530 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001531 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001532 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001533 $line++;
1534 $remain--;
1535 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001536
1537 my $statement = substr($blk, $soff, $off - $soff + 1);
1538 my $condition = substr($blk, $soff, $coff - $soff + 1);
1539
1540 #warn "STATEMENT<$statement>\n";
1541 #warn "CONDITION<$condition>\n";
1542
Andy Whitcroft773647a2008-03-28 14:15:58 -07001543 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001544
1545 return ($statement, $condition,
1546 $line, $remain + 1, $off - $loff + 1, $level);
1547}
1548
Andy Whitcroftcf655042008-03-04 14:28:20 -08001549sub statement_lines {
1550 my ($stmt) = @_;
1551
1552 # Strip the diff line prefixes and rip blank lines at start and end.
1553 $stmt =~ s/(^|\n)./$1/g;
1554 $stmt =~ s/^\s*//;
1555 $stmt =~ s/\s*$//;
1556
1557 my @stmt_lines = ($stmt =~ /\n/g);
1558
1559 return $#stmt_lines + 2;
1560}
1561
1562sub statement_rawlines {
1563 my ($stmt) = @_;
1564
1565 my @stmt_lines = ($stmt =~ /\n/g);
1566
1567 return $#stmt_lines + 2;
1568}
1569
1570sub statement_block_size {
1571 my ($stmt) = @_;
1572
1573 $stmt =~ s/(^|\n)./$1/g;
1574 $stmt =~ s/^\s*{//;
1575 $stmt =~ s/}\s*$//;
1576 $stmt =~ s/^\s*//;
1577 $stmt =~ s/\s*$//;
1578
1579 my @stmt_lines = ($stmt =~ /\n/g);
1580 my @stmt_statements = ($stmt =~ /;/g);
1581
1582 my $stmt_lines = $#stmt_lines + 2;
1583 my $stmt_statements = $#stmt_statements + 1;
1584
1585 if ($stmt_lines > $stmt_statements) {
1586 return $stmt_lines;
1587 } else {
1588 return $stmt_statements;
1589 }
1590}
1591
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001592sub ctx_statement_full {
1593 my ($linenr, $remain, $off) = @_;
1594 my ($statement, $condition, $level);
1595
1596 my (@chunks);
1597
Andy Whitcroftcf655042008-03-04 14:28:20 -08001598 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001599 ($statement, $condition, $linenr, $remain, $off, $level) =
1600 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001601 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001602 push(@chunks, [ $condition, $statement ]);
1603 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1604 return ($level, $linenr, @chunks);
1605 }
1606
1607 # Pull in the following conditional/block pairs and see if they
1608 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001609 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001610 ($statement, $condition, $linenr, $remain, $off, $level) =
1611 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001612 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001613 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001614 #print "C: push\n";
1615 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001616 }
1617
1618 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001619}
1620
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001621sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001622 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001623 my $line;
1624 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001625 my $blk = '';
1626 my @o;
1627 my @c;
1628 my @res = ();
1629
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001630 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001631 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001632 for ($line = $start; $remain > 0; $line++) {
1633 next if ($rawlines[$line] =~ /^-/);
1634 $remain--;
1635
1636 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001637
1638 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001639 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001640 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001641 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001642 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001643 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001644 $level = pop(@stack);
1645 }
1646
Andy Whitcroft01464f32010-10-26 14:23:19 -07001647 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001648 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1649 if ($off > 0) {
1650 $off--;
1651 next;
1652 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001653
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001654 if ($c eq $close && $level > 0) {
1655 $level--;
1656 last if ($level == 0);
1657 } elsif ($c eq $open) {
1658 $level++;
1659 }
1660 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001661
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001662 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001663 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001664 }
1665
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001666 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001667 }
1668
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001669 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001670}
1671sub ctx_block_outer {
1672 my ($linenr, $remain) = @_;
1673
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001674 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1675 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001676}
1677sub ctx_block {
1678 my ($linenr, $remain) = @_;
1679
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001680 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1681 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001682}
1683sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001684 my ($linenr, $remain, $off) = @_;
1685
1686 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1687 return @r;
1688}
1689sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001690 my ($linenr, $remain) = @_;
1691
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001692 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001693}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001694sub ctx_statement_level {
1695 my ($linenr, $remain, $off) = @_;
1696
1697 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1698}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001699
1700sub ctx_locate_comment {
1701 my ($first_line, $end_line) = @_;
1702
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001703 # If c99 comment on the current line, or the line before or after
1704 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@);
1705 return $current_comment if (defined $current_comment);
1706 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@);
1707 return $current_comment if (defined $current_comment);
1708 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@);
1709 return $current_comment if (defined $current_comment);
1710
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001711 # Catch a comment on the end of the line itself.
Joe Perchesa55ee0c2020-06-04 16:50:36 -07001712 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001713 return $current_comment if (defined $current_comment);
1714
1715 # Look through the context and try and figure out if there is a
1716 # comment.
1717 my $in_comment = 0;
1718 $current_comment = '';
1719 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001720 my $line = $rawlines[$linenr - 1];
1721 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001722 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1723 $in_comment = 1;
1724 }
1725 if ($line =~ m@/\*@) {
1726 $in_comment = 1;
1727 }
1728 if (!$in_comment && $current_comment ne '') {
1729 $current_comment = '';
1730 }
1731 $current_comment .= $line . "\n" if ($in_comment);
1732 if ($line =~ m@\*/@) {
1733 $in_comment = 0;
1734 }
1735 }
1736
1737 chomp($current_comment);
1738 return($current_comment);
1739}
1740sub ctx_has_comment {
1741 my ($first_line, $end_line) = @_;
1742 my $cmt = ctx_locate_comment($first_line, $end_line);
1743
Andy Whitcroft00df3442007-06-08 13:47:06 -07001744 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001745 ##print "CMMT: $cmt\n";
1746
1747 return ($cmt ne '');
1748}
1749
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001750sub raw_line {
1751 my ($linenr, $cnt) = @_;
1752
1753 my $offset = $linenr - 1;
1754 $cnt++;
1755
1756 my $line;
1757 while ($cnt) {
1758 $line = $rawlines[$offset++];
1759 next if (defined($line) && $line =~ /^-/);
1760 $cnt--;
1761 }
1762
1763 return $line;
1764}
1765
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001766sub get_stat_real {
1767 my ($linenr, $lc) = @_;
1768
1769 my $stat_real = raw_line($linenr, 0);
1770 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1771 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1772 }
1773
1774 return $stat_real;
1775}
1776
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001777sub get_stat_here {
1778 my ($linenr, $cnt, $here) = @_;
1779
1780 my $herectx = $here . "\n";
1781 for (my $n = 0; $n < $cnt; $n++) {
1782 $herectx .= raw_line($linenr, $n) . "\n";
1783 }
1784
1785 return $herectx;
1786}
1787
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001788sub cat_vet {
1789 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001790 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001791
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001792 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001793 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1794 $res .= $1;
1795 if ($2 ne '') {
1796 $coded = sprintf("^%c", unpack('C', $2) + 64);
1797 $res .= $coded;
1798 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001799 }
1800 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001801
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001802 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001803}
1804
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001805my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001806my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001807my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001808my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001809
1810sub annotate_reset {
1811 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001812 $av_pending = '_';
1813 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001814 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001815}
1816
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001817sub annotate_values {
1818 my ($stream, $type) = @_;
1819
1820 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001821 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001822 my $cur = $stream;
1823
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001824 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001825
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001826 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001827 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001828 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001829 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001830 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001831 print "WS($1)\n" if ($dbg_values > 1);
1832 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001833 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001834 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001835 }
1836
Florian Micklerc023e4732011-01-12 16:59:58 -08001837 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001838 print "CAST($1)\n" if ($dbg_values > 1);
1839 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001840 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001841
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001842 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001843 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001844 $type = 'T';
1845
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001846 } elsif ($cur =~ /^($Modifier)\s*/) {
1847 print "MODIFIER($1)\n" if ($dbg_values > 1);
1848 $type = 'T';
1849
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001850 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001851 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001852 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001853 push(@av_paren_type, $type);
1854 if ($2 ne '') {
1855 $av_pending = 'N';
1856 }
1857 $type = 'E';
1858
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001859 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001860 print "UNDEF($1)\n" if ($dbg_values > 1);
1861 $av_preprocessor = 1;
1862 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001863
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001864 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001865 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001866 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001867
1868 push(@av_paren_type, $type);
1869 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001870 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001871
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001872 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001873 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1874 $av_preprocessor = 1;
1875
1876 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1877
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001878 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001879
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001880 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001881 print "PRE_END($1)\n" if ($dbg_values > 1);
1882
1883 $av_preprocessor = 1;
1884
1885 # Assume all arms of the conditional end as this
1886 # one does, and continue as if the #endif was not here.
1887 pop(@av_paren_type);
1888 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001889 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001890
1891 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001892 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001893
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001894 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1895 print "ATTR($1)\n" if ($dbg_values > 1);
1896 $av_pending = $type;
1897 $type = 'N';
1898
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001899 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001900 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001901 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001902 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001903 }
1904 $type = 'N';
1905
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001906 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001907 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001908 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001909 $type = 'N';
1910
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001911 } elsif ($cur =~/^(case)/o) {
1912 print "CASE($1)\n" if ($dbg_values > 1);
1913 $av_pend_colon = 'C';
1914 $type = 'N';
1915
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001916 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001917 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001918 $type = 'N';
1919
1920 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001921 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001922 push(@av_paren_type, $av_pending);
1923 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001924 $type = 'N';
1925
1926 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001927 my $new_type = pop(@av_paren_type);
1928 if ($new_type ne '_') {
1929 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001930 print "PAREN('$1') -> $type\n"
1931 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001932 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001933 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001934 }
1935
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001936 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001937 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001938 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001939 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001940
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001941 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1942 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001943 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001944 } elsif ($type eq 'E') {
1945 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001946 }
1947 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1948 $type = 'V';
1949
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001950 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001951 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001952 $type = 'V';
1953
1954 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001955 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001956 $type = 'N';
1957
Andy Whitcroftcf655042008-03-04 14:28:20 -08001958 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001959 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001960 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001961 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001962
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001963 } elsif ($cur =~/^(,)/) {
1964 print "COMMA($1)\n" if ($dbg_values > 1);
1965 $type = 'C';
1966
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001967 } elsif ($cur =~ /^(\?)/o) {
1968 print "QUESTION($1)\n" if ($dbg_values > 1);
1969 $type = 'N';
1970
1971 } elsif ($cur =~ /^(:)/o) {
1972 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1973
1974 substr($var, length($res), 1, $av_pend_colon);
1975 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1976 $type = 'E';
1977 } else {
1978 $type = 'N';
1979 }
1980 $av_pend_colon = 'O';
1981
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001982 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001983 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001984 $type = 'N';
1985
Andy Whitcroft0d413862008-10-15 22:02:16 -07001986 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001987 my $variant;
1988
1989 print "OPV($1)\n" if ($dbg_values > 1);
1990 if ($type eq 'V') {
1991 $variant = 'B';
1992 } else {
1993 $variant = 'U';
1994 }
1995
1996 substr($var, length($res), 1, $variant);
1997 $type = 'N';
1998
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001999 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002000 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002001 if ($1 ne '++' && $1 ne '--') {
2002 $type = 'N';
2003 }
2004
2005 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002006 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002007 }
2008 if (defined $1) {
2009 $cur = substr($cur, length($1));
2010 $res .= $type x length($1);
2011 }
2012 }
2013
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002014 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002015}
2016
Andy Whitcroft8905a672007-11-28 16:21:06 -08002017sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002018 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002019 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002020 ^(?:
2021 $Modifier|
2022 $Storage|
2023 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002024 DEFINE_\S+
2025 )$|
2026 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07002027 goto|
2028 return|
2029 case|
2030 else|
2031 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08002032 do|
2033 \#|
2034 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002035 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07002036 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002037 )}x;
2038 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
2039 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002040 # Check for modifiers.
2041 $possible =~ s/\s*$Storage\s*//g;
2042 $possible =~ s/\s*$Sparse\s*//g;
2043 if ($possible =~ /^\s*$/) {
2044
2045 } elsif ($possible =~ /\s/) {
2046 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07002047 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002048 if ($modifier !~ $notPermitted) {
2049 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002050 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07002051 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07002052 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002053
2054 } else {
2055 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07002056 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002057 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002058 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07002059 } else {
2060 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002061 }
2062}
2063
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002064my $prefix = '';
2065
Joe Perches000d1cc12011-07-25 17:13:25 -07002066sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07002067 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002068
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002069 $type =~ tr/[a-z]/[A-Z]/;
2070
Joe Perchescbec18a2014-04-03 14:49:19 -07002071 return defined $use_type{$type} if (scalar keys %use_type > 0);
2072
2073 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002074}
2075
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002076sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002077 my ($level, $type, $msg) = @_;
2078
2079 if (!show_type($type) ||
2080 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002081 return 0;
2082 }
Joe Perches57230292015-06-25 15:03:03 -07002083 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002084 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002085 if ($level eq 'ERROR') {
2086 $output .= RED;
2087 } elsif ($level eq 'WARNING') {
2088 $output .= YELLOW;
2089 } else {
2090 $output .= GREEN;
2091 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002092 }
Joe Perches57230292015-06-25 15:03:03 -07002093 $output .= $prefix . $level . ':';
2094 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002095 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002096 $output .= "$type:";
2097 }
John Brooks737c0762017-07-10 15:52:24 -07002098 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002099 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002100
2101 if ($showfile) {
2102 my @lines = split("\n", $output, -1);
2103 splice(@lines, 1, 1);
2104 $output = join("\n", @lines);
2105 }
Joe Perches57230292015-06-25 15:03:03 -07002106 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002107
Joe Perches57230292015-06-25 15:03:03 -07002108 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002109
2110 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002111}
Joe Perchescbec18a2014-04-03 14:49:19 -07002112
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002113sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002114 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002115}
Joe Perches000d1cc12011-07-25 17:13:25 -07002116
Joe Perchesd752fcc2014-08-06 16:11:05 -07002117sub fixup_current_range {
2118 my ($lineRef, $offset, $length) = @_;
2119
2120 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2121 my $o = $1;
2122 my $l = $2;
2123 my $no = $o + $offset;
2124 my $nl = $l + $length;
2125 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2126 }
2127}
2128
2129sub fix_inserted_deleted_lines {
2130 my ($linesRef, $insertedRef, $deletedRef) = @_;
2131
2132 my $range_last_linenr = 0;
2133 my $delta_offset = 0;
2134
2135 my $old_linenr = 0;
2136 my $new_linenr = 0;
2137
2138 my $next_insert = 0;
2139 my $next_delete = 0;
2140
2141 my @lines = ();
2142
2143 my $inserted = @{$insertedRef}[$next_insert++];
2144 my $deleted = @{$deletedRef}[$next_delete++];
2145
2146 foreach my $old_line (@{$linesRef}) {
2147 my $save_line = 1;
2148 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002149 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002150 $delta_offset = 0;
2151 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2152 $range_last_linenr = $new_linenr;
2153 fixup_current_range(\$line, $delta_offset, 0);
2154 }
2155
2156 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2157 $deleted = @{$deletedRef}[$next_delete++];
2158 $save_line = 0;
2159 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2160 }
2161
2162 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2163 push(@lines, ${$inserted}{'LINE'});
2164 $inserted = @{$insertedRef}[$next_insert++];
2165 $new_linenr++;
2166 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2167 }
2168
2169 if ($save_line) {
2170 push(@lines, $line);
2171 $new_linenr++;
2172 }
2173
2174 $old_linenr++;
2175 }
2176
2177 return @lines;
2178}
2179
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002180sub fix_insert_line {
2181 my ($linenr, $line) = @_;
2182
2183 my $inserted = {
2184 LINENR => $linenr,
2185 LINE => $line,
2186 };
2187 push(@fixed_inserted, $inserted);
2188}
2189
2190sub fix_delete_line {
2191 my ($linenr, $line) = @_;
2192
2193 my $deleted = {
2194 LINENR => $linenr,
2195 LINE => $line,
2196 };
2197
2198 push(@fixed_deleted, $deleted);
2199}
2200
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002201sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002202 my ($type, $msg) = @_;
2203
2204 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002205 our $clean = 0;
2206 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002207 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002208 }
Joe Perches3705ce52013-07-03 15:05:31 -07002209 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002210}
2211sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002212 my ($type, $msg) = @_;
2213
2214 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002215 our $clean = 0;
2216 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002217 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002218 }
Joe Perches3705ce52013-07-03 15:05:31 -07002219 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002220}
2221sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002222 my ($type, $msg) = @_;
2223
2224 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002225 our $clean = 0;
2226 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002227 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002228 }
Joe Perches3705ce52013-07-03 15:05:31 -07002229 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002230}
2231
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002232sub check_absolute_file {
2233 my ($absolute, $herecurr) = @_;
2234 my $file = $absolute;
2235
2236 ##print "absolute<$absolute>\n";
2237
2238 # See if any suffix of this path is a path within the tree.
2239 while ($file =~ s@^[^/]*/@@) {
2240 if (-f "$root/$file") {
2241 ##print "file<$file>\n";
2242 last;
2243 }
2244 }
2245 if (! -f _) {
2246 return 0;
2247 }
2248
2249 # It is, so see if the prefix is acceptable.
2250 my $prefix = $absolute;
2251 substr($prefix, -length($file)) = '';
2252
2253 ##print "prefix<$prefix>\n";
2254 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002255 WARN("USE_RELATIVE_PATH",
2256 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002257 }
2258}
2259
Joe Perches3705ce52013-07-03 15:05:31 -07002260sub trim {
2261 my ($string) = @_;
2262
Joe Perchesb34c6482013-09-11 14:24:01 -07002263 $string =~ s/^\s+|\s+$//g;
2264
2265 return $string;
2266}
2267
2268sub ltrim {
2269 my ($string) = @_;
2270
2271 $string =~ s/^\s+//;
2272
2273 return $string;
2274}
2275
2276sub rtrim {
2277 my ($string) = @_;
2278
2279 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002280
2281 return $string;
2282}
2283
Joe Perches52ea8502013-11-12 15:10:09 -08002284sub string_find_replace {
2285 my ($string, $find, $replace) = @_;
2286
2287 $string =~ s/$find/$replace/g;
2288
2289 return $string;
2290}
2291
Joe Perches3705ce52013-07-03 15:05:31 -07002292sub tabify {
2293 my ($leading) = @_;
2294
Antonio Borneo713a09d2020-04-06 20:11:07 -07002295 my $source_indent = $tabsize;
Joe Perches3705ce52013-07-03 15:05:31 -07002296 my $max_spaces_before_tab = $source_indent - 1;
2297 my $spaces_to_tab = " " x $source_indent;
2298
2299 #convert leading spaces to tabs
2300 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2301 #Remove spaces before a tab
2302 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2303
2304 return "$leading";
2305}
2306
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002307sub pos_last_openparen {
2308 my ($line) = @_;
2309
2310 my $pos = 0;
2311
2312 my $opens = $line =~ tr/\(/\(/;
2313 my $closes = $line =~ tr/\)/\)/;
2314
2315 my $last_openparen = 0;
2316
2317 if (($opens == 0) || ($closes >= $opens)) {
2318 return -1;
2319 }
2320
2321 my $len = length($line);
2322
2323 for ($pos = 0; $pos < $len; $pos++) {
2324 my $string = substr($line, $pos);
2325 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2326 $pos += length($1) - 1;
2327 } elsif (substr($line, $pos, 1) eq '(') {
2328 $last_openparen = $pos;
2329 } elsif (index($string, '(') == -1) {
2330 last;
2331 }
2332 }
2333
Joe Perches91cb5192014-04-03 14:49:32 -07002334 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002335}
2336
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002337sub get_raw_comment {
2338 my ($line, $rawline) = @_;
2339 my $comment = '';
2340
2341 for my $i (0 .. (length($line) - 1)) {
2342 if (substr($line, $i, 1) eq "$;") {
2343 $comment .= substr($rawline, $i, 1);
2344 }
2345 }
2346
2347 return $comment;
2348}
2349
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002350sub process {
2351 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002352
2353 my $linenr=0;
2354 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002355 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002356 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002357 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002358
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002359 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002360 my $indent;
2361 my $previndent=0;
2362 my $stashindent=0;
2363
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002364 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002365 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002366 my $author = '';
2367 my $authorsignoff = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002368 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002369 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002370 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002371 my $in_commit_log = 0; #Scanning lines before patch
Joe Perches44d303e2020-04-06 20:11:10 -07002372 my $has_patch_separator = 0; #Found a --- line
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002373 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002374 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002375 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002376 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002377 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002378 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002379 my $non_utf8_charset = 0;
2380
Joe Perches365dd4e2014-08-06 16:10:42 -07002381 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002382 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002383
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002384 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002385 our $cnt_lines = 0;
2386 our $cnt_error = 0;
2387 our $cnt_warn = 0;
2388 our $cnt_chk = 0;
2389
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002390 # Trace the real file/line as we go.
2391 my $realfile = '';
2392 my $realline = 0;
2393 my $realcnt = 0;
2394 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002395 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002396 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002397 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002398 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002399 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002400
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002401 my $prev_values = 'E';
2402
2403 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002404 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002405 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002406 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002407 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002408
Joe Perches7e51f192013-09-11 14:23:57 -07002409 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002410
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002411 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002412 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002413 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002414 my @setup_docs = ();
2415 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002416
Joe Perchesd8b07712013-11-12 15:10:06 -08002417 my $camelcase_file_seeded = 0;
2418
Rob Herring9f3a8992018-04-10 16:33:13 -07002419 my $checklicenseline = 1;
2420
Andy Whitcroft773647a2008-03-28 14:15:58 -07002421 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002422 my $line;
2423 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002424 $linenr++;
2425 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002426
Joe Perches3705ce52013-07-03 15:05:31 -07002427 push(@fixed, $rawline) if ($fix);
2428
Andy Whitcroft773647a2008-03-28 14:15:58 -07002429 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002430 $setup_docs = 0;
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07002431 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002432 $setup_docs = 1;
2433 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002434 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002435 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002436 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002437 $realline=$1-1;
2438 if (defined $2) {
2439 $realcnt=$3+1;
2440 } else {
2441 $realcnt=1+1;
2442 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002443 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002444
2445 # Guestimate if this is a continuing comment. Run
2446 # the context looking for a comment "edge". If this
2447 # edge is a close comment then we must be in a comment
2448 # at context start.
2449 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002450 my $cnt = $realcnt;
2451 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2452 next if (defined $rawlines[$ln - 1] &&
2453 $rawlines[$ln - 1] =~ /^-/);
2454 $cnt--;
2455 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002456 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002457 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2458 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2459 ($edge) = $1;
2460 last;
2461 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002462 }
2463 if (defined $edge && $edge eq '*/') {
2464 $in_comment = 1;
2465 }
2466
2467 # Guestimate if this is a continuing comment. If this
2468 # is the start of a diff block and this line starts
2469 # ' *' then it is very likely a comment.
2470 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002471 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002472 {
2473 $in_comment = 1;
2474 }
2475
2476 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2477 sanitise_line_reset($in_comment);
2478
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002479 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002480 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002481 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002482 $line = sanitise_line($rawline);
2483 }
2484 push(@lines, $line);
2485
2486 if ($realcnt > 1) {
2487 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2488 } else {
2489 $realcnt = 0;
2490 }
2491
2492 #print "==>$rawline\n";
2493 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002494
2495 if ($setup_docs && $line =~ /^\+/) {
2496 push(@setup_docs, $line);
2497 }
2498 }
2499
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002500 $prefix = '';
2501
Andy Whitcroft773647a2008-03-28 14:15:58 -07002502 $realcnt = 0;
2503 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002504 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002505 foreach my $line (@lines) {
2506 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002507 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002508 my $sline = $line; #copy of $line
2509 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002510
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002511 my $rawline = $rawlines[$linenr - 1];
Joe Perchesf36d3eb2020-04-06 20:10:58 -07002512 my $raw_comment = get_raw_comment($line, $rawline);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002513
Joe Perches12c253a2018-06-07 17:10:58 -07002514# check if it's a mode change, rename or start of a patch
2515 if (!$in_commit_log &&
2516 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2517 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2518 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2519 $is_patch = 1;
2520 }
2521
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002522#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002523 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002524 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2525 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002526 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002527 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002528 $realline=$1-1;
2529 if (defined $2) {
2530 $realcnt=$3+1;
2531 } else {
2532 $realcnt=1+1;
2533 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002534 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002535 $prev_values = 'E';
2536
Andy Whitcroft773647a2008-03-28 14:15:58 -07002537 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002538 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002539 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002540 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002541 if ($context =~ /\b(\w+)\s*\(/) {
2542 $context_function = $1;
2543 } else {
2544 undef $context_function;
2545 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002546 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002547
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002548# track the line number as we move through the hunk, note that
2549# new versions of GNU diff omit the leading space on completely
2550# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002551 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002552 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002553 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002554
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002555 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002556 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002557
2558 # Track the previous line.
2559 ($prevline, $stashline) = ($stashline, $line);
2560 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002561 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2562
Andy Whitcroft773647a2008-03-28 14:15:58 -07002563 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002564
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002565 } elsif ($realcnt == 1) {
2566 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002567 }
2568
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002569 my $hunk_line = ($realcnt != 0);
2570
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002571 $here = "#$linenr: " if (!$file);
2572 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002573
Joe Perches2ac73b42014-06-04 16:12:05 -07002574 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002575 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002576 if ($line =~ /^diff --git.*?(\S+)$/) {
2577 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002578 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002579 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002580 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002581 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002582 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002583 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002584 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002585
2586 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002587 if (!$file && $tree && $p1_prefix ne '' &&
2588 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002589 WARN("PATCH_PREFIX",
2590 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002591 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002592
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002593 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002594 ERROR("MODIFIED_INCLUDE_ASM",
2595 "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 -07002596 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002597 $found_file = 1;
2598 }
2599
Joe Perches34d88152015-06-25 15:03:05 -07002600#make up the handle for any error we report on this line
2601 if ($showfile) {
2602 $prefix = "$realfile:$realline: "
2603 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002604 if ($file) {
2605 $prefix = "$filename:$realline: ";
2606 } else {
2607 $prefix = "$filename:$linenr: ";
2608 }
Joe Perches34d88152015-06-25 15:03:05 -07002609 }
2610
Joe Perches2ac73b42014-06-04 16:12:05 -07002611 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002612 if (is_maintained_obsolete($realfile)) {
2613 WARN("OBSOLETE",
2614 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2615 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002616 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002617 $check = 1;
2618 } else {
2619 $check = $check_orig;
2620 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002621 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002622
2623 if ($realfile !~ /^MAINTAINERS/) {
2624 my $last_binding_patch = $is_binding_patch;
2625
2626 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2627
2628 if (($last_binding_patch != -1) &&
2629 ($last_binding_patch ^ $is_binding_patch)) {
2630 WARN("DT_SPLIT_BINDING_PATCH",
Mauro Carvalho Chehab858e6842020-04-15 16:45:25 +02002631 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
Rob Herring133712a2018-08-21 21:58:16 -07002632 }
2633 }
2634
Andy Whitcroft773647a2008-03-28 14:15:58 -07002635 next;
2636 }
2637
Randy Dunlap389834b2007-06-08 13:47:03 -07002638 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002639
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002640 my $hereline = "$here\n$rawline\n";
2641 my $herecurr = "$here\n$rawline\n";
2642 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002643
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002644 $cnt_lines++ if ($realcnt != 0);
2645
Joe Perches490b2922018-08-21 21:58:01 -07002646# Verify the existence of a commit log if appropriate
2647# 2 is used because a $signature is counted in $commit_log_lines
2648 if ($in_commit_log) {
2649 if ($line !~ /^\s*$/) {
2650 $commit_log_lines++; #could be a $signature
2651 }
2652 } elsif ($has_commit_log && $commit_log_lines < 2) {
2653 WARN("COMMIT_MESSAGE",
2654 "Missing commit description - Add an appropriate one\n");
2655 $commit_log_lines = 2; #warn only once
2656 }
2657
Joe Perchese518e9a2015-06-25 15:03:27 -07002658# Check if the commit log has what seems like a diff which can confuse patch
2659 if ($in_commit_log && !$commit_log_has_diff &&
Mrinal Pandey13e45412020-09-04 16:35:52 -07002660 (($line =~ m@^\s+diff\b.*a/([\w/]+)@ &&
2661 $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) ||
Joe Perchese518e9a2015-06-25 15:03:27 -07002662 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2663 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2664 ERROR("DIFF_IN_COMMIT_MSG",
2665 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2666 $commit_log_has_diff = 1;
2667 }
2668
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002669# Check for incorrect file permissions
2670 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2671 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002672 if ($realfile !~ m@scripts/@ &&
2673 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002674 ERROR("EXECUTE_PERMISSIONS",
2675 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002676 }
2677 }
2678
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002679# Check the patch for a From:
2680 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2681 $author = $1;
2682 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2683 $author =~ s/"//g;
Joe Perchesdfa05c22020-04-06 20:10:48 -07002684 $author = reformat_email($author);
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002685 }
2686
Joe Perches20112472011-07-25 17:13:23 -07002687# Check the patch for a signoff:
Joe Perchesdfa05c22020-04-06 20:10:48 -07002688 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002689 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002690 $in_commit_log = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002691 if ($author ne '') {
Joe Perchesdfa05c22020-04-06 20:10:48 -07002692 if (same_email_addresses($1, $author)) {
2693 $authorsignoff = 1;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002694 }
2695 }
Joe Perches20112472011-07-25 17:13:23 -07002696 }
2697
Joe Perches44d303e2020-04-06 20:11:10 -07002698# Check for patch separator
2699 if ($line =~ /^---$/) {
2700 $has_patch_separator = 1;
2701 $in_commit_log = 0;
2702 }
2703
Joe Perchese0d975b2014-12-10 15:51:49 -08002704# Check if MAINTAINERS is being updated. If so, there's probably no need to
2705# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2706 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2707 $reported_maintainer_file = 1;
2708 }
2709
Joe Perches20112472011-07-25 17:13:23 -07002710# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002711 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002712 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002713 my $space_before = $1;
2714 my $sign_off = $2;
2715 my $space_after = $3;
2716 my $email = $4;
2717 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2718
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002719 if ($sign_off !~ /$signature_tags/) {
2720 WARN("BAD_SIGN_OFF",
2721 "Non-standard signature: $sign_off\n" . $herecurr);
2722 }
Joe Perches20112472011-07-25 17:13:23 -07002723 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002724 if (WARN("BAD_SIGN_OFF",
2725 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2726 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002727 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002728 "$ucfirst_sign_off $email";
2729 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002730 }
Joe Perches20112472011-07-25 17:13:23 -07002731 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002732 if (WARN("BAD_SIGN_OFF",
2733 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2734 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002735 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002736 "$ucfirst_sign_off $email";
2737 }
2738
Joe Perches20112472011-07-25 17:13:23 -07002739 }
2740 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002741 if (WARN("BAD_SIGN_OFF",
2742 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2743 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002744 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002745 "$ucfirst_sign_off $email";
2746 }
Joe Perches20112472011-07-25 17:13:23 -07002747 }
2748
Joe Perchesdfa05c22020-04-06 20:10:48 -07002749 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email);
Joe Perches20112472011-07-25 17:13:23 -07002750 my $suggested_email = format_email(($email_name, $email_address));
2751 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002752 ERROR("BAD_SIGN_OFF",
2753 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002754 } else {
2755 my $dequoted = $suggested_email;
2756 $dequoted =~ s/^"//;
2757 $dequoted =~ s/" </ </;
2758 # Don't force email to have quotes
2759 # Allow just an angle bracketed address
Joe Perchesdfa05c22020-04-06 20:10:48 -07002760 if (!same_email_addresses($email, $suggested_email)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002761 WARN("BAD_SIGN_OFF",
2762 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002763 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002764 }
Joe Perches7e51f192013-09-11 14:23:57 -07002765
2766# Check for duplicate signatures
2767 my $sig_nospace = $line;
2768 $sig_nospace =~ s/\s//g;
2769 $sig_nospace = lc($sig_nospace);
2770 if (defined $signatures{$sig_nospace}) {
2771 WARN("BAD_SIGN_OFF",
2772 "Duplicate signature\n" . $herecurr);
2773 } else {
2774 $signatures{$sig_nospace} = 1;
2775 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07002776
2777# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2778 if ($sign_off =~ /^co-developed-by:$/i) {
2779 if ($email eq $author) {
2780 WARN("BAD_SIGN_OFF",
2781 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2782 }
2783 if (!defined $lines[$linenr]) {
2784 WARN("BAD_SIGN_OFF",
2785 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2786 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2787 WARN("BAD_SIGN_OFF",
2788 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2789 } elsif ($1 ne $email) {
2790 WARN("BAD_SIGN_OFF",
2791 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2792 }
2793 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002794 }
2795
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002796# Check email subject for common tools that don't need to be mentioned
2797 if ($in_header_lines &&
2798 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2799 WARN("EMAIL_SUBJECT",
2800 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2801 }
2802
Joe Perches44d303e2020-04-06 20:11:10 -07002803# Check for Gerrit Change-Ids not in any patch context
2804 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) {
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002805 ERROR("GERRIT_CHANGE_ID",
Joe Perches44d303e2020-04-06 20:11:10 -07002806 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr);
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002807 }
2808
Joe Perches369c8dd2015-11-06 16:31:34 -08002809# Check if the commit log is in a possible stack dump
2810 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2811 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2812 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2813 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07002814 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2815 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2816 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2817 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08002818 $commit_log_possible_stack_dump = 1;
2819 }
2820
Joe Perches2a076f42015-04-16 12:44:28 -07002821# Check for line lengths > 75 in commit log, warn once
2822 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002823 length($line) > 75 &&
2824 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2825 # file delta changes
2826 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2827 # filename then :
2828 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2829 # A Fixes: or Link: line
2830 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002831 WARN("COMMIT_LOG_LONG_LINE",
2832 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2833 $commit_log_long_line = 1;
2834 }
2835
Joe Perchesbf4daf12015-09-09 15:37:50 -07002836# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002837 if ($in_commit_log && $commit_log_possible_stack_dump &&
2838 $line =~ /^\s*$/) {
2839 $commit_log_possible_stack_dump = 0;
2840 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002841
Joe Perches0d7835f2015-02-13 14:38:35 -08002842# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002843 if ($in_commit_log && !$commit_log_possible_stack_dump &&
John Hubbarda8972572020-04-06 20:10:55 -07002844 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002845 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002846 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002847 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002848 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2849 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002850 my $init_char = "c";
2851 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002852 my $short = 1;
2853 my $long = 0;
2854 my $case = 1;
2855 my $space = 1;
2856 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002857 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002858 my $id = '0123456789ab';
2859 my $orig_desc = "commit description";
2860 my $description = "";
2861
Joe Perchesfe043ea2015-09-09 15:37:25 -07002862 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2863 $init_char = $1;
2864 $orig_commit = lc($2);
2865 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2866 $orig_commit = lc($1);
2867 }
2868
Joe Perches0d7835f2015-02-13 14:38:35 -08002869 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2870 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2871 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2872 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2873 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2874 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002875 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002876 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2877 defined $rawlines[$linenr] &&
2878 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2879 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002880 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002881 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2882 defined $rawlines[$linenr] &&
2883 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2884 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2885 $orig_desc = $1;
2886 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2887 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002888 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002889 }
2890
2891 ($id, $description) = git_commit_info($orig_commit,
2892 $id, $orig_desc);
2893
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002894 if (defined($id) &&
2895 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002896 ERROR("GIT_COMMIT_ID",
2897 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2898 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002899 }
2900
Joe Perches13f19372014-08-06 16:10:59 -07002901# Check for added, moved or deleted files
2902 if (!$reported_maintainer_file && !$in_commit_log &&
2903 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2904 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2905 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2906 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002907 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002908 $reported_maintainer_file = 1;
2909 WARN("FILE_PATH_CHANGES",
2910 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2911 }
2912
Rob Herringe400edb2019-09-12 15:18:20 +01002913# Check for adding new DT bindings not in schema format
2914 if (!$in_commit_log &&
2915 ($line =~ /^new file mode\s*\d+\s*$/) &&
2916 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2917 WARN("DT_SCHEMA_BINDING_PATCH",
2918 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2919 }
2920
Andy Whitcroft00df3442007-06-08 13:47:06 -07002921# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002922 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002923 ERROR("CORRUPTED_PATCH",
2924 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002925 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002926 }
2927
2928# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2929 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002930 $rawline !~ m/^$UTF8*$/) {
2931 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2932
2933 my $blank = copy_spacing($rawline);
2934 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2935 my $hereptr = "$hereline$ptr\n";
2936
Joe Perches34d99212011-07-25 17:13:26 -07002937 CHK("INVALID_UTF8",
2938 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002939 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002940
Joe Perches15662b32011-10-31 17:13:12 -07002941# Check if it's the start of a commit log
2942# (not a header line and we haven't seen the patch filename)
2943 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002944 !($rawline =~ /^\s+(?:\S|$)/ ||
2945 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002946 $in_header_lines = 0;
2947 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002948 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002949 }
2950
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002951# Check if there is UTF-8 in a commit log when a mail header has explicitly
2952# declined it, i.e defined some charset where it is missing.
2953 if ($in_header_lines &&
2954 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2955 $1 !~ /utf-8/i) {
2956 $non_utf8_charset = 1;
2957 }
2958
2959 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002960 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002961 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002962 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2963 }
2964
Joe Perchesd6430f72016-12-12 16:46:28 -08002965# Check for absolute kernel paths in commit message
2966 if ($tree && $in_commit_log) {
2967 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2968 my $file = $1;
2969
2970 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2971 check_absolute_file($1, $herecurr)) {
2972 #
2973 } else {
2974 check_absolute_file($file, $herecurr);
2975 }
2976 }
2977 }
2978
Kees Cook66b47b42014-10-13 15:51:57 -07002979# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002980 if (defined($misspellings) &&
2981 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002982 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002983 my $typo = $1;
2984 my $typo_fix = $spelling_fix{lc($typo)};
2985 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2986 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002987 my $msg_level = \&WARN;
2988 $msg_level = \&CHK if ($file);
2989 if (&{$msg_level}("TYPO_SPELLING",
2990 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002991 $fix) {
2992 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2993 }
2994 }
2995 }
2996
Matteo Crocea8dd86b2019-09-25 16:46:38 -07002997# check for invalid commit id
2998 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2999 my $id;
3000 my $description;
3001 ($id, $description) = git_commit_info($2, undef, undef);
3002 if (!defined($id)) {
3003 WARN("UNKNOWN_COMMIT_ID",
3004 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
3005 }
3006 }
3007
Joe Perches310cd062020-10-15 20:11:52 -07003008# check for repeated words separated by a single space
3009 if ($rawline =~ /^\+/ || $in_commit_log) {
3010 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) {
3011
3012 my $first = $1;
3013 my $second = $2;
3014
3015 if ($first =~ /(?:struct|union|enum)/) {
3016 pos($rawline) += length($first) + length($second) + 1;
3017 next;
3018 }
3019
3020 next if ($first ne $second);
3021 next if ($first eq 'long');
3022
3023 if (WARN("REPEATED_WORD",
3024 "Possible repeated word: '$first'\n" . $herecurr) &&
3025 $fix) {
3026 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/;
3027 }
3028 }
3029
3030 # if it's a repeated word on consecutive lines in a comment block
3031 if ($prevline =~ /$;+\s*$/ &&
3032 $prevrawline =~ /($word_pattern)\s*$/) {
3033 my $last_word = $1;
3034 if ($rawline =~ /^\+\s*\*\s*$last_word /) {
3035 if (WARN("REPEATED_WORD",
3036 "Possible repeated word: '$last_word'\n" . $hereprev) &&
3037 $fix) {
3038 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/;
3039 }
3040 }
3041 }
3042 }
3043
Andy Whitcroft306708542008-10-15 22:02:28 -07003044# ignore non-hunk lines and lines being removed
3045 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003046
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003047#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003048 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003049 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07003050 if (ERROR("DOS_LINE_ENDINGS",
3051 "DOS line endings\n" . $herevet) &&
3052 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003053 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003054 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003055 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
3056 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003057 if (ERROR("TRAILING_WHITESPACE",
3058 "trailing whitespace\n" . $herevet) &&
3059 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003060 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07003061 }
3062
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003063 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003064 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07003065
Josh Triplett4783f892013-11-12 15:10:12 -08003066# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08003067 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08003068 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08003069 $rawline =~ /\b59\s+Temple\s+Pl/i ||
3070 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08003071 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07003072 my $msg_level = \&ERROR;
3073 $msg_level = \&CHK if ($file);
3074 &{$msg_level}("FSF_MAILING_ADDRESS",
3075 "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 -08003076 }
3077
Andi Kleen33549572010-05-24 14:33:29 -07003078# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003079# Only applies when adding the entry originally, after that we do not have
3080# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07003081 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01003082 # 'choice' is usually the last thing on the line (though
3083 # Kconfig supports named choices), so use a word boundary
3084 # (\b) rather than a whitespace character (\s)
3085 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07003086 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003087 my $cnt = $realcnt;
3088 my $ln = $linenr + 1;
3089 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003090 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003091 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08003092 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003093 $f = $lines[$ln - 1];
3094 $cnt-- if ($lines[$ln - 1] !~ /^-/);
3095 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003096
3097 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07003098 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08003099
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01003100 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003101 $is_start = 1;
Masahiro Yamada22a4ac02020-06-17 12:02:20 +09003102 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08003103 $length = -1;
3104 }
3105
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003106 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07003107 $f =~ s/#.*//;
3108 $f =~ s/^\s+//;
3109 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01003110
3111 # This only checks context lines in the patch
3112 # and so hopefully shouldn't trigger false
3113 # positives, even though some of these are
3114 # common words in help texts
3115 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3116 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003117 $is_end = 1;
3118 last;
3119 }
Andi Kleen33549572010-05-24 14:33:29 -07003120 $length++;
3121 }
Vadim Bendebury56193272014-10-13 15:51:48 -07003122 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3123 WARN("CONFIG_DESCRIPTION",
3124 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3125 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003126 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003127 }
3128
Joe Perches7ccf41a2020-06-04 16:50:33 -07003129# check MAINTAINERS entries
3130 if ($realfile =~ /^MAINTAINERS$/) {
3131# check MAINTAINERS entries for the right form
3132 if ($rawline =~ /^\+[A-Z]:/ &&
3133 $rawline !~ /^\+[A-Z]:\t\S/) {
3134 if (WARN("MAINTAINERS_STYLE",
3135 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3136 $fix) {
3137 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3138 }
3139 }
3140# check MAINTAINERS entries for the right ordering too
3141 my $preferred_order = 'MRLSWQBCPTFXNK';
3142 if ($rawline =~ /^\+[A-Z]:/ &&
3143 $prevrawline =~ /^[\+ ][A-Z]:/) {
3144 $rawline =~ /^\+([A-Z]):\s*(.*)/;
3145 my $cur = $1;
3146 my $curval = $2;
3147 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/;
3148 my $prev = $1;
3149 my $prevval = $2;
3150 my $curindex = index($preferred_order, $cur);
3151 my $previndex = index($preferred_order, $prev);
3152 if ($curindex < 0) {
3153 WARN("MAINTAINERS_STYLE",
3154 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr);
3155 } else {
3156 if ($previndex >= 0 && $curindex < $previndex) {
3157 WARN("MAINTAINERS_STYLE",
3158 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev);
3159 } elsif ((($prev eq 'F' && $cur eq 'F') ||
3160 ($prev eq 'X' && $cur eq 'X')) &&
3161 ($prevval cmp $curval) > 0) {
3162 WARN("MAINTAINERS_STYLE",
3163 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev);
3164 }
3165 }
Joe Perches628f91a2017-07-10 15:52:07 -07003166 }
3167 }
3168
Christoph Jaeger327953e2015-02-13 14:38:29 -08003169# discourage the use of boolean for type definition attributes of Kconfig options
3170 if ($realfile =~ /Kconfig/ &&
3171 $line =~ /^\+\s*\bboolean\b/) {
3172 WARN("CONFIG_TYPE_BOOLEAN",
3173 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3174 }
3175
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003176 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3177 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3178 my $flag = $1;
3179 my $replacement = {
3180 'EXTRA_AFLAGS' => 'asflags-y',
3181 'EXTRA_CFLAGS' => 'ccflags-y',
3182 'EXTRA_CPPFLAGS' => 'cppflags-y',
3183 'EXTRA_LDFLAGS' => 'ldflags-y',
3184 };
3185
3186 WARN("DEPRECATED_VARIABLE",
3187 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3188 }
3189
Rob Herringbff5da42014-01-23 15:54:51 -08003190# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003191 if (defined $root &&
3192 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3193 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3194
Rob Herringbff5da42014-01-23 15:54:51 -08003195 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3196
Florian Vaussardcc933192014-04-03 14:49:27 -07003197 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003198 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003199
Rob Herringbff5da42014-01-23 15:54:51 -08003200 foreach my $compat (@compats) {
3201 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003202 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3203 my $compat3 = $compat;
3204 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3205 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003206 if ( $? >> 8 ) {
3207 WARN("UNDOCUMENTED_DT_STRING",
3208 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3209 }
3210
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003211 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3212 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003213 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003214 if ( $? >> 8 ) {
3215 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003216 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003217 }
3218 }
3219 }
3220
Rob Herring9f3a8992018-04-10 16:33:13 -07003221# check for using SPDX license tag at beginning of files
3222 if ($realline == $checklicenseline) {
3223 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3224 $checklicenseline = 2;
3225 } elsif ($rawline =~ /^\+/) {
3226 my $comment = "";
3227 if ($realfile =~ /\.(h|s|S)$/) {
3228 $comment = '/*';
3229 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3230 $comment = '//';
Lubomir Rintelc8df0ab2020-04-06 20:10:51 -07003231 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) {
Rob Herring9f3a8992018-04-10 16:33:13 -07003232 $comment = '#';
3233 } elsif ($realfile =~ /\.rst$/) {
3234 $comment = '..';
3235 }
3236
Joe Perchesfdf13692019-03-07 16:28:32 -08003237# check SPDX comment style for .[chsS] files
3238 if ($realfile =~ /\.[chsS]$/ &&
3239 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003240 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003241 WARN("SPDX_LICENSE_TAG",
3242 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3243 }
3244
Rob Herring9f3a8992018-04-10 16:33:13 -07003245 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003246 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3247 WARN("SPDX_LICENSE_TAG",
3248 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003249 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003250 my $spdx_license = $1;
3251 if (!is_SPDX_License_valid($spdx_license)) {
3252 WARN("SPDX_LICENSE_TAG",
3253 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3254 }
Lubomir Rintel50c92902020-04-06 20:11:13 -07003255 if ($realfile =~ m@^Documentation/devicetree/bindings/@ &&
3256 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) {
3257 my $msg_level = \&WARN;
3258 $msg_level = \&CHK if ($file);
3259 if (&{$msg_level}("SPDX_LICENSE_TAG",
3260
3261 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) &&
3262 $fix) {
3263 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3264 }
3265 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003266 }
3267 }
3268 }
3269
Andy Whitcroft5368df202008-10-15 22:02:27 -07003270# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003271 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003272
Joe Perchesa8da38a2019-03-07 16:28:42 -08003273# check for using SPDX-License-Identifier on the wrong line number
3274 if ($realline != $checklicenseline &&
3275 $rawline =~ /\bSPDX-License-Identifier:/ &&
3276 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3277 WARN("SPDX_LICENSE_TAG",
3278 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3279 }
3280
Joe Perches47e0c882015-06-25 15:02:57 -07003281# line length limit (with some exclusions)
3282#
3283# There are a few types of lines that may extend beyond $max_line_length:
3284# logging functions like pr_info that end in a string
3285# lines with a single string
3286# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003287# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003288#
3289# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003290# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003291# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3292# LONG_LINE all other lines longer than $max_line_length
3293#
3294# if LONG_LINE is ignored, the other 2 types are also ignored
3295#
3296
Joe Perchesb4749e92015-07-17 16:24:01 -07003297 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003298 my $msg_type = "LONG_LINE";
3299
3300 # Check the allowed long line types first
3301
3302 # logging functions that end in a string that starts
3303 # before $max_line_length
3304 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3305 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3306 $msg_type = "";
3307
3308 # lines with only strings (w/ possible termination)
3309 # #defines with only strings
3310 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3311 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3312 $msg_type = "";
3313
Joe Perchescc147502017-11-17 15:28:44 -08003314 # More special cases
3315 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3316 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003317 $msg_type = "";
3318
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003319 # URL ($rawline is used in case the URL is in a comment)
3320 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3321 $msg_type = "";
3322
Joe Perches47e0c882015-06-25 15:02:57 -07003323 # Otherwise set the alternate message types
3324
3325 # a comment starts before $max_line_length
3326 } elsif ($line =~ /($;[\s$;]*)$/ &&
3327 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3328 $msg_type = "LONG_LINE_COMMENT"
3329
3330 # a quoted string starts before $max_line_length
3331 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3332 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3333 $msg_type = "LONG_LINE_STRING"
3334 }
3335
3336 if ($msg_type ne "" &&
3337 (show_type("LONG_LINE") || show_type($msg_type))) {
Joe Perchesbdc48fa2020-05-29 16:12:21 -07003338 my $msg_level = \&WARN;
3339 $msg_level = \&CHK if ($file);
3340 &{$msg_level}($msg_type,
3341 "line length of $length exceeds $max_line_length columns\n" . $herecurr);
Joe Perches47e0c882015-06-25 15:02:57 -07003342 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003343 }
3344
Andy Whitcroft8905a672007-11-28 16:21:06 -08003345# check for adding lines without a newline.
3346 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003347 WARN("MISSING_EOF_NEWLINE",
3348 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003349 }
3350
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003351# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003352 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003353
3354# at the beginning of a line any tabs must come first and anything
Antonio Borneo713a09d2020-04-06 20:11:07 -07003355# more than $tabsize must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003356 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3357 $rawline =~ /^\+\s* \s*/) {
3358 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003359 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003360 if (ERROR("CODE_INDENT",
3361 "code indent should use tabs where possible\n" . $herevet) &&
3362 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003363 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003364 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003365 }
3366
Alberto Panizzo08e44362010-03-05 13:43:54 -08003367# check for space before tabs.
3368 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3369 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003370 if (WARN("SPACE_BEFORE_TAB",
3371 "please, no space before tabs\n" . $herevet) &&
3372 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003373 while ($fixed[$fixlinenr] =~
Antonio Borneo713a09d2020-04-06 20:11:07 -07003374 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003375 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003376 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003377 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003378 }
3379
Joe Perches6a487212018-04-10 16:34:04 -07003380# check for assignments on the start of a line
3381 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3382 CHK("ASSIGNMENT_CONTINUATIONS",
3383 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3384 }
3385
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003386# check for && or || at the start of a line
3387 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3388 CHK("LOGICAL_CONTINUATIONS",
3389 "Logical continuations should be on the previous line\n" . $hereprev);
3390 }
3391
Joe Perchesa91e8992016-05-20 17:04:05 -07003392# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003393 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003394 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003395 my $indent = length($1);
Antonio Borneo713a09d2020-04-06 20:11:07 -07003396 if ($indent % $tabsize) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003397 if (WARN("TABSTOP",
3398 "Statements should start on a tabstop\n" . $herecurr) &&
3399 $fix) {
Antonio Borneo713a09d2020-04-06 20:11:07 -07003400 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e;
Joe Perchesa91e8992016-05-20 17:04:05 -07003401 }
3402 }
3403 }
3404
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003405# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003406 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003407 $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 -07003408 $prevline =~ /^\+(\t*)(.*)$/;
3409 my $oldindent = $1;
3410 my $rest = $2;
3411
3412 my $pos = pos_last_openparen($rest);
3413 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003414 $line =~ /^(\+| )([ \t]*)/;
3415 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003416
3417 my $goodtabindent = $oldindent .
Antonio Borneo713a09d2020-04-06 20:11:07 -07003418 "\t" x ($pos / $tabsize) .
3419 " " x ($pos % $tabsize);
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003420 my $goodspaceindent = $oldindent . " " x $pos;
3421
3422 if ($newindent ne $goodtabindent &&
3423 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003424
3425 if (CHK("PARENTHESIS_ALIGNMENT",
3426 "Alignment should match open parenthesis\n" . $hereprev) &&
3427 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003428 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003429 s/^\+[ \t]*/\+$goodtabindent/;
3430 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003431 }
3432 }
3433 }
3434
Joe Perches6ab3a972015-04-16 12:44:05 -07003435# check for space after cast like "(int) foo" or "(struct foo) bar"
3436# avoid checking a few false positives:
3437# "sizeof(<type>)" or "__alignof__(<type>)"
3438# function pointer declarations like "(*foo)(int) = bar;"
3439# structure definitions like "(struct foo) { 0 };"
3440# multiline macros that define functions
3441# known attributes or the __attribute__ keyword
3442 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3443 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003444 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003445 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003446 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003447 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003448 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003449 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003450 }
3451
Joe Perches86406b12015-09-09 15:37:41 -07003452# Block comment styles
3453# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003454 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003455 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003456 $rawline =~ /^\+[ \t]*\*/ &&
3457 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003458 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3459 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3460 }
3461
Joe Perches86406b12015-09-09 15:37:41 -07003462# Block comments use * on subsequent lines
3463 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3464 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003465 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003466 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003467 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003468 WARN("BLOCK_COMMENT_STYLE",
3469 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003470 }
3471
Joe Perches86406b12015-09-09 15:37:41 -07003472# Block comments use */ on trailing lines
3473 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003474 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3475 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3476 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003477 WARN("BLOCK_COMMENT_STYLE",
3478 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003479 }
3480
Joe Perches08eb9b82016-10-11 13:51:50 -07003481# Block comment * alignment
3482 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003483 $line =~ /^\+[ \t]*$;/ && #leading comment
3484 $rawline =~ /^\+[ \t]*\*/ && #leading *
3485 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003486 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003487 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3488 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003489 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003490 if (defined($1)) {
3491 $oldindent = expand_tabs($1);
3492 } else {
3493 $prevrawline =~ m@^\+(.*/?)\*@;
3494 $oldindent = expand_tabs($1);
3495 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003496 $rawline =~ m@^\+([ \t]*)\*@;
3497 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003498 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003499 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003500 WARN("BLOCK_COMMENT_STYLE",
3501 "Block comments should align the * on each line\n" . $hereprev);
3502 }
3503 }
3504
Joe Perches7f619192014-08-06 16:10:39 -07003505# check for missing blank lines after struct/union declarations
3506# with exceptions for various attributes and macros
3507 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3508 $line =~ /^\+/ &&
3509 !($line =~ /^\+\s*$/ ||
3510 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3511 $line =~ /^\+\s*MODULE_/i ||
3512 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3513 $line =~ /^\+[a-z_]*init/ ||
3514 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3515 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003516 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003517 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003518 if (CHK("LINE_SPACING",
3519 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3520 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003521 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003522 }
Joe Perches7f619192014-08-06 16:10:39 -07003523 }
3524
Joe Perches365dd4e2014-08-06 16:10:42 -07003525# check for multiple consecutive blank lines
3526 if ($prevline =~ /^[\+ ]\s*$/ &&
3527 $line =~ /^\+\s*$/ &&
3528 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003529 if (CHK("LINE_SPACING",
3530 "Please don't use multiple blank lines\n" . $hereprev) &&
3531 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003532 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003533 }
3534
Joe Perches365dd4e2014-08-06 16:10:42 -07003535 $last_blank_line = $linenr;
3536 }
3537
Joe Perches3b617e32014-04-03 14:49:28 -07003538# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003539 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3540 # actual declarations
3541 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003542 # function pointer declarations
3543 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003544 # foo bar; where foo is some local typedef or #define
3545 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3546 # known declaration macros
3547 $prevline =~ /^\+\s+$declaration_macros/) &&
3548 # for "else if" which can look like "$Ident $Ident"
3549 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3550 # other possible extensions of declaration lines
3551 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3552 # not starting a section or a macro "\" extended line
3553 $prevline =~ /(?:\{\s*|\\)$/) &&
3554 # looks like a declaration
3555 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003556 # function pointer declarations
3557 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003558 # foo bar; where foo is some local typedef or #define
3559 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3560 # known declaration macros
3561 $sline =~ /^\+\s+$declaration_macros/ ||
3562 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003563 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003564 # start or end of block or continuation of declaration
3565 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3566 # bitfield continuation
3567 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3568 # other possible extensions of declaration lines
3569 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3570 # indentation of previous and current line are the same
3571 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003572 if (WARN("LINE_SPACING",
3573 "Missing a blank line after declarations\n" . $hereprev) &&
3574 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003575 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003576 }
Joe Perches3b617e32014-04-03 14:49:28 -07003577 }
3578
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003579# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003580# Exceptions:
3581# 1) within comments
3582# 2) indented preprocessor commands
3583# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003584 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003585 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003586 if (WARN("LEADING_SPACE",
3587 "please, no spaces at the start of a line\n" . $herevet) &&
3588 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003589 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003590 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003591 }
3592
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003593# check we are in a valid C source file if not then ignore this hunk
3594 next if ($realfile !~ /\.(h|c)$/);
3595
Joe Perches5751a242017-11-17 15:28:52 -08003596# check for unusual line ending [ or (
3597 if ($line =~ /^\+.*([\[\(])\s*$/) {
3598 CHK("OPEN_ENDED_LINE",
3599 "Lines should not end with a '$1'\n" . $herecurr);
3600 }
3601
Joe Perches4dbed762017-05-08 15:55:39 -07003602# check if this appears to be the start function declaration, save the name
3603 if ($sline =~ /^\+\{\s*$/ &&
3604 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3605 $context_function = $1;
3606 }
3607
3608# check if this appears to be the end of function declaration
3609 if ($sline =~ /^\+\}\s*$/) {
3610 undef $context_function;
3611 }
3612
Joe Perches032a4c02014-08-06 16:10:29 -07003613# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003614# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003615# if the previous line is a break or return and is indented 1 tab more...
3616 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3617 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003618 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3619 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3620 defined $lines[$linenr] &&
3621 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003622 WARN("UNNECESSARY_ELSE",
3623 "else is not generally useful after a break or return\n" . $hereprev);
3624 }
3625 }
3626
Joe Perchesc00df192014-08-06 16:11:01 -07003627# check indentation of a line with a break;
3628# if the previous line is a goto or return and is indented the same # of tabs
3629 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3630 my $tabs = $1;
3631 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3632 WARN("UNNECESSARY_BREAK",
3633 "break is not useful after a goto or return\n" . $hereprev);
3634 }
3635 }
3636
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003637# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003638 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003639 WARN("CVS_KEYWORD",
3640 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003641 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003642
Joe Perches56e77d72013-02-21 16:44:14 -08003643# check for old HOTPLUG __dev<foo> section markings
3644 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3645 WARN("HOTPLUG_SECTION",
3646 "Using $1 is unnecessary\n" . $herecurr);
3647 }
3648
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003649# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003650 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3651 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003652#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003653 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003654 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003655 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003656 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003657 $stat =~ s/\n./\n /g;
3658 $cond =~ s/\n./\n /g;
3659
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003660#print "linenr<$linenr> <$stat>\n";
3661 # If this statement has no statement boundaries within
3662 # it there is no point in retrying a statement scan
3663 # until we hit end of it.
3664 my $frag = $stat; $frag =~ s/;+\s*$//;
3665 if ($frag !~ /(?:{|;)/) {
3666#print "skip<$line_nr_next>\n";
3667 $suppress_statement = $line_nr_next;
3668 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003669
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003670 # Find the real next line.
3671 $realline_next = $line_nr_next;
3672 if (defined $realline_next &&
3673 (!defined $lines[$realline_next - 1] ||
3674 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3675 $realline_next++;
3676 }
3677
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003678 my $s = $stat;
3679 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003680
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003681 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003682 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003683
3684 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003685 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003686
Andy Whitcroft463f2862009-09-21 17:04:34 -07003687 } elsif ($s =~ /^.\s*else\b/s) {
3688
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003689 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003690 } 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 -07003691 my $type = $1;
3692 $type =~ s/\s+/ /g;
3693 possible($type, "A:" . $s);
3694
Andy Whitcroft8905a672007-11-28 16:21:06 -08003695 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003696 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003697 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003698 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003699
3700 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003701 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003702 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003703 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003704
3705 # Check for any sort of function declaration.
3706 # int foo(something bar, other baz);
3707 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003708 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 -08003709 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003710
Andy Whitcroftcf655042008-03-04 14:28:20 -08003711 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003712 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003713 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003714
Andy Whitcroft8905a672007-11-28 16:21:06 -08003715 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003716 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003717
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003718 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003719 }
3720 }
3721 }
3722
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003723 }
3724
Andy Whitcroft653d4872007-06-23 17:16:34 -07003725#
3726# Checks which may be anchored in the context.
3727#
3728
3729# Check for switch () and associated case and default
3730# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003731 if ($line=~/\bswitch\s*\(.*\)/) {
3732 my $err = '';
3733 my $sep = '';
3734 my @ctx = ctx_block_outer($linenr, $realcnt);
3735 shift(@ctx);
3736 for my $ctx (@ctx) {
3737 my ($clen, $cindent) = line_stats($ctx);
3738 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3739 $indent != $cindent) {
3740 $err .= "$sep$ctx\n";
3741 $sep = '';
3742 } else {
3743 $sep = "[...]\n";
3744 }
3745 }
3746 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003747 ERROR("SWITCH_CASE_INDENT_LEVEL",
3748 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003749 }
3750 }
3751
3752# if/while/etc brace do not go on next line, unless defining a do while loop,
3753# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003754 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 -07003755 my $pre_ctx = "$1$2";
3756
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003757 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003758
3759 if ($line =~ /^\+\t{6,}/) {
3760 WARN("DEEP_INDENTATION",
3761 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3762 }
3763
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003764 my $ctx_cnt = $realcnt - $#ctx - 1;
3765 my $ctx = join("\n", @ctx);
3766
Andy Whitcroft548596d2008-07-23 21:29:01 -07003767 my $ctx_ln = $linenr;
3768 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003769
Andy Whitcroft548596d2008-07-23 21:29:01 -07003770 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3771 defined $lines[$ctx_ln - 1] &&
3772 $lines[$ctx_ln - 1] =~ /^-/)) {
3773 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3774 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003775 $ctx_ln++;
3776 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003777
Andy Whitcroft53210162008-07-23 21:29:03 -07003778 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3779 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003780
Joe Perchesd752fcc2014-08-06 16:11:05 -07003781 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003782 ERROR("OPEN_BRACE",
3783 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003784 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003785 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003786 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3787 $ctx =~ /\)\s*\;\s*$/ &&
3788 defined $lines[$ctx_ln - 1])
3789 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003790 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3791 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003792 WARN("TRAILING_SEMICOLON",
3793 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003794 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003795 }
3796 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003797 }
3798
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003799# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003800 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 -08003801 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3802 ctx_statement_block($linenr, $realcnt, 0)
3803 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003804 my ($s, $c) = ($stat, $cond);
3805
3806 substr($s, 0, length($c), '');
3807
Joe Perches9f5af482015-09-09 15:37:30 -07003808 # remove inline comments
3809 $s =~ s/$;/ /g;
3810 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003811
3812 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003813 my @newlines = ($c =~ /\n/gs);
3814 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003815
Joe Perches9f5af482015-09-09 15:37:30 -07003816 # Make sure we remove the line prefixes as we have
3817 # none on the first line, and are going to readd them
3818 # where necessary.
3819 $s =~ s/\n./\n/gs;
3820 while ($s =~ /\n\s+\\\n/) {
3821 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3822 }
3823
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003824 # We want to check the first line inside the block
3825 # starting at the end of the conditional, so remove:
3826 # 1) any blank line termination
3827 # 2) any opening brace { on end of the line
3828 # 3) any do (...) {
3829 my $continuation = 0;
3830 my $check = 0;
3831 $s =~ s/^.*\bdo\b//;
3832 $s =~ s/^\s*{//;
3833 if ($s =~ s/^\s*\\//) {
3834 $continuation = 1;
3835 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003836 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003837 $check = 1;
3838 $cond_lines++;
3839 }
3840
3841 # Also ignore a loop construct at the end of a
3842 # preprocessor statement.
3843 if (($prevline =~ /^.\s*#\s*define\s/ ||
3844 $prevline =~ /\\\s*$/) && $continuation == 0) {
3845 $check = 0;
3846 }
3847
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003848 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003849 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003850 while ($cond_ptr != $cond_lines) {
3851 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003852
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003853 # If we see an #else/#elif then the code
3854 # is not linear.
3855 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3856 $check = 0;
3857 }
3858
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003859 # Ignore:
3860 # 1) blank lines, they should be at 0,
3861 # 2) preprocessor lines, and
3862 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003863 if ($continuation ||
3864 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003865 $s =~ /^\s*#\s*?/ ||
3866 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003867 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003868 if ($s =~ s/^.*?\n//) {
3869 $cond_lines++;
3870 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003871 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003872 }
3873
3874 my (undef, $sindent) = line_stats("+" . $s);
3875 my $stat_real = raw_line($linenr, $cond_lines);
3876
3877 # Check if either of these lines are modified, else
3878 # this is not this patch's fault.
3879 if (!defined($stat_real) ||
3880 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3881 $check = 0;
3882 }
3883 if (defined($stat_real) && $cond_lines > 1) {
3884 $stat_real = "[...]\n$stat_real";
3885 }
3886
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003887 #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 -07003888
Joe Perches9f5af482015-09-09 15:37:30 -07003889 if ($check && $s ne '' &&
Antonio Borneo713a09d2020-04-06 20:11:07 -07003890 (($sindent % $tabsize) != 0 ||
Joe Perches9f5af482015-09-09 15:37:30 -07003891 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003892 ($sindent == $indent &&
3893 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Antonio Borneo713a09d2020-04-06 20:11:07 -07003894 ($sindent > $indent + $tabsize))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003895 WARN("SUSPECT_CODE_INDENT",
3896 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003897 }
3898 }
3899
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003900 # Track the 'values' across context and added lines.
3901 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003902 my ($curr_values, $curr_vars) =
3903 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003904 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003905 if ($dbg_values) {
3906 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003907 print "$linenr > .$outline\n";
3908 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003909 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003910 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003911 $prev_values = substr($curr_values, -1);
3912
Andy Whitcroft00df3442007-06-08 13:47:06 -07003913#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003914 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003915
Joe Perches99ca38c2020-10-15 20:12:09 -07003916# check for self assignments used to avoid compiler warnings
3917# e.g.: int foo = foo, *bar = NULL;
3918# struct foo bar = *(&(bar));
3919 if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) {
3920 my $var = $1;
3921 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
3922 WARN("SELF_ASSIGNMENT",
3923 "Do not use self-assignments to avoid compiler warnings\n" . $herecurr);
3924 }
3925 }
3926
Joe Perches11ca40a2016-12-12 16:46:31 -08003927# check for dereferences that span multiple lines
3928 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3929 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3930 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3931 my $ref = $1;
3932 $line =~ /^.\s*($Lval)/;
3933 $ref .= $1;
3934 $ref =~ s/\s//g;
3935 WARN("MULTILINE_DEREFERENCE",
3936 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3937 }
3938
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003939# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003940 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 -07003941 my $type = $1;
3942 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003943 $var = "" if (!defined $var);
3944 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003945 my $sign = $1;
3946 my $pointer = $2;
3947
3948 $pointer = "" if (!defined $pointer);
3949
3950 if (WARN("UNSPECIFIED_INT",
3951 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3952 $fix) {
3953 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003954 my $comp_pointer = $pointer;
3955 $comp_pointer =~ s/\s//g;
3956 $decl .= $comp_pointer;
3957 $decl = rtrim($decl) if ($var eq "");
3958 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003959 }
3960 }
3961 }
3962
Andy Whitcroft653d4872007-06-23 17:16:34 -07003963# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003964 if ($dbg_type) {
3965 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003966 ERROR("TEST_TYPE",
3967 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003968 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003969 ERROR("TEST_NOT_TYPE",
3970 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003971 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003972 next;
3973 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003974# TEST: allow direct testing of the attribute matcher.
3975 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003976 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003977 ERROR("TEST_ATTR",
3978 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003979 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003980 ERROR("TEST_NOT_ATTR",
3981 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003982 }
3983 next;
3984 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003985
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003986# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003987 if ($line =~ /^.\s*{/ &&
3988 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003989 if (ERROR("OPEN_BRACE",
3990 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003991 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3992 fix_delete_line($fixlinenr - 1, $prevrawline);
3993 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003994 my $fixedline = $prevrawline;
3995 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003996 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003997 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003998 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003999 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07004000 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004001 }
4002
Andy Whitcroft653d4872007-06-23 17:16:34 -07004003#
4004# Checks which are anchored on the added line.
4005#
4006
4007# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004008 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07004009 my $path = $1;
4010 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004011 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08004012 "malformed #include filename\n" . $herecurr);
4013 }
4014 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
4015 ERROR("UAPI_INCLUDE",
4016 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004017 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004018 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004019
4020# no C99 // comments
4021 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07004022 if (ERROR("C99_COMMENTS",
4023 "do not use C99 // comments\n" . $herecurr) &&
4024 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004025 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07004026 if ($line =~ /\/\/(.*)$/) {
4027 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07004028 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07004029 }
4030 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07004031 }
4032 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004033 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004034 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004035
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004036# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4037# the whole statement.
4038#print "APW <$lines[$realline_next - 1]>\n";
4039 if (defined $realline_next &&
4040 exists $lines[$realline_next - 1] &&
4041 !defined $suppress_export{$realline_next} &&
4042 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4043 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004044 # Handle definitions which produce identifiers with
4045 # a prefix:
4046 # XXX(foo);
4047 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07004048 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08004049 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07004050 $name =~ /^${Ident}_$2/) {
4051#print "FOO C name<$name>\n";
4052 $suppress_export{$realline_next} = 1;
4053
4054 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004055 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07004056 ^.DEFINE_$Ident\(\Q$name\E\)|
4057 ^.DECLARE_$Ident\(\Q$name\E\)|
4058 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004059 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
4060 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07004061 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004062#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4063 $suppress_export{$realline_next} = 2;
4064 } else {
4065 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004066 }
4067 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004068 if (!defined $suppress_export{$linenr} &&
4069 $prevline =~ /^.\s*$/ &&
4070 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
4071 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
4072#print "FOO B <$lines[$linenr - 1]>\n";
4073 $suppress_export{$linenr} = 2;
4074 }
4075 if (defined $suppress_export{$linenr} &&
4076 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004077 WARN("EXPORT_SYMBOL",
4078 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07004079 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004080
Joe Eloff5150bda2010-08-09 17:21:00 -07004081# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004082 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004083 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004084 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07004085 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004086 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004087 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004088 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004089# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08004090 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004091 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08004092 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07004093 $herecurr) &&
4094 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08004095 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004096 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004097 }
4098
Joe Perches18130872014-08-06 16:11:22 -07004099# check for misordered declarations of char/short/int/long with signed/unsigned
4100 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
4101 my $tmp = trim($1);
4102 WARN("MISORDERED_TYPE",
4103 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4104 }
4105
Joe Perches809e0822018-08-21 21:58:12 -07004106# check for unnecessary <signed> int declarations of short/long/long long
4107 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
4108 my $type = trim($1);
4109 next if ($type !~ /\bint\b/);
4110 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
4111 my $new_type = $type;
4112 $new_type =~ s/\b\s*int\s*\b/ /;
4113 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
4114 $new_type =~ s/^const\s+//;
4115 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
4116 $new_type = "const $new_type" if ($type =~ /^const\b/);
4117 $new_type =~ s/\s+/ /g;
4118 $new_type = trim($new_type);
4119 if (WARN("UNNECESSARY_INT",
4120 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
4121 $fix) {
4122 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
4123 }
4124 }
4125
Joe Perchescb710ec2010-10-26 14:23:20 -07004126# check for static const char * arrays.
4127 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004128 WARN("STATIC_CONST_CHAR_ARRAY",
4129 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004130 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004131 }
4132
4133# check for initialized const char arrays that should be static const
4134 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4135 if (WARN("STATIC_CONST_CHAR_ARRAY",
4136 "const array should probably be static const\n" . $herecurr) &&
4137 $fix) {
4138 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
4139 }
4140 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004141
4142# check for static char foo[] = "bar" declarations.
4143 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004144 WARN("STATIC_CONST_CHAR_ARRAY",
4145 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07004146 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08004147 }
Joe Perchescb710ec2010-10-26 14:23:20 -07004148
Joe Perchesab7e23f2015-04-16 12:44:22 -07004149# check for const <foo> const where <foo> is not a pointer or array type
4150 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
4151 my $found = $1;
4152 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
4153 WARN("CONST_CONST",
4154 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
4155 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
4156 WARN("CONST_CONST",
4157 "'const $found const' should probably be 'const $found'\n" . $herecurr);
4158 }
4159 }
4160
Joe Perches9b0fa602014-04-03 14:49:18 -07004161# check for non-global char *foo[] = {"bar", ...} declarations.
4162 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
4163 WARN("STATIC_CONST_CHAR_ARRAY",
4164 "char * array declaration might be better as static const\n" .
4165 $herecurr);
4166 }
4167
Joe Perchesb598b672015-04-16 12:44:36 -07004168# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4169 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4170 my $array = $1;
4171 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4172 my $array_div = $1;
4173 if (WARN("ARRAY_SIZE",
4174 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4175 $fix) {
4176 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4177 }
4178 }
4179 }
4180
Joe Perchesb36190c2014-01-27 17:07:18 -08004181# check for function declarations without arguments like "int foo()"
Joe Perches16b7f3c2020-04-06 20:11:17 -07004182 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) {
Joe Perchesb36190c2014-01-27 17:07:18 -08004183 if (ERROR("FUNCTION_WITHOUT_ARGS",
4184 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4185 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004186 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004187 }
4188 }
4189
Andy Whitcroft653d4872007-06-23 17:16:34 -07004190# check for new typedefs, only function parameters and sparse annotations
4191# make sense.
4192 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004193 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004194 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004195 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004196 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004197 WARN("NEW_TYPEDEFS",
4198 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004199 }
4200
4201# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004202 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004203 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4204 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004205 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004206
Andy Whitcroft65863862009-01-06 14:41:21 -08004207 # Should start with a space.
4208 $to =~ s/^(\S)/ $1/;
4209 # Should not end with a space.
4210 $to =~ s/\s+$//;
4211 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004212 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004213 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004214
Joe Perches3705ce52013-07-03 15:05:31 -07004215## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004216 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004217 if (ERROR("POINTER_LOCATION",
4218 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4219 $fix) {
4220 my $sub_from = $ident;
4221 my $sub_to = $ident;
4222 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004223 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004224 s@\Q$sub_from\E@$sub_to@;
4225 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004226 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004227 }
4228 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4229 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004230 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004231
Andy Whitcroft65863862009-01-06 14:41:21 -08004232 # Should start with a space.
4233 $to =~ s/^(\S)/ $1/;
4234 # Should not end with a space.
4235 $to =~ s/\s+$//;
4236 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004237 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004238 }
4239 # Modifiers should have spaces.
4240 $to =~ s/(\b$Modifier$)/$1 /;
4241
Joe Perches3705ce52013-07-03 15:05:31 -07004242## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004243 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004244 if (ERROR("POINTER_LOCATION",
4245 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4246 $fix) {
4247
4248 my $sub_from = $match;
4249 my $sub_to = $match;
4250 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004251 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004252 s@\Q$sub_from\E@$sub_to@;
4253 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004254 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004255 }
4256
Joe Perches9d3e3c72015-09-09 15:37:27 -07004257# avoid BUG() or BUG_ON()
4258 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004259 my $msg_level = \&WARN;
4260 $msg_level = \&CHK if ($file);
4261 &{$msg_level}("AVOID_BUG",
4262 "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 -07004263 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004264
Joe Perches9d3e3c72015-09-09 15:37:27 -07004265# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004266 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004267 WARN("LINUX_VERSION_CODE",
4268 "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 -08004269 }
4270
Joe Perches17441222011-06-15 15:08:17 -07004271# check for uses of printk_ratelimit
4272 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004273 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004274 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004275 }
4276
Joe Percheseeef5732017-11-17 15:28:41 -08004277# printk should use KERN_* levels
4278 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4279 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4280 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004281 }
4282
Joe Perches243f3802012-05-31 16:26:09 -07004283 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4284 my $orig = $1;
4285 my $level = lc($orig);
4286 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004287 my $level2 = $level;
4288 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004289 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004290 "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 -07004291 }
4292
Joe Perchesdc139312013-02-21 16:44:13 -08004293 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4294 my $orig = $1;
4295 my $level = lc($orig);
4296 $level = "warn" if ($level eq "warning");
4297 $level = "dbg" if ($level eq "debug");
4298 WARN("PREFER_DEV_LEVEL",
4299 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4300 }
4301
Nicolas Boichat8020b252020-10-15 20:12:02 -07004302# trace_printk should not be used in production code.
4303 if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) {
4304 WARN("TRACE_PRINTK",
4305 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4306 }
4307
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004308# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4309# number of false positives, but assembly files are not checked, so at
4310# least the arch entry code will not trigger this warning.
4311 if ($line =~ /\bENOSYS\b/) {
4312 WARN("ENOSYS",
4313 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4314 }
4315
Jakub Kicinski6b9ea5f2020-05-11 10:08:07 -07004316# ENOTSUPP is not a standard error code and should be avoided in new patches.
4317# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4318# Similarly to ENOSYS warning a small number of false positives is expected.
4319 if (!$file && $line =~ /\bENOTSUPP\b/) {
4320 if (WARN("ENOTSUPP",
4321 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) &&
4322 $fix) {
4323 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/;
4324 }
4325 }
4326
Andy Whitcroft653d4872007-06-23 17:16:34 -07004327# function brace can't be on same line, except for #defines of do while,
4328# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004329 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004330 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4331 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4332 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004333 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004334 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004335 $fix) {
4336 fix_delete_line($fixlinenr, $rawline);
4337 my $fixed_line = $rawline;
4338 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4339 my $line1 = $1;
4340 my $line2 = $2;
4341 fix_insert_line($fixlinenr, ltrim($line1));
4342 fix_insert_line($fixlinenr, "\+{");
4343 if ($line2 !~ /^\s*$/) {
4344 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4345 }
4346 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004347 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004348
Andy Whitcroft8905a672007-11-28 16:21:06 -08004349# open braces for enum, union and struct go on the same line.
4350 if ($line =~ /^.\s*{/ &&
4351 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004352 if (ERROR("OPEN_BRACE",
4353 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4354 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4355 fix_delete_line($fixlinenr - 1, $prevrawline);
4356 fix_delete_line($fixlinenr, $rawline);
4357 my $fixedline = rtrim($prevrawline) . " {";
4358 fix_insert_line($fixlinenr, $fixedline);
4359 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004360 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004361 if ($fixedline !~ /^\+\s*$/) {
4362 fix_insert_line($fixlinenr, $fixedline);
4363 }
4364 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004365 }
4366
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004367# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004368 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4369 if (WARN("SPACING",
4370 "missing space after $1 definition\n" . $herecurr) &&
4371 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004372 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004373 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4374 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004375 }
4376
Joe Perches31070b52014-01-23 15:54:49 -08004377# Function pointer declarations
4378# check spacing between type, funcptr, and args
4379# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004380 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004381 my $declare = $1;
4382 my $pre_pointer_space = $2;
4383 my $post_pointer_space = $3;
4384 my $funcname = $4;
4385 my $post_funcname_space = $5;
4386 my $pre_args_space = $6;
4387
Joe Perches91f72e92014-04-03 14:49:12 -07004388# the $Declare variable will capture all spaces after the type
4389# so check it for a missing trailing missing space but pointer return types
4390# don't need a space so don't warn for those.
4391 my $post_declare_space = "";
4392 if ($declare =~ /(\s+)$/) {
4393 $post_declare_space = $1;
4394 $declare = rtrim($declare);
4395 }
4396 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004397 WARN("SPACING",
4398 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004399 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004400 }
4401
4402# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004403# This test is not currently implemented because these declarations are
4404# equivalent to
4405# int foo(int bar, ...)
4406# and this is form shouldn't/doesn't generate a checkpatch warning.
4407#
4408# elsif ($declare =~ /\s{2,}$/) {
4409# WARN("SPACING",
4410# "Multiple spaces after return type\n" . $herecurr);
4411# }
Joe Perches31070b52014-01-23 15:54:49 -08004412
4413# unnecessary space "type ( *funcptr)(args...)"
4414 if (defined $pre_pointer_space &&
4415 $pre_pointer_space =~ /^\s/) {
4416 WARN("SPACING",
4417 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4418 }
4419
4420# unnecessary space "type (* funcptr)(args...)"
4421 if (defined $post_pointer_space &&
4422 $post_pointer_space =~ /^\s/) {
4423 WARN("SPACING",
4424 "Unnecessary space before function pointer name\n" . $herecurr);
4425 }
4426
4427# unnecessary space "type (*funcptr )(args...)"
4428 if (defined $post_funcname_space &&
4429 $post_funcname_space =~ /^\s/) {
4430 WARN("SPACING",
4431 "Unnecessary space after function pointer name\n" . $herecurr);
4432 }
4433
4434# unnecessary space "type (*funcptr) (args...)"
4435 if (defined $pre_args_space &&
4436 $pre_args_space =~ /^\s/) {
4437 WARN("SPACING",
4438 "Unnecessary space before function pointer arguments\n" . $herecurr);
4439 }
4440
4441 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004442 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004443 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004444 }
4445 }
4446
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004447# check for spacing round square brackets; allowed:
4448# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004449# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4450# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004451 while ($line =~ /(.*?\s)\[/g) {
4452 my ($where, $prefix) = ($-[1], $1);
4453 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004454 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004455 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004456 if (ERROR("BRACKET_SPACE",
4457 "space prohibited before open square bracket '['\n" . $herecurr) &&
4458 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004459 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004460 s/^(\+.*?)\s+\[/$1\[/;
4461 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004462 }
4463 }
4464
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004465# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004466 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004467 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004468 my $ctx_before = substr($line, 0, $-[1]);
4469 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004470
4471 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004472 if ($name =~ /^(?:
4473 if|for|while|switch|return|case|
4474 volatile|__volatile__|
4475 __attribute__|format|__extension__|
4476 asm|__asm__)$/x)
4477 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004478 # cpp #define statements have non-optional spaces, ie
4479 # if there is a space between the name and the open
4480 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004481 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004482
4483 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004484 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004485
4486 # If this whole things ends with a type its most
4487 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004488 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004489
4490 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004491 if (WARN("SPACING",
4492 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4493 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004494 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004495 s/\b$name\s+\(/$name\(/;
4496 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004497 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004498 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004499
Andy Whitcroft653d4872007-06-23 17:16:34 -07004500# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004501 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004502 my $fixed_line = "";
4503 my $line_fixed = 0;
4504
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004505 my $ops = qr{
4506 <<=|>>=|<=|>=|==|!=|
4507 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4508 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004509 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004510 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004511 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004512 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004513
4514## print("element count: <" . $#elements . ">\n");
4515## foreach my $el (@elements) {
4516## print("el: <$el>\n");
4517## }
4518
4519 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004520 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004521
Joe Perches3705ce52013-07-03 15:05:31 -07004522 foreach my $el (@elements) {
4523 push(@fix_elements, substr($rawline, $off, length($el)));
4524 $off += length($el);
4525 }
4526
4527 $off = 0;
4528
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004529 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004530 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004531
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004532 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004533
4534 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4535
4536## print("n: <$n> good: <$good>\n");
4537
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004538 $off += length($elements[$n]);
4539
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004540 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004541 my $ca = substr($opline, 0, $off);
4542 my $cc = '';
4543 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4544 $cc = substr($opline, $off + length($elements[$n + 1]));
4545 }
4546 my $cb = "$ca$;$cc";
4547
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004548 my $a = '';
4549 $a = 'V' if ($elements[$n] ne '');
4550 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004551 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004552 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4553 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004554 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004555
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004556 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004557
4558 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004559 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004560 $c = 'V' if ($elements[$n + 2] ne '');
4561 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004562 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004563 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4564 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004565 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004566 } else {
4567 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004568 }
4569
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004570 my $ctx = "${a}x${c}";
4571
4572 my $at = "(ctx:$ctx)";
4573
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004574 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004575 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004576
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004577 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004578 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004579
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004580 # Get the full operator variant.
4581 my $opv = $op . substr($curr_vars, $off, 1);
4582
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004583 # Ignore operators passed as parameters.
4584 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004585 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004586
Andy Whitcroftcf655042008-03-04 14:28:20 -08004587# # Ignore comments
4588# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004589
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004590 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004591 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004592 if ($ctx !~ /.x[WEBC]/ &&
4593 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004594 if (ERROR("SPACING",
4595 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004596 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004597 $line_fixed = 1;
4598 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004599 }
4600
4601 # // is a comment
4602 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004603
Joe Perchesb00e4812014-04-03 14:49:33 -07004604 # : when part of a bitfield
4605 } elsif ($opv eq ':B') {
4606 # skip the bitfield test for now
4607
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004608 # No spaces for:
4609 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004610 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004611 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004612 if (ERROR("SPACING",
4613 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004614 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004615 if (defined $fix_elements[$n + 2]) {
4616 $fix_elements[$n + 2] =~ s/^\s+//;
4617 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004618 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004619 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004620 }
4621
Joe Perches23810972014-12-10 15:51:32 -08004622 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004623 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004624 my $rtrim_before = 0;
4625 my $space_after = 0;
4626 if ($ctx =~ /Wx./) {
4627 if (ERROR("SPACING",
4628 "space prohibited before that '$op' $at\n" . $hereptr)) {
4629 $line_fixed = 1;
4630 $rtrim_before = 1;
4631 }
4632 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004633 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004634 if (ERROR("SPACING",
4635 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004636 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004637 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004638 $space_after = 1;
4639 }
4640 }
4641 if ($rtrim_before || $space_after) {
4642 if ($rtrim_before) {
4643 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4644 } else {
4645 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4646 }
4647 if ($space_after) {
4648 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004649 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004650 }
4651
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004652 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004653 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004654 #warn "'*' is part of type\n";
4655
4656 # unary operators should have a space before and
4657 # none after. May be left adjacent to another
4658 # unary operator, or a cast
4659 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004660 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004661 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004662 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004663 if (ERROR("SPACING",
4664 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004665 if ($n != $last_after + 2) {
4666 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4667 $line_fixed = 1;
4668 }
Joe Perches3705ce52013-07-03 15:05:31 -07004669 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004670 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004671 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004672 # A unary '*' may be const
4673
4674 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004675 if (ERROR("SPACING",
4676 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004677 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004678 if (defined $fix_elements[$n + 2]) {
4679 $fix_elements[$n + 2] =~ s/^\s+//;
4680 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004681 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004682 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004683 }
4684
4685 # unary ++ and unary -- are allowed no space on one side.
4686 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004687 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004688 if (ERROR("SPACING",
4689 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004690 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004691 $line_fixed = 1;
4692 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004693 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004694 if ($ctx =~ /Wx[BE]/ ||
4695 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004696 if (ERROR("SPACING",
4697 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004698 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004699 $line_fixed = 1;
4700 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004701 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004702 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004703 if (ERROR("SPACING",
4704 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004705 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004706 if (defined $fix_elements[$n + 2]) {
4707 $fix_elements[$n + 2] =~ s/^\s+//;
4708 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004709 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004710 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004711 }
4712
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004713 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004714 } elsif ($op eq '<<' or $op eq '>>' or
4715 $op eq '&' or $op eq '^' or $op eq '|' or
4716 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004717 $op eq '*' or $op eq '/' or
4718 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004719 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004720 if ($check) {
4721 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4722 if (CHK("SPACING",
4723 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4724 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4725 $fix_elements[$n + 2] =~ s/^\s+//;
4726 $line_fixed = 1;
4727 }
4728 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4729 if (CHK("SPACING",
4730 "space preferred before that '$op' $at\n" . $hereptr)) {
4731 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4732 $line_fixed = 1;
4733 }
4734 }
4735 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004736 if (ERROR("SPACING",
4737 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004738 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4739 if (defined $fix_elements[$n + 2]) {
4740 $fix_elements[$n + 2] =~ s/^\s+//;
4741 }
Joe Perches3705ce52013-07-03 15:05:31 -07004742 $line_fixed = 1;
4743 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004744 }
4745
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004746 # A colon needs no spaces before when it is
4747 # terminating a case value or a label.
4748 } elsif ($opv eq ':C' || $opv eq ':L') {
4749 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004750 if (ERROR("SPACING",
4751 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004752 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004753 $line_fixed = 1;
4754 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004755 }
4756
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004757 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004758 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004759 my $ok = 0;
4760
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004761 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004762 if (($op eq '<' &&
4763 $cc =~ /^\S+\@\S+>/) ||
4764 ($op eq '>' &&
4765 $ca =~ /<\S+\@\S+$/))
4766 {
Antonio Borneo342d3d22020-04-06 20:11:01 -07004767 $ok = 1;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004768 }
4769
Joe Perchese0df7e12015-04-16 12:44:53 -07004770 # for asm volatile statements
4771 # ignore a colon with another
4772 # colon immediately before or after
4773 if (($op eq ':') &&
4774 ($ca =~ /:$/ || $cc =~ /^:/)) {
4775 $ok = 1;
4776 }
4777
Joe Perches84731622013-11-12 15:10:05 -08004778 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004779 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004780 my $msg_level = \&ERROR;
4781 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004782
Jean Delvare0675a8f2017-09-08 16:16:07 -07004783 if (&{$msg_level}("SPACING",
4784 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004785 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4786 if (defined $fix_elements[$n + 2]) {
4787 $fix_elements[$n + 2] =~ s/^\s+//;
4788 }
Joe Perches3705ce52013-07-03 15:05:31 -07004789 $line_fixed = 1;
4790 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004791 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004792 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004793 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004794
4795## print("n: <$n> GOOD: <$good>\n");
4796
4797 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004798 }
Joe Perches3705ce52013-07-03 15:05:31 -07004799
4800 if (($#elements % 2) == 0) {
4801 $fixed_line = $fixed_line . $fix_elements[$#elements];
4802 }
4803
Joe Perches194f66f2014-08-06 16:11:03 -07004804 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4805 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004806 }
4807
4808
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004809 }
4810
Joe Perches786b6322013-07-03 15:05:32 -07004811# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004812 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004813 if (WARN("SPACING",
4814 "space prohibited before semicolon\n" . $herecurr) &&
4815 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004816 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004817 s/^(\+.*\S)\s+;/$1;/;
4818 }
4819 }
4820
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004821# check for multiple assignments
4822 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004823 CHK("MULTIPLE_ASSIGNMENTS",
4824 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004825 }
4826
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004827## # check for multiple declarations, allowing for a function declaration
4828## # continuation.
4829## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4830## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4831##
4832## # Remove any bracketed sections to ensure we do not
4833## # falsly report the parameters of functions.
4834## my $ln = $line;
4835## while ($ln =~ s/\([^\(\)]*\)//g) {
4836## }
4837## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004838## WARN("MULTIPLE_DECLARATION",
4839## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004840## }
4841## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004842
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004843#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004844 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004845 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004846 if (ERROR("SPACING",
4847 "space required before the open brace '{'\n" . $herecurr) &&
4848 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004849 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004850 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004851 }
4852
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004853## # check for blank lines before declarations
4854## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4855## $prevrawline =~ /^.\s*$/) {
4856## WARN("SPACING",
4857## "No blank lines before declarations\n" . $hereprev);
4858## }
4859##
4860
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004861# closing brace should have a space following it when it has anything
4862# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07004863 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004864 if (ERROR("SPACING",
4865 "space required after that close brace '}'\n" . $herecurr) &&
4866 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004867 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004868 s/}((?!(?:,|;|\)))\S)/} $1/;
4869 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004870 }
4871
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004872# check spacing on square brackets
4873 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004874 if (ERROR("SPACING",
4875 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4876 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004877 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004878 s/\[\s+/\[/;
4879 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004880 }
4881 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004882 if (ERROR("SPACING",
4883 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4884 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004885 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004886 s/\s+\]/\]/;
4887 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004888 }
4889
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004890# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004891 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4892 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004893 if (ERROR("SPACING",
4894 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4895 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004896 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004897 s/\(\s+/\(/;
4898 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004899 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004900 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004901 $line !~ /for\s*\(.*;\s+\)/ &&
4902 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004903 if (ERROR("SPACING",
4904 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4905 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004906 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004907 s/\s+\)/\)/;
4908 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004909 }
4910
Joe Perchese2826fd2014-08-06 16:10:48 -07004911# check unnecessary parentheses around addressof/dereference single $Lvals
4912# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4913
4914 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004915 my $var = $1;
4916 if (CHK("UNNECESSARY_PARENTHESES",
4917 "Unnecessary parentheses around $var\n" . $herecurr) &&
4918 $fix) {
4919 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4920 }
4921 }
4922
4923# check for unnecessary parentheses around function pointer uses
4924# ie: (foo->bar)(); should be foo->bar();
4925# but not "if (foo->bar) (" to avoid some false positives
4926 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4927 my $var = $2;
4928 if (CHK("UNNECESSARY_PARENTHESES",
4929 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4930 $fix) {
4931 my $var2 = deparenthesize($var);
4932 $var2 =~ s/\s//g;
4933 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4934 }
4935 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004936
Joe Perches63b7c732017-09-08 16:16:01 -07004937# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004938# when !drivers/staging or command-line uses --strict
4939 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07004940 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004941 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4942 my $if_stat = $1;
4943 my $test = substr($2, 1, -1);
4944 my $herectx;
4945 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4946 my $match = $1;
4947 # avoid parentheses around potential macro args
4948 next if ($match =~ /^\s*\w+\s*$/);
4949 if (!defined($herectx)) {
4950 $herectx = $here . "\n";
4951 my $cnt = statement_rawlines($if_stat);
4952 for (my $n = 0; $n < $cnt; $n++) {
4953 my $rl = raw_line($linenr, $n);
4954 $herectx .= $rl . "\n";
4955 last if $rl =~ /^[ \+].*\{/;
4956 }
4957 }
4958 CHK("UNNECESSARY_PARENTHESES",
4959 "Unnecessary parentheses around '$match'\n" . $herectx);
4960 }
4961 }
4962
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004963#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004964 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004965 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004966 if (WARN("INDENTED_LABEL",
4967 "labels should not be indented\n" . $herecurr) &&
4968 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004969 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004970 s/^(.)\s+/$1/;
4971 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004972 }
4973
Joe Perches40873ab2020-10-15 20:11:56 -07004974# check if a statement with a comma should be two statements like:
4975# foo = bar(), /* comma should be semicolon */
4976# bar = baz();
4977 if (defined($stat) &&
4978 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
4979 my $cnt = statement_rawlines($stat);
4980 my $herectx = get_stat_here($linenr, $cnt, $here);
4981 WARN("SUSPECT_COMMA_SEMICOLON",
4982 "Possible comma where semicolon could be used\n" . $herectx);
4983 }
4984
Joe Perches5b9553a2014-04-03 14:49:21 -07004985# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004986 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004987 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07004988 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004989 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4990 my $value = $1;
4991 $value = deparenthesize($value);
4992 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4993 ERROR("RETURN_PARENTHESES",
4994 "return is not a function, parentheses are not required\n" . $herecurr);
4995 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004996 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004997 ERROR("SPACING",
4998 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004999 }
5000 }
Joe Perches507e5142013-11-12 15:10:13 -08005001
Joe Perchesb43ae212014-06-23 13:22:07 -07005002# unnecessary return in a void function
5003# at end-of-function, with the previous line a single leading tab, then return;
5004# and the line before that not a goto label target like "out:"
5005 if ($sline =~ /^[ \+]}\s*$/ &&
5006 $prevline =~ /^\+\treturn\s*;\s*$/ &&
5007 $linenr >= 3 &&
5008 $lines[$linenr - 3] =~ /^[ +]/ &&
5009 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07005010 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07005011 "void function return statements are not generally useful\n" . $hereprev);
5012 }
Joe Perches9819cf22014-06-04 16:12:09 -07005013
Joe Perches189248d2014-01-23 15:54:47 -08005014# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07005015 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08005016 $line =~ /\bif\s*((?:\(\s*){2,})/) {
5017 my $openparens = $1;
5018 my $count = $openparens =~ tr@\(@\(@;
5019 my $msg = "";
5020 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5021 my $comp = $4; #Not $1 because of $LvalOrFunc
5022 $msg = " - maybe == should be = ?" if ($comp eq "==");
5023 WARN("UNNECESSARY_PARENTHESES",
5024 "Unnecessary parentheses$msg\n" . $herecurr);
5025 }
5026 }
5027
Joe Perchesc5595fa2015-09-09 15:37:58 -07005028# comparisons with a constant or upper case identifier on the left
5029# avoid cases like "foo + BAR < baz"
5030# only fix matches surrounded by parentheses to avoid incorrect
5031# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07005032 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005033 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
5034 my $lead = $1;
5035 my $const = $2;
5036 my $comp = $3;
5037 my $to = $4;
5038 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07005039 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07005040 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
5041 WARN("CONSTANT_COMPARISON",
5042 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
5043 $fix) {
5044 if ($comp eq "<") {
5045 $newcomp = ">";
5046 } elsif ($comp eq "<=") {
5047 $newcomp = ">=";
5048 } elsif ($comp eq ">") {
5049 $newcomp = "<";
5050 } elsif ($comp eq ">=") {
5051 $newcomp = "<=";
5052 }
5053 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
5054 }
5055 }
5056
Joe Perchesf34e4a42015-04-16 12:44:19 -07005057# Return of what appears to be an errno should normally be negative
5058 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005059 my $name = $1;
5060 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07005061 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07005062 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07005063 }
5064 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005065
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005066# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07005067 if ($line =~ /\b(if|while|for|switch)\(/) {
5068 if (ERROR("SPACING",
5069 "space required before the open parenthesis '('\n" . $herecurr) &&
5070 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005071 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005072 s/\b(if|while|for|switch)\(/$1 \(/;
5073 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005074 }
5075
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07005076# Check for illegal assignment in if conditional -- and check for trailing
5077# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005078 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08005079 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
5080 ctx_statement_block($linenr, $realcnt, 0)
5081 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005082 my ($stat_next) = ctx_statement_block($line_nr_next,
5083 $remain_next, $off_next);
5084 $stat_next =~ s/\n./\n /g;
5085 ##print "stat<$stat> stat_next<$stat_next>\n";
5086
5087 if ($stat_next =~ /^\s*while\b/) {
5088 # If the statement carries leading newlines,
5089 # then count those as offsets.
5090 my ($whitespace) =
5091 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
5092 my $offset =
5093 statement_rawlines($whitespace) - 1;
5094
5095 $suppress_whiletrailers{$line_nr_next +
5096 $offset} = 1;
5097 }
5098 }
5099 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08005100 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07005101 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005102 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005103
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08005104 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches65b64b32020-08-11 18:35:10 -07005105 if (ERROR("ASSIGN_IN_IF",
5106 "do not use assignment in if condition\n" . $herecurr) &&
5107 $fix && $perl_version_ok) {
5108 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5109 my $space = $1;
5110 my $not = $2;
5111 my $statement = $3;
5112 my $assigned = $4;
5113 my $test = $8;
5114 my $against = $9;
5115 my $brace = $15;
5116 fix_delete_line($fixlinenr, $rawline);
5117 fix_insert_line($fixlinenr, "$space$statement;");
5118 my $newline = "${space}if (";
5119 $newline .= '!' if defined($not);
5120 $newline .= '(' if (defined $not && defined($test) && defined($against));
5121 $newline .= "$assigned";
5122 $newline .= " $test $against" if (defined($test) && defined($against));
5123 $newline .= ')' if (defined $not && defined($test) && defined($against));
5124 $newline .= ')';
5125 $newline .= " {" if (defined($brace));
5126 fix_insert_line($fixlinenr + 1, $newline);
5127 }
5128 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005129 }
5130
5131 # Find out what is on the end of the line after the
5132 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005133 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08005134 $s =~ s/\n.*//g;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005135 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07005136 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
5137 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005138 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005139 # Find out how long the conditional actually is.
5140 my @newlines = ($c =~ /\n/gs);
5141 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005142 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005143
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08005144 $stat_real = raw_line($linenr, $cond_lines)
5145 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07005146 if (defined($stat_real) && $cond_lines > 1) {
5147 $stat_real = "[...]\n$stat_real";
5148 }
5149
Joe Perches000d1cc12011-07-25 17:13:25 -07005150 ERROR("TRAILING_STATEMENTS",
5151 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08005152 }
5153 }
5154
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005155# Check for bitwise tests written as boolean
5156 if ($line =~ /
5157 (?:
5158 (?:\[|\(|\&\&|\|\|)
5159 \s*0[xX][0-9]+\s*
5160 (?:\&\&|\|\|)
5161 |
5162 (?:\&\&|\|\|)
5163 \s*0[xX][0-9]+\s*
5164 (?:\&\&|\|\||\)|\])
5165 )/x)
5166 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005167 WARN("HEXADECIMAL_BOOLEAN_TEST",
5168 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005169 }
5170
Andy Whitcroft8905a672007-11-28 16:21:06 -08005171# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005172 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
5173 my $s = $1;
Antonio Borneo342d3d22020-04-06 20:11:01 -07005174 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005175 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005176 ERROR("TRAILING_STATEMENTS",
5177 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005178 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005179 }
Andy Whitcroft39667782009-01-15 13:51:06 -08005180# if should not continue a brace
5181 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005182 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07005183 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08005184 $herecurr);
5185 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005186# case and default should not have general statements after them
5187 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
5188 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07005189 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005190 \s*return\s+
5191 )/xg)
5192 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005193 ERROR("TRAILING_STATEMENTS",
5194 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07005195 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005196
5197 # Check for }<nl>else {, these must be at the same
5198 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07005199 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
5200 $previndent == $indent) {
5201 if (ERROR("ELSE_AFTER_BRACE",
5202 "else should follow close brace '}'\n" . $hereprev) &&
5203 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5204 fix_delete_line($fixlinenr - 1, $prevrawline);
5205 fix_delete_line($fixlinenr, $rawline);
5206 my $fixedline = $prevrawline;
5207 $fixedline =~ s/}\s*$//;
5208 if ($fixedline !~ /^\+\s*$/) {
5209 fix_insert_line($fixlinenr, $fixedline);
5210 }
5211 $fixedline = $rawline;
5212 $fixedline =~ s/^(.\s*)else/$1} else/;
5213 fix_insert_line($fixlinenr, $fixedline);
5214 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005215 }
5216
Joe Perches8b8856f2014-08-06 16:11:14 -07005217 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5218 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005219 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5220
5221 # Find out what is on the end of the line after the
5222 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005223 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005224 $s =~ s/\n.*//g;
5225
5226 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005227 if (ERROR("WHILE_AFTER_BRACE",
5228 "while should follow close brace '}'\n" . $hereprev) &&
5229 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5230 fix_delete_line($fixlinenr - 1, $prevrawline);
5231 fix_delete_line($fixlinenr, $rawline);
5232 my $fixedline = $prevrawline;
5233 my $trailing = $rawline;
5234 $trailing =~ s/^\+//;
5235 $trailing = trim($trailing);
5236 $fixedline =~ s/}\s*$/} $trailing/;
5237 fix_insert_line($fixlinenr, $fixedline);
5238 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005239 }
5240 }
5241
Joe Perches95e2c602013-07-03 15:05:20 -07005242#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005243 while ($line =~ m{($Constant|$Lval)}g) {
5244 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005245
Joe Perches95e2c602013-07-03 15:05:20 -07005246#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005247 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005248 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005249#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005250 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perchesd439e6a2019-12-04 16:52:06 -08005251#Ignore SI style variants like nS, mV and dB
5252#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5253 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ &&
Julius Wernerf5123572014-12-10 15:51:54 -08005254#Ignore some three character SI units explicitly, like MiB and KHz
5255 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005256 while ($var =~ m{($Ident)}g) {
5257 my $word = $1;
5258 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005259 if ($check) {
5260 seed_camelcase_includes();
5261 if (!$file && !$camelcase_file_seeded) {
5262 seed_camelcase_file($realfile);
5263 $camelcase_file_seeded = 1;
5264 }
5265 }
Joe Perches7e781f62013-09-11 14:23:55 -07005266 if (!defined $camelcase{$word}) {
5267 $camelcase{$word} = 1;
5268 CHK("CAMELCASE",
5269 "Avoid CamelCase: <$word>\n" . $herecurr);
5270 }
Joe Perches34456862013-07-03 15:05:34 -07005271 }
Joe Perches323c1262012-12-17 16:02:07 -08005272 }
5273 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005274
5275#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005276 if ($line =~ /\#\s*define.*\\\s+$/) {
5277 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5278 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5279 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005280 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005281 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005282 }
5283
Fabian Frederick0e212e02015-04-16 12:44:25 -07005284# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5285# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005286 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005287 my $file = "$1.h";
5288 my $checkfile = "include/linux/$file";
5289 if (-f "$root/$checkfile" &&
5290 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005291 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005292 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005293 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5294 if ($asminclude > 0) {
5295 if ($realfile =~ m{^arch/}) {
5296 CHK("ARCH_INCLUDE_LINUX",
5297 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5298 } else {
5299 WARN("INCLUDE_LINUX",
5300 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5301 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005302 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005303 }
5304 }
5305
Andy Whitcroft653d4872007-06-23 17:16:34 -07005306# multi-statement macros should be enclosed in a do while loop, grab the
5307# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005308# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07005309 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5310 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005311 my $ln = $linenr;
5312 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005313 my ($off, $dstat, $dcond, $rest);
5314 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005315 my $has_flow_statement = 0;
5316 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005317 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005318 ctx_statement_block($linenr, $realcnt, 0);
5319 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005320 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005321 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005322
Joe Perches08a28432014-10-13 15:51:55 -07005323 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005324 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005325
Joe Perchesf59b64b2016-10-11 13:52:08 -07005326 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5327 my $define_args = $1;
5328 my $define_stmt = $dstat;
5329 my @def_args = ();
5330
5331 if (defined $define_args && $define_args ne "") {
5332 $define_args = substr($define_args, 1, length($define_args) - 2);
5333 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005334 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005335 @def_args = split(",", $define_args);
5336 }
5337
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005338 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005339 $dstat =~ s/\\\n.//g;
5340 $dstat =~ s/^\s*//s;
5341 $dstat =~ s/\s*$//s;
5342
5343 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005344 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5345 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005346 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005347 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005348 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005349
Antonio Borneo342d3d22020-04-06 20:11:01 -07005350 # Flatten any obvious string concatenation.
Joe Perches33acb542015-06-25 15:02:54 -07005351 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5352 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005353 {
5354 }
5355
Joe Perches42e15292016-03-15 14:58:01 -07005356 # Make asm volatile uses seem like a generic function
5357 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5358
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005359 my $exceptions = qr{
5360 $Declare|
5361 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005362 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005363 DECLARE_PER_CPU|
5364 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005365 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005366 union|
5367 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005368 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005369 ^\"|\"$|
5370 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005371 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005372 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005373
5374 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005375 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005376 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005377
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005378 if ($dstat ne '' &&
5379 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5380 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005381 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005382 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005383 $dstat !~ /$exceptions/ &&
5384 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005385 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005386 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005387 $dstat !~ /^for\s*$Constant$/ && # for (...)
5388 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5389 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005390 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005391 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005392 {
Joe Perchese7955562017-05-08 15:55:48 -07005393 if ($dstat =~ /^\s*if\b/) {
5394 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5395 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5396 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005397 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5398 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5399 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005400 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005401 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005402 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005403
5404 }
Joe Perches52076492016-10-11 13:52:14 -07005405
5406 # Make $define_stmt single line, comment-free, etc
5407 my @stmt_array = split('\n', $define_stmt);
5408 my $first = 1;
5409 $define_stmt = "";
5410 foreach my $l (@stmt_array) {
5411 $l =~ s/\\$//;
5412 if ($first) {
5413 $define_stmt = $l;
5414 $first = 0;
5415 } elsif ($l =~ /^[\+ ]/) {
5416 $define_stmt .= substr($l, 1);
5417 }
5418 }
5419 $define_stmt =~ s/$;//g;
5420 $define_stmt =~ s/\s+/ /g;
5421 $define_stmt = trim($define_stmt);
5422
Joe Perchesf59b64b2016-10-11 13:52:08 -07005423# check if any macro arguments are reused (ignore '...' and 'type')
5424 foreach my $arg (@def_args) {
5425 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005426 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005427 my $tmp_stmt = $define_stmt;
Brendan Jackman6dba8242019-09-25 16:46:41 -07005428 $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 -07005429 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5430 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005431 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005432 if ($use_cnt > 1) {
5433 CHK("MACRO_ARG_REUSE",
5434 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005435 }
5436# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005437 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005438 ((defined($1) && $1 ne ',') ||
5439 (defined($2) && $2 ne ','))) {
5440 CHK("MACRO_ARG_PRECEDENCE",
5441 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005442 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005443 }
Joe Perches5023d342012-12-17 16:01:47 -08005444
Joe Perches08a28432014-10-13 15:51:55 -07005445# check for macros with flow control, but without ## concatenation
5446# ## concatenation is commonly a macro that defines a function so ignore those
5447 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005448 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005449 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005450
Joe Perches08a28432014-10-13 15:51:55 -07005451 WARN("MACRO_WITH_FLOW_CONTROL",
5452 "Macros with flow control statements should be avoided\n" . "$herectx");
5453 }
5454
Joe Perches481eb482012-12-17 16:01:56 -08005455# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005456
5457 } else {
5458 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005459 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5460 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005461 $line =~ /^\+.*\\$/) {
5462 WARN("LINE_CONTINUATIONS",
5463 "Avoid unnecessary line continuations\n" . $herecurr);
5464 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005465 }
5466
Joe Perchesb13edf72012-07-30 14:41:24 -07005467# do {} while (0) macro tests:
5468# single-statement macros do not need to be enclosed in do while (0) loop,
5469# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005470 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005471 $realfile !~ m@/vmlinux.lds.h$@ &&
5472 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5473 my $ln = $linenr;
5474 my $cnt = $realcnt;
5475 my ($off, $dstat, $dcond, $rest);
5476 my $ctx = '';
5477 ($dstat, $dcond, $ln, $cnt, $off) =
5478 ctx_statement_block($linenr, $realcnt, 0);
5479 $ctx = $dstat;
5480
5481 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005482 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005483
5484 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5485 my $stmts = $2;
5486 my $semis = $3;
5487
5488 $ctx =~ s/\n*$//;
5489 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005490 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005491
Joe Perchesac8e97f2012-08-21 16:15:53 -07005492 if (($stmts =~ tr/;/;/) == 1 &&
5493 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005494 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5495 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5496 }
5497 if (defined $semis && $semis ne "") {
5498 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5499 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5500 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005501 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5502 $ctx =~ s/\n*$//;
5503 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005504 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005505
5506 WARN("TRAILING_SEMICOLON",
5507 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005508 }
5509 }
5510
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005511# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005512 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5513 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005514 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005515 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005516 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5517 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005518 my @allowed = ();
5519 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005520 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005521 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005522 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005523 for my $chunk (@chunks) {
5524 my ($cond, $block) = @{$chunk};
5525
Andy Whitcroft773647a2008-03-28 14:15:58 -07005526 # If the condition carries leading newlines, then count those as offsets.
5527 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5528 my $offset = statement_rawlines($whitespace) - 1;
5529
Joe Perchesaad4f612012-03-23 15:02:19 -07005530 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005531 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5532
5533 # We have looked at and allowed this specific line.
5534 $suppress_ifbraces{$ln + $offset} = 1;
5535
5536 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005537 $ln += statement_rawlines($block) - 1;
5538
Andy Whitcroft773647a2008-03-28 14:15:58 -07005539 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005540
5541 $seen++ if ($block =~ /^\s*{/);
5542
Joe Perchesaad4f612012-03-23 15:02:19 -07005543 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005544 if (statement_lines($cond) > 1) {
5545 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005546 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005547 }
5548 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005549 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005550 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005551 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005552 if (statement_block_size($block) > 1) {
5553 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005554 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005555 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005556 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005557 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005558 if ($seen) {
5559 my $sum_allowed = 0;
5560 foreach (@allowed) {
5561 $sum_allowed += $_;
5562 }
5563 if ($sum_allowed == 0) {
5564 WARN("BRACES",
5565 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5566 } elsif ($sum_allowed != $allow &&
5567 $seen != $allow) {
5568 CHK("BRACES",
5569 "braces {} should be used on all arms of this statement\n" . $herectx);
5570 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005571 }
5572 }
5573 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005574 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005575 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005576 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005577
Andy Whitcroftcf655042008-03-04 14:28:20 -08005578 # Check the pre-context.
5579 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5580 #print "APW: ALLOWED: pre<$1>\n";
5581 $allowed = 1;
5582 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005583
5584 my ($level, $endln, @chunks) =
5585 ctx_statement_full($linenr, $realcnt, $-[0]);
5586
Andy Whitcroftcf655042008-03-04 14:28:20 -08005587 # Check the condition.
5588 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005589 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005590 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005591 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005592 }
5593 if (statement_lines($cond) > 1) {
5594 #print "APW: ALLOWED: cond<$cond>\n";
5595 $allowed = 1;
5596 }
5597 if ($block =~/\b(?:if|for|while)\b/) {
5598 #print "APW: ALLOWED: block<$block>\n";
5599 $allowed = 1;
5600 }
5601 if (statement_block_size($block) > 1) {
5602 #print "APW: ALLOWED: lines block<$block>\n";
5603 $allowed = 1;
5604 }
5605 # Check the post-context.
5606 if (defined $chunks[1]) {
5607 my ($cond, $block) = @{$chunks[1]};
5608 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005609 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005610 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005611 if ($block =~ /^\s*\{/) {
5612 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5613 $allowed = 1;
5614 }
5615 }
5616 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005617 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005618 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005619
Joe Perches000d1cc12011-07-25 17:13:25 -07005620 WARN("BRACES",
5621 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005622 }
5623 }
5624
Joe Perchese4c5bab2017-02-24 15:01:41 -08005625# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005626 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5627 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005628 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5629 }
5630
Joe Perches0979ae62012-12-17 16:01:59 -08005631# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005632 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005633 if (CHK("BRACES",
5634 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5635 $fix && $prevrawline =~ /^\+/) {
5636 fix_delete_line($fixlinenr - 1, $prevrawline);
5637 }
Joe Perches0979ae62012-12-17 16:01:59 -08005638 }
Joe Perches77b9a532013-07-03 15:05:29 -07005639 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005640 if (CHK("BRACES",
5641 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5642 $fix) {
5643 fix_delete_line($fixlinenr, $rawline);
5644 }
Joe Perches0979ae62012-12-17 16:01:59 -08005645 }
5646
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005647# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005648 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5649 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005650 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005651 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005652 }
5653
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005654# Check for user-visible strings broken across lines, which breaks the ability
5655# to grep for the string. Make exceptions when the previous string ends in a
5656# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5657# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005658 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005659 $prevline =~ /"\s*$/ &&
5660 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5661 if (WARN("SPLIT_STRING",
5662 "quoted string split across lines\n" . $hereprev) &&
5663 $fix &&
5664 $prevrawline =~ /^\+.*"\s*$/ &&
5665 $last_coalesced_string_linenr != $linenr - 1) {
5666 my $extracted_string = get_quoted_string($line, $rawline);
5667 my $comma_close = "";
5668 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5669 $comma_close = $1;
5670 }
5671
5672 fix_delete_line($fixlinenr - 1, $prevrawline);
5673 fix_delete_line($fixlinenr, $rawline);
5674 my $fixedline = $prevrawline;
5675 $fixedline =~ s/"\s*$//;
5676 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5677 fix_insert_line($fixlinenr - 1, $fixedline);
5678 $fixedline = $rawline;
5679 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5680 if ($fixedline !~ /\+\s*$/) {
5681 fix_insert_line($fixlinenr, $fixedline);
5682 }
5683 $last_coalesced_string_linenr = $linenr;
5684 }
5685 }
5686
5687# check for missing a space in a string concatenation
5688 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5689 WARN('MISSING_SPACE',
5690 "break quoted strings at a space character\n" . $hereprev);
5691 }
5692
Joe Perchese4b7d302017-05-08 15:55:51 -07005693# check for an embedded function name in a string when the function is known
5694# This does not work very well for -f --file checking as it depends on patch
5695# context providing the function name or a single line form for in-file
5696# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005697 if ($line =~ /^\+.*$String/ &&
5698 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005699 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5700 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005701 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005702 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005703 }
5704
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005705# check for spaces before a quoted newline
5706 if ($rawline =~ /^.*\".*\s\\n/) {
5707 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5708 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5709 $fix) {
5710 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5711 }
5712
5713 }
5714
Joe Perchesf17dba42014-10-13 15:51:51 -07005715# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005716 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5717 if (CHK("CONCATENATED_STRING",
5718 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5719 $fix) {
5720 while ($line =~ /($String)/g) {
5721 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5722 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5723 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5724 }
5725 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005726 }
5727
Joe Perches90ad30e2014-12-10 15:51:59 -08005728# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005729 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005730 if (WARN("STRING_FRAGMENTS",
5731 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5732 $fix) {
5733 while ($line =~ /($String)(?=\s*")/g) {
5734 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5735 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5736 }
5737 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005738 }
5739
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005740# check for non-standard and hex prefixed decimal printf formats
5741 my $show_L = 1; #don't show the same defect twice
5742 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005743 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005744 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005745 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005746 # check for %L
5747 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005748 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005749 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5750 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005751 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005752 # check for %Z
5753 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5754 WARN("PRINTF_Z",
5755 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5756 $show_Z = 0;
5757 }
5758 # check for 0x<decimal>
5759 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5760 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005761 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5762 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005763 }
5764
5765# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005766 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005767 WARN("LINE_CONTINUATIONS",
5768 "Avoid line continuations in quoted strings\n" . $herecurr);
5769 }
5770
Andy Whitcroft00df3442007-06-08 13:47:06 -07005771# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005772 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07005773 WARN("IF_0",
5774 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5775 }
5776
5777# warn about #if 1
5778 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5779 WARN("IF_1",
5780 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005781 }
5782
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005783# check for needless "if (<foo>) fn(<foo>)" uses
5784 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005785 my $tested = quotemeta($1);
5786 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5787 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5788 my $func = $1;
5789 if (WARN('NEEDLESS_IF',
5790 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5791 $fix) {
5792 my $do_fix = 1;
5793 my $leading_tabs = "";
5794 my $new_leading_tabs = "";
5795 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5796 $leading_tabs = $1;
5797 } else {
5798 $do_fix = 0;
5799 }
5800 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5801 $new_leading_tabs = $1;
5802 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5803 $do_fix = 0;
5804 }
5805 } else {
5806 $do_fix = 0;
5807 }
5808 if ($do_fix) {
5809 fix_delete_line($fixlinenr - 1, $prevrawline);
5810 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5811 }
5812 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005813 }
5814 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005815
Joe Perchesebfdc402014-08-06 16:10:27 -07005816# check for unnecessary "Out of Memory" messages
5817 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5818 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5819 (defined $1 || defined $3) &&
5820 $linenr > 3) {
5821 my $testval = $2;
5822 my $testline = $lines[$linenr - 3];
5823
5824 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5825# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5826
Joe Perchese29a70f2019-03-07 16:28:35 -08005827 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5828 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005829 WARN("OOM_MESSAGE",
5830 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5831 }
5832 }
5833
Joe Perchesf78d98f2014-10-13 15:52:01 -07005834# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005835 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005836 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5837 my $level = $1;
5838 if (WARN("UNNECESSARY_KERN_LEVEL",
5839 "Possible unnecessary $level\n" . $herecurr) &&
5840 $fix) {
5841 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5842 }
5843 }
5844
Joe Perches45c55e92017-02-24 15:01:31 -08005845# check for logging continuations
5846 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5847 WARN("LOGGING_CONTINUATION",
5848 "Avoid logging continuation uses where feasible\n" . $herecurr);
5849 }
5850
Joe Perchesabb08a52014-12-10 15:51:46 -08005851# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07005852 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08005853 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5854 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5855 WARN("MASK_THEN_SHIFT",
5856 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5857 }
5858
Joe Perchesb75ac612014-12-10 15:52:02 -08005859# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07005860 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08005861 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5862 my $val = $1;
5863 my $equal = "!";
5864 $equal = "" if ($4 eq "!=");
5865 if (CHK("COMPARISON_TO_NULL",
5866 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5867 $fix) {
5868 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5869 }
5870 }
5871 }
5872
Joe Perches8716de32013-09-11 14:24:05 -07005873# check for bad placement of section $InitAttribute (e.g.: __initdata)
5874 if ($line =~ /(\b$InitAttribute\b)/) {
5875 my $attr = $1;
5876 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5877 my $ptr = $1;
5878 my $var = $2;
5879 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5880 ERROR("MISPLACED_INIT",
5881 "$attr should be placed after $var\n" . $herecurr)) ||
5882 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5883 WARN("MISPLACED_INIT",
5884 "$attr should be placed after $var\n" . $herecurr))) &&
5885 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005886 $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 -07005887 }
5888 }
5889 }
5890
Joe Perchese970b8842013-11-12 15:10:10 -08005891# check for $InitAttributeData (ie: __initdata) with const
5892 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5893 my $attr = $1;
5894 $attr =~ /($InitAttributePrefix)(.*)/;
5895 my $attr_prefix = $1;
5896 my $attr_type = $2;
5897 if (ERROR("INIT_ATTRIBUTE",
5898 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5899 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005900 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005901 s/$InitAttributeData/${attr_prefix}initconst/;
5902 }
5903 }
5904
5905# check for $InitAttributeConst (ie: __initconst) without const
5906 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5907 my $attr = $1;
5908 if (ERROR("INIT_ATTRIBUTE",
5909 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5910 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005911 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005912 /(^\+\s*(?:static\s+))/;
5913 $lead = rtrim($1);
5914 $lead = "$lead " if ($lead !~ /^\+$/);
5915 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005916 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005917 }
5918 }
5919
Joe Perchesc17893c2015-04-16 12:44:42 -07005920# check for __read_mostly with const non-pointer (should just be const)
5921 if ($line =~ /\b__read_mostly\b/ &&
5922 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5923 if (ERROR("CONST_READ_MOSTLY",
5924 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5925 $fix) {
5926 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5927 }
5928 }
5929
Joe Perchesfbdb8132014-04-03 14:49:14 -07005930# don't use __constant_<foo> functions outside of include/uapi/
5931 if ($realfile !~ m@^include/uapi/@ &&
5932 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5933 my $constant_func = $1;
5934 my $func = $constant_func;
5935 $func =~ s/^__constant_//;
5936 if (WARN("CONSTANT_CONVERSION",
5937 "$constant_func should be $func\n" . $herecurr) &&
5938 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005939 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005940 }
5941 }
5942
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005943# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005944 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005945 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005946 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005947 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005948 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005949 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07005950 }
5951 if ($delay > 2000) {
5952 WARN("LONG_UDELAY",
5953 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005954 }
5955 }
5956
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005957# warn about unexpectedly long msleep's
5958 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5959 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005960 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005961 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005962 }
5963 }
5964
Joe Perches36ec1932013-07-03 15:05:25 -07005965# check for comparisons of jiffies
5966 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5967 WARN("JIFFIES_COMPARISON",
5968 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5969 }
5970
Joe Perches9d7a34a2013-07-03 15:05:26 -07005971# check for comparisons of get_jiffies_64()
5972 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5973 WARN("JIFFIES_COMPARISON",
5974 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5975 }
5976
Andy Whitcroft00df3442007-06-08 13:47:06 -07005977# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005978# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005979# print "#ifdef in C files should be avoided\n";
5980# print "$herecurr";
5981# $clean = 0;
5982# }
5983
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005984# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005985 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005986 if (ERROR("SPACING",
5987 "exactly one space required after that #$1\n" . $herecurr) &&
5988 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005989 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005990 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5991 }
5992
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005993 }
5994
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005995# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005996 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5997 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005998 my $which = $1;
5999 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006000 CHK("UNCOMMENTED_DEFINITION",
6001 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006002 }
6003 }
6004# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006005
6006 my $barriers = qr{
6007 mb|
6008 rmb|
Will Deaconad83ec62019-11-07 14:49:00 +00006009 wmb
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006010 }x;
6011 my $barrier_stems = qr{
6012 mb__before_atomic|
6013 mb__after_atomic|
6014 store_release|
6015 load_acquire|
6016 store_mb|
6017 (?:$barriers)
6018 }x;
6019 my $all_barriers = qr{
6020 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02006021 smp_(?:$barrier_stems)|
6022 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02006023 }x;
6024
6025 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006026 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08006027 WARN("MEMORY_BARRIER",
6028 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006029 }
6030 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006031
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02006032 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
6033
6034 if ($realfile !~ m@^include/asm-generic/@ &&
6035 $realfile !~ m@/barrier\.h$@ &&
6036 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
6037 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
6038 WARN("MEMORY_BARRIER",
6039 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
6040 }
6041
Joe Perchescb426e92015-06-25 15:02:46 -07006042# check for waitqueue_active without a comment.
6043 if ($line =~ /\bwaitqueue_active\s*\(/) {
6044 if (!ctx_has_comment($first_line, $linenr)) {
6045 WARN("WAITQUEUE_ACTIVE",
6046 "waitqueue_active without comment\n" . $herecurr);
6047 }
6048 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07006049
Marco Elver5099a722020-04-01 12:17:14 +02006050# check for data_race without a comment.
6051 if ($line =~ /\bdata_race\s*\(/) {
6052 if (!ctx_has_comment($first_line, $linenr)) {
6053 WARN("DATA_RACE",
6054 "data_race without comment\n" . $herecurr);
6055 }
6056 }
6057
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07006058# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006059 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006060 CHK("ARCH_DEFINES",
6061 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006062 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006063
Joe Perches596ed452017-07-12 14:37:02 -07006064# check that the storage class is not after a type
6065 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006066 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07006067 "storage class '$2' should be located before type '$1'\n" . $herecurr);
6068 }
6069# Check that the storage class is at the beginning of a declaration
6070 if ($line =~ /\b$Storage\b/ &&
6071 $line !~ /^.\s*$Storage/ &&
6072 $line =~ /^.\s*(.+?)\$Storage\s/ &&
6073 $1 !~ /[\,\)]\s*$/) {
6074 WARN("STORAGE_CLASS",
6075 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07006076 }
6077
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006078# check the location of the inline attribute, that it is between
6079# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006080 if ($line =~ /\b$Type\s+$Inline\b/ ||
6081 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006082 ERROR("INLINE_LOCATION",
6083 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006084 }
6085
Andy Whitcroft8905a672007-11-28 16:21:06 -08006086# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08006087 if ($realfile !~ m@\binclude/uapi/@ &&
6088 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006089 if (WARN("INLINE",
6090 "plain inline is preferred over $1\n" . $herecurr) &&
6091 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006092 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006093
6094 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006095 }
6096
Joe Perches3d130fd2011-01-12 17:00:00 -08006097# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08006098 if ($realfile !~ m@\binclude/uapi/@ &&
6099 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006100 WARN("PREFER_PACKED",
6101 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08006102 }
6103
Joe Perches39b7e282011-07-25 17:13:24 -07006104# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08006105 if ($realfile !~ m@\binclude/uapi/@ &&
6106 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006107 WARN("PREFER_ALIGNED",
6108 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07006109 }
6110
Joe Perches462811d2019-09-25 16:46:44 -07006111# Check for __attribute__ section, prefer __section
6112 if ($realfile !~ m@\binclude/uapi/@ &&
6113 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
6114 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
6115 my $new = substr($old, 1, -1);
6116 if (WARN("PREFER_SECTION",
6117 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
6118 $fix) {
6119 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6120 }
6121 }
6122
Joe Perches5f14d3b2012-01-10 15:09:52 -08006123# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08006124 if ($realfile !~ m@\binclude/uapi/@ &&
6125 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006126 if (WARN("PREFER_PRINTF",
6127 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6128 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006129 $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 -07006130
6131 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08006132 }
6133
Joe Perches6061d942012-03-23 15:02:16 -07006134# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08006135 if ($realfile !~ m@\binclude/uapi/@ &&
6136 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006137 if (WARN("PREFER_SCANF",
6138 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6139 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006140 $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 -07006141 }
Joe Perches6061d942012-03-23 15:02:16 -07006142 }
6143
Joe Perches619a9082014-12-10 15:51:35 -08006144# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07006145 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08006146 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6147 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
6148 $line =~ /\b__weak\b/)) {
6149 ERROR("WEAK_DECLARATION",
6150 "Using weak declarations can have unintended link defects\n" . $herecurr);
6151 }
6152
Tomas Winklerfd39f902016-12-12 16:46:34 -08006153# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07006154 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08006155 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07006156 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
6157 my $type = $1;
6158 if ($type =~ /\b($typeC99Typedefs)\b/) {
6159 $type = $1;
6160 my $kernel_type = 'u';
6161 $kernel_type = 's' if ($type =~ /^_*[si]/);
6162 $type =~ /(\d+)/;
6163 $kernel_type .= $1;
6164 if (CHK("PREFER_KERNEL_TYPES",
6165 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
6166 $fix) {
6167 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
6168 }
6169 }
6170 }
6171
Joe Perches938224b2016-01-20 14:59:15 -08006172# check for cast of C90 native int or longer types constants
6173 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
6174 my $cast = $1;
6175 my $const = $2;
6176 if (WARN("TYPECAST_INT_CONSTANT",
6177 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
6178 $fix) {
6179 my $suffix = "";
6180 my $newconst = $const;
6181 $newconst =~ s/${Int_type}$//;
6182 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
6183 if ($cast =~ /\blong\s+long\b/) {
6184 $suffix .= 'LL';
6185 } elsif ($cast =~ /\blong\b/) {
6186 $suffix .= 'L';
6187 }
6188 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
6189 }
6190 }
6191
Joe Perches8f53a9b2010-03-05 13:43:48 -08006192# check for sizeof(&)
6193 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006194 WARN("SIZEOF_ADDRESS",
6195 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08006196 }
6197
Joe Perches66c80b62012-07-30 14:41:22 -07006198# check for sizeof without parenthesis
6199 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006200 if (WARN("SIZEOF_PARENTHESIS",
6201 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
6202 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006203 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006204 }
Joe Perches66c80b62012-07-30 14:41:22 -07006205 }
6206
Joe Perches88982fe2012-12-17 16:02:00 -08006207# check for struct spinlock declarations
6208 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
6209 WARN("USE_SPINLOCK_T",
6210 "struct spinlock should be spinlock_t\n" . $herecurr);
6211 }
6212
Joe Perchesa6962d72013-04-29 16:18:13 -07006213# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006214 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006215 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006216 $fmt =~ s/%%//g;
6217 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006218 if (WARN("PREFER_SEQ_PUTS",
6219 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6220 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006221 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006222 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006223 }
6224 }
6225
Joe Perches478b1792018-04-10 16:33:34 -07006226# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006227 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006228 defined $stat &&
6229 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6230 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006231 my $stat_real;
6232
Joe Perches0b523762017-05-08 15:55:36 -07006233 my $lc = $stat =~ tr@\n@@;
6234 $lc = $lc + $linenr;
6235 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006236 my $specifier;
6237 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006238 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006239 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006240 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6241 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006242
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006243 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006244 $specifier = $1;
6245 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006246 $qualifier = $3;
Linus Torvalds361b0d22019-11-26 19:45:12 -08006247 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006248 ($extension eq "f" &&
6249 defined $qualifier && $qualifier !~ /^w/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006250 $bad_specifier = $specifier;
6251 last;
6252 }
6253 if ($extension eq "x" && !defined($stat_real)) {
6254 if (!defined($stat_real)) {
6255 $stat_real = get_stat_real($linenr, $lc);
6256 }
6257 WARN("VSPRINTF_SPECIFIER_PX",
6258 "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");
6259 }
6260 }
6261 if ($bad_specifier ne "") {
6262 my $stat_real = get_stat_real($linenr, $lc);
6263 my $ext_type = "Invalid";
6264 my $use = "";
6265 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006266 $use = " - use %pS instead";
6267 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6268 }
6269
6270 WARN("VSPRINTF_POINTER_EXTENSION",
6271 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6272 }
Joe Perches0b523762017-05-08 15:55:36 -07006273 }
6274 }
6275
Andy Whitcroft554e1652012-01-10 15:09:57 -08006276# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006277 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006278 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006279 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006280
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006281 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006282 my $ms_val = $7;
6283 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006284
Andy Whitcroft554e1652012-01-10 15:09:57 -08006285 if ($ms_size =~ /^(0x|)0$/i) {
6286 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006287 "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 -08006288 } elsif ($ms_size =~ /^(0x|)1$/i) {
6289 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006290 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6291 }
6292 }
6293
Joe Perches98a9bba2014-01-23 15:54:52 -08006294# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006295# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006296# defined $stat &&
6297# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6298# if (WARN("PREFER_ETHER_ADDR_COPY",
6299# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6300# $fix) {
6301# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6302# }
6303# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006304
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006305# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006306# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006307# defined $stat &&
6308# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6309# WARN("PREFER_ETHER_ADDR_EQUAL",
6310# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6311# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006312
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006313# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6314# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006315# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006316# defined $stat &&
6317# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6318#
6319# my $ms_val = $7;
6320#
6321# if ($ms_val =~ /^(?:0x|)0+$/i) {
6322# if (WARN("PREFER_ETH_ZERO_ADDR",
6323# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6324# $fix) {
6325# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6326# }
6327# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6328# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6329# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6330# $fix) {
6331# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6332# }
6333# }
6334# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006335
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006336# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006337 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006338 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006339 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006340 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006341 my $call = $1;
6342 my $cast1 = deparenthesize($2);
6343 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006344 my $cast2 = deparenthesize($7);
6345 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006346 my $cast;
6347
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006348 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006349 $cast = "$cast1 or $cast2";
6350 } elsif ($cast1 ne "") {
6351 $cast = $cast1;
6352 } else {
6353 $cast = $cast2;
6354 }
6355 WARN("MINMAX",
6356 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006357 }
6358 }
6359
Joe Perches4a273192012-07-30 14:41:20 -07006360# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006361 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006362 defined $stat &&
6363 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6364 my $min = $1;
6365 my $max = $7;
6366 if ($min eq $max) {
6367 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006368 "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 -07006369 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6370 $min > $max) {
6371 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006372 "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 -07006373 }
6374 }
6375
Joe Perches823b7942013-11-12 15:10:15 -08006376# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006377 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006378 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006379 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006380 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6381 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6382 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6383 my $lc = $stat =~ tr@\n@@;
6384 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006385 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006386 WARN("NAKED_SSCANF",
6387 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6388 }
6389
Joe Perchesafc819a2014-06-04 16:12:08 -07006390# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006391 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006392 defined $stat &&
6393 $line =~ /\bsscanf\b/) {
6394 my $lc = $stat =~ tr@\n@@;
6395 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006396 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006397 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6398 my $format = $6;
6399 my $count = $format =~ tr@%@%@;
6400 if ($count == 1 &&
6401 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6402 WARN("SSCANF_TO_KSTRTO",
6403 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6404 }
6405 }
6406 }
6407
Joe Perches70dc8a42013-09-11 14:23:58 -07006408# check for new externs in .h files.
6409 if ($realfile =~ /\.h$/ &&
6410 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006411 if (CHK("AVOID_EXTERNS",
6412 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006413 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006414 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006415 }
6416 }
6417
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006418# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006419 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006420 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006421 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006422 my $function_name = $1;
6423 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006424
6425 my $s = $stat;
6426 if (defined $cond) {
6427 substr($s, 0, length($cond), '');
6428 }
Kees Cookd8b44b52020-06-03 14:18:09 -07006429 if ($s =~ /^\s*;/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006430 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006431 WARN("AVOID_EXTERNS",
6432 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006433 }
6434
6435 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006436 WARN("FUNCTION_ARGUMENTS",
6437 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006438 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006439
6440 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6441 $stat =~ /^.\s*extern\s+/)
6442 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006443 WARN("AVOID_EXTERNS",
6444 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006445 }
6446
Joe Perchesa0ad7592017-07-10 15:52:19 -07006447# check for function declarations that have arguments without identifier names
6448 if (defined $stat &&
Kees Cookd8b44b52020-06-03 14:18:09 -07006449 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6450 $1 ne "void") {
6451 my $args = trim($1);
Joe Perchesca0d8922016-10-11 13:52:16 -07006452 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6453 my $arg = trim($1);
Kees Cookd8b44b52020-06-03 14:18:09 -07006454 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
Joe Perchesca0d8922016-10-11 13:52:16 -07006455 WARN("FUNCTION_ARGUMENTS",
6456 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6457 }
6458 }
6459 }
6460
Joe Perchesa0ad7592017-07-10 15:52:19 -07006461# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006462 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006463 defined $stat &&
6464 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6465 $context_function = $1;
6466
6467# check for multiline function definition with misplaced open brace
6468 my $ok = 0;
6469 my $cnt = statement_rawlines($stat);
6470 my $herectx = $here . "\n";
6471 for (my $n = 0; $n < $cnt; $n++) {
6472 my $rl = raw_line($linenr, $n);
6473 $herectx .= $rl . "\n";
6474 $ok = 1 if ($rl =~ /^[ \+]\{/);
6475 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6476 last if $rl =~ /^[ \+].*\{/;
6477 }
6478 if (!$ok) {
6479 ERROR("OPEN_BRACE",
6480 "open brace '{' following function definitions go on the next line\n" . $herectx);
6481 }
6482 }
6483
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006484# checks for new __setup's
6485 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6486 my $name = $1;
6487
6488 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006489 CHK("UNDOCUMENTED_SETUP",
Tim Froidcoeur2581ac72020-06-10 18:41:38 -07006490 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006491 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006492 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006493
Joe Perchese29a70f2019-03-07 16:28:35 -08006494# check for pointless casting of alloc functions
6495 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006496 WARN("UNNECESSARY_CASTS",
6497 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006498 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006499
Joe Perchesa640d252013-07-03 15:05:21 -07006500# alloc style
6501# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006502 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006503 $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 -07006504 CHK("ALLOC_SIZEOF_STRUCT",
6505 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6506 }
6507
Joe Perches60a55362014-06-04 16:12:07 -07006508# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006509 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006510 defined $stat &&
6511 $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 -07006512 my $oldfunc = $3;
6513 my $a1 = $4;
6514 my $a2 = $10;
6515 my $newfunc = "kmalloc_array";
6516 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006517 my $r1 = $a1;
6518 my $r2 = $a2;
6519 if ($a1 =~ /^sizeof\s*\S/) {
6520 $r1 = $a2;
6521 $r2 = $a1;
6522 }
6523 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6524 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006525 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006526 my $herectx = get_stat_here($linenr, $cnt, $here);
6527
Joe Perches60a55362014-06-04 16:12:07 -07006528 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006529 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6530 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006531 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006532 $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 -07006533 }
6534 }
6535 }
6536
Joe Perches972fdea2013-04-29 16:18:12 -07006537# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006538 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006539 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6540 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006541 WARN("KREALLOC_ARG_REUSE",
6542 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6543 }
6544
Joe Perches5ce59ae2013-02-21 16:44:18 -08006545# check for alloc argument mismatch
6546 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6547 WARN("ALLOC_ARRAY_ARGS",
6548 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6549 }
6550
Joe Perchescaf2a542011-01-12 16:59:56 -08006551# check for multiple semicolons
6552 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006553 if (WARN("ONE_SEMICOLON",
6554 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6555 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006556 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006557 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006558 }
6559
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006560# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6561 if ($realfile !~ m@^include/uapi/@ &&
6562 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006563 my $ull = "";
6564 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6565 if (CHK("BIT_MACRO",
6566 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6567 $fix) {
6568 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6569 }
6570 }
6571
Joe Perches50161262020-08-11 18:35:07 -07006572# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006573 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) {
Joe Perches50161262020-08-11 18:35:07 -07006574 WARN("IS_ENABLED_CONFIG",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006575 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr);
Joe Perches50161262020-08-11 18:35:07 -07006576 }
6577
Joe Perches2d632742016-05-20 17:04:00 -07006578# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006579 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
Joe Perches2d632742016-05-20 17:04:00 -07006580 my $config = $1;
6581 if (WARN("PREFER_IS_ENABLED",
Jerome Forissier3e89ad82020-10-15 20:11:49 -07006582 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) &&
Joe Perches2d632742016-05-20 17:04:00 -07006583 $fix) {
6584 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6585 }
6586 }
6587
Joe Perchesf36d3eb2020-04-06 20:10:58 -07006588# check for /* fallthrough */ like comment, prefer fallthrough;
6589 my @fallthroughs = (
6590 'fallthrough',
6591 '@fallthrough@',
6592 'lint -fallthrough[ \t]*',
6593 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)',
6594 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?',
6595 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6596 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?',
6597 );
6598 if ($raw_comment ne '') {
6599 foreach my $ft (@fallthroughs) {
6600 if ($raw_comment =~ /$ft/) {
6601 my $msg_level = \&WARN;
6602 $msg_level = \&CHK if ($file);
6603 &{$msg_level}("PREFER_FALLTHROUGH",
6604 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr);
6605 last;
6606 }
6607 }
6608 }
6609
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006610# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006611 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006612 defined $stat &&
6613 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006614 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006615 my $herectx = get_stat_here($linenr, $cnt, $here);
6616
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006617 WARN("DEFAULT_NO_BREAK",
6618 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006619 }
6620
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006621# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006622 if ($line =~ /\b__FUNCTION__\b/) {
6623 if (WARN("USE_FUNC",
6624 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6625 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006626 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006627 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006628 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006629
Joe Perches62ec8182015-02-13 14:38:18 -08006630# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6631 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6632 ERROR("DATE_TIME",
6633 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6634 }
6635
Joe Perches2c924882012-03-23 15:02:20 -07006636# check for use of yield()
6637 if ($line =~ /\byield\s*\(\s*\)/) {
6638 WARN("YIELD",
6639 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6640 }
6641
Joe Perches179f8f42013-07-03 15:05:30 -07006642# check for comparisons against true and false
6643 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6644 my $lead = $1;
6645 my $arg = $2;
6646 my $test = $3;
6647 my $otype = $4;
6648 my $trail = $5;
6649 my $op = "!";
6650
6651 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6652
6653 my $type = lc($otype);
6654 if ($type =~ /^(?:true|false)$/) {
6655 if (("$test" eq "==" && "$type" eq "true") ||
6656 ("$test" eq "!=" && "$type" eq "false")) {
6657 $op = "";
6658 }
6659
6660 CHK("BOOL_COMPARISON",
6661 "Using comparison to $otype is error prone\n" . $herecurr);
6662
6663## maybe suggesting a correct construct would better
6664## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6665
6666 }
6667 }
6668
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006669# check for semaphores initialized locked
6670 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006671 WARN("CONSIDER_COMPLETION",
6672 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006673 }
Joe Perches6712d852012-03-23 15:02:20 -07006674
Joe Perches67d0a072011-10-31 17:13:10 -07006675# recommend kstrto* over simple_strto* and strict_strto*
6676 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006677 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006678 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006679 }
Joe Perches6712d852012-03-23 15:02:20 -07006680
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006681# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006682 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006683 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006684 "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 -07006685 }
Joe Perches6712d852012-03-23 15:02:20 -07006686
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006687# check for spin_is_locked(), suggest lockdep instead
6688 if ($line =~ /\bspin_is_locked\(/) {
6689 WARN("USE_LOCKDEP",
6690 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6691 }
6692
Joe Perches9189c7e2018-09-07 15:26:18 -07006693# check for deprecated apis
6694 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6695 my $deprecated_api = $1;
6696 my $new_api = $deprecated_apis{$deprecated_api};
6697 WARN("DEPRECATED_API",
6698 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6699 }
6700
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006701# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006702# and avoid what seem like struct definitions 'struct foo {'
Quentin Monnetced69da12020-08-11 18:35:13 -07006703 if (defined($const_structs) &&
6704 $line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006705 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006706 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006707 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006708 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006709
6710# use of NR_CPUS is usually wrong
6711# ignore definitions of NR_CPUS and usage to define arrays as likely right
6712 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006713 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6714 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006715 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6716 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6717 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006718 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006719 WARN("NR_CPUS",
6720 "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 -07006721 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006722
Joe Perches52ea8502013-11-12 15:10:09 -08006723# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6724 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6725 ERROR("DEFINE_ARCH_HAS",
6726 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6727 }
6728
Joe Perchesacd93622015-02-13 14:38:38 -08006729# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07006730 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08006731 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6732 WARN("LIKELY_MISUSE",
6733 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6734 }
6735
Denis Efremovde3f1862019-09-25 16:49:25 -07006736# nested likely/unlikely calls
6737 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6738 WARN("LIKELY_MISUSE",
6739 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6740 }
6741
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006742# whine mightly about in_atomic
6743 if ($line =~ /\bin_atomic\s*\(/) {
6744 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006745 ERROR("IN_ATOMIC",
6746 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006747 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006748 WARN("IN_ATOMIC",
6749 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006750 }
6751 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006752
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006753# check for mutex_trylock_recursive usage
6754 if ($line =~ /mutex_trylock_recursive/) {
6755 ERROR("LOCKING",
6756 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6757 }
6758
Peter Zijlstra1704f472010-03-19 01:37:42 +01006759# check for lockdep_set_novalidate_class
6760 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6761 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6762 if ($realfile !~ m@^kernel/lockdep@ &&
6763 $realfile !~ m@^include/linux/lockdep@ &&
6764 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006765 ERROR("LOCKDEP",
6766 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006767 }
6768 }
Dave Jones88f88312011-01-12 16:59:59 -08006769
Joe Perchesb392c642015-04-16 12:44:16 -07006770 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6771 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006772 WARN("EXPORTED_WORLD_WRITABLE",
6773 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006774 }
Joe Perches24358802014-04-03 14:49:13 -07006775
Joe Perches00180462018-02-06 15:38:55 -08006776# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6777# and whether or not function naming is typical and if
6778# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07006779 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08006780 defined $stat &&
6781 $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*\)/) {
6782 my $var = $1;
6783 my $perms = $2;
6784 my $show = $3;
6785 my $store = $4;
6786 my $octal_perms = perms_to_octal($perms);
6787 if ($show =~ /^${var}_show$/ &&
6788 $store =~ /^${var}_store$/ &&
6789 $octal_perms eq "0644") {
6790 if (WARN("DEVICE_ATTR_RW",
6791 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6792 $fix) {
6793 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6794 }
6795 } elsif ($show =~ /^${var}_show$/ &&
6796 $store =~ /^NULL$/ &&
6797 $octal_perms eq "0444") {
6798 if (WARN("DEVICE_ATTR_RO",
6799 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6800 $fix) {
6801 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6802 }
6803 } elsif ($show =~ /^NULL$/ &&
6804 $store =~ /^${var}_store$/ &&
6805 $octal_perms eq "0200") {
6806 if (WARN("DEVICE_ATTR_WO",
6807 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6808 $fix) {
6809 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6810 }
6811 } elsif ($octal_perms eq "0644" ||
6812 $octal_perms eq "0444" ||
6813 $octal_perms eq "0200") {
6814 my $newshow = "$show";
6815 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6816 my $newstore = $store;
6817 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6818 my $rename = "";
6819 if ($show ne $newshow) {
6820 $rename .= " '$show' to '$newshow'";
6821 }
6822 if ($store ne $newstore) {
6823 $rename .= " '$store' to '$newstore'";
6824 }
6825 WARN("DEVICE_ATTR_FUNCTIONS",
6826 "Consider renaming function(s)$rename\n" . $herecurr);
6827 } else {
6828 WARN("DEVICE_ATTR_PERMS",
6829 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6830 }
6831 }
6832
Joe Perches515a2352014-04-03 14:49:24 -07006833# Mode permission misuses where it seems decimal should be octal
6834# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006835# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6836# specific definition of not visible in sysfs.
6837# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6838# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07006839 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006840 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006841 $line =~ /$mode_perms_search/) {
6842 foreach my $entry (@mode_permission_funcs) {
6843 my $func = $entry->[0];
6844 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006845
Joe Perches459cf0a2016-10-11 13:52:19 -07006846 my $lc = $stat =~ tr@\n@@;
6847 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006848 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006849
Joe Perches515a2352014-04-03 14:49:24 -07006850 my $skip_args = "";
6851 if ($arg_pos > 1) {
6852 $arg_pos--;
6853 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6854 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006855 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006856 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006857 my $val = $1;
6858 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006859 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6860 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6861 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006862 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006863 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006864 }
6865 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006866 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006867 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006868 }
Joe Perches24358802014-04-03 14:49:13 -07006869 }
6870 }
6871 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006872
Joe Perches459cf0a2016-10-11 13:52:19 -07006873# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07006874 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08006875 my $oval = $1;
6876 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006877 if (WARN("SYMBOLIC_PERMS",
6878 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6879 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006880 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006881 }
6882 }
6883
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006884# validate content of MODULE_LICENSE against list from include/linux/module.h
6885 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6886 my $extracted_string = get_quoted_string($line, $rawline);
6887 my $valid_licenses = qr{
6888 GPL|
6889 GPL\ v2|
6890 GPL\ and\ additional\ rights|
6891 Dual\ BSD/GPL|
6892 Dual\ MIT/GPL|
6893 Dual\ MPL/GPL|
6894 Proprietary
6895 }x;
6896 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6897 WARN("MODULE_LICENSE",
6898 "unknown module license " . $extracted_string . "\n" . $herecurr);
6899 }
6900 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07006901
6902# check for sysctl duplicate constants
6903 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6904 WARN("DUPLICATED_SYSCTL_CONST",
6905 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6906 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006907 }
6908
6909 # If we have no input at all, then there is nothing to report on
6910 # so just keep quiet.
6911 if ($#rawlines == -1) {
6912 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006913 }
6914
Andy Whitcroft8905a672007-11-28 16:21:06 -08006915 # In mailback mode only produce a report in the negative, for
6916 # things that appear to be patches.
6917 if ($mailback && ($clean == 1 || !$is_patch)) {
6918 exit(0);
6919 }
6920
6921 # This is not a patch, and we are are in 'no-patch' mode so
6922 # just keep quiet.
6923 if (!$chk_patch && !$is_patch) {
6924 exit(0);
6925 }
6926
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006927 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006928 ERROR("NOT_UNIFIED_DIFF",
6929 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006930 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07006931 if ($is_patch && $has_commit_log && $chk_signoff) {
6932 if ($signoff == 0) {
6933 ERROR("MISSING_SIGN_OFF",
6934 "Missing Signed-off-by: line(s)\n");
6935 } elsif (!$authorsignoff) {
6936 WARN("NO_AUTHOR_SIGN_OFF",
6937 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6938 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006939 }
6940
Andy Whitcroft8905a672007-11-28 16:21:06 -08006941 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006942 if ($summary && !($clean == 1 && $quiet == 1)) {
6943 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006944 print "total: $cnt_error errors, $cnt_warn warnings, " .
6945 (($check)? "$cnt_chk checks, " : "") .
6946 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006947 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006948
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006949 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006950 # If there were any defects found and not already fixing them
6951 if (!$clean and !$fix) {
6952 print << "EOM"
6953
6954NOTE: For some of the reported defects, checkpatch may be able to
6955 mechanically convert to the typical style using --fix or --fix-inplace.
6956EOM
6957 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006958 # If there were whitespace errors which cleanpatch can fix
6959 # then suggest that.
6960 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006961 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006962 print << "EOM"
6963
6964NOTE: Whitespace errors detected.
6965 You may wish to use scripts/cleanpatch or scripts/cleanfile
6966EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006967 }
6968 }
6969
Joe Perchesd752fcc2014-08-06 16:11:05 -07006970 if ($clean == 0 && $fix &&
6971 ("@rawlines" ne "@fixed" ||
6972 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006973 my $newfile = $filename;
6974 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006975 my $linecount = 0;
6976 my $f;
6977
Joe Perchesd752fcc2014-08-06 16:11:05 -07006978 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6979
Joe Perches3705ce52013-07-03 15:05:31 -07006980 open($f, '>', $newfile)
6981 or die "$P: Can't open $newfile for write\n";
6982 foreach my $fixed_line (@fixed) {
6983 $linecount++;
6984 if ($file) {
6985 if ($linecount > 3) {
6986 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006987 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006988 }
6989 } else {
6990 print $f $fixed_line . "\n";
6991 }
6992 }
6993 close($f);
6994
6995 if (!$quiet) {
6996 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006997
Joe Perches3705ce52013-07-03 15:05:31 -07006998Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6999
7000Do _NOT_ trust the results written to this file.
7001Do _NOT_ submit these changes without inspecting them for correctness.
7002
7003This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7004No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07007005EOM
7006 }
7007 }
7008
Joe Perchesd8469f12015-06-25 15:03:00 -07007009 if ($quiet == 0) {
7010 print "\n";
7011 if ($clean == 1) {
7012 print "$vname has no obvious style problems and is ready for submission.\n";
7013 } else {
7014 print "$vname has style problems, please review.\n";
7015 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007016 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07007017 return $clean;
7018}