blob: 6fcc66afb088083080a4b492be6af4b67d4c1430 [file] [log] [blame]
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02001#!/usr/bin/env perl
Joe Perches882ea1d2018-06-07 17:04:33 -07002# SPDX-License-Identifier: GPL-2.0
3#
Dave Jonesdbf004d2010-01-12 16:59:52 -05004# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07005# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08006# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07007# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Joe Perches882ea1d2018-06-07 17:04:33 -07008# (c) 2010-2018 Joe Perches <joe@perches.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07009
10use strict;
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +020011use warnings;
Joe Perchesc707a812013-07-08 16:00:43 -070012use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080013use File::Basename;
14use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070015use Term::ANSIColor qw(:constants);
Geert Uytterhoevencd261492018-08-21 21:57:40 -070016use Encode qw(decode encode);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070017
18my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080019my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070020
Joe Perches000d1cc12011-07-25 17:13:25 -070021my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070022
23use Getopt::Long qw(:config no_auto_abbrev);
24
25my $quiet = 0;
26my $tree = 1;
27my $chk_signoff = 1;
28my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070029my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080031my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070032my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070034my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070035my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070036my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070037my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080038my $summary = 1;
39my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080040my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070041my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070042my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070043my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080044my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070045my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080046my %debug;
Joe Perches34456862013-07-03 15:05:34 -070047my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070048my %use_type = ();
49my @use = ();
50my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070051my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070052my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070053my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080054my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070055my $ignore_perl_version = 0;
56my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070057my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070058my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070059my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070060my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070061my $conststructsfile = "$D/const_structs.checkpatch";
Jerome Forissier75ad8c52017-05-08 15:56:00 -070062my $typedefsfile = "";
John Brooks737c0762017-07-10 15:52:24 -070063my $color = "auto";
Vadim Bendebury98005e82019-03-07 16:28:38 -080064my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE
Joe Perchesdbbf8692019-09-25 16:46:52 -070065# git output parsing needs US English output, so first set backtick child process LANGUAGE
66my $git_command ='export LANGUAGE=en_US.UTF-8; git';
Hannes Eder77f5b102009-09-21 17:04:37 -070067
68sub help {
69 my ($exitcode) = @_;
70
71 print << "EOM";
72Usage: $P [OPTION]... [FILE]...
73Version: $V
74
75Options:
76 -q, --quiet quiet
77 --no-tree run without a kernel tree
78 --no-signoff do not check for 'Signed-off-by' line
79 --patch treat FILE as patchfile (default)
80 --emacs emacs compile window format
81 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070082 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070083 -g, --git treat FILE as a single commit or git revision range
84 single git commit with:
85 <rev>
86 <rev>^
87 <rev>~n
88 multiple git commits with:
89 <rev1>..<rev2>
90 <rev1>...<rev2>
91 <rev>-<count>
92 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070093 -f, --file treat FILE as regular source file
94 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070095 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070096 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070097 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070098 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080099 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -0700100 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -0700101 --root=PATH PATH to the kernel tree root
102 --no-summary suppress the per-file summary
103 --mailback only produce a report in case of warnings/errors
104 --summary-file include the filename in summary
105 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
106 'values', 'possible', 'type', and 'attr' (default
107 is all off)
108 --test-only=WORD report only warnings/errors containing WORD
109 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700110 --fix EXPERIMENTAL - may create horrible results
111 If correctable single-line errors exist, create
112 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
113 with potential errors corrected to the preferred
114 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800115 --fix-inplace EXPERIMENTAL - may create horrible results
116 Is the same as --fix, but overwrites the input
117 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700118 --ignore-perl-version override checking of perl version. expect
119 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700120 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700121 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700122 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700123 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700124 --color[=WHEN] Use colors 'always', 'never', or only when output
125 is a terminal ('auto'). Default is 'auto'.
Hannes Eder77f5b102009-09-21 17:04:37 -0700126 -h, --help, --version display this help and exit
127
128When FILE is - read standard input.
129EOM
130
131 exit($exitcode);
132}
133
Joe Perches3beb42e2016-05-20 17:04:14 -0700134sub uniq {
135 my %seen;
136 return grep { !$seen{$_}++ } @_;
137}
138
139sub list_types {
140 my ($exitcode) = @_;
141
142 my $count = 0;
143
144 local $/ = undef;
145
146 open(my $script, '<', abs_path($P)) or
147 die "$P: Can't read '$P' $!\n";
148
149 my $text = <$script>;
150 close($script);
151
152 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700153 # Also catch when type or level is passed through a variable
154 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700155 push (@types, $_);
156 }
157 @types = sort(uniq(@types));
158 print("#\tMessage type\n\n");
159 foreach my $type (@types) {
160 print(++$count . "\t" . $type . "\n");
161 }
162
163 exit($exitcode);
164}
165
Joe Perches000d1cc12011-07-25 17:13:25 -0700166my $conf = which_conf($configuration_file);
167if (-f $conf) {
168 my @conf_args;
169 open(my $conffile, '<', "$conf")
170 or warn "$P: Can't find a readable $configuration_file file $!\n";
171
172 while (<$conffile>) {
173 my $line = $_;
174
175 $line =~ s/\s*\n?$//g;
176 $line =~ s/^\s*//g;
177 $line =~ s/\s+/ /g;
178
179 next if ($line =~ m/^\s*#/);
180 next if ($line =~ m/^\s*$/);
181
182 my @words = split(" ", $line);
183 foreach my $word (@words) {
184 last if ($word =~ m/^#/);
185 push (@conf_args, $word);
186 }
187 }
188 close($conffile);
189 unshift(@ARGV, @conf_args) if @conf_args;
190}
191
John Brooks737c0762017-07-10 15:52:24 -0700192# Perl's Getopt::Long allows options to take optional arguments after a space.
193# Prevent --color by itself from consuming other arguments
194foreach (@ARGV) {
195 if ($_ eq "--color" || $_ eq "-color") {
196 $_ = "--color=$color";
197 }
198}
199
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700200GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700201 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700202 'tree!' => \$tree,
203 'signoff!' => \$chk_signoff,
204 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700205 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800206 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700207 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700208 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700209 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700210 'subjective!' => \$check,
211 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700212 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700213 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700214 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700215 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800216 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700217 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700218 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800219 'summary!' => \$summary,
220 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800221 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700222 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800223 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700224 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800225 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700226 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700227 'codespell!' => \$codespell,
228 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700229 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700230 'color=s' => \$color,
231 'no-color' => \$color, #keep old behaviors of -nocolor
232 'nocolor' => \$color, #keep old behaviors of -nocolor
Hannes Eder77f5b102009-09-21 17:04:37 -0700233 'h|help' => \$help,
234 'version' => \$help
235) or help(1);
236
237help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700238
Joe Perches3beb42e2016-05-20 17:04:14 -0700239list_types(0) if ($list_types);
240
Joe Perches9624b8d2014-01-23 15:54:44 -0800241$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700242$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800243
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700244my $exit = 0;
245
Joe Perches5b579802018-08-21 21:57:33 -0700246my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700247if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700248 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700249 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700250 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700251}
252
Allen Hubbe45107ff2016-08-02 14:04:47 -0700253#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700254if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700255 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700256}
257
John Brooks737c0762017-07-10 15:52:24 -0700258if ($color =~ /^[01]$/) {
259 $color = !$color;
260} elsif ($color =~ /^always$/i) {
261 $color = 1;
262} elsif ($color =~ /^never$/i) {
263 $color = 0;
264} elsif ($color =~ /^auto$/i) {
265 $color = (-t STDOUT);
266} else {
267 die "Invalid color mode: $color\n";
268}
269
Joe Perches91bfe482013-09-11 14:23:59 -0700270sub hash_save_array_words {
271 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700272
Joe Perches91bfe482013-09-11 14:23:59 -0700273 my @array = split(/,/, join(',', @$arrayRef));
274 foreach my $word (@array) {
275 $word =~ s/\s*\n?$//g;
276 $word =~ s/^\s*//g;
277 $word =~ s/\s+/ /g;
278 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700279
Joe Perches91bfe482013-09-11 14:23:59 -0700280 next if ($word =~ m/^\s*#/);
281 next if ($word =~ m/^\s*$/);
282
283 $hashRef->{$word}++;
284 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700285}
286
Joe Perches91bfe482013-09-11 14:23:59 -0700287sub hash_show_words {
288 my ($hashRef, $prefix) = @_;
289
Joe Perches3c816e42015-06-25 15:03:29 -0700290 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700291 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700292 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700293 print " $word";
294 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700295 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700296 }
297}
298
299hash_save_array_words(\%ignore_type, \@ignore);
300hash_save_array_words(\%use_type, \@use);
301
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800302my $dbg_values = 0;
303my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700304my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700305my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800306for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800307 ## no critic
308 eval "\${dbg_$key} = '$debug{$key}';";
309 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800310}
311
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700312my $rpt_cleaners = 0;
313
Andy Whitcroft8905a672007-11-28 16:21:06 -0800314if ($terse) {
315 $emacs = 1;
316 $quiet++;
317}
318
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700319if ($tree) {
320 if (defined $root) {
321 if (!top_of_kernel_tree($root)) {
322 die "$P: $root: --root does not point at a valid tree\n";
323 }
324 } else {
325 if (top_of_kernel_tree('.')) {
326 $root = '.';
327 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
328 top_of_kernel_tree($1)) {
329 $root = $1;
330 }
331 }
332
333 if (!defined $root) {
334 print "Must be run from the top-level dir. of a kernel tree\n";
335 exit(2);
336 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700337}
338
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700339my $emitted_corrupt = 0;
340
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700341our $Ident = qr{
342 [A-Za-z_][A-Za-z\d_]*
343 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
344 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700345our $Storage = qr{extern|static|asmlinkage};
346our $Sparse = qr{
347 __user|
348 __kernel|
349 __force|
350 __iomem|
351 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800352 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700353 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700354 __refconst|
355 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800356 __rcu|
357 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700358 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800359our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
360our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
361our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
362our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
363our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700364
Wolfram Sang52131292010-03-05 13:43:51 -0800365# Notes to $Attribute:
366# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700367our $Attribute = qr{
368 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700369 __percpu|
370 __nocast|
371 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200372 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700373 __packed__|
374 __packed2__|
375 __naked|
376 __maybe_unused|
377 __always_unused|
378 __noreturn|
379 __used|
380 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800381 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700382 __noclone|
383 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700384 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700385 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700386 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700387 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700388 ____cacheline_aligned|
389 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800390 ____cacheline_internodealigned_in_smp|
391 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700392 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700393our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700394our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700395our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
396our $Lval = qr{$Ident(?:$Member)*};
397
Joe Perches95e2c602013-07-03 15:05:20 -0700398our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
399our $Binary = qr{(?i)0b[01]+$Int_type?};
400our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
401our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700402our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800403our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800404our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
405our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
406our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800407our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700408our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800409our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700410our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700411our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700412our $Operators = qr{
413 <=|>=|==|!=|
414 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700415 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700416 }x;
417
Joe Perches91cb5192014-04-03 14:49:32 -0700418our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
419
Joe Perchesab7e23f2015-04-16 12:44:22 -0700420our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800421our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700422our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700423our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800424our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700425our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700427our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800428
Joe Perches15662b32011-10-31 17:13:12 -0700429our $NON_ASCII_UTF8 = qr{
430 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700431 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
432 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
433 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
434 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
435 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
436 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
437}x;
438
Joe Perches15662b32011-10-31 17:13:12 -0700439our $UTF8 = qr{
440 [\x09\x0A\x0D\x20-\x7E] # ASCII
441 | $NON_ASCII_UTF8
442}x;
443
Joe Perchese6176fa2015-06-25 15:02:49 -0700444our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800445our $typeOtherOSTypedefs = qr{(?x:
446 u_(?:char|short|int|long) | # bsd
447 u(?:nchar|short|int|long) # sysv
448)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700449our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700450 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700451 atomic_t
452)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700453our $typeTypedefs = qr{(?x:
454 $typeC99Typedefs\b|
455 $typeOtherOSTypedefs\b|
456 $typeKernelTypedefs\b
457)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700458
Joe Perches6d32f7a2015-11-06 16:31:37 -0800459our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
460
Joe Perches691e6692010-03-05 13:43:51 -0800461our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800462 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700463 (?:[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 -0800464 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700465 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700466 panic|
Joe Perches06668722013-11-12 15:10:07 -0800467 MODULE_[A-Z_]+|
468 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800469)};
470
Joe Perchese29a70f2019-03-07 16:28:35 -0800471our $allocFunctions = qr{(?x:
472 (?:(?:devm_)?
473 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
474 kstrdup(?:_const)? |
475 kmemdup(?:_nul)?) |
476 (?:\w+)?alloc_skb(?:ip_align)? |
477 # dev_alloc_skb/netdev_alloc_skb, et al
478 dma_alloc_coherent
479)};
480
Joe Perches20112472011-07-25 17:13:23 -0700481our $signature_tags = qr{(?xi:
482 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800483 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700484 Acked-by:|
485 Tested-by:|
486 Reviewed-by:|
487 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700488 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700489 To:|
490 Cc:
491)};
492
Joe Perches18130872014-08-06 16:11:22 -0700493our @typeListMisordered = (
494 qr{char\s+(?:un)?signed},
495 qr{int\s+(?:(?:un)?signed\s+)?short\s},
496 qr{int\s+short(?:\s+(?:un)?signed)},
497 qr{short\s+int(?:\s+(?:un)?signed)},
498 qr{(?:un)?signed\s+int\s+short},
499 qr{short\s+(?:un)?signed},
500 qr{long\s+int\s+(?:un)?signed},
501 qr{int\s+long\s+(?:un)?signed},
502 qr{long\s+(?:un)?signed\s+int},
503 qr{int\s+(?:un)?signed\s+long},
504 qr{int\s+(?:un)?signed},
505 qr{int\s+long\s+long\s+(?:un)?signed},
506 qr{long\s+long\s+int\s+(?:un)?signed},
507 qr{long\s+long\s+(?:un)?signed\s+int},
508 qr{long\s+long\s+(?:un)?signed},
509 qr{long\s+(?:un)?signed},
510);
511
Andy Whitcroft8905a672007-11-28 16:21:06 -0800512our @typeList = (
513 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700514 qr{(?:(?:un)?signed\s+)?char},
515 qr{(?:(?:un)?signed\s+)?short\s+int},
516 qr{(?:(?:un)?signed\s+)?short},
517 qr{(?:(?:un)?signed\s+)?int},
518 qr{(?:(?:un)?signed\s+)?long\s+int},
519 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
520 qr{(?:(?:un)?signed\s+)?long\s+long},
521 qr{(?:(?:un)?signed\s+)?long},
522 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800523 qr{float},
524 qr{double},
525 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800526 qr{struct\s+$Ident},
527 qr{union\s+$Ident},
528 qr{enum\s+$Ident},
529 qr{${Ident}_t},
530 qr{${Ident}_handler},
531 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700532 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800533);
Joe Perches938224b2016-01-20 14:59:15 -0800534
535our $C90_int_types = qr{(?x:
536 long\s+long\s+int\s+(?:un)?signed|
537 long\s+long\s+(?:un)?signed\s+int|
538 long\s+long\s+(?:un)?signed|
539 (?:(?:un)?signed\s+)?long\s+long\s+int|
540 (?:(?:un)?signed\s+)?long\s+long|
541 int\s+long\s+long\s+(?:un)?signed|
542 int\s+(?:(?:un)?signed\s+)?long\s+long|
543
544 long\s+int\s+(?:un)?signed|
545 long\s+(?:un)?signed\s+int|
546 long\s+(?:un)?signed|
547 (?:(?:un)?signed\s+)?long\s+int|
548 (?:(?:un)?signed\s+)?long|
549 int\s+long\s+(?:un)?signed|
550 int\s+(?:(?:un)?signed\s+)?long|
551
552 int\s+(?:un)?signed|
553 (?:(?:un)?signed\s+)?int
554)};
555
Alex Dowad485ff232015-06-25 15:02:52 -0700556our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700557our @typeListWithAttr = (
558 @typeList,
559 qr{struct\s+$InitAttribute\s+$Ident},
560 qr{union\s+$InitAttribute\s+$Ident},
561);
562
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700563our @modifierList = (
564 qr{fastcall},
565);
Alex Dowad485ff232015-06-25 15:02:52 -0700566our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800567
Joe Perches24358802014-04-03 14:49:13 -0700568our @mode_permission_funcs = (
569 ["module_param", 3],
570 ["module_param_(?:array|named|string)", 4],
571 ["module_param_array_named", 5],
572 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
573 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700574 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
575 ["IIO_DEV_ATTR_[A-Z_]+", 1],
576 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
577 ["SENSOR_TEMPLATE(?:_2|)", 3],
578 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700579);
580
Joe Perches515a2352014-04-03 14:49:24 -0700581#Create a search pattern for all these functions to speed up a loop below
582our $mode_perms_search = "";
583foreach my $entry (@mode_permission_funcs) {
584 $mode_perms_search .= '|' if ($mode_perms_search ne "");
585 $mode_perms_search .= $entry->[0];
586}
Joe Perches00180462018-02-06 15:38:55 -0800587$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700588
Joe Perches9189c7e2018-09-07 15:26:18 -0700589our %deprecated_apis = (
590 "synchronize_rcu_bh" => "synchronize_rcu",
591 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
592 "call_rcu_bh" => "call_rcu",
593 "rcu_barrier_bh" => "rcu_barrier",
594 "synchronize_sched" => "synchronize_rcu",
595 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
596 "call_rcu_sched" => "call_rcu",
597 "rcu_barrier_sched" => "rcu_barrier",
598 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
599 "cond_synchronize_sched" => "cond_synchronize_rcu",
600);
601
602#Create a search pattern for all these strings to speed up a loop below
603our $deprecated_apis_search = "";
604foreach my $entry (keys %deprecated_apis) {
605 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
606 $deprecated_apis_search .= $entry;
607}
608$deprecated_apis_search = "(?:${deprecated_apis_search})";
609
Joe Perchesb392c642015-04-16 12:44:16 -0700610our $mode_perms_world_writable = qr{
611 S_IWUGO |
612 S_IWOTH |
613 S_IRWXUGO |
614 S_IALLUGO |
615 0[0-7][0-7][2367]
616}x;
617
Joe Perchesf90774e2016-10-11 13:51:47 -0700618our %mode_permission_string_types = (
619 "S_IRWXU" => 0700,
620 "S_IRUSR" => 0400,
621 "S_IWUSR" => 0200,
622 "S_IXUSR" => 0100,
623 "S_IRWXG" => 0070,
624 "S_IRGRP" => 0040,
625 "S_IWGRP" => 0020,
626 "S_IXGRP" => 0010,
627 "S_IRWXO" => 0007,
628 "S_IROTH" => 0004,
629 "S_IWOTH" => 0002,
630 "S_IXOTH" => 0001,
631 "S_IRWXUGO" => 0777,
632 "S_IRUGO" => 0444,
633 "S_IWUGO" => 0222,
634 "S_IXUGO" => 0111,
635);
636
637#Create a search pattern for all these strings to speed up a loop below
638our $mode_perms_string_search = "";
639foreach my $entry (keys %mode_permission_string_types) {
640 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
641 $mode_perms_string_search .= $entry;
642}
Joe Perches00180462018-02-06 15:38:55 -0800643our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
644our $multi_mode_perms_string_search = qr{
645 ${single_mode_perms_string_search}
646 (?:\s*\|\s*${single_mode_perms_string_search})*
647}x;
648
649sub perms_to_octal {
650 my ($string) = @_;
651
652 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
653
654 my $val = "";
655 my $oval = "";
656 my $to = 0;
657 my $curpos = 0;
658 my $lastpos = 0;
659 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
660 $curpos = pos($string);
661 my $match = $2;
662 my $omatch = $1;
663 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
664 $lastpos = $curpos;
665 $to |= $mode_permission_string_types{$match};
666 $val .= '\s*\|\s*' if ($val ne "");
667 $val .= $match;
668 $oval .= $omatch;
669 }
670 $oval =~ s/^\s*\|\s*//;
671 $oval =~ s/\s*\|\s*$//;
672 return sprintf("%04o", $to);
673}
Joe Perchesf90774e2016-10-11 13:51:47 -0700674
Wolfram Sang7840a942010-08-09 17:20:57 -0700675our $allowed_asm_includes = qr{(?x:
676 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700677 memory|
678 time|
679 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700680)};
681# memory.h: ARM has a custom one
682
Kees Cook66b47b42014-10-13 15:51:57 -0700683# Load common spelling mistakes and build regular expression list.
684my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700685my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700686
Joe Perches36061e32014-12-10 15:51:43 -0800687if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800688 while (<$spelling>) {
689 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700690
Joe Perches36061e32014-12-10 15:51:43 -0800691 $line =~ s/\s*\n?$//g;
692 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700693
Joe Perches36061e32014-12-10 15:51:43 -0800694 next if ($line =~ m/^\s*#/);
695 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700696
Joe Perches36061e32014-12-10 15:51:43 -0800697 my ($suspect, $fix) = split(/\|\|/, $line);
698
Joe Perches36061e32014-12-10 15:51:43 -0800699 $spelling_fix{$suspect} = $fix;
700 }
701 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800702} else {
703 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700704}
Kees Cook66b47b42014-10-13 15:51:57 -0700705
Joe Perchesebfd7d62015-04-16 12:44:14 -0700706if ($codespell) {
707 if (open(my $spelling, '<', $codespellfile)) {
708 while (<$spelling>) {
709 my $line = $_;
710
711 $line =~ s/\s*\n?$//g;
712 $line =~ s/^\s*//g;
713
714 next if ($line =~ m/^\s*#/);
715 next if ($line =~ m/^\s*$/);
716 next if ($line =~ m/, disabled/i);
717
718 $line =~ s/,.*$//;
719
720 my ($suspect, $fix) = split(/->/, $line);
721
722 $spelling_fix{$suspect} = $fix;
723 }
724 close($spelling);
725 } else {
726 warn "No codespell typos will be found - file '$codespellfile': $!\n";
727 }
728}
729
730$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
731
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700732sub read_words {
733 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700734
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700735 if (open(my $words, '<', $file)) {
736 while (<$words>) {
737 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700738
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700739 $line =~ s/\s*\n?$//g;
740 $line =~ s/^\s*//g;
741
742 next if ($line =~ m/^\s*#/);
743 next if ($line =~ m/^\s*$/);
744 if ($line =~ /\s/) {
745 print("$file: '$line' invalid - ignored\n");
746 next;
747 }
748
749 $$wordsRef .= '|' if ($$wordsRef ne "");
750 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700751 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700752 close($file);
753 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700754 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700755
756 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700757}
758
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700759my $const_structs = "";
760read_words(\$const_structs, $conststructsfile)
761 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
762
763my $typeOtherTypedefs = "";
764if (length($typedefsfile)) {
765 read_words(\$typeOtherTypedefs, $typedefsfile)
766 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
767}
768$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
769
Andy Whitcroft8905a672007-11-28 16:21:06 -0800770sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700771 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
772 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700773 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700774 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700775 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700776 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700777 (?:$typeTypedefs\b)|
778 (?:${all}\b)
779 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800780 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700781 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800782 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800783 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700784 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700785 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800786 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700787 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800788 }x;
Joe Perches18130872014-08-06 16:11:22 -0700789 $NonptrTypeMisordered = qr{
790 (?:$Modifier\s+|const\s+)*
791 (?:
792 (?:${Misordered}\b)
793 )
794 (?:\s+$Modifier|\s+const)*
795 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700796 $NonptrTypeWithAttr = qr{
797 (?:$Modifier\s+|const\s+)*
798 (?:
799 (?:typeof|__typeof__)\s*\([^\)]*\)|
800 (?:$typeTypedefs\b)|
801 (?:${allWithAttr}\b)
802 )
803 (?:\s+$Modifier|\s+const)*
804 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800805 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700806 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700807 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700808 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800809 }x;
Joe Perches18130872014-08-06 16:11:22 -0700810 $TypeMisordered = qr{
811 $NonptrTypeMisordered
812 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
813 (?:\s+$Inline|\s+$Modifier)*
814 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700815 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700816 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800817}
818build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700819
Joe Perches7d2367a2011-07-25 17:13:22 -0700820our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700821
822# Using $balanced_parens, $LvalOrFunc, or $FuncArg
823# requires at least perl version v5.10.0
824# Any use must be runtime checked with $^V
825
826our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700827our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800828our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700829
Joe Perchesf8422302014-08-06 16:11:31 -0700830our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700831 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700832 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700833 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
834 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700835)};
836
Joe Perches7d2367a2011-07-25 17:13:22 -0700837sub deparenthesize {
838 my ($string) = @_;
839 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700840
841 while ($string =~ /^\s*\(.*\)\s*$/) {
842 $string =~ s@^\s*\(\s*@@;
843 $string =~ s@\s*\)\s*$@@;
844 }
845
Joe Perches7d2367a2011-07-25 17:13:22 -0700846 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700847
Joe Perches7d2367a2011-07-25 17:13:22 -0700848 return $string;
849}
850
Joe Perches34456862013-07-03 15:05:34 -0700851sub seed_camelcase_file {
852 my ($file) = @_;
853
854 return if (!(-f $file));
855
856 local $/;
857
858 open(my $include_file, '<', "$file")
859 or warn "$P: Can't read '$file' $!\n";
860 my $text = <$include_file>;
861 close($include_file);
862
863 my @lines = split('\n', $text);
864
865 foreach my $line (@lines) {
866 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
867 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
868 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800869 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
870 $camelcase{$1} = 1;
871 } 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 -0700872 $camelcase{$1} = 1;
873 }
874 }
875}
876
Joe Perches85b0ee12016-10-11 13:51:44 -0700877sub is_maintained_obsolete {
878 my ($filename) = @_;
879
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800880 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700881
Joe Perches0616efa2016-10-11 13:52:02 -0700882 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
Joe Perches85b0ee12016-10-11 13:51:44 -0700883
884 return $status =~ /obsolete/i;
885}
886
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700887sub is_SPDX_License_valid {
888 my ($license) = @_;
889
Joe Perches56294112018-08-21 21:58:04 -0700890 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700891
Joe Perches56294112018-08-21 21:58:04 -0700892 my $root_path = abs_path($root);
893 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700894 return 0 if ($status ne "");
895 return 1;
896}
897
Joe Perches34456862013-07-03 15:05:34 -0700898my $camelcase_seeded = 0;
899sub seed_camelcase_includes {
900 return if ($camelcase_seeded);
901
902 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700903 my $camelcase_cache = "";
904 my @include_files = ();
905
906 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700907
Richard Genoud3645e322014-02-10 14:25:32 -0800908 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700909 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
Joe Perches351b2a12013-07-03 15:05:36 -0700910 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700911 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700912 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700913 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700914 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700915 @include_files = split('\n', $files);
916 foreach my $file (@include_files) {
917 my $date = POSIX::strftime("%Y%m%d%H%M",
918 localtime((stat $file)[9]));
919 $last_mod_date = $date if ($last_mod_date < $date);
920 }
921 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700922 }
Joe Perchesc707a812013-07-08 16:00:43 -0700923
924 if ($camelcase_cache ne "" && -f $camelcase_cache) {
925 open(my $camelcase_file, '<', "$camelcase_cache")
926 or warn "$P: Can't read '$camelcase_cache' $!\n";
927 while (<$camelcase_file>) {
928 chomp;
929 $camelcase{$_} = 1;
930 }
931 close($camelcase_file);
932
933 return;
934 }
935
Richard Genoud3645e322014-02-10 14:25:32 -0800936 if (-e ".git") {
Joe Perchesdbbf8692019-09-25 16:46:52 -0700937 $files = `${git_command} ls-files "include/*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700938 @include_files = split('\n', $files);
939 }
940
Joe Perches34456862013-07-03 15:05:34 -0700941 foreach my $file (@include_files) {
942 seed_camelcase_file($file);
943 }
Joe Perches351b2a12013-07-03 15:05:36 -0700944
Joe Perchesc707a812013-07-08 16:00:43 -0700945 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700946 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700947 open(my $camelcase_file, '>', "$camelcase_cache")
948 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700949 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
950 print $camelcase_file ("$_\n");
951 }
952 close($camelcase_file);
953 }
Joe Perches34456862013-07-03 15:05:34 -0700954}
955
Joe Perchesd311cd42014-08-06 16:10:57 -0700956sub git_commit_info {
957 my ($commit, $id, $desc) = @_;
958
959 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
960
Joe Perchesdbbf8692019-09-25 16:46:52 -0700961 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`;
Joe Perchesd311cd42014-08-06 16:10:57 -0700962 $output =~ s/^\s*//gm;
963 my @lines = split("\n", $output);
964
Joe Perches0d7835f2015-02-13 14:38:35 -0800965 return ($id, $desc) if ($#lines < 0);
966
Sean Christopherson5a7f4452019-09-25 16:46:49 -0700967 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) {
Joe Perchesd311cd42014-08-06 16:10:57 -0700968# Maybe one day convert this block of bash into something that returns
969# all matching commit ids, but it's very slow...
970#
971# echo "checking commits $1..."
972# git rev-list --remotes | grep -i "^$1" |
973# while read line ; do
974# git log --format='%H %s' -1 $line |
975# echo "commit $(cut -c 1-12,41-)"
976# done
977 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700978 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700979 } else {
980 $id = substr($lines[0], 0, 12);
981 $desc = substr($lines[0], 41);
982 }
983
984 return ($id, $desc);
985}
986
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700987$chk_signoff = 0 if ($file);
988
Andy Whitcroft00df3442007-06-08 13:47:06 -0700989my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800990my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700991my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700992my @fixed_inserted = ();
993my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700994my $fixlinenr = -1;
995
Du, Changbin4a593c32016-05-20 17:04:16 -0700996# If input is git commits, extract all commits from the commit expressions.
997# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
998die "$P: No git repository found\n" if ($git && !-e ".git");
999
1000if ($git) {
1001 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001002 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001003 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001004 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1005 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001006 } elsif ($commit_expr =~ m/\.\./) {
1007 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001008 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001009 $git_range = "-1 $commit_expr";
1010 }
Joe Perchesdbbf8692019-09-25 16:46:52 -07001011 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001012 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001013 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1014 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001015 my $sha1 = $1;
1016 my $subject = $2;
1017 unshift(@commits, $sha1);
1018 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001019 }
1020 }
1021 die "$P: no git commits after extraction!\n" if (@commits == 0);
1022 @ARGV = @commits;
1023}
1024
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001025my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001026$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001027for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001028 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -07001029 if ($git) {
1030 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1031 die "$P: $filename: git format-patch failed - $!\n";
1032 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001033 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001034 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001035 } elsif ($filename eq '-') {
1036 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001037 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001038 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001039 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001040 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001041 if ($filename eq '-') {
1042 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001043 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001044 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001045 } else {
1046 $vname = $filename;
1047 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001048 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001049 chomp;
1050 push(@rawlines, $_);
1051 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001052 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001053
1054 if ($#ARGV > 0 && $quiet == 0) {
1055 print '-' x length($vname) . "\n";
1056 print "$vname\n";
1057 print '-' x length($vname) . "\n";
1058 }
1059
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001060 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001061 $exit = 1;
1062 }
1063 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001064 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001065 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001066 @fixed_inserted = ();
1067 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001068 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001069 @modifierListFile = ();
1070 @typeListFile = ();
1071 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001072}
1073
Joe Perchesd8469f12015-06-25 15:03:00 -07001074if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001075 hash_show_words(\%use_type, "Used");
1076 hash_show_words(\%ignore_type, "Ignored");
1077
Joe Perches5b579802018-08-21 21:57:33 -07001078 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001079 print << "EOM"
1080
1081NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001082 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001083EOM
1084 }
1085 if ($exit) {
1086 print << "EOM"
1087
1088NOTE: If any of the errors are false positives, please report
1089 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1090EOM
1091 }
1092}
1093
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001094exit($exit);
1095
1096sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001097 my ($root) = @_;
1098
1099 my @tree_check = (
1100 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1101 "README", "Documentation", "arch", "include", "drivers",
1102 "fs", "init", "ipc", "kernel", "lib", "scripts",
1103 );
1104
1105 foreach my $check (@tree_check) {
1106 if (! -e $root . '/' . $check) {
1107 return 0;
1108 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001109 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001110 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001111}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001112
Joe Perches20112472011-07-25 17:13:23 -07001113sub parse_email {
1114 my ($formatted_email) = @_;
1115
1116 my $name = "";
1117 my $address = "";
1118 my $comment = "";
1119
1120 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1121 $name = $1;
1122 $address = $2;
1123 $comment = $3 if defined $3;
1124 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1125 $address = $1;
1126 $comment = $2 if defined $2;
1127 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1128 $address = $1;
1129 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001130 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001131 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001132 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001133 $name =~ s/^\"|\"$//g;
1134 # If there's a name left after stripping spaces and
1135 # leading quotes, and the address doesn't have both
1136 # leading and trailing angle brackets, the address
1137 # is invalid. ie:
1138 # "joe smith joe@smith.com" bad
1139 # "joe smith <joe@smith.com" bad
1140 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1141 $name = "";
1142 $address = "";
1143 $comment = "";
1144 }
1145 }
1146
Joe Perches3705ce52013-07-03 15:05:31 -07001147 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001148 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001149 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001150 $address =~ s/^\<|\>$//g;
1151
1152 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1153 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1154 $name = "\"$name\"";
1155 }
1156
1157 return ($name, $address, $comment);
1158}
1159
1160sub format_email {
1161 my ($name, $address) = @_;
1162
1163 my $formatted_email;
1164
Joe Perches3705ce52013-07-03 15:05:31 -07001165 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001166 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001167 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001168
1169 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1170 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1171 $name = "\"$name\"";
1172 }
1173
1174 if ("$name" eq "") {
1175 $formatted_email = "$address";
1176 } else {
1177 $formatted_email = "$name <$address>";
1178 }
1179
1180 return $formatted_email;
1181}
1182
Joe Perchesd311cd42014-08-06 16:10:57 -07001183sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001184 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001185
Joe Perchesbd474ca2014-08-06 16:11:10 -07001186 foreach my $path (split(/:/, $ENV{PATH})) {
1187 if (-e "$path/$bin") {
1188 return "$path/$bin";
1189 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001190 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001191
Joe Perchesbd474ca2014-08-06 16:11:10 -07001192 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001193}
1194
Joe Perches000d1cc12011-07-25 17:13:25 -07001195sub which_conf {
1196 my ($conf) = @_;
1197
1198 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1199 if (-e "$path/$conf") {
1200 return "$path/$conf";
1201 }
1202 }
1203
1204 return "";
1205}
1206
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001207sub expand_tabs {
1208 my ($str) = @_;
1209
1210 my $res = '';
1211 my $n = 0;
1212 for my $c (split(//, $str)) {
1213 if ($c eq "\t") {
1214 $res .= ' ';
1215 $n++;
1216 for (; ($n % 8) != 0; $n++) {
1217 $res .= ' ';
1218 }
1219 next;
1220 }
1221 $res .= $c;
1222 $n++;
1223 }
1224
1225 return $res;
1226}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001227sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001228 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001229 return $res;
1230}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001231
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001232sub line_stats {
1233 my ($line) = @_;
1234
1235 # Drop the diff line leader and expand tabs
1236 $line =~ s/^.//;
1237 $line = expand_tabs($line);
1238
1239 # Pick the indent from the front of the line.
1240 my ($white) = ($line =~ /^(\s*)/);
1241
1242 return (length($line), length($white));
1243}
1244
Andy Whitcroft773647a2008-03-28 14:15:58 -07001245my $sanitise_quote = '';
1246
1247sub sanitise_line_reset {
1248 my ($in_comment) = @_;
1249
1250 if ($in_comment) {
1251 $sanitise_quote = '*/';
1252 } else {
1253 $sanitise_quote = '';
1254 }
1255}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001256sub sanitise_line {
1257 my ($line) = @_;
1258
1259 my $res = '';
1260 my $l = '';
1261
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001262 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001263 my $off = 0;
1264 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001265
Andy Whitcroft773647a2008-03-28 14:15:58 -07001266 # Always copy over the diff marker.
1267 $res = substr($line, 0, 1);
1268
1269 for ($off = 1; $off < length($line); $off++) {
1270 $c = substr($line, $off, 1);
1271
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001272 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001273 # and end, all to $;.
1274 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1275 $sanitise_quote = '*/';
1276
1277 substr($res, $off, 2, "$;$;");
1278 $off++;
1279 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001280 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001281 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001282 $sanitise_quote = '';
1283 substr($res, $off, 2, "$;$;");
1284 $off++;
1285 next;
1286 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001287 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1288 $sanitise_quote = '//';
1289
1290 substr($res, $off, 2, $sanitise_quote);
1291 $off++;
1292 next;
1293 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001294
1295 # A \ in a string means ignore the next character.
1296 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1297 $c eq "\\") {
1298 substr($res, $off, 2, 'XX');
1299 $off++;
1300 next;
1301 }
1302 # Regular quotes.
1303 if ($c eq "'" || $c eq '"') {
1304 if ($sanitise_quote eq '') {
1305 $sanitise_quote = $c;
1306
1307 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001308 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001309 } elsif ($sanitise_quote eq $c) {
1310 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001311 }
1312 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001313
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001314 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001315 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1316 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001317 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1318 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001319 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1320 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001321 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001322 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001323 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001324 }
1325
Daniel Walker113f04a2009-09-21 17:04:35 -07001326 if ($sanitise_quote eq '//') {
1327 $sanitise_quote = '';
1328 }
1329
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001330 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001331 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001332 my $clean = 'X' x length($1);
1333 $res =~ s@\<.*\>@<$clean>@;
1334
1335 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001336 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001337 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001338 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001339 }
1340
Joe Perchesdadf6802016-08-02 14:04:33 -07001341 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1342 my $match = $1;
1343 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1344 }
1345
Andy Whitcroft00df3442007-06-08 13:47:06 -07001346 return $res;
1347}
1348
Joe Perchesa6962d72013-04-29 16:18:13 -07001349sub get_quoted_string {
1350 my ($line, $rawline) = @_;
1351
Joe Perches478b1792018-04-10 16:33:34 -07001352 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001353 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001354 return substr($rawline, $-[0], $+[0] - $-[0]);
1355}
1356
Andy Whitcroft8905a672007-11-28 16:21:06 -08001357sub ctx_statement_block {
1358 my ($linenr, $remain, $off) = @_;
1359 my $line = $linenr - 1;
1360 my $blk = '';
1361 my $soff = $off;
1362 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001363 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001364
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001365 my $loff = 0;
1366
Andy Whitcroft8905a672007-11-28 16:21:06 -08001367 my $type = '';
1368 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001369 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001370 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001371 my $c;
1372 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001373
1374 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001375 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001376 @stack = (['', 0]) if ($#stack == -1);
1377
Andy Whitcroft773647a2008-03-28 14:15:58 -07001378 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001379 # If we are about to drop off the end, pull in more
1380 # context.
1381 if ($off >= $len) {
1382 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001383 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001384 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001385 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001386 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001387 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001388 $len = length($blk);
1389 $line++;
1390 last;
1391 }
1392 # Bail if there is no further context.
1393 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001394 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001395 last;
1396 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001397 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1398 $level++;
1399 $type = '#';
1400 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001401 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001402 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001403 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001404 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001405
Andy Whitcroft773647a2008-03-28 14:15:58 -07001406 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001407
1408 # Handle nested #if/#else.
1409 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1410 push(@stack, [ $type, $level ]);
1411 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1412 ($type, $level) = @{$stack[$#stack - 1]};
1413 } elsif ($remainder =~ /^#\s*endif\b/) {
1414 ($type, $level) = @{pop(@stack)};
1415 }
1416
Andy Whitcroft8905a672007-11-28 16:21:06 -08001417 # Statement ends at the ';' or a close '}' at the
1418 # outermost level.
1419 if ($level == 0 && $c eq ';') {
1420 last;
1421 }
1422
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001423 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001424 if ($level == 0 && $coff_set == 0 &&
1425 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1426 $remainder =~ /^(else)(?:\s|{)/ &&
1427 $remainder !~ /^else\s+if\b/) {
1428 $coff = $off + length($1) - 1;
1429 $coff_set = 1;
1430 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1431 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001432 }
1433
Andy Whitcroft8905a672007-11-28 16:21:06 -08001434 if (($type eq '' || $type eq '(') && $c eq '(') {
1435 $level++;
1436 $type = '(';
1437 }
1438 if ($type eq '(' && $c eq ')') {
1439 $level--;
1440 $type = ($level != 0)? '(' : '';
1441
1442 if ($level == 0 && $coff < $soff) {
1443 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001444 $coff_set = 1;
1445 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001446 }
1447 }
1448 if (($type eq '' || $type eq '{') && $c eq '{') {
1449 $level++;
1450 $type = '{';
1451 }
1452 if ($type eq '{' && $c eq '}') {
1453 $level--;
1454 $type = ($level != 0)? '{' : '';
1455
1456 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001457 if (substr($blk, $off + 1, 1) eq ';') {
1458 $off++;
1459 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001460 last;
1461 }
1462 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001463 # Preprocessor commands end at the newline unless escaped.
1464 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1465 $level--;
1466 $type = '';
1467 $off++;
1468 last;
1469 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001470 $off++;
1471 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001472 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001473 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001474 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001475 $line++;
1476 $remain--;
1477 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001478
1479 my $statement = substr($blk, $soff, $off - $soff + 1);
1480 my $condition = substr($blk, $soff, $coff - $soff + 1);
1481
1482 #warn "STATEMENT<$statement>\n";
1483 #warn "CONDITION<$condition>\n";
1484
Andy Whitcroft773647a2008-03-28 14:15:58 -07001485 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001486
1487 return ($statement, $condition,
1488 $line, $remain + 1, $off - $loff + 1, $level);
1489}
1490
Andy Whitcroftcf655042008-03-04 14:28:20 -08001491sub statement_lines {
1492 my ($stmt) = @_;
1493
1494 # Strip the diff line prefixes and rip blank lines at start and end.
1495 $stmt =~ s/(^|\n)./$1/g;
1496 $stmt =~ s/^\s*//;
1497 $stmt =~ s/\s*$//;
1498
1499 my @stmt_lines = ($stmt =~ /\n/g);
1500
1501 return $#stmt_lines + 2;
1502}
1503
1504sub statement_rawlines {
1505 my ($stmt) = @_;
1506
1507 my @stmt_lines = ($stmt =~ /\n/g);
1508
1509 return $#stmt_lines + 2;
1510}
1511
1512sub statement_block_size {
1513 my ($stmt) = @_;
1514
1515 $stmt =~ s/(^|\n)./$1/g;
1516 $stmt =~ s/^\s*{//;
1517 $stmt =~ s/}\s*$//;
1518 $stmt =~ s/^\s*//;
1519 $stmt =~ s/\s*$//;
1520
1521 my @stmt_lines = ($stmt =~ /\n/g);
1522 my @stmt_statements = ($stmt =~ /;/g);
1523
1524 my $stmt_lines = $#stmt_lines + 2;
1525 my $stmt_statements = $#stmt_statements + 1;
1526
1527 if ($stmt_lines > $stmt_statements) {
1528 return $stmt_lines;
1529 } else {
1530 return $stmt_statements;
1531 }
1532}
1533
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001534sub ctx_statement_full {
1535 my ($linenr, $remain, $off) = @_;
1536 my ($statement, $condition, $level);
1537
1538 my (@chunks);
1539
Andy Whitcroftcf655042008-03-04 14:28:20 -08001540 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001541 ($statement, $condition, $linenr, $remain, $off, $level) =
1542 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001543 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001544 push(@chunks, [ $condition, $statement ]);
1545 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1546 return ($level, $linenr, @chunks);
1547 }
1548
1549 # Pull in the following conditional/block pairs and see if they
1550 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001551 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001552 ($statement, $condition, $linenr, $remain, $off, $level) =
1553 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001554 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001555 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001556 #print "C: push\n";
1557 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001558 }
1559
1560 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001561}
1562
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001563sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001564 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001565 my $line;
1566 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001567 my $blk = '';
1568 my @o;
1569 my @c;
1570 my @res = ();
1571
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001572 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001573 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001574 for ($line = $start; $remain > 0; $line++) {
1575 next if ($rawlines[$line] =~ /^-/);
1576 $remain--;
1577
1578 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001579
1580 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001581 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001582 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001583 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001584 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001585 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001586 $level = pop(@stack);
1587 }
1588
Andy Whitcroft01464f32010-10-26 14:23:19 -07001589 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001590 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1591 if ($off > 0) {
1592 $off--;
1593 next;
1594 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001595
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001596 if ($c eq $close && $level > 0) {
1597 $level--;
1598 last if ($level == 0);
1599 } elsif ($c eq $open) {
1600 $level++;
1601 }
1602 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001603
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001604 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001605 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001606 }
1607
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001608 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001609 }
1610
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001611 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001612}
1613sub ctx_block_outer {
1614 my ($linenr, $remain) = @_;
1615
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001616 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1617 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001618}
1619sub ctx_block {
1620 my ($linenr, $remain) = @_;
1621
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001622 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1623 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001624}
1625sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001626 my ($linenr, $remain, $off) = @_;
1627
1628 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1629 return @r;
1630}
1631sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001632 my ($linenr, $remain) = @_;
1633
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001634 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001635}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001636sub ctx_statement_level {
1637 my ($linenr, $remain, $off) = @_;
1638
1639 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1640}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001641
1642sub ctx_locate_comment {
1643 my ($first_line, $end_line) = @_;
1644
1645 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001646 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001647 return $current_comment if (defined $current_comment);
1648
1649 # Look through the context and try and figure out if there is a
1650 # comment.
1651 my $in_comment = 0;
1652 $current_comment = '';
1653 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001654 my $line = $rawlines[$linenr - 1];
1655 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001656 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1657 $in_comment = 1;
1658 }
1659 if ($line =~ m@/\*@) {
1660 $in_comment = 1;
1661 }
1662 if (!$in_comment && $current_comment ne '') {
1663 $current_comment = '';
1664 }
1665 $current_comment .= $line . "\n" if ($in_comment);
1666 if ($line =~ m@\*/@) {
1667 $in_comment = 0;
1668 }
1669 }
1670
1671 chomp($current_comment);
1672 return($current_comment);
1673}
1674sub ctx_has_comment {
1675 my ($first_line, $end_line) = @_;
1676 my $cmt = ctx_locate_comment($first_line, $end_line);
1677
Andy Whitcroft00df3442007-06-08 13:47:06 -07001678 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001679 ##print "CMMT: $cmt\n";
1680
1681 return ($cmt ne '');
1682}
1683
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001684sub raw_line {
1685 my ($linenr, $cnt) = @_;
1686
1687 my $offset = $linenr - 1;
1688 $cnt++;
1689
1690 my $line;
1691 while ($cnt) {
1692 $line = $rawlines[$offset++];
1693 next if (defined($line) && $line =~ /^-/);
1694 $cnt--;
1695 }
1696
1697 return $line;
1698}
1699
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001700sub get_stat_real {
1701 my ($linenr, $lc) = @_;
1702
1703 my $stat_real = raw_line($linenr, 0);
1704 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1705 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1706 }
1707
1708 return $stat_real;
1709}
1710
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001711sub get_stat_here {
1712 my ($linenr, $cnt, $here) = @_;
1713
1714 my $herectx = $here . "\n";
1715 for (my $n = 0; $n < $cnt; $n++) {
1716 $herectx .= raw_line($linenr, $n) . "\n";
1717 }
1718
1719 return $herectx;
1720}
1721
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001722sub cat_vet {
1723 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001724 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001725
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001726 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001727 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1728 $res .= $1;
1729 if ($2 ne '') {
1730 $coded = sprintf("^%c", unpack('C', $2) + 64);
1731 $res .= $coded;
1732 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001733 }
1734 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001735
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001736 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001737}
1738
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001739my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001740my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001741my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001742my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001743
1744sub annotate_reset {
1745 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001746 $av_pending = '_';
1747 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001748 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001749}
1750
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001751sub annotate_values {
1752 my ($stream, $type) = @_;
1753
1754 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001755 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001756 my $cur = $stream;
1757
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001758 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001759
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001760 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001761 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001762 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001763 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001764 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001765 print "WS($1)\n" if ($dbg_values > 1);
1766 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001767 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001768 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001769 }
1770
Florian Micklerc023e4732011-01-12 16:59:58 -08001771 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001772 print "CAST($1)\n" if ($dbg_values > 1);
1773 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001774 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001775
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001776 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001777 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001778 $type = 'T';
1779
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001780 } elsif ($cur =~ /^($Modifier)\s*/) {
1781 print "MODIFIER($1)\n" if ($dbg_values > 1);
1782 $type = 'T';
1783
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001784 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001785 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001786 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001787 push(@av_paren_type, $type);
1788 if ($2 ne '') {
1789 $av_pending = 'N';
1790 }
1791 $type = 'E';
1792
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001793 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001794 print "UNDEF($1)\n" if ($dbg_values > 1);
1795 $av_preprocessor = 1;
1796 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001797
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001798 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001799 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001800 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001801
1802 push(@av_paren_type, $type);
1803 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001804 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001805
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001806 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001807 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1808 $av_preprocessor = 1;
1809
1810 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1811
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001812 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001813
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001814 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001815 print "PRE_END($1)\n" if ($dbg_values > 1);
1816
1817 $av_preprocessor = 1;
1818
1819 # Assume all arms of the conditional end as this
1820 # one does, and continue as if the #endif was not here.
1821 pop(@av_paren_type);
1822 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001823 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001824
1825 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001826 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001827
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001828 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1829 print "ATTR($1)\n" if ($dbg_values > 1);
1830 $av_pending = $type;
1831 $type = 'N';
1832
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001833 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001834 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001835 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001836 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001837 }
1838 $type = 'N';
1839
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001840 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001841 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001842 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001843 $type = 'N';
1844
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001845 } elsif ($cur =~/^(case)/o) {
1846 print "CASE($1)\n" if ($dbg_values > 1);
1847 $av_pend_colon = 'C';
1848 $type = 'N';
1849
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001850 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001851 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001852 $type = 'N';
1853
1854 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001855 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001856 push(@av_paren_type, $av_pending);
1857 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001858 $type = 'N';
1859
1860 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001861 my $new_type = pop(@av_paren_type);
1862 if ($new_type ne '_') {
1863 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001864 print "PAREN('$1') -> $type\n"
1865 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001866 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001867 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001868 }
1869
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001870 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001871 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001872 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001873 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001874
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001875 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1876 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001877 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001878 } elsif ($type eq 'E') {
1879 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001880 }
1881 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1882 $type = 'V';
1883
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001884 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001885 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001886 $type = 'V';
1887
1888 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001889 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001890 $type = 'N';
1891
Andy Whitcroftcf655042008-03-04 14:28:20 -08001892 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001893 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001894 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001895 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001896
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001897 } elsif ($cur =~/^(,)/) {
1898 print "COMMA($1)\n" if ($dbg_values > 1);
1899 $type = 'C';
1900
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001901 } elsif ($cur =~ /^(\?)/o) {
1902 print "QUESTION($1)\n" if ($dbg_values > 1);
1903 $type = 'N';
1904
1905 } elsif ($cur =~ /^(:)/o) {
1906 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1907
1908 substr($var, length($res), 1, $av_pend_colon);
1909 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1910 $type = 'E';
1911 } else {
1912 $type = 'N';
1913 }
1914 $av_pend_colon = 'O';
1915
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001916 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001917 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001918 $type = 'N';
1919
Andy Whitcroft0d413862008-10-15 22:02:16 -07001920 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001921 my $variant;
1922
1923 print "OPV($1)\n" if ($dbg_values > 1);
1924 if ($type eq 'V') {
1925 $variant = 'B';
1926 } else {
1927 $variant = 'U';
1928 }
1929
1930 substr($var, length($res), 1, $variant);
1931 $type = 'N';
1932
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001933 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001934 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001935 if ($1 ne '++' && $1 ne '--') {
1936 $type = 'N';
1937 }
1938
1939 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001940 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001941 }
1942 if (defined $1) {
1943 $cur = substr($cur, length($1));
1944 $res .= $type x length($1);
1945 }
1946 }
1947
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001948 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001949}
1950
Andy Whitcroft8905a672007-11-28 16:21:06 -08001951sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001952 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001953 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001954 ^(?:
1955 $Modifier|
1956 $Storage|
1957 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001958 DEFINE_\S+
1959 )$|
1960 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001961 goto|
1962 return|
1963 case|
1964 else|
1965 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001966 do|
1967 \#|
1968 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001969 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001970 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001971 )}x;
1972 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1973 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001974 # Check for modifiers.
1975 $possible =~ s/\s*$Storage\s*//g;
1976 $possible =~ s/\s*$Sparse\s*//g;
1977 if ($possible =~ /^\s*$/) {
1978
1979 } elsif ($possible =~ /\s/) {
1980 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001981 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001982 if ($modifier !~ $notPermitted) {
1983 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001984 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001985 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001986 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001987
1988 } else {
1989 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001990 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001991 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001992 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001993 } else {
1994 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001995 }
1996}
1997
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001998my $prefix = '';
1999
Joe Perches000d1cc12011-07-25 17:13:25 -07002000sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07002001 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002002
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002003 $type =~ tr/[a-z]/[A-Z]/;
2004
Joe Perchescbec18a2014-04-03 14:49:19 -07002005 return defined $use_type{$type} if (scalar keys %use_type > 0);
2006
2007 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002008}
2009
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002010sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002011 my ($level, $type, $msg) = @_;
2012
2013 if (!show_type($type) ||
2014 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002015 return 0;
2016 }
Joe Perches57230292015-06-25 15:03:03 -07002017 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002018 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002019 if ($level eq 'ERROR') {
2020 $output .= RED;
2021 } elsif ($level eq 'WARNING') {
2022 $output .= YELLOW;
2023 } else {
2024 $output .= GREEN;
2025 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002026 }
Joe Perches57230292015-06-25 15:03:03 -07002027 $output .= $prefix . $level . ':';
2028 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002029 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002030 $output .= "$type:";
2031 }
John Brooks737c0762017-07-10 15:52:24 -07002032 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002033 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002034
2035 if ($showfile) {
2036 my @lines = split("\n", $output, -1);
2037 splice(@lines, 1, 1);
2038 $output = join("\n", @lines);
2039 }
Joe Perches57230292015-06-25 15:03:03 -07002040 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002041
Joe Perches57230292015-06-25 15:03:03 -07002042 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002043
2044 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002045}
Joe Perchescbec18a2014-04-03 14:49:19 -07002046
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002047sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002048 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002049}
Joe Perches000d1cc12011-07-25 17:13:25 -07002050
Joe Perchesd752fcc2014-08-06 16:11:05 -07002051sub fixup_current_range {
2052 my ($lineRef, $offset, $length) = @_;
2053
2054 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2055 my $o = $1;
2056 my $l = $2;
2057 my $no = $o + $offset;
2058 my $nl = $l + $length;
2059 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2060 }
2061}
2062
2063sub fix_inserted_deleted_lines {
2064 my ($linesRef, $insertedRef, $deletedRef) = @_;
2065
2066 my $range_last_linenr = 0;
2067 my $delta_offset = 0;
2068
2069 my $old_linenr = 0;
2070 my $new_linenr = 0;
2071
2072 my $next_insert = 0;
2073 my $next_delete = 0;
2074
2075 my @lines = ();
2076
2077 my $inserted = @{$insertedRef}[$next_insert++];
2078 my $deleted = @{$deletedRef}[$next_delete++];
2079
2080 foreach my $old_line (@{$linesRef}) {
2081 my $save_line = 1;
2082 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002083 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002084 $delta_offset = 0;
2085 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2086 $range_last_linenr = $new_linenr;
2087 fixup_current_range(\$line, $delta_offset, 0);
2088 }
2089
2090 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2091 $deleted = @{$deletedRef}[$next_delete++];
2092 $save_line = 0;
2093 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2094 }
2095
2096 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2097 push(@lines, ${$inserted}{'LINE'});
2098 $inserted = @{$insertedRef}[$next_insert++];
2099 $new_linenr++;
2100 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2101 }
2102
2103 if ($save_line) {
2104 push(@lines, $line);
2105 $new_linenr++;
2106 }
2107
2108 $old_linenr++;
2109 }
2110
2111 return @lines;
2112}
2113
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002114sub fix_insert_line {
2115 my ($linenr, $line) = @_;
2116
2117 my $inserted = {
2118 LINENR => $linenr,
2119 LINE => $line,
2120 };
2121 push(@fixed_inserted, $inserted);
2122}
2123
2124sub fix_delete_line {
2125 my ($linenr, $line) = @_;
2126
2127 my $deleted = {
2128 LINENR => $linenr,
2129 LINE => $line,
2130 };
2131
2132 push(@fixed_deleted, $deleted);
2133}
2134
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002135sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002136 my ($type, $msg) = @_;
2137
2138 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002139 our $clean = 0;
2140 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002141 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002142 }
Joe Perches3705ce52013-07-03 15:05:31 -07002143 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002144}
2145sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002146 my ($type, $msg) = @_;
2147
2148 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002149 our $clean = 0;
2150 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002151 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002152 }
Joe Perches3705ce52013-07-03 15:05:31 -07002153 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002154}
2155sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002156 my ($type, $msg) = @_;
2157
2158 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002159 our $clean = 0;
2160 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002161 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002162 }
Joe Perches3705ce52013-07-03 15:05:31 -07002163 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002164}
2165
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002166sub check_absolute_file {
2167 my ($absolute, $herecurr) = @_;
2168 my $file = $absolute;
2169
2170 ##print "absolute<$absolute>\n";
2171
2172 # See if any suffix of this path is a path within the tree.
2173 while ($file =~ s@^[^/]*/@@) {
2174 if (-f "$root/$file") {
2175 ##print "file<$file>\n";
2176 last;
2177 }
2178 }
2179 if (! -f _) {
2180 return 0;
2181 }
2182
2183 # It is, so see if the prefix is acceptable.
2184 my $prefix = $absolute;
2185 substr($prefix, -length($file)) = '';
2186
2187 ##print "prefix<$prefix>\n";
2188 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002189 WARN("USE_RELATIVE_PATH",
2190 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002191 }
2192}
2193
Joe Perches3705ce52013-07-03 15:05:31 -07002194sub trim {
2195 my ($string) = @_;
2196
Joe Perchesb34c6482013-09-11 14:24:01 -07002197 $string =~ s/^\s+|\s+$//g;
2198
2199 return $string;
2200}
2201
2202sub ltrim {
2203 my ($string) = @_;
2204
2205 $string =~ s/^\s+//;
2206
2207 return $string;
2208}
2209
2210sub rtrim {
2211 my ($string) = @_;
2212
2213 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002214
2215 return $string;
2216}
2217
Joe Perches52ea8502013-11-12 15:10:09 -08002218sub string_find_replace {
2219 my ($string, $find, $replace) = @_;
2220
2221 $string =~ s/$find/$replace/g;
2222
2223 return $string;
2224}
2225
Joe Perches3705ce52013-07-03 15:05:31 -07002226sub tabify {
2227 my ($leading) = @_;
2228
2229 my $source_indent = 8;
2230 my $max_spaces_before_tab = $source_indent - 1;
2231 my $spaces_to_tab = " " x $source_indent;
2232
2233 #convert leading spaces to tabs
2234 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2235 #Remove spaces before a tab
2236 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2237
2238 return "$leading";
2239}
2240
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002241sub pos_last_openparen {
2242 my ($line) = @_;
2243
2244 my $pos = 0;
2245
2246 my $opens = $line =~ tr/\(/\(/;
2247 my $closes = $line =~ tr/\)/\)/;
2248
2249 my $last_openparen = 0;
2250
2251 if (($opens == 0) || ($closes >= $opens)) {
2252 return -1;
2253 }
2254
2255 my $len = length($line);
2256
2257 for ($pos = 0; $pos < $len; $pos++) {
2258 my $string = substr($line, $pos);
2259 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2260 $pos += length($1) - 1;
2261 } elsif (substr($line, $pos, 1) eq '(') {
2262 $last_openparen = $pos;
2263 } elsif (index($string, '(') == -1) {
2264 last;
2265 }
2266 }
2267
Joe Perches91cb5192014-04-03 14:49:32 -07002268 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002269}
2270
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002271sub process {
2272 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002273
2274 my $linenr=0;
2275 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002276 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002277 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002278 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002279
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002280 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002281 my $indent;
2282 my $previndent=0;
2283 my $stashindent=0;
2284
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002285 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002286 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002287 my $author = '';
2288 my $authorsignoff = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002289 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002290 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002291 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002292 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002293 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002294 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002295 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002296 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002297 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002298 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002299 my $non_utf8_charset = 0;
2300
Joe Perches365dd4e2014-08-06 16:10:42 -07002301 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002302 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002303
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002304 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002305 our $cnt_lines = 0;
2306 our $cnt_error = 0;
2307 our $cnt_warn = 0;
2308 our $cnt_chk = 0;
2309
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002310 # Trace the real file/line as we go.
2311 my $realfile = '';
2312 my $realline = 0;
2313 my $realcnt = 0;
2314 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002315 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002316 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002317 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002318 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002319 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002320
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002321 my $prev_values = 'E';
2322
2323 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002324 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002325 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002326 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002327 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002328
Joe Perches7e51f192013-09-11 14:23:57 -07002329 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002330
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002331 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002332 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002333 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002334 my @setup_docs = ();
2335 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002336
Joe Perchesd8b07712013-11-12 15:10:06 -08002337 my $camelcase_file_seeded = 0;
2338
Rob Herring9f3a8992018-04-10 16:33:13 -07002339 my $checklicenseline = 1;
2340
Andy Whitcroft773647a2008-03-28 14:15:58 -07002341 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002342 my $line;
2343 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002344 $linenr++;
2345 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002346
Joe Perches3705ce52013-07-03 15:05:31 -07002347 push(@fixed, $rawline) if ($fix);
2348
Andy Whitcroft773647a2008-03-28 14:15:58 -07002349 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002350 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002351 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002352 $setup_docs = 1;
2353 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002354 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002355 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002356 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002357 $realline=$1-1;
2358 if (defined $2) {
2359 $realcnt=$3+1;
2360 } else {
2361 $realcnt=1+1;
2362 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002363 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002364
2365 # Guestimate if this is a continuing comment. Run
2366 # the context looking for a comment "edge". If this
2367 # edge is a close comment then we must be in a comment
2368 # at context start.
2369 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002370 my $cnt = $realcnt;
2371 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2372 next if (defined $rawlines[$ln - 1] &&
2373 $rawlines[$ln - 1] =~ /^-/);
2374 $cnt--;
2375 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002376 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002377 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2378 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2379 ($edge) = $1;
2380 last;
2381 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002382 }
2383 if (defined $edge && $edge eq '*/') {
2384 $in_comment = 1;
2385 }
2386
2387 # Guestimate if this is a continuing comment. If this
2388 # is the start of a diff block and this line starts
2389 # ' *' then it is very likely a comment.
2390 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002391 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002392 {
2393 $in_comment = 1;
2394 }
2395
2396 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2397 sanitise_line_reset($in_comment);
2398
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002399 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002400 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002401 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002402 $line = sanitise_line($rawline);
2403 }
2404 push(@lines, $line);
2405
2406 if ($realcnt > 1) {
2407 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2408 } else {
2409 $realcnt = 0;
2410 }
2411
2412 #print "==>$rawline\n";
2413 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002414
2415 if ($setup_docs && $line =~ /^\+/) {
2416 push(@setup_docs, $line);
2417 }
2418 }
2419
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002420 $prefix = '';
2421
Andy Whitcroft773647a2008-03-28 14:15:58 -07002422 $realcnt = 0;
2423 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002424 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002425 foreach my $line (@lines) {
2426 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002427 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002428 my $sline = $line; #copy of $line
2429 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002430
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002431 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002432
Joe Perches12c253a2018-06-07 17:10:58 -07002433# check if it's a mode change, rename or start of a patch
2434 if (!$in_commit_log &&
2435 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2436 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2437 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2438 $is_patch = 1;
2439 }
2440
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002441#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002442 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002443 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2444 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002445 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002446 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002447 $realline=$1-1;
2448 if (defined $2) {
2449 $realcnt=$3+1;
2450 } else {
2451 $realcnt=1+1;
2452 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002453 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002454 $prev_values = 'E';
2455
Andy Whitcroft773647a2008-03-28 14:15:58 -07002456 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002457 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002458 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002459 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002460 if ($context =~ /\b(\w+)\s*\(/) {
2461 $context_function = $1;
2462 } else {
2463 undef $context_function;
2464 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002465 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002466
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002467# track the line number as we move through the hunk, note that
2468# new versions of GNU diff omit the leading space on completely
2469# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002470 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002471 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002472 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002473
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002474 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002475 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002476
2477 # Track the previous line.
2478 ($prevline, $stashline) = ($stashline, $line);
2479 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002480 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2481
Andy Whitcroft773647a2008-03-28 14:15:58 -07002482 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002483
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002484 } elsif ($realcnt == 1) {
2485 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002486 }
2487
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002488 my $hunk_line = ($realcnt != 0);
2489
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002490 $here = "#$linenr: " if (!$file);
2491 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002492
Joe Perches2ac73b42014-06-04 16:12:05 -07002493 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002494 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002495 if ($line =~ /^diff --git.*?(\S+)$/) {
2496 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002497 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002498 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002499 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002500 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002501 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002502 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002503 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002504
2505 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002506 if (!$file && $tree && $p1_prefix ne '' &&
2507 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002508 WARN("PATCH_PREFIX",
2509 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002510 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002511
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002512 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002513 ERROR("MODIFIED_INCLUDE_ASM",
2514 "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 -07002515 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002516 $found_file = 1;
2517 }
2518
Joe Perches34d88152015-06-25 15:03:05 -07002519#make up the handle for any error we report on this line
2520 if ($showfile) {
2521 $prefix = "$realfile:$realline: "
2522 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002523 if ($file) {
2524 $prefix = "$filename:$realline: ";
2525 } else {
2526 $prefix = "$filename:$linenr: ";
2527 }
Joe Perches34d88152015-06-25 15:03:05 -07002528 }
2529
Joe Perches2ac73b42014-06-04 16:12:05 -07002530 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002531 if (is_maintained_obsolete($realfile)) {
2532 WARN("OBSOLETE",
2533 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2534 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002535 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002536 $check = 1;
2537 } else {
2538 $check = $check_orig;
2539 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002540 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002541
2542 if ($realfile !~ /^MAINTAINERS/) {
2543 my $last_binding_patch = $is_binding_patch;
2544
2545 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2546
2547 if (($last_binding_patch != -1) &&
2548 ($last_binding_patch ^ $is_binding_patch)) {
2549 WARN("DT_SPLIT_BINDING_PATCH",
2550 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2551 }
2552 }
2553
Andy Whitcroft773647a2008-03-28 14:15:58 -07002554 next;
2555 }
2556
Randy Dunlap389834b2007-06-08 13:47:03 -07002557 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002558
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002559 my $hereline = "$here\n$rawline\n";
2560 my $herecurr = "$here\n$rawline\n";
2561 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002562
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002563 $cnt_lines++ if ($realcnt != 0);
2564
Joe Perches490b2922018-08-21 21:58:01 -07002565# Verify the existence of a commit log if appropriate
2566# 2 is used because a $signature is counted in $commit_log_lines
2567 if ($in_commit_log) {
2568 if ($line !~ /^\s*$/) {
2569 $commit_log_lines++; #could be a $signature
2570 }
2571 } elsif ($has_commit_log && $commit_log_lines < 2) {
2572 WARN("COMMIT_MESSAGE",
2573 "Missing commit description - Add an appropriate one\n");
2574 $commit_log_lines = 2; #warn only once
2575 }
2576
Joe Perchese518e9a2015-06-25 15:03:27 -07002577# Check if the commit log has what seems like a diff which can confuse patch
2578 if ($in_commit_log && !$commit_log_has_diff &&
2579 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2580 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2581 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2582 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2583 ERROR("DIFF_IN_COMMIT_MSG",
2584 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2585 $commit_log_has_diff = 1;
2586 }
2587
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002588# Check for incorrect file permissions
2589 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2590 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002591 if ($realfile !~ m@scripts/@ &&
2592 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002593 ERROR("EXECUTE_PERMISSIONS",
2594 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002595 }
2596 }
2597
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002598# Check the patch for a From:
2599 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2600 $author = $1;
2601 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2602 $author =~ s/"//g;
2603 }
2604
Joe Perches20112472011-07-25 17:13:23 -07002605# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002606 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002607 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002608 $in_commit_log = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002609 if ($author ne '') {
2610 my $l = $line;
2611 $l =~ s/"//g;
2612 if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) {
2613 $authorsignoff = 1;
2614 }
2615 }
Joe Perches20112472011-07-25 17:13:23 -07002616 }
2617
Joe Perchese0d975b2014-12-10 15:51:49 -08002618# Check if MAINTAINERS is being updated. If so, there's probably no need to
2619# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2620 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2621 $reported_maintainer_file = 1;
2622 }
2623
Joe Perches20112472011-07-25 17:13:23 -07002624# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002625 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002626 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002627 my $space_before = $1;
2628 my $sign_off = $2;
2629 my $space_after = $3;
2630 my $email = $4;
2631 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2632
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002633 if ($sign_off !~ /$signature_tags/) {
2634 WARN("BAD_SIGN_OFF",
2635 "Non-standard signature: $sign_off\n" . $herecurr);
2636 }
Joe Perches20112472011-07-25 17:13:23 -07002637 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002638 if (WARN("BAD_SIGN_OFF",
2639 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2640 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002641 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002642 "$ucfirst_sign_off $email";
2643 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002644 }
Joe Perches20112472011-07-25 17:13:23 -07002645 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002646 if (WARN("BAD_SIGN_OFF",
2647 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2648 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002649 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002650 "$ucfirst_sign_off $email";
2651 }
2652
Joe Perches20112472011-07-25 17:13:23 -07002653 }
2654 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002655 if (WARN("BAD_SIGN_OFF",
2656 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2657 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002658 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002659 "$ucfirst_sign_off $email";
2660 }
Joe Perches20112472011-07-25 17:13:23 -07002661 }
2662
2663 my ($email_name, $email_address, $comment) = parse_email($email);
2664 my $suggested_email = format_email(($email_name, $email_address));
2665 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002666 ERROR("BAD_SIGN_OFF",
2667 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002668 } else {
2669 my $dequoted = $suggested_email;
2670 $dequoted =~ s/^"//;
2671 $dequoted =~ s/" </ </;
2672 # Don't force email to have quotes
2673 # Allow just an angle bracketed address
2674 if ("$dequoted$comment" ne $email &&
2675 "<$email_address>$comment" ne $email &&
2676 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002677 WARN("BAD_SIGN_OFF",
2678 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002679 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002680 }
Joe Perches7e51f192013-09-11 14:23:57 -07002681
2682# Check for duplicate signatures
2683 my $sig_nospace = $line;
2684 $sig_nospace =~ s/\s//g;
2685 $sig_nospace = lc($sig_nospace);
2686 if (defined $signatures{$sig_nospace}) {
2687 WARN("BAD_SIGN_OFF",
2688 "Duplicate signature\n" . $herecurr);
2689 } else {
2690 $signatures{$sig_nospace} = 1;
2691 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07002692
2693# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2694 if ($sign_off =~ /^co-developed-by:$/i) {
2695 if ($email eq $author) {
2696 WARN("BAD_SIGN_OFF",
2697 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2698 }
2699 if (!defined $lines[$linenr]) {
2700 WARN("BAD_SIGN_OFF",
2701 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2702 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2703 WARN("BAD_SIGN_OFF",
2704 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2705 } elsif ($1 ne $email) {
2706 WARN("BAD_SIGN_OFF",
2707 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2708 }
2709 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002710 }
2711
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002712# Check email subject for common tools that don't need to be mentioned
2713 if ($in_header_lines &&
2714 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2715 WARN("EMAIL_SUBJECT",
2716 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2717 }
2718
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002719# Check for unwanted Gerrit info
2720 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2721 ERROR("GERRIT_CHANGE_ID",
2722 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2723 }
2724
Joe Perches369c8dd2015-11-06 16:31:34 -08002725# Check if the commit log is in a possible stack dump
2726 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2727 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2728 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2729 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07002730 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2731 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2732 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2733 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08002734 $commit_log_possible_stack_dump = 1;
2735 }
2736
Joe Perches2a076f42015-04-16 12:44:28 -07002737# Check for line lengths > 75 in commit log, warn once
2738 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002739 length($line) > 75 &&
2740 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2741 # file delta changes
2742 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2743 # filename then :
2744 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2745 # A Fixes: or Link: line
2746 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002747 WARN("COMMIT_LOG_LONG_LINE",
2748 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2749 $commit_log_long_line = 1;
2750 }
2751
Joe Perchesbf4daf12015-09-09 15:37:50 -07002752# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002753 if ($in_commit_log && $commit_log_possible_stack_dump &&
2754 $line =~ /^\s*$/) {
2755 $commit_log_possible_stack_dump = 0;
2756 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002757
Joe Perches0d7835f2015-02-13 14:38:35 -08002758# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002759 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002760 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002761 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002762 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002763 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002764 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2765 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002766 my $init_char = "c";
2767 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002768 my $short = 1;
2769 my $long = 0;
2770 my $case = 1;
2771 my $space = 1;
2772 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002773 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002774 my $id = '0123456789ab';
2775 my $orig_desc = "commit description";
2776 my $description = "";
2777
Joe Perchesfe043ea2015-09-09 15:37:25 -07002778 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2779 $init_char = $1;
2780 $orig_commit = lc($2);
2781 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2782 $orig_commit = lc($1);
2783 }
2784
Joe Perches0d7835f2015-02-13 14:38:35 -08002785 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2786 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2787 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2788 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2789 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2790 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002791 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002792 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2793 defined $rawlines[$linenr] &&
2794 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2795 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002796 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002797 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2798 defined $rawlines[$linenr] &&
2799 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2800 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2801 $orig_desc = $1;
2802 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2803 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002804 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002805 }
2806
2807 ($id, $description) = git_commit_info($orig_commit,
2808 $id, $orig_desc);
2809
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002810 if (defined($id) &&
2811 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002812 ERROR("GIT_COMMIT_ID",
2813 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2814 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002815 }
2816
Joe Perches13f19372014-08-06 16:10:59 -07002817# Check for added, moved or deleted files
2818 if (!$reported_maintainer_file && !$in_commit_log &&
2819 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2820 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2821 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2822 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002823 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002824 $reported_maintainer_file = 1;
2825 WARN("FILE_PATH_CHANGES",
2826 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2827 }
2828
Andy Whitcroft00df3442007-06-08 13:47:06 -07002829# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002830 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002831 ERROR("CORRUPTED_PATCH",
2832 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002833 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002834 }
2835
2836# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2837 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002838 $rawline !~ m/^$UTF8*$/) {
2839 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2840
2841 my $blank = copy_spacing($rawline);
2842 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2843 my $hereptr = "$hereline$ptr\n";
2844
Joe Perches34d99212011-07-25 17:13:26 -07002845 CHK("INVALID_UTF8",
2846 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002847 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002848
Joe Perches15662b32011-10-31 17:13:12 -07002849# Check if it's the start of a commit log
2850# (not a header line and we haven't seen the patch filename)
2851 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002852 !($rawline =~ /^\s+(?:\S|$)/ ||
2853 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002854 $in_header_lines = 0;
2855 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002856 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002857 }
2858
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002859# Check if there is UTF-8 in a commit log when a mail header has explicitly
2860# declined it, i.e defined some charset where it is missing.
2861 if ($in_header_lines &&
2862 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2863 $1 !~ /utf-8/i) {
2864 $non_utf8_charset = 1;
2865 }
2866
2867 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002868 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002869 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002870 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2871 }
2872
Joe Perchesd6430f72016-12-12 16:46:28 -08002873# Check for absolute kernel paths in commit message
2874 if ($tree && $in_commit_log) {
2875 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2876 my $file = $1;
2877
2878 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2879 check_absolute_file($1, $herecurr)) {
2880 #
2881 } else {
2882 check_absolute_file($file, $herecurr);
2883 }
2884 }
2885 }
2886
Kees Cook66b47b42014-10-13 15:51:57 -07002887# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002888 if (defined($misspellings) &&
2889 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002890 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002891 my $typo = $1;
2892 my $typo_fix = $spelling_fix{lc($typo)};
2893 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2894 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002895 my $msg_level = \&WARN;
2896 $msg_level = \&CHK if ($file);
2897 if (&{$msg_level}("TYPO_SPELLING",
2898 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002899 $fix) {
2900 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2901 }
2902 }
2903 }
2904
Matteo Crocea8dd86b2019-09-25 16:46:38 -07002905# check for invalid commit id
2906 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2907 my $id;
2908 my $description;
2909 ($id, $description) = git_commit_info($2, undef, undef);
2910 if (!defined($id)) {
2911 WARN("UNKNOWN_COMMIT_ID",
2912 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2913 }
2914 }
2915
Andy Whitcroft306708542008-10-15 22:02:28 -07002916# ignore non-hunk lines and lines being removed
2917 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002918
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002919#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002920 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002921 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002922 if (ERROR("DOS_LINE_ENDINGS",
2923 "DOS line endings\n" . $herevet) &&
2924 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002925 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002926 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002927 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2928 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002929 if (ERROR("TRAILING_WHITESPACE",
2930 "trailing whitespace\n" . $herevet) &&
2931 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002932 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002933 }
2934
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002935 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002936 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002937
Josh Triplett4783f892013-11-12 15:10:12 -08002938# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002939 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002940 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002941 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2942 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002943 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002944 my $msg_level = \&ERROR;
2945 $msg_level = \&CHK if ($file);
2946 &{$msg_level}("FSF_MAILING_ADDRESS",
2947 "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 -08002948 }
2949
Andi Kleen33549572010-05-24 14:33:29 -07002950# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002951# Only applies when adding the entry originally, after that we do not have
2952# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002953 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002954 # 'choice' is usually the last thing on the line (though
2955 # Kconfig supports named choices), so use a word boundary
2956 # (\b) rather than a whitespace character (\s)
2957 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002958 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002959 my $cnt = $realcnt;
2960 my $ln = $linenr + 1;
2961 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002962 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002963 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002964 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002965 $f = $lines[$ln - 1];
2966 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2967 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002968
2969 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002970 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002971
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002972 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002973 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002974 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2975 if ($lines[$ln - 1] =~ "---help---") {
2976 WARN("CONFIG_DESCRIPTION",
2977 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2978 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002979 $length = -1;
2980 }
2981
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002982 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002983 $f =~ s/#.*//;
2984 $f =~ s/^\s+//;
2985 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002986
2987 # This only checks context lines in the patch
2988 # and so hopefully shouldn't trigger false
2989 # positives, even though some of these are
2990 # common words in help texts
2991 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2992 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002993 $is_end = 1;
2994 last;
2995 }
Andi Kleen33549572010-05-24 14:33:29 -07002996 $length++;
2997 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002998 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2999 WARN("CONFIG_DESCRIPTION",
3000 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3001 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003002 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003003 }
3004
Joe Perches628f91a2017-07-10 15:52:07 -07003005# check for MAINTAINERS entries that don't have the right form
3006 if ($realfile =~ /^MAINTAINERS$/ &&
3007 $rawline =~ /^\+[A-Z]:/ &&
3008 $rawline !~ /^\+[A-Z]:\t\S/) {
3009 if (WARN("MAINTAINERS_STYLE",
3010 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3011 $fix) {
3012 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3013 }
3014 }
3015
Christoph Jaeger327953e2015-02-13 14:38:29 -08003016# discourage the use of boolean for type definition attributes of Kconfig options
3017 if ($realfile =~ /Kconfig/ &&
3018 $line =~ /^\+\s*\bboolean\b/) {
3019 WARN("CONFIG_TYPE_BOOLEAN",
3020 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3021 }
3022
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003023 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3024 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3025 my $flag = $1;
3026 my $replacement = {
3027 'EXTRA_AFLAGS' => 'asflags-y',
3028 'EXTRA_CFLAGS' => 'ccflags-y',
3029 'EXTRA_CPPFLAGS' => 'cppflags-y',
3030 'EXTRA_LDFLAGS' => 'ldflags-y',
3031 };
3032
3033 WARN("DEPRECATED_VARIABLE",
3034 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3035 }
3036
Rob Herringbff5da42014-01-23 15:54:51 -08003037# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003038 if (defined $root &&
3039 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3040 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3041
Rob Herringbff5da42014-01-23 15:54:51 -08003042 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3043
Florian Vaussardcc933192014-04-03 14:49:27 -07003044 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003045 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003046
Rob Herringbff5da42014-01-23 15:54:51 -08003047 foreach my $compat (@compats) {
3048 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003049 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3050 my $compat3 = $compat;
3051 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3052 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003053 if ( $? >> 8 ) {
3054 WARN("UNDOCUMENTED_DT_STRING",
3055 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3056 }
3057
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003058 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3059 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003060 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003061 if ( $? >> 8 ) {
3062 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003063 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003064 }
3065 }
3066 }
3067
Rob Herring9f3a8992018-04-10 16:33:13 -07003068# check for using SPDX license tag at beginning of files
3069 if ($realline == $checklicenseline) {
3070 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3071 $checklicenseline = 2;
3072 } elsif ($rawline =~ /^\+/) {
3073 my $comment = "";
3074 if ($realfile =~ /\.(h|s|S)$/) {
3075 $comment = '/*';
3076 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3077 $comment = '//';
3078 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
3079 $comment = '#';
3080 } elsif ($realfile =~ /\.rst$/) {
3081 $comment = '..';
3082 }
3083
Joe Perchesfdf13692019-03-07 16:28:32 -08003084# check SPDX comment style for .[chsS] files
3085 if ($realfile =~ /\.[chsS]$/ &&
3086 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003087 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003088 WARN("SPDX_LICENSE_TAG",
3089 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3090 }
3091
Rob Herring9f3a8992018-04-10 16:33:13 -07003092 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003093 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3094 WARN("SPDX_LICENSE_TAG",
3095 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003096 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003097 my $spdx_license = $1;
3098 if (!is_SPDX_License_valid($spdx_license)) {
3099 WARN("SPDX_LICENSE_TAG",
3100 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3101 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003102 }
3103 }
3104 }
3105
Andy Whitcroft5368df202008-10-15 22:02:27 -07003106# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003107 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003108
Joe Perchesa8da38a2019-03-07 16:28:42 -08003109# check for using SPDX-License-Identifier on the wrong line number
3110 if ($realline != $checklicenseline &&
3111 $rawline =~ /\bSPDX-License-Identifier:/ &&
3112 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3113 WARN("SPDX_LICENSE_TAG",
3114 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3115 }
3116
Joe Perches47e0c882015-06-25 15:02:57 -07003117# line length limit (with some exclusions)
3118#
3119# There are a few types of lines that may extend beyond $max_line_length:
3120# logging functions like pr_info that end in a string
3121# lines with a single string
3122# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003123# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003124#
3125# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003126# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003127# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3128# LONG_LINE all other lines longer than $max_line_length
3129#
3130# if LONG_LINE is ignored, the other 2 types are also ignored
3131#
3132
Joe Perchesb4749e92015-07-17 16:24:01 -07003133 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003134 my $msg_type = "LONG_LINE";
3135
3136 # Check the allowed long line types first
3137
3138 # logging functions that end in a string that starts
3139 # before $max_line_length
3140 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3141 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3142 $msg_type = "";
3143
3144 # lines with only strings (w/ possible termination)
3145 # #defines with only strings
3146 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3147 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3148 $msg_type = "";
3149
Joe Perchescc147502017-11-17 15:28:44 -08003150 # More special cases
3151 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3152 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003153 $msg_type = "";
3154
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003155 # URL ($rawline is used in case the URL is in a comment)
3156 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3157 $msg_type = "";
3158
Joe Perches47e0c882015-06-25 15:02:57 -07003159 # Otherwise set the alternate message types
3160
3161 # a comment starts before $max_line_length
3162 } elsif ($line =~ /($;[\s$;]*)$/ &&
3163 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3164 $msg_type = "LONG_LINE_COMMENT"
3165
3166 # a quoted string starts before $max_line_length
3167 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3168 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3169 $msg_type = "LONG_LINE_STRING"
3170 }
3171
3172 if ($msg_type ne "" &&
3173 (show_type("LONG_LINE") || show_type($msg_type))) {
3174 WARN($msg_type,
3175 "line over $max_line_length characters\n" . $herecurr);
3176 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003177 }
3178
Andy Whitcroft8905a672007-11-28 16:21:06 -08003179# check for adding lines without a newline.
3180 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003181 WARN("MISSING_EOF_NEWLINE",
3182 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003183 }
3184
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003185# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003186 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003187
3188# at the beginning of a line any tabs must come first and anything
3189# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003190 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3191 $rawline =~ /^\+\s* \s*/) {
3192 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003193 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003194 if (ERROR("CODE_INDENT",
3195 "code indent should use tabs where possible\n" . $herevet) &&
3196 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003197 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003198 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003199 }
3200
Alberto Panizzo08e44362010-03-05 13:43:54 -08003201# check for space before tabs.
3202 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3203 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003204 if (WARN("SPACE_BEFORE_TAB",
3205 "please, no space before tabs\n" . $herevet) &&
3206 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003207 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003208 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003209 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003210 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003211 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003212 }
3213
Joe Perches6a487212018-04-10 16:34:04 -07003214# check for assignments on the start of a line
3215 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3216 CHK("ASSIGNMENT_CONTINUATIONS",
3217 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3218 }
3219
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003220# check for && or || at the start of a line
3221 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3222 CHK("LOGICAL_CONTINUATIONS",
3223 "Logical continuations should be on the previous line\n" . $hereprev);
3224 }
3225
Joe Perchesa91e8992016-05-20 17:04:05 -07003226# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003227 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003228 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003229 my $indent = length($1);
3230 if ($indent % 8) {
3231 if (WARN("TABSTOP",
3232 "Statements should start on a tabstop\n" . $herecurr) &&
3233 $fix) {
3234 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3235 }
3236 }
3237 }
3238
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003239# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003240 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003241 $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 -07003242 $prevline =~ /^\+(\t*)(.*)$/;
3243 my $oldindent = $1;
3244 my $rest = $2;
3245
3246 my $pos = pos_last_openparen($rest);
3247 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003248 $line =~ /^(\+| )([ \t]*)/;
3249 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003250
3251 my $goodtabindent = $oldindent .
3252 "\t" x ($pos / 8) .
3253 " " x ($pos % 8);
3254 my $goodspaceindent = $oldindent . " " x $pos;
3255
3256 if ($newindent ne $goodtabindent &&
3257 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003258
3259 if (CHK("PARENTHESIS_ALIGNMENT",
3260 "Alignment should match open parenthesis\n" . $hereprev) &&
3261 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003262 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003263 s/^\+[ \t]*/\+$goodtabindent/;
3264 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003265 }
3266 }
3267 }
3268
Joe Perches6ab3a972015-04-16 12:44:05 -07003269# check for space after cast like "(int) foo" or "(struct foo) bar"
3270# avoid checking a few false positives:
3271# "sizeof(<type>)" or "__alignof__(<type>)"
3272# function pointer declarations like "(*foo)(int) = bar;"
3273# structure definitions like "(struct foo) { 0 };"
3274# multiline macros that define functions
3275# known attributes or the __attribute__ keyword
3276 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3277 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003278 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003279 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003280 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003281 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003282 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003283 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003284 }
3285
Joe Perches86406b12015-09-09 15:37:41 -07003286# Block comment styles
3287# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003288 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003289 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003290 $rawline =~ /^\+[ \t]*\*/ &&
3291 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003292 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3293 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3294 }
3295
Joe Perches86406b12015-09-09 15:37:41 -07003296# Block comments use * on subsequent lines
3297 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3298 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003299 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003300 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003301 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003302 WARN("BLOCK_COMMENT_STYLE",
3303 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003304 }
3305
Joe Perches86406b12015-09-09 15:37:41 -07003306# Block comments use */ on trailing lines
3307 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003308 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3309 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3310 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003311 WARN("BLOCK_COMMENT_STYLE",
3312 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003313 }
3314
Joe Perches08eb9b82016-10-11 13:51:50 -07003315# Block comment * alignment
3316 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003317 $line =~ /^\+[ \t]*$;/ && #leading comment
3318 $rawline =~ /^\+[ \t]*\*/ && #leading *
3319 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003320 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003321 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3322 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003323 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003324 if (defined($1)) {
3325 $oldindent = expand_tabs($1);
3326 } else {
3327 $prevrawline =~ m@^\+(.*/?)\*@;
3328 $oldindent = expand_tabs($1);
3329 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003330 $rawline =~ m@^\+([ \t]*)\*@;
3331 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003332 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003333 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003334 WARN("BLOCK_COMMENT_STYLE",
3335 "Block comments should align the * on each line\n" . $hereprev);
3336 }
3337 }
3338
Joe Perches7f619192014-08-06 16:10:39 -07003339# check for missing blank lines after struct/union declarations
3340# with exceptions for various attributes and macros
3341 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3342 $line =~ /^\+/ &&
3343 !($line =~ /^\+\s*$/ ||
3344 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3345 $line =~ /^\+\s*MODULE_/i ||
3346 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3347 $line =~ /^\+[a-z_]*init/ ||
3348 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3349 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003350 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003351 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003352 if (CHK("LINE_SPACING",
3353 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3354 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003355 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003356 }
Joe Perches7f619192014-08-06 16:10:39 -07003357 }
3358
Joe Perches365dd4e2014-08-06 16:10:42 -07003359# check for multiple consecutive blank lines
3360 if ($prevline =~ /^[\+ ]\s*$/ &&
3361 $line =~ /^\+\s*$/ &&
3362 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003363 if (CHK("LINE_SPACING",
3364 "Please don't use multiple blank lines\n" . $hereprev) &&
3365 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003366 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003367 }
3368
Joe Perches365dd4e2014-08-06 16:10:42 -07003369 $last_blank_line = $linenr;
3370 }
3371
Joe Perches3b617e32014-04-03 14:49:28 -07003372# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003373 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3374 # actual declarations
3375 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003376 # function pointer declarations
3377 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003378 # foo bar; where foo is some local typedef or #define
3379 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3380 # known declaration macros
3381 $prevline =~ /^\+\s+$declaration_macros/) &&
3382 # for "else if" which can look like "$Ident $Ident"
3383 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3384 # other possible extensions of declaration lines
3385 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3386 # not starting a section or a macro "\" extended line
3387 $prevline =~ /(?:\{\s*|\\)$/) &&
3388 # looks like a declaration
3389 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003390 # function pointer declarations
3391 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003392 # foo bar; where foo is some local typedef or #define
3393 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3394 # known declaration macros
3395 $sline =~ /^\+\s+$declaration_macros/ ||
3396 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003397 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003398 # start or end of block or continuation of declaration
3399 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3400 # bitfield continuation
3401 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3402 # other possible extensions of declaration lines
3403 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3404 # indentation of previous and current line are the same
3405 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003406 if (WARN("LINE_SPACING",
3407 "Missing a blank line after declarations\n" . $hereprev) &&
3408 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003409 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003410 }
Joe Perches3b617e32014-04-03 14:49:28 -07003411 }
3412
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003413# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003414# Exceptions:
3415# 1) within comments
3416# 2) indented preprocessor commands
3417# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003418 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003419 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003420 if (WARN("LEADING_SPACE",
3421 "please, no spaces at the start of a line\n" . $herevet) &&
3422 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003423 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003424 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003425 }
3426
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003427# check we are in a valid C source file if not then ignore this hunk
3428 next if ($realfile !~ /\.(h|c)$/);
3429
Joe Perches5751a242017-11-17 15:28:52 -08003430# check for unusual line ending [ or (
3431 if ($line =~ /^\+.*([\[\(])\s*$/) {
3432 CHK("OPEN_ENDED_LINE",
3433 "Lines should not end with a '$1'\n" . $herecurr);
3434 }
3435
Joe Perches4dbed762017-05-08 15:55:39 -07003436# check if this appears to be the start function declaration, save the name
3437 if ($sline =~ /^\+\{\s*$/ &&
3438 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3439 $context_function = $1;
3440 }
3441
3442# check if this appears to be the end of function declaration
3443 if ($sline =~ /^\+\}\s*$/) {
3444 undef $context_function;
3445 }
3446
Joe Perches032a4c02014-08-06 16:10:29 -07003447# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003448# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003449# if the previous line is a break or return and is indented 1 tab more...
3450 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3451 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003452 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3453 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3454 defined $lines[$linenr] &&
3455 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003456 WARN("UNNECESSARY_ELSE",
3457 "else is not generally useful after a break or return\n" . $hereprev);
3458 }
3459 }
3460
Joe Perchesc00df192014-08-06 16:11:01 -07003461# check indentation of a line with a break;
3462# if the previous line is a goto or return and is indented the same # of tabs
3463 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3464 my $tabs = $1;
3465 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3466 WARN("UNNECESSARY_BREAK",
3467 "break is not useful after a goto or return\n" . $hereprev);
3468 }
3469 }
3470
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003471# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003472 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003473 WARN("CVS_KEYWORD",
3474 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003475 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003476
Joe Perches56e77d72013-02-21 16:44:14 -08003477# check for old HOTPLUG __dev<foo> section markings
3478 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3479 WARN("HOTPLUG_SECTION",
3480 "Using $1 is unnecessary\n" . $herecurr);
3481 }
3482
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003483# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003484 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3485 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003486#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003487 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003488 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003489 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003490 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003491 $stat =~ s/\n./\n /g;
3492 $cond =~ s/\n./\n /g;
3493
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003494#print "linenr<$linenr> <$stat>\n";
3495 # If this statement has no statement boundaries within
3496 # it there is no point in retrying a statement scan
3497 # until we hit end of it.
3498 my $frag = $stat; $frag =~ s/;+\s*$//;
3499 if ($frag !~ /(?:{|;)/) {
3500#print "skip<$line_nr_next>\n";
3501 $suppress_statement = $line_nr_next;
3502 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003503
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003504 # Find the real next line.
3505 $realline_next = $line_nr_next;
3506 if (defined $realline_next &&
3507 (!defined $lines[$realline_next - 1] ||
3508 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3509 $realline_next++;
3510 }
3511
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003512 my $s = $stat;
3513 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003514
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003515 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003516 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003517
3518 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003519 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003520
Andy Whitcroft463f2862009-09-21 17:04:34 -07003521 } elsif ($s =~ /^.\s*else\b/s) {
3522
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003523 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003524 } 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 -07003525 my $type = $1;
3526 $type =~ s/\s+/ /g;
3527 possible($type, "A:" . $s);
3528
Andy Whitcroft8905a672007-11-28 16:21:06 -08003529 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003530 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003531 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003532 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003533
3534 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003535 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003536 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003537 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003538
3539 # Check for any sort of function declaration.
3540 # int foo(something bar, other baz);
3541 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003542 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 -08003543 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003544
Andy Whitcroftcf655042008-03-04 14:28:20 -08003545 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003546 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003547 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003548
Andy Whitcroft8905a672007-11-28 16:21:06 -08003549 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003550 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003551
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003552 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003553 }
3554 }
3555 }
3556
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003557 }
3558
Andy Whitcroft653d4872007-06-23 17:16:34 -07003559#
3560# Checks which may be anchored in the context.
3561#
3562
3563# Check for switch () and associated case and default
3564# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003565 if ($line=~/\bswitch\s*\(.*\)/) {
3566 my $err = '';
3567 my $sep = '';
3568 my @ctx = ctx_block_outer($linenr, $realcnt);
3569 shift(@ctx);
3570 for my $ctx (@ctx) {
3571 my ($clen, $cindent) = line_stats($ctx);
3572 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3573 $indent != $cindent) {
3574 $err .= "$sep$ctx\n";
3575 $sep = '';
3576 } else {
3577 $sep = "[...]\n";
3578 }
3579 }
3580 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003581 ERROR("SWITCH_CASE_INDENT_LEVEL",
3582 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003583 }
3584 }
3585
3586# if/while/etc brace do not go on next line, unless defining a do while loop,
3587# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003588 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 -07003589 my $pre_ctx = "$1$2";
3590
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003591 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003592
3593 if ($line =~ /^\+\t{6,}/) {
3594 WARN("DEEP_INDENTATION",
3595 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3596 }
3597
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003598 my $ctx_cnt = $realcnt - $#ctx - 1;
3599 my $ctx = join("\n", @ctx);
3600
Andy Whitcroft548596d2008-07-23 21:29:01 -07003601 my $ctx_ln = $linenr;
3602 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003603
Andy Whitcroft548596d2008-07-23 21:29:01 -07003604 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3605 defined $lines[$ctx_ln - 1] &&
3606 $lines[$ctx_ln - 1] =~ /^-/)) {
3607 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3608 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003609 $ctx_ln++;
3610 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003611
Andy Whitcroft53210162008-07-23 21:29:03 -07003612 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3613 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003614
Joe Perchesd752fcc2014-08-06 16:11:05 -07003615 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003616 ERROR("OPEN_BRACE",
3617 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003618 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003619 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003620 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3621 $ctx =~ /\)\s*\;\s*$/ &&
3622 defined $lines[$ctx_ln - 1])
3623 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003624 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3625 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003626 WARN("TRAILING_SEMICOLON",
3627 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003628 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003629 }
3630 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003631 }
3632
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003633# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003634 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 -08003635 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3636 ctx_statement_block($linenr, $realcnt, 0)
3637 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003638 my ($s, $c) = ($stat, $cond);
3639
3640 substr($s, 0, length($c), '');
3641
Joe Perches9f5af482015-09-09 15:37:30 -07003642 # remove inline comments
3643 $s =~ s/$;/ /g;
3644 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003645
3646 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003647 my @newlines = ($c =~ /\n/gs);
3648 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003649
Joe Perches9f5af482015-09-09 15:37:30 -07003650 # Make sure we remove the line prefixes as we have
3651 # none on the first line, and are going to readd them
3652 # where necessary.
3653 $s =~ s/\n./\n/gs;
3654 while ($s =~ /\n\s+\\\n/) {
3655 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3656 }
3657
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003658 # We want to check the first line inside the block
3659 # starting at the end of the conditional, so remove:
3660 # 1) any blank line termination
3661 # 2) any opening brace { on end of the line
3662 # 3) any do (...) {
3663 my $continuation = 0;
3664 my $check = 0;
3665 $s =~ s/^.*\bdo\b//;
3666 $s =~ s/^\s*{//;
3667 if ($s =~ s/^\s*\\//) {
3668 $continuation = 1;
3669 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003670 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003671 $check = 1;
3672 $cond_lines++;
3673 }
3674
3675 # Also ignore a loop construct at the end of a
3676 # preprocessor statement.
3677 if (($prevline =~ /^.\s*#\s*define\s/ ||
3678 $prevline =~ /\\\s*$/) && $continuation == 0) {
3679 $check = 0;
3680 }
3681
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003682 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003683 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003684 while ($cond_ptr != $cond_lines) {
3685 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003686
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003687 # If we see an #else/#elif then the code
3688 # is not linear.
3689 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3690 $check = 0;
3691 }
3692
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003693 # Ignore:
3694 # 1) blank lines, they should be at 0,
3695 # 2) preprocessor lines, and
3696 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003697 if ($continuation ||
3698 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003699 $s =~ /^\s*#\s*?/ ||
3700 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003701 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003702 if ($s =~ s/^.*?\n//) {
3703 $cond_lines++;
3704 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003705 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003706 }
3707
3708 my (undef, $sindent) = line_stats("+" . $s);
3709 my $stat_real = raw_line($linenr, $cond_lines);
3710
3711 # Check if either of these lines are modified, else
3712 # this is not this patch's fault.
3713 if (!defined($stat_real) ||
3714 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3715 $check = 0;
3716 }
3717 if (defined($stat_real) && $cond_lines > 1) {
3718 $stat_real = "[...]\n$stat_real";
3719 }
3720
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003721 #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 -07003722
Joe Perches9f5af482015-09-09 15:37:30 -07003723 if ($check && $s ne '' &&
3724 (($sindent % 8) != 0 ||
3725 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003726 ($sindent == $indent &&
3727 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003728 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003729 WARN("SUSPECT_CODE_INDENT",
3730 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003731 }
3732 }
3733
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003734 # Track the 'values' across context and added lines.
3735 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003736 my ($curr_values, $curr_vars) =
3737 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003738 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003739 if ($dbg_values) {
3740 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003741 print "$linenr > .$outline\n";
3742 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003743 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003744 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003745 $prev_values = substr($curr_values, -1);
3746
Andy Whitcroft00df3442007-06-08 13:47:06 -07003747#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003748 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003749
Joe Perches11ca40a2016-12-12 16:46:31 -08003750# check for dereferences that span multiple lines
3751 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3752 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3753 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3754 my $ref = $1;
3755 $line =~ /^.\s*($Lval)/;
3756 $ref .= $1;
3757 $ref =~ s/\s//g;
3758 WARN("MULTILINE_DEREFERENCE",
3759 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3760 }
3761
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003762# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003763 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 -07003764 my $type = $1;
3765 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003766 $var = "" if (!defined $var);
3767 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003768 my $sign = $1;
3769 my $pointer = $2;
3770
3771 $pointer = "" if (!defined $pointer);
3772
3773 if (WARN("UNSPECIFIED_INT",
3774 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3775 $fix) {
3776 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003777 my $comp_pointer = $pointer;
3778 $comp_pointer =~ s/\s//g;
3779 $decl .= $comp_pointer;
3780 $decl = rtrim($decl) if ($var eq "");
3781 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003782 }
3783 }
3784 }
3785
Andy Whitcroft653d4872007-06-23 17:16:34 -07003786# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003787 if ($dbg_type) {
3788 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003789 ERROR("TEST_TYPE",
3790 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003791 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003792 ERROR("TEST_NOT_TYPE",
3793 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003794 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003795 next;
3796 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003797# TEST: allow direct testing of the attribute matcher.
3798 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003799 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003800 ERROR("TEST_ATTR",
3801 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003802 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003803 ERROR("TEST_NOT_ATTR",
3804 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003805 }
3806 next;
3807 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003808
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003809# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003810 if ($line =~ /^.\s*{/ &&
3811 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003812 if (ERROR("OPEN_BRACE",
3813 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003814 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3815 fix_delete_line($fixlinenr - 1, $prevrawline);
3816 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003817 my $fixedline = $prevrawline;
3818 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003819 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003820 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003821 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003822 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003823 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003824 }
3825
Andy Whitcroft653d4872007-06-23 17:16:34 -07003826#
3827# Checks which are anchored on the added line.
3828#
3829
3830# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003831 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003832 my $path = $1;
3833 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003834 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003835 "malformed #include filename\n" . $herecurr);
3836 }
3837 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3838 ERROR("UAPI_INCLUDE",
3839 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003840 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003841 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003842
3843# no C99 // comments
3844 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003845 if (ERROR("C99_COMMENTS",
3846 "do not use C99 // comments\n" . $herecurr) &&
3847 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003848 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003849 if ($line =~ /\/\/(.*)$/) {
3850 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003851 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003852 }
3853 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003854 }
3855 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003856 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003857 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003858
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003859# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3860# the whole statement.
3861#print "APW <$lines[$realline_next - 1]>\n";
3862 if (defined $realline_next &&
3863 exists $lines[$realline_next - 1] &&
3864 !defined $suppress_export{$realline_next} &&
3865 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3866 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003867 # Handle definitions which produce identifiers with
3868 # a prefix:
3869 # XXX(foo);
3870 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003871 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003872 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003873 $name =~ /^${Ident}_$2/) {
3874#print "FOO C name<$name>\n";
3875 $suppress_export{$realline_next} = 1;
3876
3877 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003878 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003879 ^.DEFINE_$Ident\(\Q$name\E\)|
3880 ^.DECLARE_$Ident\(\Q$name\E\)|
3881 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003882 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3883 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003884 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003885#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3886 $suppress_export{$realline_next} = 2;
3887 } else {
3888 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003889 }
3890 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003891 if (!defined $suppress_export{$linenr} &&
3892 $prevline =~ /^.\s*$/ &&
3893 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3894 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3895#print "FOO B <$lines[$linenr - 1]>\n";
3896 $suppress_export{$linenr} = 2;
3897 }
3898 if (defined $suppress_export{$linenr} &&
3899 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003900 WARN("EXPORT_SYMBOL",
3901 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003902 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003903
Joe Eloff5150bda2010-08-09 17:21:00 -07003904# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003905 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003906 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003907 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003908 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003909 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003910 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003911 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003912# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003913 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003914 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003915 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003916 $herecurr) &&
3917 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003918 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003919 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003920 }
3921
Joe Perches18130872014-08-06 16:11:22 -07003922# check for misordered declarations of char/short/int/long with signed/unsigned
3923 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3924 my $tmp = trim($1);
3925 WARN("MISORDERED_TYPE",
3926 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3927 }
3928
Joe Perches809e0822018-08-21 21:58:12 -07003929# check for unnecessary <signed> int declarations of short/long/long long
3930 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
3931 my $type = trim($1);
3932 next if ($type !~ /\bint\b/);
3933 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
3934 my $new_type = $type;
3935 $new_type =~ s/\b\s*int\s*\b/ /;
3936 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
3937 $new_type =~ s/^const\s+//;
3938 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
3939 $new_type = "const $new_type" if ($type =~ /^const\b/);
3940 $new_type =~ s/\s+/ /g;
3941 $new_type = trim($new_type);
3942 if (WARN("UNNECESSARY_INT",
3943 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
3944 $fix) {
3945 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
3946 }
3947 }
3948
Joe Perchescb710ec2010-10-26 14:23:20 -07003949# check for static const char * arrays.
3950 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003951 WARN("STATIC_CONST_CHAR_ARRAY",
3952 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003953 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08003954 }
3955
3956# check for initialized const char arrays that should be static const
3957 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3958 if (WARN("STATIC_CONST_CHAR_ARRAY",
3959 "const array should probably be static const\n" . $herecurr) &&
3960 $fix) {
3961 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
3962 }
3963 }
Joe Perchescb710ec2010-10-26 14:23:20 -07003964
3965# check for static char foo[] = "bar" declarations.
3966 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003967 WARN("STATIC_CONST_CHAR_ARRAY",
3968 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003969 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08003970 }
Joe Perchescb710ec2010-10-26 14:23:20 -07003971
Joe Perchesab7e23f2015-04-16 12:44:22 -07003972# check for const <foo> const where <foo> is not a pointer or array type
3973 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3974 my $found = $1;
3975 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3976 WARN("CONST_CONST",
3977 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3978 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3979 WARN("CONST_CONST",
3980 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3981 }
3982 }
3983
Joe Perches9b0fa602014-04-03 14:49:18 -07003984# check for non-global char *foo[] = {"bar", ...} declarations.
3985 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3986 WARN("STATIC_CONST_CHAR_ARRAY",
3987 "char * array declaration might be better as static const\n" .
3988 $herecurr);
3989 }
3990
Joe Perchesb598b672015-04-16 12:44:36 -07003991# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3992 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3993 my $array = $1;
3994 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3995 my $array_div = $1;
3996 if (WARN("ARRAY_SIZE",
3997 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3998 $fix) {
3999 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4000 }
4001 }
4002 }
4003
Joe Perchesb36190c2014-01-27 17:07:18 -08004004# check for function declarations without arguments like "int foo()"
4005 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
4006 if (ERROR("FUNCTION_WITHOUT_ARGS",
4007 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4008 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004009 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004010 }
4011 }
4012
Andy Whitcroft653d4872007-06-23 17:16:34 -07004013# check for new typedefs, only function parameters and sparse annotations
4014# make sense.
4015 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004016 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004017 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004018 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004019 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004020 WARN("NEW_TYPEDEFS",
4021 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004022 }
4023
4024# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004025 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004026 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4027 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004028 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004029
Andy Whitcroft65863862009-01-06 14:41:21 -08004030 # Should start with a space.
4031 $to =~ s/^(\S)/ $1/;
4032 # Should not end with a space.
4033 $to =~ s/\s+$//;
4034 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004035 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004036 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004037
Joe Perches3705ce52013-07-03 15:05:31 -07004038## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004039 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004040 if (ERROR("POINTER_LOCATION",
4041 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4042 $fix) {
4043 my $sub_from = $ident;
4044 my $sub_to = $ident;
4045 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004046 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004047 s@\Q$sub_from\E@$sub_to@;
4048 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004049 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004050 }
4051 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4052 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004053 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004054
Andy Whitcroft65863862009-01-06 14:41:21 -08004055 # Should start with a space.
4056 $to =~ s/^(\S)/ $1/;
4057 # Should not end with a space.
4058 $to =~ s/\s+$//;
4059 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004060 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004061 }
4062 # Modifiers should have spaces.
4063 $to =~ s/(\b$Modifier$)/$1 /;
4064
Joe Perches3705ce52013-07-03 15:05:31 -07004065## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004066 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004067 if (ERROR("POINTER_LOCATION",
4068 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4069 $fix) {
4070
4071 my $sub_from = $match;
4072 my $sub_to = $match;
4073 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004074 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004075 s@\Q$sub_from\E@$sub_to@;
4076 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004077 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004078 }
4079
Joe Perches9d3e3c72015-09-09 15:37:27 -07004080# avoid BUG() or BUG_ON()
4081 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004082 my $msg_level = \&WARN;
4083 $msg_level = \&CHK if ($file);
4084 &{$msg_level}("AVOID_BUG",
4085 "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 -07004086 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004087
Joe Perches9d3e3c72015-09-09 15:37:27 -07004088# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004089 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004090 WARN("LINUX_VERSION_CODE",
4091 "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 -08004092 }
4093
Joe Perches17441222011-06-15 15:08:17 -07004094# check for uses of printk_ratelimit
4095 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004096 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004097 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004098 }
4099
Joe Percheseeef5732017-11-17 15:28:41 -08004100# printk should use KERN_* levels
4101 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4102 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4103 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004104 }
4105
Joe Perches243f3802012-05-31 16:26:09 -07004106 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4107 my $orig = $1;
4108 my $level = lc($orig);
4109 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004110 my $level2 = $level;
4111 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004112 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004113 "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 -07004114 }
4115
4116 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004117 if (WARN("PREFER_PR_LEVEL",
4118 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
4119 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004120 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004121 s/\bpr_warning\b/pr_warn/;
4122 }
Joe Perches243f3802012-05-31 16:26:09 -07004123 }
4124
Joe Perchesdc139312013-02-21 16:44:13 -08004125 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4126 my $orig = $1;
4127 my $level = lc($orig);
4128 $level = "warn" if ($level eq "warning");
4129 $level = "dbg" if ($level eq "debug");
4130 WARN("PREFER_DEV_LEVEL",
4131 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4132 }
4133
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004134# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4135# number of false positives, but assembly files are not checked, so at
4136# least the arch entry code will not trigger this warning.
4137 if ($line =~ /\bENOSYS\b/) {
4138 WARN("ENOSYS",
4139 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4140 }
4141
Andy Whitcroft653d4872007-06-23 17:16:34 -07004142# function brace can't be on same line, except for #defines of do while,
4143# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004144 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004145 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4146 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4147 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004148 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004149 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004150 $fix) {
4151 fix_delete_line($fixlinenr, $rawline);
4152 my $fixed_line = $rawline;
4153 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4154 my $line1 = $1;
4155 my $line2 = $2;
4156 fix_insert_line($fixlinenr, ltrim($line1));
4157 fix_insert_line($fixlinenr, "\+{");
4158 if ($line2 !~ /^\s*$/) {
4159 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4160 }
4161 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004162 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004163
Andy Whitcroft8905a672007-11-28 16:21:06 -08004164# open braces for enum, union and struct go on the same line.
4165 if ($line =~ /^.\s*{/ &&
4166 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004167 if (ERROR("OPEN_BRACE",
4168 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4169 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4170 fix_delete_line($fixlinenr - 1, $prevrawline);
4171 fix_delete_line($fixlinenr, $rawline);
4172 my $fixedline = rtrim($prevrawline) . " {";
4173 fix_insert_line($fixlinenr, $fixedline);
4174 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004175 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004176 if ($fixedline !~ /^\+\s*$/) {
4177 fix_insert_line($fixlinenr, $fixedline);
4178 }
4179 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004180 }
4181
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004182# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004183 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4184 if (WARN("SPACING",
4185 "missing space after $1 definition\n" . $herecurr) &&
4186 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004187 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004188 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4189 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004190 }
4191
Joe Perches31070b52014-01-23 15:54:49 -08004192# Function pointer declarations
4193# check spacing between type, funcptr, and args
4194# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004195 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004196 my $declare = $1;
4197 my $pre_pointer_space = $2;
4198 my $post_pointer_space = $3;
4199 my $funcname = $4;
4200 my $post_funcname_space = $5;
4201 my $pre_args_space = $6;
4202
Joe Perches91f72e92014-04-03 14:49:12 -07004203# the $Declare variable will capture all spaces after the type
4204# so check it for a missing trailing missing space but pointer return types
4205# don't need a space so don't warn for those.
4206 my $post_declare_space = "";
4207 if ($declare =~ /(\s+)$/) {
4208 $post_declare_space = $1;
4209 $declare = rtrim($declare);
4210 }
4211 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004212 WARN("SPACING",
4213 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004214 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004215 }
4216
4217# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004218# This test is not currently implemented because these declarations are
4219# equivalent to
4220# int foo(int bar, ...)
4221# and this is form shouldn't/doesn't generate a checkpatch warning.
4222#
4223# elsif ($declare =~ /\s{2,}$/) {
4224# WARN("SPACING",
4225# "Multiple spaces after return type\n" . $herecurr);
4226# }
Joe Perches31070b52014-01-23 15:54:49 -08004227
4228# unnecessary space "type ( *funcptr)(args...)"
4229 if (defined $pre_pointer_space &&
4230 $pre_pointer_space =~ /^\s/) {
4231 WARN("SPACING",
4232 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4233 }
4234
4235# unnecessary space "type (* funcptr)(args...)"
4236 if (defined $post_pointer_space &&
4237 $post_pointer_space =~ /^\s/) {
4238 WARN("SPACING",
4239 "Unnecessary space before function pointer name\n" . $herecurr);
4240 }
4241
4242# unnecessary space "type (*funcptr )(args...)"
4243 if (defined $post_funcname_space &&
4244 $post_funcname_space =~ /^\s/) {
4245 WARN("SPACING",
4246 "Unnecessary space after function pointer name\n" . $herecurr);
4247 }
4248
4249# unnecessary space "type (*funcptr) (args...)"
4250 if (defined $pre_args_space &&
4251 $pre_args_space =~ /^\s/) {
4252 WARN("SPACING",
4253 "Unnecessary space before function pointer arguments\n" . $herecurr);
4254 }
4255
4256 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004257 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004258 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004259 }
4260 }
4261
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004262# check for spacing round square brackets; allowed:
4263# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004264# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4265# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004266 while ($line =~ /(.*?\s)\[/g) {
4267 my ($where, $prefix) = ($-[1], $1);
4268 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004269 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004270 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004271 if (ERROR("BRACKET_SPACE",
4272 "space prohibited before open square bracket '['\n" . $herecurr) &&
4273 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004274 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004275 s/^(\+.*?)\s+\[/$1\[/;
4276 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004277 }
4278 }
4279
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004280# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004281 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004282 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004283 my $ctx_before = substr($line, 0, $-[1]);
4284 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004285
4286 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004287 if ($name =~ /^(?:
4288 if|for|while|switch|return|case|
4289 volatile|__volatile__|
4290 __attribute__|format|__extension__|
4291 asm|__asm__)$/x)
4292 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004293 # cpp #define statements have non-optional spaces, ie
4294 # if there is a space between the name and the open
4295 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004296 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004297
4298 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004299 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004300
4301 # If this whole things ends with a type its most
4302 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004303 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004304
4305 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004306 if (WARN("SPACING",
4307 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4308 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004309 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004310 s/\b$name\s+\(/$name\(/;
4311 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004312 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004313 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004314
Andy Whitcroft653d4872007-06-23 17:16:34 -07004315# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004316 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004317 my $fixed_line = "";
4318 my $line_fixed = 0;
4319
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004320 my $ops = qr{
4321 <<=|>>=|<=|>=|==|!=|
4322 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4323 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004324 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004325 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004326 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004327 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004328
4329## print("element count: <" . $#elements . ">\n");
4330## foreach my $el (@elements) {
4331## print("el: <$el>\n");
4332## }
4333
4334 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004335 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004336
Joe Perches3705ce52013-07-03 15:05:31 -07004337 foreach my $el (@elements) {
4338 push(@fix_elements, substr($rawline, $off, length($el)));
4339 $off += length($el);
4340 }
4341
4342 $off = 0;
4343
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004344 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004345 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004346
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004347 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004348
4349 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4350
4351## print("n: <$n> good: <$good>\n");
4352
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004353 $off += length($elements[$n]);
4354
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004355 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004356 my $ca = substr($opline, 0, $off);
4357 my $cc = '';
4358 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4359 $cc = substr($opline, $off + length($elements[$n + 1]));
4360 }
4361 my $cb = "$ca$;$cc";
4362
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004363 my $a = '';
4364 $a = 'V' if ($elements[$n] ne '');
4365 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004366 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004367 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4368 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004369 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004370
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004371 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004372
4373 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004374 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004375 $c = 'V' if ($elements[$n + 2] ne '');
4376 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004377 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004378 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4379 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004380 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004381 } else {
4382 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004383 }
4384
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004385 my $ctx = "${a}x${c}";
4386
4387 my $at = "(ctx:$ctx)";
4388
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004389 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004390 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004391
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004392 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004393 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004394
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004395 # Get the full operator variant.
4396 my $opv = $op . substr($curr_vars, $off, 1);
4397
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004398 # Ignore operators passed as parameters.
4399 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004400 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004401
Andy Whitcroftcf655042008-03-04 14:28:20 -08004402# # Ignore comments
4403# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004404
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004405 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004406 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004407 if ($ctx !~ /.x[WEBC]/ &&
4408 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004409 if (ERROR("SPACING",
4410 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004411 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004412 $line_fixed = 1;
4413 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004414 }
4415
4416 # // is a comment
4417 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004418
Joe Perchesb00e4812014-04-03 14:49:33 -07004419 # : when part of a bitfield
4420 } elsif ($opv eq ':B') {
4421 # skip the bitfield test for now
4422
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004423 # No spaces for:
4424 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004425 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004426 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004427 if (ERROR("SPACING",
4428 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004429 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004430 if (defined $fix_elements[$n + 2]) {
4431 $fix_elements[$n + 2] =~ s/^\s+//;
4432 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004433 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004434 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004435 }
4436
Joe Perches23810972014-12-10 15:51:32 -08004437 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004438 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004439 my $rtrim_before = 0;
4440 my $space_after = 0;
4441 if ($ctx =~ /Wx./) {
4442 if (ERROR("SPACING",
4443 "space prohibited before that '$op' $at\n" . $hereptr)) {
4444 $line_fixed = 1;
4445 $rtrim_before = 1;
4446 }
4447 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004448 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004449 if (ERROR("SPACING",
4450 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004451 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004452 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004453 $space_after = 1;
4454 }
4455 }
4456 if ($rtrim_before || $space_after) {
4457 if ($rtrim_before) {
4458 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4459 } else {
4460 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4461 }
4462 if ($space_after) {
4463 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004464 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004465 }
4466
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004467 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004468 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004469 #warn "'*' is part of type\n";
4470
4471 # unary operators should have a space before and
4472 # none after. May be left adjacent to another
4473 # unary operator, or a cast
4474 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004475 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004476 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004477 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004478 if (ERROR("SPACING",
4479 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004480 if ($n != $last_after + 2) {
4481 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4482 $line_fixed = 1;
4483 }
Joe Perches3705ce52013-07-03 15:05:31 -07004484 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004485 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004486 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004487 # A unary '*' may be const
4488
4489 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004490 if (ERROR("SPACING",
4491 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004492 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004493 if (defined $fix_elements[$n + 2]) {
4494 $fix_elements[$n + 2] =~ s/^\s+//;
4495 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004496 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004497 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004498 }
4499
4500 # unary ++ and unary -- are allowed no space on one side.
4501 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004502 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004503 if (ERROR("SPACING",
4504 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004505 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004506 $line_fixed = 1;
4507 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004508 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004509 if ($ctx =~ /Wx[BE]/ ||
4510 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004511 if (ERROR("SPACING",
4512 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004513 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004514 $line_fixed = 1;
4515 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004516 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004517 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004518 if (ERROR("SPACING",
4519 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004520 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004521 if (defined $fix_elements[$n + 2]) {
4522 $fix_elements[$n + 2] =~ s/^\s+//;
4523 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004524 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004525 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004526 }
4527
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004528 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004529 } elsif ($op eq '<<' or $op eq '>>' or
4530 $op eq '&' or $op eq '^' or $op eq '|' or
4531 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004532 $op eq '*' or $op eq '/' or
4533 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004534 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004535 if ($check) {
4536 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4537 if (CHK("SPACING",
4538 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4539 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4540 $fix_elements[$n + 2] =~ s/^\s+//;
4541 $line_fixed = 1;
4542 }
4543 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4544 if (CHK("SPACING",
4545 "space preferred before that '$op' $at\n" . $hereptr)) {
4546 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4547 $line_fixed = 1;
4548 }
4549 }
4550 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004551 if (ERROR("SPACING",
4552 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004553 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4554 if (defined $fix_elements[$n + 2]) {
4555 $fix_elements[$n + 2] =~ s/^\s+//;
4556 }
Joe Perches3705ce52013-07-03 15:05:31 -07004557 $line_fixed = 1;
4558 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004559 }
4560
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004561 # A colon needs no spaces before when it is
4562 # terminating a case value or a label.
4563 } elsif ($opv eq ':C' || $opv eq ':L') {
4564 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004565 if (ERROR("SPACING",
4566 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004567 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004568 $line_fixed = 1;
4569 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004570 }
4571
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004572 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004573 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004574 my $ok = 0;
4575
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004576 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004577 if (($op eq '<' &&
4578 $cc =~ /^\S+\@\S+>/) ||
4579 ($op eq '>' &&
4580 $ca =~ /<\S+\@\S+$/))
4581 {
4582 $ok = 1;
4583 }
4584
Joe Perchese0df7e12015-04-16 12:44:53 -07004585 # for asm volatile statements
4586 # ignore a colon with another
4587 # colon immediately before or after
4588 if (($op eq ':') &&
4589 ($ca =~ /:$/ || $cc =~ /^:/)) {
4590 $ok = 1;
4591 }
4592
Joe Perches84731622013-11-12 15:10:05 -08004593 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004594 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004595 my $msg_level = \&ERROR;
4596 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004597
Jean Delvare0675a8f2017-09-08 16:16:07 -07004598 if (&{$msg_level}("SPACING",
4599 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004600 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4601 if (defined $fix_elements[$n + 2]) {
4602 $fix_elements[$n + 2] =~ s/^\s+//;
4603 }
Joe Perches3705ce52013-07-03 15:05:31 -07004604 $line_fixed = 1;
4605 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004606 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004607 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004608 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004609
4610## print("n: <$n> GOOD: <$good>\n");
4611
4612 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004613 }
Joe Perches3705ce52013-07-03 15:05:31 -07004614
4615 if (($#elements % 2) == 0) {
4616 $fixed_line = $fixed_line . $fix_elements[$#elements];
4617 }
4618
Joe Perches194f66f2014-08-06 16:11:03 -07004619 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4620 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004621 }
4622
4623
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004624 }
4625
Joe Perches786b6322013-07-03 15:05:32 -07004626# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004627 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004628 if (WARN("SPACING",
4629 "space prohibited before semicolon\n" . $herecurr) &&
4630 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004631 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004632 s/^(\+.*\S)\s+;/$1;/;
4633 }
4634 }
4635
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004636# check for multiple assignments
4637 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004638 CHK("MULTIPLE_ASSIGNMENTS",
4639 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004640 }
4641
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004642## # check for multiple declarations, allowing for a function declaration
4643## # continuation.
4644## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4645## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4646##
4647## # Remove any bracketed sections to ensure we do not
4648## # falsly report the parameters of functions.
4649## my $ln = $line;
4650## while ($ln =~ s/\([^\(\)]*\)//g) {
4651## }
4652## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004653## WARN("MULTIPLE_DECLARATION",
4654## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004655## }
4656## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004657
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004658#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004659 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004660 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004661 if (ERROR("SPACING",
4662 "space required before the open brace '{'\n" . $herecurr) &&
4663 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004664 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004665 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004666 }
4667
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004668## # check for blank lines before declarations
4669## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4670## $prevrawline =~ /^.\s*$/) {
4671## WARN("SPACING",
4672## "No blank lines before declarations\n" . $hereprev);
4673## }
4674##
4675
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004676# closing brace should have a space following it when it has anything
4677# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07004678 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004679 if (ERROR("SPACING",
4680 "space required after that close brace '}'\n" . $herecurr) &&
4681 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004682 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004683 s/}((?!(?:,|;|\)))\S)/} $1/;
4684 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004685 }
4686
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004687# check spacing on square brackets
4688 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004689 if (ERROR("SPACING",
4690 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4691 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004692 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004693 s/\[\s+/\[/;
4694 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004695 }
4696 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004697 if (ERROR("SPACING",
4698 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4699 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004700 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004701 s/\s+\]/\]/;
4702 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004703 }
4704
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004705# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004706 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4707 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004708 if (ERROR("SPACING",
4709 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4710 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004711 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004712 s/\(\s+/\(/;
4713 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004714 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004715 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004716 $line !~ /for\s*\(.*;\s+\)/ &&
4717 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004718 if (ERROR("SPACING",
4719 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4720 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004721 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004722 s/\s+\)/\)/;
4723 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004724 }
4725
Joe Perchese2826fd2014-08-06 16:10:48 -07004726# check unnecessary parentheses around addressof/dereference single $Lvals
4727# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4728
4729 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004730 my $var = $1;
4731 if (CHK("UNNECESSARY_PARENTHESES",
4732 "Unnecessary parentheses around $var\n" . $herecurr) &&
4733 $fix) {
4734 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4735 }
4736 }
4737
4738# check for unnecessary parentheses around function pointer uses
4739# ie: (foo->bar)(); should be foo->bar();
4740# but not "if (foo->bar) (" to avoid some false positives
4741 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4742 my $var = $2;
4743 if (CHK("UNNECESSARY_PARENTHESES",
4744 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4745 $fix) {
4746 my $var2 = deparenthesize($var);
4747 $var2 =~ s/\s//g;
4748 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4749 }
4750 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004751
Joe Perches63b7c732017-09-08 16:16:01 -07004752# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004753# when !drivers/staging or command-line uses --strict
4754 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07004755 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004756 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4757 my $if_stat = $1;
4758 my $test = substr($2, 1, -1);
4759 my $herectx;
4760 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4761 my $match = $1;
4762 # avoid parentheses around potential macro args
4763 next if ($match =~ /^\s*\w+\s*$/);
4764 if (!defined($herectx)) {
4765 $herectx = $here . "\n";
4766 my $cnt = statement_rawlines($if_stat);
4767 for (my $n = 0; $n < $cnt; $n++) {
4768 my $rl = raw_line($linenr, $n);
4769 $herectx .= $rl . "\n";
4770 last if $rl =~ /^[ \+].*\{/;
4771 }
4772 }
4773 CHK("UNNECESSARY_PARENTHESES",
4774 "Unnecessary parentheses around '$match'\n" . $herectx);
4775 }
4776 }
4777
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004778#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004779 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004780 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004781 if (WARN("INDENTED_LABEL",
4782 "labels should not be indented\n" . $herecurr) &&
4783 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004784 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004785 s/^(.)\s+/$1/;
4786 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004787 }
4788
Joe Perches5b9553a2014-04-03 14:49:21 -07004789# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004790 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004791 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07004792 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004793 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4794 my $value = $1;
4795 $value = deparenthesize($value);
4796 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4797 ERROR("RETURN_PARENTHESES",
4798 "return is not a function, parentheses are not required\n" . $herecurr);
4799 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004800 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004801 ERROR("SPACING",
4802 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004803 }
4804 }
Joe Perches507e5142013-11-12 15:10:13 -08004805
Joe Perchesb43ae212014-06-23 13:22:07 -07004806# unnecessary return in a void function
4807# at end-of-function, with the previous line a single leading tab, then return;
4808# and the line before that not a goto label target like "out:"
4809 if ($sline =~ /^[ \+]}\s*$/ &&
4810 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4811 $linenr >= 3 &&
4812 $lines[$linenr - 3] =~ /^[ +]/ &&
4813 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004814 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004815 "void function return statements are not generally useful\n" . $hereprev);
4816 }
Joe Perches9819cf22014-06-04 16:12:09 -07004817
Joe Perches189248d2014-01-23 15:54:47 -08004818# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07004819 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08004820 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4821 my $openparens = $1;
4822 my $count = $openparens =~ tr@\(@\(@;
4823 my $msg = "";
4824 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4825 my $comp = $4; #Not $1 because of $LvalOrFunc
4826 $msg = " - maybe == should be = ?" if ($comp eq "==");
4827 WARN("UNNECESSARY_PARENTHESES",
4828 "Unnecessary parentheses$msg\n" . $herecurr);
4829 }
4830 }
4831
Joe Perchesc5595fa2015-09-09 15:37:58 -07004832# comparisons with a constant or upper case identifier on the left
4833# avoid cases like "foo + BAR < baz"
4834# only fix matches surrounded by parentheses to avoid incorrect
4835# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07004836 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004837 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4838 my $lead = $1;
4839 my $const = $2;
4840 my $comp = $3;
4841 my $to = $4;
4842 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004843 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004844 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4845 WARN("CONSTANT_COMPARISON",
4846 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4847 $fix) {
4848 if ($comp eq "<") {
4849 $newcomp = ">";
4850 } elsif ($comp eq "<=") {
4851 $newcomp = ">=";
4852 } elsif ($comp eq ">") {
4853 $newcomp = "<";
4854 } elsif ($comp eq ">=") {
4855 $newcomp = "<=";
4856 }
4857 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4858 }
4859 }
4860
Joe Perchesf34e4a42015-04-16 12:44:19 -07004861# Return of what appears to be an errno should normally be negative
4862 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004863 my $name = $1;
4864 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004865 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004866 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004867 }
4868 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004869
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004870# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004871 if ($line =~ /\b(if|while|for|switch)\(/) {
4872 if (ERROR("SPACING",
4873 "space required before the open parenthesis '('\n" . $herecurr) &&
4874 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004875 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004876 s/\b(if|while|for|switch)\(/$1 \(/;
4877 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004878 }
4879
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004880# Check for illegal assignment in if conditional -- and check for trailing
4881# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004882 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004883 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4884 ctx_statement_block($linenr, $realcnt, 0)
4885 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004886 my ($stat_next) = ctx_statement_block($line_nr_next,
4887 $remain_next, $off_next);
4888 $stat_next =~ s/\n./\n /g;
4889 ##print "stat<$stat> stat_next<$stat_next>\n";
4890
4891 if ($stat_next =~ /^\s*while\b/) {
4892 # If the statement carries leading newlines,
4893 # then count those as offsets.
4894 my ($whitespace) =
4895 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4896 my $offset =
4897 statement_rawlines($whitespace) - 1;
4898
4899 $suppress_whiletrailers{$line_nr_next +
4900 $offset} = 1;
4901 }
4902 }
4903 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004904 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004905 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004906 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004907
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004908 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004909 ERROR("ASSIGN_IN_IF",
4910 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004911 }
4912
4913 # Find out what is on the end of the line after the
4914 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004915 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004916 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004917 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004918 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4919 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004920 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004921 # Find out how long the conditional actually is.
4922 my @newlines = ($c =~ /\n/gs);
4923 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004924 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004925
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004926 $stat_real = raw_line($linenr, $cond_lines)
4927 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004928 if (defined($stat_real) && $cond_lines > 1) {
4929 $stat_real = "[...]\n$stat_real";
4930 }
4931
Joe Perches000d1cc12011-07-25 17:13:25 -07004932 ERROR("TRAILING_STATEMENTS",
4933 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004934 }
4935 }
4936
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004937# Check for bitwise tests written as boolean
4938 if ($line =~ /
4939 (?:
4940 (?:\[|\(|\&\&|\|\|)
4941 \s*0[xX][0-9]+\s*
4942 (?:\&\&|\|\|)
4943 |
4944 (?:\&\&|\|\|)
4945 \s*0[xX][0-9]+\s*
4946 (?:\&\&|\|\||\)|\])
4947 )/x)
4948 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004949 WARN("HEXADECIMAL_BOOLEAN_TEST",
4950 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004951 }
4952
Andy Whitcroft8905a672007-11-28 16:21:06 -08004953# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004954 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4955 my $s = $1;
4956 $s =~ s/$;//g; # Remove any comments
4957 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004958 ERROR("TRAILING_STATEMENTS",
4959 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004960 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004961 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004962# if should not continue a brace
4963 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004964 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004965 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004966 $herecurr);
4967 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004968# case and default should not have general statements after them
4969 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4970 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004971 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004972 \s*return\s+
4973 )/xg)
4974 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004975 ERROR("TRAILING_STATEMENTS",
4976 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004977 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004978
4979 # Check for }<nl>else {, these must be at the same
4980 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004981 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4982 $previndent == $indent) {
4983 if (ERROR("ELSE_AFTER_BRACE",
4984 "else should follow close brace '}'\n" . $hereprev) &&
4985 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4986 fix_delete_line($fixlinenr - 1, $prevrawline);
4987 fix_delete_line($fixlinenr, $rawline);
4988 my $fixedline = $prevrawline;
4989 $fixedline =~ s/}\s*$//;
4990 if ($fixedline !~ /^\+\s*$/) {
4991 fix_insert_line($fixlinenr, $fixedline);
4992 }
4993 $fixedline = $rawline;
4994 $fixedline =~ s/^(.\s*)else/$1} else/;
4995 fix_insert_line($fixlinenr, $fixedline);
4996 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004997 }
4998
Joe Perches8b8856f2014-08-06 16:11:14 -07004999 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5000 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005001 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5002
5003 # Find out what is on the end of the line after the
5004 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005005 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005006 $s =~ s/\n.*//g;
5007
5008 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005009 if (ERROR("WHILE_AFTER_BRACE",
5010 "while should follow close brace '}'\n" . $hereprev) &&
5011 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5012 fix_delete_line($fixlinenr - 1, $prevrawline);
5013 fix_delete_line($fixlinenr, $rawline);
5014 my $fixedline = $prevrawline;
5015 my $trailing = $rawline;
5016 $trailing =~ s/^\+//;
5017 $trailing = trim($trailing);
5018 $fixedline =~ s/}\s*$/} $trailing/;
5019 fix_insert_line($fixlinenr, $fixedline);
5020 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005021 }
5022 }
5023
Joe Perches95e2c602013-07-03 15:05:20 -07005024#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005025 while ($line =~ m{($Constant|$Lval)}g) {
5026 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005027
Joe Perches95e2c602013-07-03 15:05:20 -07005028#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005029 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005030 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005031#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005032 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005033#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08005034 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
5035#Ignore some three character SI units explicitly, like MiB and KHz
5036 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005037 while ($var =~ m{($Ident)}g) {
5038 my $word = $1;
5039 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005040 if ($check) {
5041 seed_camelcase_includes();
5042 if (!$file && !$camelcase_file_seeded) {
5043 seed_camelcase_file($realfile);
5044 $camelcase_file_seeded = 1;
5045 }
5046 }
Joe Perches7e781f62013-09-11 14:23:55 -07005047 if (!defined $camelcase{$word}) {
5048 $camelcase{$word} = 1;
5049 CHK("CAMELCASE",
5050 "Avoid CamelCase: <$word>\n" . $herecurr);
5051 }
Joe Perches34456862013-07-03 15:05:34 -07005052 }
Joe Perches323c1262012-12-17 16:02:07 -08005053 }
5054 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005055
5056#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005057 if ($line =~ /\#\s*define.*\\\s+$/) {
5058 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5059 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5060 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005061 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005062 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005063 }
5064
Fabian Frederick0e212e02015-04-16 12:44:25 -07005065# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5066# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005067 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005068 my $file = "$1.h";
5069 my $checkfile = "include/linux/$file";
5070 if (-f "$root/$checkfile" &&
5071 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005072 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005073 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005074 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5075 if ($asminclude > 0) {
5076 if ($realfile =~ m{^arch/}) {
5077 CHK("ARCH_INCLUDE_LINUX",
5078 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5079 } else {
5080 WARN("INCLUDE_LINUX",
5081 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5082 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005083 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005084 }
5085 }
5086
Andy Whitcroft653d4872007-06-23 17:16:34 -07005087# multi-statement macros should be enclosed in a do while loop, grab the
5088# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005089# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07005090 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5091 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005092 my $ln = $linenr;
5093 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005094 my ($off, $dstat, $dcond, $rest);
5095 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005096 my $has_flow_statement = 0;
5097 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005098 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005099 ctx_statement_block($linenr, $realcnt, 0);
5100 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005101 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005102 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005103
Joe Perches08a28432014-10-13 15:51:55 -07005104 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005105 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005106
Joe Perchesf59b64b2016-10-11 13:52:08 -07005107 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5108 my $define_args = $1;
5109 my $define_stmt = $dstat;
5110 my @def_args = ();
5111
5112 if (defined $define_args && $define_args ne "") {
5113 $define_args = substr($define_args, 1, length($define_args) - 2);
5114 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005115 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005116 @def_args = split(",", $define_args);
5117 }
5118
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005119 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005120 $dstat =~ s/\\\n.//g;
5121 $dstat =~ s/^\s*//s;
5122 $dstat =~ s/\s*$//s;
5123
5124 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005125 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5126 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005127 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005128 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005129 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005130
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005131 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07005132 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5133 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005134 {
5135 }
5136
Joe Perches42e15292016-03-15 14:58:01 -07005137 # Make asm volatile uses seem like a generic function
5138 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5139
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005140 my $exceptions = qr{
5141 $Declare|
5142 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005143 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005144 DECLARE_PER_CPU|
5145 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005146 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005147 union|
5148 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005149 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005150 ^\"|\"$|
5151 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005152 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005153 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005154
5155 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005156 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005157 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005158
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005159 if ($dstat ne '' &&
5160 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5161 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005162 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005163 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005164 $dstat !~ /$exceptions/ &&
5165 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005166 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005167 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005168 $dstat !~ /^for\s*$Constant$/ && # for (...)
5169 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5170 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005171 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005172 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005173 {
Joe Perchese7955562017-05-08 15:55:48 -07005174 if ($dstat =~ /^\s*if\b/) {
5175 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5176 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5177 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005178 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5179 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5180 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005181 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005182 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005183 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005184
5185 }
Joe Perches52076492016-10-11 13:52:14 -07005186
5187 # Make $define_stmt single line, comment-free, etc
5188 my @stmt_array = split('\n', $define_stmt);
5189 my $first = 1;
5190 $define_stmt = "";
5191 foreach my $l (@stmt_array) {
5192 $l =~ s/\\$//;
5193 if ($first) {
5194 $define_stmt = $l;
5195 $first = 0;
5196 } elsif ($l =~ /^[\+ ]/) {
5197 $define_stmt .= substr($l, 1);
5198 }
5199 }
5200 $define_stmt =~ s/$;//g;
5201 $define_stmt =~ s/\s+/ /g;
5202 $define_stmt = trim($define_stmt);
5203
Joe Perchesf59b64b2016-10-11 13:52:08 -07005204# check if any macro arguments are reused (ignore '...' and 'type')
5205 foreach my $arg (@def_args) {
5206 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005207 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005208 my $tmp_stmt = $define_stmt;
Brendan Jackman6dba8242019-09-25 16:46:41 -07005209 $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 -07005210 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5211 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005212 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005213 if ($use_cnt > 1) {
5214 CHK("MACRO_ARG_REUSE",
5215 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005216 }
5217# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005218 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005219 ((defined($1) && $1 ne ',') ||
5220 (defined($2) && $2 ne ','))) {
5221 CHK("MACRO_ARG_PRECEDENCE",
5222 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005223 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005224 }
Joe Perches5023d342012-12-17 16:01:47 -08005225
Joe Perches08a28432014-10-13 15:51:55 -07005226# check for macros with flow control, but without ## concatenation
5227# ## concatenation is commonly a macro that defines a function so ignore those
5228 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005229 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005230 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005231
Joe Perches08a28432014-10-13 15:51:55 -07005232 WARN("MACRO_WITH_FLOW_CONTROL",
5233 "Macros with flow control statements should be avoided\n" . "$herectx");
5234 }
5235
Joe Perches481eb482012-12-17 16:01:56 -08005236# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005237
5238 } else {
5239 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005240 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5241 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005242 $line =~ /^\+.*\\$/) {
5243 WARN("LINE_CONTINUATIONS",
5244 "Avoid unnecessary line continuations\n" . $herecurr);
5245 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005246 }
5247
Joe Perchesb13edf72012-07-30 14:41:24 -07005248# do {} while (0) macro tests:
5249# single-statement macros do not need to be enclosed in do while (0) loop,
5250# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005251 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005252 $realfile !~ m@/vmlinux.lds.h$@ &&
5253 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5254 my $ln = $linenr;
5255 my $cnt = $realcnt;
5256 my ($off, $dstat, $dcond, $rest);
5257 my $ctx = '';
5258 ($dstat, $dcond, $ln, $cnt, $off) =
5259 ctx_statement_block($linenr, $realcnt, 0);
5260 $ctx = $dstat;
5261
5262 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005263 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005264
5265 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5266 my $stmts = $2;
5267 my $semis = $3;
5268
5269 $ctx =~ s/\n*$//;
5270 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005271 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005272
Joe Perchesac8e97f2012-08-21 16:15:53 -07005273 if (($stmts =~ tr/;/;/) == 1 &&
5274 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005275 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5276 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5277 }
5278 if (defined $semis && $semis ne "") {
5279 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5280 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5281 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005282 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5283 $ctx =~ s/\n*$//;
5284 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005285 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005286
5287 WARN("TRAILING_SEMICOLON",
5288 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005289 }
5290 }
5291
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005292# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005293 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5294 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005295 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005296 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005297 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5298 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005299 my @allowed = ();
5300 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005301 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005302 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005303 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005304 for my $chunk (@chunks) {
5305 my ($cond, $block) = @{$chunk};
5306
Andy Whitcroft773647a2008-03-28 14:15:58 -07005307 # If the condition carries leading newlines, then count those as offsets.
5308 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5309 my $offset = statement_rawlines($whitespace) - 1;
5310
Joe Perchesaad4f612012-03-23 15:02:19 -07005311 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005312 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5313
5314 # We have looked at and allowed this specific line.
5315 $suppress_ifbraces{$ln + $offset} = 1;
5316
5317 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005318 $ln += statement_rawlines($block) - 1;
5319
Andy Whitcroft773647a2008-03-28 14:15:58 -07005320 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005321
5322 $seen++ if ($block =~ /^\s*{/);
5323
Joe Perchesaad4f612012-03-23 15:02:19 -07005324 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005325 if (statement_lines($cond) > 1) {
5326 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005327 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005328 }
5329 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005330 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005331 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005332 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005333 if (statement_block_size($block) > 1) {
5334 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005335 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005336 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005337 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005338 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005339 if ($seen) {
5340 my $sum_allowed = 0;
5341 foreach (@allowed) {
5342 $sum_allowed += $_;
5343 }
5344 if ($sum_allowed == 0) {
5345 WARN("BRACES",
5346 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5347 } elsif ($sum_allowed != $allow &&
5348 $seen != $allow) {
5349 CHK("BRACES",
5350 "braces {} should be used on all arms of this statement\n" . $herectx);
5351 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005352 }
5353 }
5354 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005355 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005356 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005357 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005358
Andy Whitcroftcf655042008-03-04 14:28:20 -08005359 # Check the pre-context.
5360 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5361 #print "APW: ALLOWED: pre<$1>\n";
5362 $allowed = 1;
5363 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005364
5365 my ($level, $endln, @chunks) =
5366 ctx_statement_full($linenr, $realcnt, $-[0]);
5367
Andy Whitcroftcf655042008-03-04 14:28:20 -08005368 # Check the condition.
5369 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005370 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005371 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005372 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005373 }
5374 if (statement_lines($cond) > 1) {
5375 #print "APW: ALLOWED: cond<$cond>\n";
5376 $allowed = 1;
5377 }
5378 if ($block =~/\b(?:if|for|while)\b/) {
5379 #print "APW: ALLOWED: block<$block>\n";
5380 $allowed = 1;
5381 }
5382 if (statement_block_size($block) > 1) {
5383 #print "APW: ALLOWED: lines block<$block>\n";
5384 $allowed = 1;
5385 }
5386 # Check the post-context.
5387 if (defined $chunks[1]) {
5388 my ($cond, $block) = @{$chunks[1]};
5389 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005390 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005391 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005392 if ($block =~ /^\s*\{/) {
5393 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5394 $allowed = 1;
5395 }
5396 }
5397 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005398 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005399 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005400
Joe Perches000d1cc12011-07-25 17:13:25 -07005401 WARN("BRACES",
5402 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005403 }
5404 }
5405
Joe Perchese4c5bab2017-02-24 15:01:41 -08005406# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005407 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5408 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005409 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5410 }
5411
Joe Perches0979ae62012-12-17 16:01:59 -08005412# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005413 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005414 if (CHK("BRACES",
5415 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5416 $fix && $prevrawline =~ /^\+/) {
5417 fix_delete_line($fixlinenr - 1, $prevrawline);
5418 }
Joe Perches0979ae62012-12-17 16:01:59 -08005419 }
Joe Perches77b9a532013-07-03 15:05:29 -07005420 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005421 if (CHK("BRACES",
5422 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5423 $fix) {
5424 fix_delete_line($fixlinenr, $rawline);
5425 }
Joe Perches0979ae62012-12-17 16:01:59 -08005426 }
5427
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005428# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005429 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5430 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005431 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005432 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005433 }
5434
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005435# Check for user-visible strings broken across lines, which breaks the ability
5436# to grep for the string. Make exceptions when the previous string ends in a
5437# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5438# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005439 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005440 $prevline =~ /"\s*$/ &&
5441 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5442 if (WARN("SPLIT_STRING",
5443 "quoted string split across lines\n" . $hereprev) &&
5444 $fix &&
5445 $prevrawline =~ /^\+.*"\s*$/ &&
5446 $last_coalesced_string_linenr != $linenr - 1) {
5447 my $extracted_string = get_quoted_string($line, $rawline);
5448 my $comma_close = "";
5449 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5450 $comma_close = $1;
5451 }
5452
5453 fix_delete_line($fixlinenr - 1, $prevrawline);
5454 fix_delete_line($fixlinenr, $rawline);
5455 my $fixedline = $prevrawline;
5456 $fixedline =~ s/"\s*$//;
5457 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5458 fix_insert_line($fixlinenr - 1, $fixedline);
5459 $fixedline = $rawline;
5460 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5461 if ($fixedline !~ /\+\s*$/) {
5462 fix_insert_line($fixlinenr, $fixedline);
5463 }
5464 $last_coalesced_string_linenr = $linenr;
5465 }
5466 }
5467
5468# check for missing a space in a string concatenation
5469 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5470 WARN('MISSING_SPACE',
5471 "break quoted strings at a space character\n" . $hereprev);
5472 }
5473
Joe Perchese4b7d302017-05-08 15:55:51 -07005474# check for an embedded function name in a string when the function is known
5475# This does not work very well for -f --file checking as it depends on patch
5476# context providing the function name or a single line form for in-file
5477# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005478 if ($line =~ /^\+.*$String/ &&
5479 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005480 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5481 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005482 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005483 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005484 }
5485
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005486# check for spaces before a quoted newline
5487 if ($rawline =~ /^.*\".*\s\\n/) {
5488 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5489 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5490 $fix) {
5491 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5492 }
5493
5494 }
5495
Joe Perchesf17dba42014-10-13 15:51:51 -07005496# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005497 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5498 if (CHK("CONCATENATED_STRING",
5499 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5500 $fix) {
5501 while ($line =~ /($String)/g) {
5502 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5503 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5504 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5505 }
5506 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005507 }
5508
Joe Perches90ad30e2014-12-10 15:51:59 -08005509# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005510 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005511 if (WARN("STRING_FRAGMENTS",
5512 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5513 $fix) {
5514 while ($line =~ /($String)(?=\s*")/g) {
5515 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5516 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5517 }
5518 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005519 }
5520
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005521# check for non-standard and hex prefixed decimal printf formats
5522 my $show_L = 1; #don't show the same defect twice
5523 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005524 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005525 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005526 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005527 # check for %L
5528 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005529 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005530 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5531 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005532 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005533 # check for %Z
5534 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5535 WARN("PRINTF_Z",
5536 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5537 $show_Z = 0;
5538 }
5539 # check for 0x<decimal>
5540 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5541 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005542 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5543 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005544 }
5545
5546# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005547 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005548 WARN("LINE_CONTINUATIONS",
5549 "Avoid line continuations in quoted strings\n" . $herecurr);
5550 }
5551
Andy Whitcroft00df3442007-06-08 13:47:06 -07005552# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005553 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07005554 WARN("IF_0",
5555 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5556 }
5557
5558# warn about #if 1
5559 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5560 WARN("IF_1",
5561 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005562 }
5563
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005564# check for needless "if (<foo>) fn(<foo>)" uses
5565 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005566 my $tested = quotemeta($1);
5567 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5568 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5569 my $func = $1;
5570 if (WARN('NEEDLESS_IF',
5571 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5572 $fix) {
5573 my $do_fix = 1;
5574 my $leading_tabs = "";
5575 my $new_leading_tabs = "";
5576 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5577 $leading_tabs = $1;
5578 } else {
5579 $do_fix = 0;
5580 }
5581 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5582 $new_leading_tabs = $1;
5583 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5584 $do_fix = 0;
5585 }
5586 } else {
5587 $do_fix = 0;
5588 }
5589 if ($do_fix) {
5590 fix_delete_line($fixlinenr - 1, $prevrawline);
5591 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5592 }
5593 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005594 }
5595 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005596
Joe Perchesebfdc402014-08-06 16:10:27 -07005597# check for unnecessary "Out of Memory" messages
5598 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5599 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5600 (defined $1 || defined $3) &&
5601 $linenr > 3) {
5602 my $testval = $2;
5603 my $testline = $lines[$linenr - 3];
5604
5605 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5606# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5607
Joe Perchese29a70f2019-03-07 16:28:35 -08005608 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5609 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005610 WARN("OOM_MESSAGE",
5611 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5612 }
5613 }
5614
Joe Perchesf78d98f2014-10-13 15:52:01 -07005615# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005616 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005617 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5618 my $level = $1;
5619 if (WARN("UNNECESSARY_KERN_LEVEL",
5620 "Possible unnecessary $level\n" . $herecurr) &&
5621 $fix) {
5622 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5623 }
5624 }
5625
Joe Perches45c55e92017-02-24 15:01:31 -08005626# check for logging continuations
5627 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5628 WARN("LOGGING_CONTINUATION",
5629 "Avoid logging continuation uses where feasible\n" . $herecurr);
5630 }
5631
Joe Perchesabb08a52014-12-10 15:51:46 -08005632# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07005633 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08005634 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5635 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5636 WARN("MASK_THEN_SHIFT",
5637 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5638 }
5639
Joe Perchesb75ac612014-12-10 15:52:02 -08005640# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07005641 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08005642 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5643 my $val = $1;
5644 my $equal = "!";
5645 $equal = "" if ($4 eq "!=");
5646 if (CHK("COMPARISON_TO_NULL",
5647 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5648 $fix) {
5649 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5650 }
5651 }
5652 }
5653
Joe Perches8716de32013-09-11 14:24:05 -07005654# check for bad placement of section $InitAttribute (e.g.: __initdata)
5655 if ($line =~ /(\b$InitAttribute\b)/) {
5656 my $attr = $1;
5657 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5658 my $ptr = $1;
5659 my $var = $2;
5660 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5661 ERROR("MISPLACED_INIT",
5662 "$attr should be placed after $var\n" . $herecurr)) ||
5663 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5664 WARN("MISPLACED_INIT",
5665 "$attr should be placed after $var\n" . $herecurr))) &&
5666 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005667 $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 -07005668 }
5669 }
5670 }
5671
Joe Perchese970b8842013-11-12 15:10:10 -08005672# check for $InitAttributeData (ie: __initdata) with const
5673 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5674 my $attr = $1;
5675 $attr =~ /($InitAttributePrefix)(.*)/;
5676 my $attr_prefix = $1;
5677 my $attr_type = $2;
5678 if (ERROR("INIT_ATTRIBUTE",
5679 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5680 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005681 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005682 s/$InitAttributeData/${attr_prefix}initconst/;
5683 }
5684 }
5685
5686# check for $InitAttributeConst (ie: __initconst) without const
5687 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5688 my $attr = $1;
5689 if (ERROR("INIT_ATTRIBUTE",
5690 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5691 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005692 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005693 /(^\+\s*(?:static\s+))/;
5694 $lead = rtrim($1);
5695 $lead = "$lead " if ($lead !~ /^\+$/);
5696 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005697 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005698 }
5699 }
5700
Joe Perchesc17893c2015-04-16 12:44:42 -07005701# check for __read_mostly with const non-pointer (should just be const)
5702 if ($line =~ /\b__read_mostly\b/ &&
5703 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5704 if (ERROR("CONST_READ_MOSTLY",
5705 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5706 $fix) {
5707 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5708 }
5709 }
5710
Joe Perchesfbdb8132014-04-03 14:49:14 -07005711# don't use __constant_<foo> functions outside of include/uapi/
5712 if ($realfile !~ m@^include/uapi/@ &&
5713 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5714 my $constant_func = $1;
5715 my $func = $constant_func;
5716 $func =~ s/^__constant_//;
5717 if (WARN("CONSTANT_CONVERSION",
5718 "$constant_func should be $func\n" . $herecurr) &&
5719 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005720 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005721 }
5722 }
5723
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005724# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005725 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005726 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005727 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005728 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005729 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005730 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07005731 }
5732 if ($delay > 2000) {
5733 WARN("LONG_UDELAY",
5734 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005735 }
5736 }
5737
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005738# warn about unexpectedly long msleep's
5739 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5740 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005741 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005742 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005743 }
5744 }
5745
Joe Perches36ec1932013-07-03 15:05:25 -07005746# check for comparisons of jiffies
5747 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5748 WARN("JIFFIES_COMPARISON",
5749 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5750 }
5751
Joe Perches9d7a34a2013-07-03 15:05:26 -07005752# check for comparisons of get_jiffies_64()
5753 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5754 WARN("JIFFIES_COMPARISON",
5755 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5756 }
5757
Andy Whitcroft00df3442007-06-08 13:47:06 -07005758# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005759# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005760# print "#ifdef in C files should be avoided\n";
5761# print "$herecurr";
5762# $clean = 0;
5763# }
5764
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005765# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005766 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005767 if (ERROR("SPACING",
5768 "exactly one space required after that #$1\n" . $herecurr) &&
5769 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005770 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005771 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5772 }
5773
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005774 }
5775
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005776# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005777 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5778 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005779 my $which = $1;
5780 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005781 CHK("UNCOMMENTED_DEFINITION",
5782 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005783 }
5784 }
5785# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005786
5787 my $barriers = qr{
5788 mb|
5789 rmb|
5790 wmb|
5791 read_barrier_depends
5792 }x;
5793 my $barrier_stems = qr{
5794 mb__before_atomic|
5795 mb__after_atomic|
5796 store_release|
5797 load_acquire|
5798 store_mb|
5799 (?:$barriers)
5800 }x;
5801 my $all_barriers = qr{
5802 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005803 smp_(?:$barrier_stems)|
5804 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005805 }x;
5806
5807 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005808 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005809 WARN("MEMORY_BARRIER",
5810 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005811 }
5812 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005813
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005814 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5815
5816 if ($realfile !~ m@^include/asm-generic/@ &&
5817 $realfile !~ m@/barrier\.h$@ &&
5818 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5819 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5820 WARN("MEMORY_BARRIER",
5821 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5822 }
5823
Joe Perchescb426e92015-06-25 15:02:46 -07005824# check for waitqueue_active without a comment.
5825 if ($line =~ /\bwaitqueue_active\s*\(/) {
5826 if (!ctx_has_comment($first_line, $linenr)) {
5827 WARN("WAITQUEUE_ACTIVE",
5828 "waitqueue_active without comment\n" . $herecurr);
5829 }
5830 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005831
Paul E. McKenney91db2592017-11-27 09:37:35 -08005832# check for smp_read_barrier_depends and read_barrier_depends
5833 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5834 WARN("READ_BARRIER_DEPENDS",
5835 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5836 }
5837
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005838# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005839 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005840 CHK("ARCH_DEFINES",
5841 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005842 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005843
Joe Perches596ed452017-07-12 14:37:02 -07005844# check that the storage class is not after a type
5845 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005846 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005847 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5848 }
5849# Check that the storage class is at the beginning of a declaration
5850 if ($line =~ /\b$Storage\b/ &&
5851 $line !~ /^.\s*$Storage/ &&
5852 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5853 $1 !~ /[\,\)]\s*$/) {
5854 WARN("STORAGE_CLASS",
5855 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005856 }
5857
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005858# check the location of the inline attribute, that it is between
5859# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005860 if ($line =~ /\b$Type\s+$Inline\b/ ||
5861 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005862 ERROR("INLINE_LOCATION",
5863 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005864 }
5865
Andy Whitcroft8905a672007-11-28 16:21:06 -08005866# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005867 if ($realfile !~ m@\binclude/uapi/@ &&
5868 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005869 if (WARN("INLINE",
5870 "plain inline is preferred over $1\n" . $herecurr) &&
5871 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005872 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005873
5874 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005875 }
5876
Joe Perches3d130fd2011-01-12 17:00:00 -08005877# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005878 if ($realfile !~ m@\binclude/uapi/@ &&
5879 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005880 WARN("PREFER_PACKED",
5881 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005882 }
5883
Joe Perches39b7e282011-07-25 17:13:24 -07005884# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005885 if ($realfile !~ m@\binclude/uapi/@ &&
5886 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005887 WARN("PREFER_ALIGNED",
5888 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005889 }
5890
Joe Perches462811d2019-09-25 16:46:44 -07005891# Check for __attribute__ section, prefer __section
5892 if ($realfile !~ m@\binclude/uapi/@ &&
5893 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
5894 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
5895 my $new = substr($old, 1, -1);
5896 if (WARN("PREFER_SECTION",
5897 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
5898 $fix) {
5899 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
5900 }
5901 }
5902
Joe Perches5f14d3b2012-01-10 15:09:52 -08005903# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005904 if ($realfile !~ m@\binclude/uapi/@ &&
5905 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005906 if (WARN("PREFER_PRINTF",
5907 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5908 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005909 $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 -07005910
5911 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005912 }
5913
Joe Perches6061d942012-03-23 15:02:16 -07005914# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005915 if ($realfile !~ m@\binclude/uapi/@ &&
5916 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005917 if (WARN("PREFER_SCANF",
5918 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5919 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005920 $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 -07005921 }
Joe Perches6061d942012-03-23 15:02:16 -07005922 }
5923
Joe Perches619a9082014-12-10 15:51:35 -08005924# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07005925 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08005926 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5927 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5928 $line =~ /\b__weak\b/)) {
5929 ERROR("WEAK_DECLARATION",
5930 "Using weak declarations can have unintended link defects\n" . $herecurr);
5931 }
5932
Tomas Winklerfd39f902016-12-12 16:46:34 -08005933# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005934 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005935 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005936 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5937 my $type = $1;
5938 if ($type =~ /\b($typeC99Typedefs)\b/) {
5939 $type = $1;
5940 my $kernel_type = 'u';
5941 $kernel_type = 's' if ($type =~ /^_*[si]/);
5942 $type =~ /(\d+)/;
5943 $kernel_type .= $1;
5944 if (CHK("PREFER_KERNEL_TYPES",
5945 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5946 $fix) {
5947 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5948 }
5949 }
5950 }
5951
Joe Perches938224b2016-01-20 14:59:15 -08005952# check for cast of C90 native int or longer types constants
5953 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5954 my $cast = $1;
5955 my $const = $2;
5956 if (WARN("TYPECAST_INT_CONSTANT",
5957 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5958 $fix) {
5959 my $suffix = "";
5960 my $newconst = $const;
5961 $newconst =~ s/${Int_type}$//;
5962 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5963 if ($cast =~ /\blong\s+long\b/) {
5964 $suffix .= 'LL';
5965 } elsif ($cast =~ /\blong\b/) {
5966 $suffix .= 'L';
5967 }
5968 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5969 }
5970 }
5971
Joe Perches8f53a9b2010-03-05 13:43:48 -08005972# check for sizeof(&)
5973 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005974 WARN("SIZEOF_ADDRESS",
5975 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005976 }
5977
Joe Perches66c80b62012-07-30 14:41:22 -07005978# check for sizeof without parenthesis
5979 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005980 if (WARN("SIZEOF_PARENTHESIS",
5981 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5982 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005983 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005984 }
Joe Perches66c80b62012-07-30 14:41:22 -07005985 }
5986
Joe Perches88982fe2012-12-17 16:02:00 -08005987# check for struct spinlock declarations
5988 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5989 WARN("USE_SPINLOCK_T",
5990 "struct spinlock should be spinlock_t\n" . $herecurr);
5991 }
5992
Joe Perchesa6962d72013-04-29 16:18:13 -07005993# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005994 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005995 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005996 $fmt =~ s/%%//g;
5997 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005998 if (WARN("PREFER_SEQ_PUTS",
5999 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6000 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006001 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006002 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006003 }
6004 }
6005
Joe Perches478b1792018-04-10 16:33:34 -07006006# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006007 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006008 defined $stat &&
6009 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6010 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006011 my $stat_real;
6012
Joe Perches0b523762017-05-08 15:55:36 -07006013 my $lc = $stat =~ tr@\n@@;
6014 $lc = $lc + $linenr;
6015 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006016 my $specifier;
6017 my $extension;
6018 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006019 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6020 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006021
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006022 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
6023 $specifier = $1;
6024 $extension = $2;
Alexandre Belloni44629962019-03-28 20:44:32 -07006025 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOxt]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006026 $bad_specifier = $specifier;
6027 last;
6028 }
6029 if ($extension eq "x" && !defined($stat_real)) {
6030 if (!defined($stat_real)) {
6031 $stat_real = get_stat_real($linenr, $lc);
6032 }
6033 WARN("VSPRINTF_SPECIFIER_PX",
6034 "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");
6035 }
6036 }
6037 if ($bad_specifier ne "") {
6038 my $stat_real = get_stat_real($linenr, $lc);
6039 my $ext_type = "Invalid";
6040 my $use = "";
6041 if ($bad_specifier =~ /p[Ff]/) {
6042 $ext_type = "Deprecated";
6043 $use = " - use %pS instead";
6044 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6045 }
6046
6047 WARN("VSPRINTF_POINTER_EXTENSION",
6048 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6049 }
Joe Perches0b523762017-05-08 15:55:36 -07006050 }
6051 }
6052
Andy Whitcroft554e1652012-01-10 15:09:57 -08006053# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006054 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006055 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006056 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006057
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006058 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006059 my $ms_val = $7;
6060 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006061
Andy Whitcroft554e1652012-01-10 15:09:57 -08006062 if ($ms_size =~ /^(0x|)0$/i) {
6063 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006064 "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 -08006065 } elsif ($ms_size =~ /^(0x|)1$/i) {
6066 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006067 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6068 }
6069 }
6070
Joe Perches98a9bba2014-01-23 15:54:52 -08006071# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006072# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006073# defined $stat &&
6074# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6075# if (WARN("PREFER_ETHER_ADDR_COPY",
6076# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6077# $fix) {
6078# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6079# }
6080# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006081
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006082# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006083# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006084# defined $stat &&
6085# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6086# WARN("PREFER_ETHER_ADDR_EQUAL",
6087# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6088# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006089
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006090# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6091# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006092# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006093# defined $stat &&
6094# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6095#
6096# my $ms_val = $7;
6097#
6098# if ($ms_val =~ /^(?:0x|)0+$/i) {
6099# if (WARN("PREFER_ETH_ZERO_ADDR",
6100# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6101# $fix) {
6102# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6103# }
6104# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6105# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6106# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6107# $fix) {
6108# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6109# }
6110# }
6111# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006112
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006113# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006114 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006115 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006116 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006117 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006118 my $call = $1;
6119 my $cast1 = deparenthesize($2);
6120 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006121 my $cast2 = deparenthesize($7);
6122 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006123 my $cast;
6124
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006125 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006126 $cast = "$cast1 or $cast2";
6127 } elsif ($cast1 ne "") {
6128 $cast = $cast1;
6129 } else {
6130 $cast = $cast2;
6131 }
6132 WARN("MINMAX",
6133 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006134 }
6135 }
6136
Joe Perches4a273192012-07-30 14:41:20 -07006137# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006138 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006139 defined $stat &&
6140 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6141 my $min = $1;
6142 my $max = $7;
6143 if ($min eq $max) {
6144 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006145 "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 -07006146 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6147 $min > $max) {
6148 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006149 "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 -07006150 }
6151 }
6152
Joe Perches823b7942013-11-12 15:10:15 -08006153# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006154 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006155 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006156 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006157 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6158 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6159 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6160 my $lc = $stat =~ tr@\n@@;
6161 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006162 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006163 WARN("NAKED_SSCANF",
6164 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6165 }
6166
Joe Perchesafc819a2014-06-04 16:12:08 -07006167# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006168 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006169 defined $stat &&
6170 $line =~ /\bsscanf\b/) {
6171 my $lc = $stat =~ tr@\n@@;
6172 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006173 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006174 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6175 my $format = $6;
6176 my $count = $format =~ tr@%@%@;
6177 if ($count == 1 &&
6178 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6179 WARN("SSCANF_TO_KSTRTO",
6180 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6181 }
6182 }
6183 }
6184
Joe Perches70dc8a42013-09-11 14:23:58 -07006185# check for new externs in .h files.
6186 if ($realfile =~ /\.h$/ &&
6187 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006188 if (CHK("AVOID_EXTERNS",
6189 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006190 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006191 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006192 }
6193 }
6194
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006195# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006196 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006197 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006198 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006199 my $function_name = $1;
6200 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006201
6202 my $s = $stat;
6203 if (defined $cond) {
6204 substr($s, 0, length($cond), '');
6205 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006206 if ($s =~ /^\s*;/ &&
6207 $function_name ne 'uninitialized_var')
6208 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006209 WARN("AVOID_EXTERNS",
6210 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006211 }
6212
6213 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006214 WARN("FUNCTION_ARGUMENTS",
6215 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006216 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006217
6218 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6219 $stat =~ /^.\s*extern\s+/)
6220 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006221 WARN("AVOID_EXTERNS",
6222 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006223 }
6224
Joe Perchesa0ad7592017-07-10 15:52:19 -07006225# check for function declarations that have arguments without identifier names
6226 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006227 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006228 $1 ne "void") {
6229 my $args = trim($1);
6230 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6231 my $arg = trim($1);
6232 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6233 WARN("FUNCTION_ARGUMENTS",
6234 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6235 }
6236 }
6237 }
6238
Joe Perchesa0ad7592017-07-10 15:52:19 -07006239# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006240 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006241 defined $stat &&
6242 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6243 $context_function = $1;
6244
6245# check for multiline function definition with misplaced open brace
6246 my $ok = 0;
6247 my $cnt = statement_rawlines($stat);
6248 my $herectx = $here . "\n";
6249 for (my $n = 0; $n < $cnt; $n++) {
6250 my $rl = raw_line($linenr, $n);
6251 $herectx .= $rl . "\n";
6252 $ok = 1 if ($rl =~ /^[ \+]\{/);
6253 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6254 last if $rl =~ /^[ \+].*\{/;
6255 }
6256 if (!$ok) {
6257 ERROR("OPEN_BRACE",
6258 "open brace '{' following function definitions go on the next line\n" . $herectx);
6259 }
6260 }
6261
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006262# checks for new __setup's
6263 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6264 my $name = $1;
6265
6266 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006267 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006268 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006269 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006270 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006271
Joe Perchese29a70f2019-03-07 16:28:35 -08006272# check for pointless casting of alloc functions
6273 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006274 WARN("UNNECESSARY_CASTS",
6275 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006276 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006277
Joe Perchesa640d252013-07-03 15:05:21 -07006278# alloc style
6279# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006280 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006281 $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 -07006282 CHK("ALLOC_SIZEOF_STRUCT",
6283 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6284 }
6285
Joe Perches60a55362014-06-04 16:12:07 -07006286# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006287 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006288 defined $stat &&
6289 $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 -07006290 my $oldfunc = $3;
6291 my $a1 = $4;
6292 my $a2 = $10;
6293 my $newfunc = "kmalloc_array";
6294 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006295 my $r1 = $a1;
6296 my $r2 = $a2;
6297 if ($a1 =~ /^sizeof\s*\S/) {
6298 $r1 = $a2;
6299 $r2 = $a1;
6300 }
6301 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6302 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006303 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006304 my $herectx = get_stat_here($linenr, $cnt, $here);
6305
Joe Perches60a55362014-06-04 16:12:07 -07006306 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006307 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6308 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006309 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006310 $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 -07006311 }
6312 }
6313 }
6314
Joe Perches972fdea2013-04-29 16:18:12 -07006315# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006316 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006317 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6318 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006319 WARN("KREALLOC_ARG_REUSE",
6320 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6321 }
6322
Joe Perches5ce59ae2013-02-21 16:44:18 -08006323# check for alloc argument mismatch
6324 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6325 WARN("ALLOC_ARRAY_ARGS",
6326 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6327 }
6328
Joe Perchescaf2a542011-01-12 16:59:56 -08006329# check for multiple semicolons
6330 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006331 if (WARN("ONE_SEMICOLON",
6332 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6333 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006334 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006335 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006336 }
6337
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006338# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6339 if ($realfile !~ m@^include/uapi/@ &&
6340 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006341 my $ull = "";
6342 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6343 if (CHK("BIT_MACRO",
6344 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6345 $fix) {
6346 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6347 }
6348 }
6349
Joe Perches2d632742016-05-20 17:04:00 -07006350# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6351 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6352 my $config = $1;
6353 if (WARN("PREFER_IS_ENABLED",
6354 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6355 $fix) {
6356 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6357 }
6358 }
6359
Joe Perchese81f2392014-08-06 16:11:25 -07006360# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006361 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6362 my $has_break = 0;
6363 my $has_statement = 0;
6364 my $count = 0;
6365 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006366 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006367 $prevline--;
6368 my $rline = $rawlines[$prevline - 1];
6369 my $fline = $lines[$prevline - 1];
6370 last if ($fline =~ /^\@\@/);
6371 next if ($fline =~ /^\-/);
6372 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6373 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6374 next if ($fline =~ /^.[\s$;]*$/);
6375 $has_statement = 1;
6376 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006377 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006378 }
6379 if (!$has_break && $has_statement) {
6380 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006381 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006382 }
6383 }
6384
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006385# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006386 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006387 defined $stat &&
6388 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006389 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006390 my $herectx = get_stat_here($linenr, $cnt, $here);
6391
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006392 WARN("DEFAULT_NO_BREAK",
6393 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006394 }
6395
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006396# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006397 if ($line =~ /\b__FUNCTION__\b/) {
6398 if (WARN("USE_FUNC",
6399 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6400 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006401 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006402 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006403 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006404
Joe Perches62ec8182015-02-13 14:38:18 -08006405# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6406 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6407 ERROR("DATE_TIME",
6408 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6409 }
6410
Joe Perches2c924882012-03-23 15:02:20 -07006411# check for use of yield()
6412 if ($line =~ /\byield\s*\(\s*\)/) {
6413 WARN("YIELD",
6414 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6415 }
6416
Joe Perches179f8f42013-07-03 15:05:30 -07006417# check for comparisons against true and false
6418 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6419 my $lead = $1;
6420 my $arg = $2;
6421 my $test = $3;
6422 my $otype = $4;
6423 my $trail = $5;
6424 my $op = "!";
6425
6426 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6427
6428 my $type = lc($otype);
6429 if ($type =~ /^(?:true|false)$/) {
6430 if (("$test" eq "==" && "$type" eq "true") ||
6431 ("$test" eq "!=" && "$type" eq "false")) {
6432 $op = "";
6433 }
6434
6435 CHK("BOOL_COMPARISON",
6436 "Using comparison to $otype is error prone\n" . $herecurr);
6437
6438## maybe suggesting a correct construct would better
6439## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6440
6441 }
6442 }
6443
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006444# check for semaphores initialized locked
6445 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006446 WARN("CONSIDER_COMPLETION",
6447 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006448 }
Joe Perches6712d852012-03-23 15:02:20 -07006449
Joe Perches67d0a072011-10-31 17:13:10 -07006450# recommend kstrto* over simple_strto* and strict_strto*
6451 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006452 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006453 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006454 }
Joe Perches6712d852012-03-23 15:02:20 -07006455
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006456# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006457 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006458 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006459 "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 -07006460 }
Joe Perches6712d852012-03-23 15:02:20 -07006461
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006462# check for spin_is_locked(), suggest lockdep instead
6463 if ($line =~ /\bspin_is_locked\(/) {
6464 WARN("USE_LOCKDEP",
6465 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6466 }
6467
Joe Perches9189c7e2018-09-07 15:26:18 -07006468# check for deprecated apis
6469 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6470 my $deprecated_api = $1;
6471 my $new_api = $deprecated_apis{$deprecated_api};
6472 WARN("DEPRECATED_API",
6473 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6474 }
6475
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006476# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006477# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006478 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006479 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006480 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006481 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006482 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006483
6484# use of NR_CPUS is usually wrong
6485# ignore definitions of NR_CPUS and usage to define arrays as likely right
6486 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006487 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6488 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006489 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6490 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6491 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006492 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006493 WARN("NR_CPUS",
6494 "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 -07006495 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006496
Joe Perches52ea8502013-11-12 15:10:09 -08006497# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6498 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6499 ERROR("DEFINE_ARCH_HAS",
6500 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6501 }
6502
Joe Perchesacd93622015-02-13 14:38:38 -08006503# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07006504 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08006505 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6506 WARN("LIKELY_MISUSE",
6507 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6508 }
6509
Denis Efremovde3f1862019-09-25 16:49:25 -07006510# nested likely/unlikely calls
6511 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6512 WARN("LIKELY_MISUSE",
6513 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6514 }
6515
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006516# whine mightly about in_atomic
6517 if ($line =~ /\bin_atomic\s*\(/) {
6518 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006519 ERROR("IN_ATOMIC",
6520 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006521 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006522 WARN("IN_ATOMIC",
6523 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006524 }
6525 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006526
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006527# check for mutex_trylock_recursive usage
6528 if ($line =~ /mutex_trylock_recursive/) {
6529 ERROR("LOCKING",
6530 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6531 }
6532
Peter Zijlstra1704f472010-03-19 01:37:42 +01006533# check for lockdep_set_novalidate_class
6534 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6535 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6536 if ($realfile !~ m@^kernel/lockdep@ &&
6537 $realfile !~ m@^include/linux/lockdep@ &&
6538 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006539 ERROR("LOCKDEP",
6540 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006541 }
6542 }
Dave Jones88f88312011-01-12 16:59:59 -08006543
Joe Perchesb392c642015-04-16 12:44:16 -07006544 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6545 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006546 WARN("EXPORTED_WORLD_WRITABLE",
6547 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006548 }
Joe Perches24358802014-04-03 14:49:13 -07006549
Joe Perches00180462018-02-06 15:38:55 -08006550# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6551# and whether or not function naming is typical and if
6552# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07006553 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08006554 defined $stat &&
6555 $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*\)/) {
6556 my $var = $1;
6557 my $perms = $2;
6558 my $show = $3;
6559 my $store = $4;
6560 my $octal_perms = perms_to_octal($perms);
6561 if ($show =~ /^${var}_show$/ &&
6562 $store =~ /^${var}_store$/ &&
6563 $octal_perms eq "0644") {
6564 if (WARN("DEVICE_ATTR_RW",
6565 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6566 $fix) {
6567 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6568 }
6569 } elsif ($show =~ /^${var}_show$/ &&
6570 $store =~ /^NULL$/ &&
6571 $octal_perms eq "0444") {
6572 if (WARN("DEVICE_ATTR_RO",
6573 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6574 $fix) {
6575 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6576 }
6577 } elsif ($show =~ /^NULL$/ &&
6578 $store =~ /^${var}_store$/ &&
6579 $octal_perms eq "0200") {
6580 if (WARN("DEVICE_ATTR_WO",
6581 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6582 $fix) {
6583 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6584 }
6585 } elsif ($octal_perms eq "0644" ||
6586 $octal_perms eq "0444" ||
6587 $octal_perms eq "0200") {
6588 my $newshow = "$show";
6589 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6590 my $newstore = $store;
6591 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6592 my $rename = "";
6593 if ($show ne $newshow) {
6594 $rename .= " '$show' to '$newshow'";
6595 }
6596 if ($store ne $newstore) {
6597 $rename .= " '$store' to '$newstore'";
6598 }
6599 WARN("DEVICE_ATTR_FUNCTIONS",
6600 "Consider renaming function(s)$rename\n" . $herecurr);
6601 } else {
6602 WARN("DEVICE_ATTR_PERMS",
6603 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6604 }
6605 }
6606
Joe Perches515a2352014-04-03 14:49:24 -07006607# Mode permission misuses where it seems decimal should be octal
6608# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006609# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6610# specific definition of not visible in sysfs.
6611# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6612# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07006613 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006614 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006615 $line =~ /$mode_perms_search/) {
6616 foreach my $entry (@mode_permission_funcs) {
6617 my $func = $entry->[0];
6618 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006619
Joe Perches459cf0a2016-10-11 13:52:19 -07006620 my $lc = $stat =~ tr@\n@@;
6621 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006622 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006623
Joe Perches515a2352014-04-03 14:49:24 -07006624 my $skip_args = "";
6625 if ($arg_pos > 1) {
6626 $arg_pos--;
6627 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6628 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006629 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006630 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006631 my $val = $1;
6632 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006633 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6634 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6635 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006636 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006637 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006638 }
6639 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006640 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006641 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006642 }
Joe Perches24358802014-04-03 14:49:13 -07006643 }
6644 }
6645 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006646
Joe Perches459cf0a2016-10-11 13:52:19 -07006647# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07006648 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08006649 my $oval = $1;
6650 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006651 if (WARN("SYMBOLIC_PERMS",
6652 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6653 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006654 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006655 }
6656 }
6657
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006658# validate content of MODULE_LICENSE against list from include/linux/module.h
6659 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6660 my $extracted_string = get_quoted_string($line, $rawline);
6661 my $valid_licenses = qr{
6662 GPL|
6663 GPL\ v2|
6664 GPL\ and\ additional\ rights|
6665 Dual\ BSD/GPL|
6666 Dual\ MIT/GPL|
6667 Dual\ MPL/GPL|
6668 Proprietary
6669 }x;
6670 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6671 WARN("MODULE_LICENSE",
6672 "unknown module license " . $extracted_string . "\n" . $herecurr);
6673 }
6674 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07006675
6676# check for sysctl duplicate constants
6677 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6678 WARN("DUPLICATED_SYSCTL_CONST",
6679 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6680 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006681 }
6682
6683 # If we have no input at all, then there is nothing to report on
6684 # so just keep quiet.
6685 if ($#rawlines == -1) {
6686 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006687 }
6688
Andy Whitcroft8905a672007-11-28 16:21:06 -08006689 # In mailback mode only produce a report in the negative, for
6690 # things that appear to be patches.
6691 if ($mailback && ($clean == 1 || !$is_patch)) {
6692 exit(0);
6693 }
6694
6695 # This is not a patch, and we are are in 'no-patch' mode so
6696 # just keep quiet.
6697 if (!$chk_patch && !$is_patch) {
6698 exit(0);
6699 }
6700
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006701 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006702 ERROR("NOT_UNIFIED_DIFF",
6703 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006704 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07006705 if ($is_patch && $has_commit_log && $chk_signoff) {
6706 if ($signoff == 0) {
6707 ERROR("MISSING_SIGN_OFF",
6708 "Missing Signed-off-by: line(s)\n");
6709 } elsif (!$authorsignoff) {
6710 WARN("NO_AUTHOR_SIGN_OFF",
6711 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6712 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006713 }
6714
Andy Whitcroft8905a672007-11-28 16:21:06 -08006715 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006716 if ($summary && !($clean == 1 && $quiet == 1)) {
6717 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006718 print "total: $cnt_error errors, $cnt_warn warnings, " .
6719 (($check)? "$cnt_chk checks, " : "") .
6720 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006721 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006722
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006723 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006724 # If there were any defects found and not already fixing them
6725 if (!$clean and !$fix) {
6726 print << "EOM"
6727
6728NOTE: For some of the reported defects, checkpatch may be able to
6729 mechanically convert to the typical style using --fix or --fix-inplace.
6730EOM
6731 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006732 # If there were whitespace errors which cleanpatch can fix
6733 # then suggest that.
6734 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006735 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006736 print << "EOM"
6737
6738NOTE: Whitespace errors detected.
6739 You may wish to use scripts/cleanpatch or scripts/cleanfile
6740EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006741 }
6742 }
6743
Joe Perchesd752fcc2014-08-06 16:11:05 -07006744 if ($clean == 0 && $fix &&
6745 ("@rawlines" ne "@fixed" ||
6746 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006747 my $newfile = $filename;
6748 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006749 my $linecount = 0;
6750 my $f;
6751
Joe Perchesd752fcc2014-08-06 16:11:05 -07006752 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6753
Joe Perches3705ce52013-07-03 15:05:31 -07006754 open($f, '>', $newfile)
6755 or die "$P: Can't open $newfile for write\n";
6756 foreach my $fixed_line (@fixed) {
6757 $linecount++;
6758 if ($file) {
6759 if ($linecount > 3) {
6760 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006761 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006762 }
6763 } else {
6764 print $f $fixed_line . "\n";
6765 }
6766 }
6767 close($f);
6768
6769 if (!$quiet) {
6770 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006771
Joe Perches3705ce52013-07-03 15:05:31 -07006772Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6773
6774Do _NOT_ trust the results written to this file.
6775Do _NOT_ submit these changes without inspecting them for correctness.
6776
6777This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6778No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006779EOM
6780 }
6781 }
6782
Joe Perchesd8469f12015-06-25 15:03:00 -07006783 if ($quiet == 0) {
6784 print "\n";
6785 if ($clean == 1) {
6786 print "$vname has no obvious style problems and is ready for submission.\n";
6787 } else {
6788 print "$vname has style problems, please review.\n";
6789 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006790 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006791 return $clean;
6792}