blob: 592911a2f06ca3fabaeb341d3a58612d2f4da79d [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
Rob Herringe400edb2019-09-12 15:18:20 +01002829# Check for adding new DT bindings not in schema format
2830 if (!$in_commit_log &&
2831 ($line =~ /^new file mode\s*\d+\s*$/) &&
2832 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) {
2833 WARN("DT_SCHEMA_BINDING_PATCH",
2834 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2835 }
2836
Andy Whitcroft00df3442007-06-08 13:47:06 -07002837# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002838 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002839 ERROR("CORRUPTED_PATCH",
2840 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002841 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002842 }
2843
2844# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2845 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002846 $rawline !~ m/^$UTF8*$/) {
2847 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2848
2849 my $blank = copy_spacing($rawline);
2850 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2851 my $hereptr = "$hereline$ptr\n";
2852
Joe Perches34d99212011-07-25 17:13:26 -07002853 CHK("INVALID_UTF8",
2854 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002855 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002856
Joe Perches15662b32011-10-31 17:13:12 -07002857# Check if it's the start of a commit log
2858# (not a header line and we haven't seen the patch filename)
2859 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002860 !($rawline =~ /^\s+(?:\S|$)/ ||
2861 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002862 $in_header_lines = 0;
2863 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002864 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002865 }
2866
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002867# Check if there is UTF-8 in a commit log when a mail header has explicitly
2868# declined it, i.e defined some charset where it is missing.
2869 if ($in_header_lines &&
2870 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2871 $1 !~ /utf-8/i) {
2872 $non_utf8_charset = 1;
2873 }
2874
2875 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002876 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002877 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002878 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2879 }
2880
Joe Perchesd6430f72016-12-12 16:46:28 -08002881# Check for absolute kernel paths in commit message
2882 if ($tree && $in_commit_log) {
2883 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2884 my $file = $1;
2885
2886 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2887 check_absolute_file($1, $herecurr)) {
2888 #
2889 } else {
2890 check_absolute_file($file, $herecurr);
2891 }
2892 }
2893 }
2894
Kees Cook66b47b42014-10-13 15:51:57 -07002895# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002896 if (defined($misspellings) &&
2897 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002898 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002899 my $typo = $1;
2900 my $typo_fix = $spelling_fix{lc($typo)};
2901 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2902 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002903 my $msg_level = \&WARN;
2904 $msg_level = \&CHK if ($file);
2905 if (&{$msg_level}("TYPO_SPELLING",
2906 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002907 $fix) {
2908 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2909 }
2910 }
2911 }
2912
Matteo Crocea8dd86b2019-09-25 16:46:38 -07002913# check for invalid commit id
2914 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) {
2915 my $id;
2916 my $description;
2917 ($id, $description) = git_commit_info($2, undef, undef);
2918 if (!defined($id)) {
2919 WARN("UNKNOWN_COMMIT_ID",
2920 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr);
2921 }
2922 }
2923
Andy Whitcroft306708542008-10-15 22:02:28 -07002924# ignore non-hunk lines and lines being removed
2925 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002926
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002927#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002928 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002929 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002930 if (ERROR("DOS_LINE_ENDINGS",
2931 "DOS line endings\n" . $herevet) &&
2932 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002933 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002934 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002935 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2936 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002937 if (ERROR("TRAILING_WHITESPACE",
2938 "trailing whitespace\n" . $herevet) &&
2939 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002940 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002941 }
2942
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002943 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002944 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002945
Josh Triplett4783f892013-11-12 15:10:12 -08002946# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002947 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002948 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002949 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2950 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002951 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002952 my $msg_level = \&ERROR;
2953 $msg_level = \&CHK if ($file);
2954 &{$msg_level}("FSF_MAILING_ADDRESS",
2955 "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 -08002956 }
2957
Andi Kleen33549572010-05-24 14:33:29 -07002958# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002959# Only applies when adding the entry originally, after that we do not have
2960# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002961 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002962 # 'choice' is usually the last thing on the line (though
2963 # Kconfig supports named choices), so use a word boundary
2964 # (\b) rather than a whitespace character (\s)
2965 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002966 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002967 my $cnt = $realcnt;
2968 my $ln = $linenr + 1;
2969 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002970 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002971 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002972 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002973 $f = $lines[$ln - 1];
2974 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2975 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002976
2977 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002978 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002979
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002980 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002981 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002982 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2983 if ($lines[$ln - 1] =~ "---help---") {
2984 WARN("CONFIG_DESCRIPTION",
2985 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2986 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002987 $length = -1;
2988 }
2989
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002990 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002991 $f =~ s/#.*//;
2992 $f =~ s/^\s+//;
2993 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002994
2995 # This only checks context lines in the patch
2996 # and so hopefully shouldn't trigger false
2997 # positives, even though some of these are
2998 # common words in help texts
2999 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
3000 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07003001 $is_end = 1;
3002 last;
3003 }
Andi Kleen33549572010-05-24 14:33:29 -07003004 $length++;
3005 }
Vadim Bendebury56193272014-10-13 15:51:48 -07003006 if ($is_start && $is_end && $length < $min_conf_desc_length) {
3007 WARN("CONFIG_DESCRIPTION",
3008 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
3009 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08003010 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07003011 }
3012
Joe Perches628f91a2017-07-10 15:52:07 -07003013# check for MAINTAINERS entries that don't have the right form
3014 if ($realfile =~ /^MAINTAINERS$/ &&
3015 $rawline =~ /^\+[A-Z]:/ &&
3016 $rawline !~ /^\+[A-Z]:\t\S/) {
3017 if (WARN("MAINTAINERS_STYLE",
3018 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
3019 $fix) {
3020 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3021 }
3022 }
3023
Christoph Jaeger327953e2015-02-13 14:38:29 -08003024# discourage the use of boolean for type definition attributes of Kconfig options
3025 if ($realfile =~ /Kconfig/ &&
3026 $line =~ /^\+\s*\bboolean\b/) {
3027 WARN("CONFIG_TYPE_BOOLEAN",
3028 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3029 }
3030
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003031 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3032 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3033 my $flag = $1;
3034 my $replacement = {
3035 'EXTRA_AFLAGS' => 'asflags-y',
3036 'EXTRA_CFLAGS' => 'ccflags-y',
3037 'EXTRA_CPPFLAGS' => 'cppflags-y',
3038 'EXTRA_LDFLAGS' => 'ldflags-y',
3039 };
3040
3041 WARN("DEPRECATED_VARIABLE",
3042 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3043 }
3044
Rob Herringbff5da42014-01-23 15:54:51 -08003045# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003046 if (defined $root &&
3047 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3048 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3049
Rob Herringbff5da42014-01-23 15:54:51 -08003050 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3051
Florian Vaussardcc933192014-04-03 14:49:27 -07003052 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003053 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003054
Rob Herringbff5da42014-01-23 15:54:51 -08003055 foreach my $compat (@compats) {
3056 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003057 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3058 my $compat3 = $compat;
3059 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3060 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003061 if ( $? >> 8 ) {
3062 WARN("UNDOCUMENTED_DT_STRING",
3063 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3064 }
3065
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003066 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3067 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003068 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003069 if ( $? >> 8 ) {
3070 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003071 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003072 }
3073 }
3074 }
3075
Rob Herring9f3a8992018-04-10 16:33:13 -07003076# check for using SPDX license tag at beginning of files
3077 if ($realline == $checklicenseline) {
3078 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3079 $checklicenseline = 2;
3080 } elsif ($rawline =~ /^\+/) {
3081 my $comment = "";
3082 if ($realfile =~ /\.(h|s|S)$/) {
3083 $comment = '/*';
3084 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3085 $comment = '//';
3086 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
3087 $comment = '#';
3088 } elsif ($realfile =~ /\.rst$/) {
3089 $comment = '..';
3090 }
3091
Joe Perchesfdf13692019-03-07 16:28:32 -08003092# check SPDX comment style for .[chsS] files
3093 if ($realfile =~ /\.[chsS]$/ &&
3094 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003095 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003096 WARN("SPDX_LICENSE_TAG",
3097 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3098 }
3099
Rob Herring9f3a8992018-04-10 16:33:13 -07003100 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003101 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3102 WARN("SPDX_LICENSE_TAG",
3103 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003104 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003105 my $spdx_license = $1;
3106 if (!is_SPDX_License_valid($spdx_license)) {
3107 WARN("SPDX_LICENSE_TAG",
3108 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3109 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003110 }
3111 }
3112 }
3113
Andy Whitcroft5368df202008-10-15 22:02:27 -07003114# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003115 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07003116
Joe Perchesa8da38a2019-03-07 16:28:42 -08003117# check for using SPDX-License-Identifier on the wrong line number
3118 if ($realline != $checklicenseline &&
3119 $rawline =~ /\bSPDX-License-Identifier:/ &&
3120 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3121 WARN("SPDX_LICENSE_TAG",
3122 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3123 }
3124
Joe Perches47e0c882015-06-25 15:02:57 -07003125# line length limit (with some exclusions)
3126#
3127# There are a few types of lines that may extend beyond $max_line_length:
3128# logging functions like pr_info that end in a string
3129# lines with a single string
3130# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003131# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003132#
3133# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003134# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003135# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3136# LONG_LINE all other lines longer than $max_line_length
3137#
3138# if LONG_LINE is ignored, the other 2 types are also ignored
3139#
3140
Joe Perchesb4749e92015-07-17 16:24:01 -07003141 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003142 my $msg_type = "LONG_LINE";
3143
3144 # Check the allowed long line types first
3145
3146 # logging functions that end in a string that starts
3147 # before $max_line_length
3148 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3149 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3150 $msg_type = "";
3151
3152 # lines with only strings (w/ possible termination)
3153 # #defines with only strings
3154 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3155 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3156 $msg_type = "";
3157
Joe Perchescc147502017-11-17 15:28:44 -08003158 # More special cases
3159 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3160 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003161 $msg_type = "";
3162
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003163 # URL ($rawline is used in case the URL is in a comment)
3164 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3165 $msg_type = "";
3166
Joe Perches47e0c882015-06-25 15:02:57 -07003167 # Otherwise set the alternate message types
3168
3169 # a comment starts before $max_line_length
3170 } elsif ($line =~ /($;[\s$;]*)$/ &&
3171 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3172 $msg_type = "LONG_LINE_COMMENT"
3173
3174 # a quoted string starts before $max_line_length
3175 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3176 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3177 $msg_type = "LONG_LINE_STRING"
3178 }
3179
3180 if ($msg_type ne "" &&
3181 (show_type("LONG_LINE") || show_type($msg_type))) {
3182 WARN($msg_type,
3183 "line over $max_line_length characters\n" . $herecurr);
3184 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003185 }
3186
Andy Whitcroft8905a672007-11-28 16:21:06 -08003187# check for adding lines without a newline.
3188 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003189 WARN("MISSING_EOF_NEWLINE",
3190 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003191 }
3192
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003193# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003194 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003195
3196# at the beginning of a line any tabs must come first and anything
3197# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003198 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3199 $rawline =~ /^\+\s* \s*/) {
3200 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003201 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003202 if (ERROR("CODE_INDENT",
3203 "code indent should use tabs where possible\n" . $herevet) &&
3204 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003205 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003206 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003207 }
3208
Alberto Panizzo08e44362010-03-05 13:43:54 -08003209# check for space before tabs.
3210 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3211 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003212 if (WARN("SPACE_BEFORE_TAB",
3213 "please, no space before tabs\n" . $herevet) &&
3214 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003215 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003216 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003217 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003218 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003219 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003220 }
3221
Joe Perches6a487212018-04-10 16:34:04 -07003222# check for assignments on the start of a line
3223 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3224 CHK("ASSIGNMENT_CONTINUATIONS",
3225 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3226 }
3227
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003228# check for && or || at the start of a line
3229 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3230 CHK("LOGICAL_CONTINUATIONS",
3231 "Logical continuations should be on the previous line\n" . $hereprev);
3232 }
3233
Joe Perchesa91e8992016-05-20 17:04:05 -07003234# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003235 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003236 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003237 my $indent = length($1);
3238 if ($indent % 8) {
3239 if (WARN("TABSTOP",
3240 "Statements should start on a tabstop\n" . $herecurr) &&
3241 $fix) {
3242 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3243 }
3244 }
3245 }
3246
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003247# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003248 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003249 $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 -07003250 $prevline =~ /^\+(\t*)(.*)$/;
3251 my $oldindent = $1;
3252 my $rest = $2;
3253
3254 my $pos = pos_last_openparen($rest);
3255 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003256 $line =~ /^(\+| )([ \t]*)/;
3257 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003258
3259 my $goodtabindent = $oldindent .
3260 "\t" x ($pos / 8) .
3261 " " x ($pos % 8);
3262 my $goodspaceindent = $oldindent . " " x $pos;
3263
3264 if ($newindent ne $goodtabindent &&
3265 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003266
3267 if (CHK("PARENTHESIS_ALIGNMENT",
3268 "Alignment should match open parenthesis\n" . $hereprev) &&
3269 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003270 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003271 s/^\+[ \t]*/\+$goodtabindent/;
3272 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003273 }
3274 }
3275 }
3276
Joe Perches6ab3a972015-04-16 12:44:05 -07003277# check for space after cast like "(int) foo" or "(struct foo) bar"
3278# avoid checking a few false positives:
3279# "sizeof(<type>)" or "__alignof__(<type>)"
3280# function pointer declarations like "(*foo)(int) = bar;"
3281# structure definitions like "(struct foo) { 0 };"
3282# multiline macros that define functions
3283# known attributes or the __attribute__ keyword
3284 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3285 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003286 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003287 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003288 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003289 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003290 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003291 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003292 }
3293
Joe Perches86406b12015-09-09 15:37:41 -07003294# Block comment styles
3295# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003296 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003297 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003298 $rawline =~ /^\+[ \t]*\*/ &&
3299 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003300 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3301 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3302 }
3303
Joe Perches86406b12015-09-09 15:37:41 -07003304# Block comments use * on subsequent lines
3305 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3306 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003307 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003308 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003309 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003310 WARN("BLOCK_COMMENT_STYLE",
3311 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003312 }
3313
Joe Perches86406b12015-09-09 15:37:41 -07003314# Block comments use */ on trailing lines
3315 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003316 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3317 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3318 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003319 WARN("BLOCK_COMMENT_STYLE",
3320 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003321 }
3322
Joe Perches08eb9b82016-10-11 13:51:50 -07003323# Block comment * alignment
3324 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003325 $line =~ /^\+[ \t]*$;/ && #leading comment
3326 $rawline =~ /^\+[ \t]*\*/ && #leading *
3327 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003328 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003329 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3330 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003331 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003332 if (defined($1)) {
3333 $oldindent = expand_tabs($1);
3334 } else {
3335 $prevrawline =~ m@^\+(.*/?)\*@;
3336 $oldindent = expand_tabs($1);
3337 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003338 $rawline =~ m@^\+([ \t]*)\*@;
3339 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003340 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003341 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003342 WARN("BLOCK_COMMENT_STYLE",
3343 "Block comments should align the * on each line\n" . $hereprev);
3344 }
3345 }
3346
Joe Perches7f619192014-08-06 16:10:39 -07003347# check for missing blank lines after struct/union declarations
3348# with exceptions for various attributes and macros
3349 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3350 $line =~ /^\+/ &&
3351 !($line =~ /^\+\s*$/ ||
3352 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3353 $line =~ /^\+\s*MODULE_/i ||
3354 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3355 $line =~ /^\+[a-z_]*init/ ||
3356 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3357 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003358 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003359 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003360 if (CHK("LINE_SPACING",
3361 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3362 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003363 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003364 }
Joe Perches7f619192014-08-06 16:10:39 -07003365 }
3366
Joe Perches365dd4e2014-08-06 16:10:42 -07003367# check for multiple consecutive blank lines
3368 if ($prevline =~ /^[\+ ]\s*$/ &&
3369 $line =~ /^\+\s*$/ &&
3370 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003371 if (CHK("LINE_SPACING",
3372 "Please don't use multiple blank lines\n" . $hereprev) &&
3373 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003374 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003375 }
3376
Joe Perches365dd4e2014-08-06 16:10:42 -07003377 $last_blank_line = $linenr;
3378 }
3379
Joe Perches3b617e32014-04-03 14:49:28 -07003380# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003381 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3382 # actual declarations
3383 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003384 # function pointer declarations
3385 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003386 # foo bar; where foo is some local typedef or #define
3387 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3388 # known declaration macros
3389 $prevline =~ /^\+\s+$declaration_macros/) &&
3390 # for "else if" which can look like "$Ident $Ident"
3391 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3392 # other possible extensions of declaration lines
3393 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3394 # not starting a section or a macro "\" extended line
3395 $prevline =~ /(?:\{\s*|\\)$/) &&
3396 # looks like a declaration
3397 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003398 # function pointer declarations
3399 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003400 # foo bar; where foo is some local typedef or #define
3401 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3402 # known declaration macros
3403 $sline =~ /^\+\s+$declaration_macros/ ||
3404 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003405 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003406 # start or end of block or continuation of declaration
3407 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3408 # bitfield continuation
3409 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3410 # other possible extensions of declaration lines
3411 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3412 # indentation of previous and current line are the same
3413 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003414 if (WARN("LINE_SPACING",
3415 "Missing a blank line after declarations\n" . $hereprev) &&
3416 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003417 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003418 }
Joe Perches3b617e32014-04-03 14:49:28 -07003419 }
3420
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003421# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003422# Exceptions:
3423# 1) within comments
3424# 2) indented preprocessor commands
3425# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003426 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003427 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003428 if (WARN("LEADING_SPACE",
3429 "please, no spaces at the start of a line\n" . $herevet) &&
3430 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003431 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003432 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003433 }
3434
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003435# check we are in a valid C source file if not then ignore this hunk
3436 next if ($realfile !~ /\.(h|c)$/);
3437
Joe Perches5751a242017-11-17 15:28:52 -08003438# check for unusual line ending [ or (
3439 if ($line =~ /^\+.*([\[\(])\s*$/) {
3440 CHK("OPEN_ENDED_LINE",
3441 "Lines should not end with a '$1'\n" . $herecurr);
3442 }
3443
Joe Perches4dbed762017-05-08 15:55:39 -07003444# check if this appears to be the start function declaration, save the name
3445 if ($sline =~ /^\+\{\s*$/ &&
3446 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3447 $context_function = $1;
3448 }
3449
3450# check if this appears to be the end of function declaration
3451 if ($sline =~ /^\+\}\s*$/) {
3452 undef $context_function;
3453 }
3454
Joe Perches032a4c02014-08-06 16:10:29 -07003455# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003456# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003457# if the previous line is a break or return and is indented 1 tab more...
3458 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3459 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003460 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3461 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3462 defined $lines[$linenr] &&
3463 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003464 WARN("UNNECESSARY_ELSE",
3465 "else is not generally useful after a break or return\n" . $hereprev);
3466 }
3467 }
3468
Joe Perchesc00df192014-08-06 16:11:01 -07003469# check indentation of a line with a break;
3470# if the previous line is a goto or return and is indented the same # of tabs
3471 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3472 my $tabs = $1;
3473 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3474 WARN("UNNECESSARY_BREAK",
3475 "break is not useful after a goto or return\n" . $hereprev);
3476 }
3477 }
3478
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003479# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003480 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003481 WARN("CVS_KEYWORD",
3482 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003483 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003484
Joe Perches56e77d72013-02-21 16:44:14 -08003485# check for old HOTPLUG __dev<foo> section markings
3486 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3487 WARN("HOTPLUG_SECTION",
3488 "Using $1 is unnecessary\n" . $herecurr);
3489 }
3490
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003491# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003492 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3493 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003494#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003495 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003496 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003497 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003498 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003499 $stat =~ s/\n./\n /g;
3500 $cond =~ s/\n./\n /g;
3501
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003502#print "linenr<$linenr> <$stat>\n";
3503 # If this statement has no statement boundaries within
3504 # it there is no point in retrying a statement scan
3505 # until we hit end of it.
3506 my $frag = $stat; $frag =~ s/;+\s*$//;
3507 if ($frag !~ /(?:{|;)/) {
3508#print "skip<$line_nr_next>\n";
3509 $suppress_statement = $line_nr_next;
3510 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003511
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003512 # Find the real next line.
3513 $realline_next = $line_nr_next;
3514 if (defined $realline_next &&
3515 (!defined $lines[$realline_next - 1] ||
3516 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3517 $realline_next++;
3518 }
3519
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003520 my $s = $stat;
3521 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003522
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003523 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003524 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003525
3526 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003527 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003528
Andy Whitcroft463f2862009-09-21 17:04:34 -07003529 } elsif ($s =~ /^.\s*else\b/s) {
3530
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003531 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003532 } 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 -07003533 my $type = $1;
3534 $type =~ s/\s+/ /g;
3535 possible($type, "A:" . $s);
3536
Andy Whitcroft8905a672007-11-28 16:21:06 -08003537 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003538 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003539 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003540 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003541
3542 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003543 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003544 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003545 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003546
3547 # Check for any sort of function declaration.
3548 # int foo(something bar, other baz);
3549 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003550 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 -08003551 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003552
Andy Whitcroftcf655042008-03-04 14:28:20 -08003553 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003554 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003555 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003556
Andy Whitcroft8905a672007-11-28 16:21:06 -08003557 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003558 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003559
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003560 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003561 }
3562 }
3563 }
3564
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003565 }
3566
Andy Whitcroft653d4872007-06-23 17:16:34 -07003567#
3568# Checks which may be anchored in the context.
3569#
3570
3571# Check for switch () and associated case and default
3572# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003573 if ($line=~/\bswitch\s*\(.*\)/) {
3574 my $err = '';
3575 my $sep = '';
3576 my @ctx = ctx_block_outer($linenr, $realcnt);
3577 shift(@ctx);
3578 for my $ctx (@ctx) {
3579 my ($clen, $cindent) = line_stats($ctx);
3580 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3581 $indent != $cindent) {
3582 $err .= "$sep$ctx\n";
3583 $sep = '';
3584 } else {
3585 $sep = "[...]\n";
3586 }
3587 }
3588 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003589 ERROR("SWITCH_CASE_INDENT_LEVEL",
3590 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003591 }
3592 }
3593
3594# if/while/etc brace do not go on next line, unless defining a do while loop,
3595# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003596 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 -07003597 my $pre_ctx = "$1$2";
3598
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003599 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003600
3601 if ($line =~ /^\+\t{6,}/) {
3602 WARN("DEEP_INDENTATION",
3603 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3604 }
3605
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003606 my $ctx_cnt = $realcnt - $#ctx - 1;
3607 my $ctx = join("\n", @ctx);
3608
Andy Whitcroft548596d2008-07-23 21:29:01 -07003609 my $ctx_ln = $linenr;
3610 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003611
Andy Whitcroft548596d2008-07-23 21:29:01 -07003612 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3613 defined $lines[$ctx_ln - 1] &&
3614 $lines[$ctx_ln - 1] =~ /^-/)) {
3615 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3616 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003617 $ctx_ln++;
3618 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003619
Andy Whitcroft53210162008-07-23 21:29:03 -07003620 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3621 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003622
Joe Perchesd752fcc2014-08-06 16:11:05 -07003623 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003624 ERROR("OPEN_BRACE",
3625 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003626 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003627 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003628 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3629 $ctx =~ /\)\s*\;\s*$/ &&
3630 defined $lines[$ctx_ln - 1])
3631 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003632 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3633 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003634 WARN("TRAILING_SEMICOLON",
3635 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003636 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003637 }
3638 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003639 }
3640
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003641# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003642 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 -08003643 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3644 ctx_statement_block($linenr, $realcnt, 0)
3645 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003646 my ($s, $c) = ($stat, $cond);
3647
3648 substr($s, 0, length($c), '');
3649
Joe Perches9f5af482015-09-09 15:37:30 -07003650 # remove inline comments
3651 $s =~ s/$;/ /g;
3652 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003653
3654 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003655 my @newlines = ($c =~ /\n/gs);
3656 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003657
Joe Perches9f5af482015-09-09 15:37:30 -07003658 # Make sure we remove the line prefixes as we have
3659 # none on the first line, and are going to readd them
3660 # where necessary.
3661 $s =~ s/\n./\n/gs;
3662 while ($s =~ /\n\s+\\\n/) {
3663 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3664 }
3665
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003666 # We want to check the first line inside the block
3667 # starting at the end of the conditional, so remove:
3668 # 1) any blank line termination
3669 # 2) any opening brace { on end of the line
3670 # 3) any do (...) {
3671 my $continuation = 0;
3672 my $check = 0;
3673 $s =~ s/^.*\bdo\b//;
3674 $s =~ s/^\s*{//;
3675 if ($s =~ s/^\s*\\//) {
3676 $continuation = 1;
3677 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003678 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003679 $check = 1;
3680 $cond_lines++;
3681 }
3682
3683 # Also ignore a loop construct at the end of a
3684 # preprocessor statement.
3685 if (($prevline =~ /^.\s*#\s*define\s/ ||
3686 $prevline =~ /\\\s*$/) && $continuation == 0) {
3687 $check = 0;
3688 }
3689
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003690 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003691 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003692 while ($cond_ptr != $cond_lines) {
3693 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003694
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003695 # If we see an #else/#elif then the code
3696 # is not linear.
3697 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3698 $check = 0;
3699 }
3700
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003701 # Ignore:
3702 # 1) blank lines, they should be at 0,
3703 # 2) preprocessor lines, and
3704 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003705 if ($continuation ||
3706 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003707 $s =~ /^\s*#\s*?/ ||
3708 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003709 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003710 if ($s =~ s/^.*?\n//) {
3711 $cond_lines++;
3712 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003713 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003714 }
3715
3716 my (undef, $sindent) = line_stats("+" . $s);
3717 my $stat_real = raw_line($linenr, $cond_lines);
3718
3719 # Check if either of these lines are modified, else
3720 # this is not this patch's fault.
3721 if (!defined($stat_real) ||
3722 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3723 $check = 0;
3724 }
3725 if (defined($stat_real) && $cond_lines > 1) {
3726 $stat_real = "[...]\n$stat_real";
3727 }
3728
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003729 #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 -07003730
Joe Perches9f5af482015-09-09 15:37:30 -07003731 if ($check && $s ne '' &&
3732 (($sindent % 8) != 0 ||
3733 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003734 ($sindent == $indent &&
3735 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003736 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003737 WARN("SUSPECT_CODE_INDENT",
3738 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003739 }
3740 }
3741
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003742 # Track the 'values' across context and added lines.
3743 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003744 my ($curr_values, $curr_vars) =
3745 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003746 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003747 if ($dbg_values) {
3748 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003749 print "$linenr > .$outline\n";
3750 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003751 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003752 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003753 $prev_values = substr($curr_values, -1);
3754
Andy Whitcroft00df3442007-06-08 13:47:06 -07003755#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003756 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003757
Joe Perches11ca40a2016-12-12 16:46:31 -08003758# check for dereferences that span multiple lines
3759 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3760 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3761 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3762 my $ref = $1;
3763 $line =~ /^.\s*($Lval)/;
3764 $ref .= $1;
3765 $ref =~ s/\s//g;
3766 WARN("MULTILINE_DEREFERENCE",
3767 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3768 }
3769
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003770# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003771 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 -07003772 my $type = $1;
3773 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003774 $var = "" if (!defined $var);
3775 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003776 my $sign = $1;
3777 my $pointer = $2;
3778
3779 $pointer = "" if (!defined $pointer);
3780
3781 if (WARN("UNSPECIFIED_INT",
3782 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3783 $fix) {
3784 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003785 my $comp_pointer = $pointer;
3786 $comp_pointer =~ s/\s//g;
3787 $decl .= $comp_pointer;
3788 $decl = rtrim($decl) if ($var eq "");
3789 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003790 }
3791 }
3792 }
3793
Andy Whitcroft653d4872007-06-23 17:16:34 -07003794# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003795 if ($dbg_type) {
3796 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003797 ERROR("TEST_TYPE",
3798 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003799 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003800 ERROR("TEST_NOT_TYPE",
3801 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003802 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003803 next;
3804 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003805# TEST: allow direct testing of the attribute matcher.
3806 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003807 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003808 ERROR("TEST_ATTR",
3809 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003810 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003811 ERROR("TEST_NOT_ATTR",
3812 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003813 }
3814 next;
3815 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003816
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003817# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003818 if ($line =~ /^.\s*{/ &&
3819 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003820 if (ERROR("OPEN_BRACE",
3821 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003822 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3823 fix_delete_line($fixlinenr - 1, $prevrawline);
3824 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003825 my $fixedline = $prevrawline;
3826 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003827 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003828 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003829 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003830 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003831 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003832 }
3833
Andy Whitcroft653d4872007-06-23 17:16:34 -07003834#
3835# Checks which are anchored on the added line.
3836#
3837
3838# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003839 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003840 my $path = $1;
3841 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003842 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003843 "malformed #include filename\n" . $herecurr);
3844 }
3845 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3846 ERROR("UAPI_INCLUDE",
3847 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003848 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003849 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003850
3851# no C99 // comments
3852 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003853 if (ERROR("C99_COMMENTS",
3854 "do not use C99 // comments\n" . $herecurr) &&
3855 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003856 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003857 if ($line =~ /\/\/(.*)$/) {
3858 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003859 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003860 }
3861 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003862 }
3863 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003864 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003865 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003866
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003867# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3868# the whole statement.
3869#print "APW <$lines[$realline_next - 1]>\n";
3870 if (defined $realline_next &&
3871 exists $lines[$realline_next - 1] &&
3872 !defined $suppress_export{$realline_next} &&
3873 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3874 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003875 # Handle definitions which produce identifiers with
3876 # a prefix:
3877 # XXX(foo);
3878 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003879 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003880 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003881 $name =~ /^${Ident}_$2/) {
3882#print "FOO C name<$name>\n";
3883 $suppress_export{$realline_next} = 1;
3884
3885 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003886 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003887 ^.DEFINE_$Ident\(\Q$name\E\)|
3888 ^.DECLARE_$Ident\(\Q$name\E\)|
3889 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003890 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3891 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003892 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003893#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3894 $suppress_export{$realline_next} = 2;
3895 } else {
3896 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003897 }
3898 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003899 if (!defined $suppress_export{$linenr} &&
3900 $prevline =~ /^.\s*$/ &&
3901 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3902 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3903#print "FOO B <$lines[$linenr - 1]>\n";
3904 $suppress_export{$linenr} = 2;
3905 }
3906 if (defined $suppress_export{$linenr} &&
3907 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003908 WARN("EXPORT_SYMBOL",
3909 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003910 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003911
Joe Eloff5150bda2010-08-09 17:21:00 -07003912# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003913 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003914 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003915 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003916 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003917 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003918 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003919 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003920# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003921 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003922 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003923 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003924 $herecurr) &&
3925 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003926 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003927 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003928 }
3929
Joe Perches18130872014-08-06 16:11:22 -07003930# check for misordered declarations of char/short/int/long with signed/unsigned
3931 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3932 my $tmp = trim($1);
3933 WARN("MISORDERED_TYPE",
3934 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3935 }
3936
Joe Perches809e0822018-08-21 21:58:12 -07003937# check for unnecessary <signed> int declarations of short/long/long long
3938 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
3939 my $type = trim($1);
3940 next if ($type !~ /\bint\b/);
3941 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
3942 my $new_type = $type;
3943 $new_type =~ s/\b\s*int\s*\b/ /;
3944 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
3945 $new_type =~ s/^const\s+//;
3946 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
3947 $new_type = "const $new_type" if ($type =~ /^const\b/);
3948 $new_type =~ s/\s+/ /g;
3949 $new_type = trim($new_type);
3950 if (WARN("UNNECESSARY_INT",
3951 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
3952 $fix) {
3953 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
3954 }
3955 }
3956
Joe Perchescb710ec2010-10-26 14:23:20 -07003957# check for static const char * arrays.
3958 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003959 WARN("STATIC_CONST_CHAR_ARRAY",
3960 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003961 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08003962 }
3963
3964# check for initialized const char arrays that should be static const
3965 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3966 if (WARN("STATIC_CONST_CHAR_ARRAY",
3967 "const array should probably be static const\n" . $herecurr) &&
3968 $fix) {
3969 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
3970 }
3971 }
Joe Perchescb710ec2010-10-26 14:23:20 -07003972
3973# check for static char foo[] = "bar" declarations.
3974 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003975 WARN("STATIC_CONST_CHAR_ARRAY",
3976 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003977 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08003978 }
Joe Perchescb710ec2010-10-26 14:23:20 -07003979
Joe Perchesab7e23f2015-04-16 12:44:22 -07003980# check for const <foo> const where <foo> is not a pointer or array type
3981 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3982 my $found = $1;
3983 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3984 WARN("CONST_CONST",
3985 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3986 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3987 WARN("CONST_CONST",
3988 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3989 }
3990 }
3991
Joe Perches9b0fa602014-04-03 14:49:18 -07003992# check for non-global char *foo[] = {"bar", ...} declarations.
3993 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3994 WARN("STATIC_CONST_CHAR_ARRAY",
3995 "char * array declaration might be better as static const\n" .
3996 $herecurr);
3997 }
3998
Joe Perchesb598b672015-04-16 12:44:36 -07003999# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4000 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
4001 my $array = $1;
4002 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4003 my $array_div = $1;
4004 if (WARN("ARRAY_SIZE",
4005 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
4006 $fix) {
4007 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
4008 }
4009 }
4010 }
4011
Joe Perchesb36190c2014-01-27 17:07:18 -08004012# check for function declarations without arguments like "int foo()"
4013 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
4014 if (ERROR("FUNCTION_WITHOUT_ARGS",
4015 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
4016 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004017 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08004018 }
4019 }
4020
Andy Whitcroft653d4872007-06-23 17:16:34 -07004021# check for new typedefs, only function parameters and sparse annotations
4022# make sense.
4023 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004024 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004025 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004026 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004027 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004028 WARN("NEW_TYPEDEFS",
4029 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004030 }
4031
4032# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004033 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004034 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4035 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004036 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004037
Andy Whitcroft65863862009-01-06 14:41:21 -08004038 # Should start with a space.
4039 $to =~ s/^(\S)/ $1/;
4040 # Should not end with a space.
4041 $to =~ s/\s+$//;
4042 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004043 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004044 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004045
Joe Perches3705ce52013-07-03 15:05:31 -07004046## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004047 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004048 if (ERROR("POINTER_LOCATION",
4049 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4050 $fix) {
4051 my $sub_from = $ident;
4052 my $sub_to = $ident;
4053 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004054 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004055 s@\Q$sub_from\E@$sub_to@;
4056 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004057 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004058 }
4059 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4060 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004061 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004062
Andy Whitcroft65863862009-01-06 14:41:21 -08004063 # Should start with a space.
4064 $to =~ s/^(\S)/ $1/;
4065 # Should not end with a space.
4066 $to =~ s/\s+$//;
4067 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004068 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004069 }
4070 # Modifiers should have spaces.
4071 $to =~ s/(\b$Modifier$)/$1 /;
4072
Joe Perches3705ce52013-07-03 15:05:31 -07004073## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004074 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004075 if (ERROR("POINTER_LOCATION",
4076 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4077 $fix) {
4078
4079 my $sub_from = $match;
4080 my $sub_to = $match;
4081 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004082 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004083 s@\Q$sub_from\E@$sub_to@;
4084 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004085 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004086 }
4087
Joe Perches9d3e3c72015-09-09 15:37:27 -07004088# avoid BUG() or BUG_ON()
4089 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004090 my $msg_level = \&WARN;
4091 $msg_level = \&CHK if ($file);
4092 &{$msg_level}("AVOID_BUG",
4093 "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 -07004094 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004095
Joe Perches9d3e3c72015-09-09 15:37:27 -07004096# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004097 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004098 WARN("LINUX_VERSION_CODE",
4099 "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 -08004100 }
4101
Joe Perches17441222011-06-15 15:08:17 -07004102# check for uses of printk_ratelimit
4103 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004104 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004105 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004106 }
4107
Joe Percheseeef5732017-11-17 15:28:41 -08004108# printk should use KERN_* levels
4109 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4110 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4111 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004112 }
4113
Joe Perches243f3802012-05-31 16:26:09 -07004114 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4115 my $orig = $1;
4116 my $level = lc($orig);
4117 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004118 my $level2 = $level;
4119 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004120 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004121 "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 -07004122 }
4123
4124 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004125 if (WARN("PREFER_PR_LEVEL",
4126 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
4127 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004128 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004129 s/\bpr_warning\b/pr_warn/;
4130 }
Joe Perches243f3802012-05-31 16:26:09 -07004131 }
4132
Joe Perchesdc139312013-02-21 16:44:13 -08004133 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4134 my $orig = $1;
4135 my $level = lc($orig);
4136 $level = "warn" if ($level eq "warning");
4137 $level = "dbg" if ($level eq "debug");
4138 WARN("PREFER_DEV_LEVEL",
4139 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4140 }
4141
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004142# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4143# number of false positives, but assembly files are not checked, so at
4144# least the arch entry code will not trigger this warning.
4145 if ($line =~ /\bENOSYS\b/) {
4146 WARN("ENOSYS",
4147 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4148 }
4149
Andy Whitcroft653d4872007-06-23 17:16:34 -07004150# function brace can't be on same line, except for #defines of do while,
4151# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004152 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004153 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4154 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4155 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004156 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004157 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004158 $fix) {
4159 fix_delete_line($fixlinenr, $rawline);
4160 my $fixed_line = $rawline;
4161 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4162 my $line1 = $1;
4163 my $line2 = $2;
4164 fix_insert_line($fixlinenr, ltrim($line1));
4165 fix_insert_line($fixlinenr, "\+{");
4166 if ($line2 !~ /^\s*$/) {
4167 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4168 }
4169 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004170 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004171
Andy Whitcroft8905a672007-11-28 16:21:06 -08004172# open braces for enum, union and struct go on the same line.
4173 if ($line =~ /^.\s*{/ &&
4174 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004175 if (ERROR("OPEN_BRACE",
4176 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4177 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4178 fix_delete_line($fixlinenr - 1, $prevrawline);
4179 fix_delete_line($fixlinenr, $rawline);
4180 my $fixedline = rtrim($prevrawline) . " {";
4181 fix_insert_line($fixlinenr, $fixedline);
4182 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004183 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004184 if ($fixedline !~ /^\+\s*$/) {
4185 fix_insert_line($fixlinenr, $fixedline);
4186 }
4187 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004188 }
4189
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004190# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004191 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4192 if (WARN("SPACING",
4193 "missing space after $1 definition\n" . $herecurr) &&
4194 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004195 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004196 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4197 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004198 }
4199
Joe Perches31070b52014-01-23 15:54:49 -08004200# Function pointer declarations
4201# check spacing between type, funcptr, and args
4202# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004203 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004204 my $declare = $1;
4205 my $pre_pointer_space = $2;
4206 my $post_pointer_space = $3;
4207 my $funcname = $4;
4208 my $post_funcname_space = $5;
4209 my $pre_args_space = $6;
4210
Joe Perches91f72e92014-04-03 14:49:12 -07004211# the $Declare variable will capture all spaces after the type
4212# so check it for a missing trailing missing space but pointer return types
4213# don't need a space so don't warn for those.
4214 my $post_declare_space = "";
4215 if ($declare =~ /(\s+)$/) {
4216 $post_declare_space = $1;
4217 $declare = rtrim($declare);
4218 }
4219 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004220 WARN("SPACING",
4221 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004222 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004223 }
4224
4225# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004226# This test is not currently implemented because these declarations are
4227# equivalent to
4228# int foo(int bar, ...)
4229# and this is form shouldn't/doesn't generate a checkpatch warning.
4230#
4231# elsif ($declare =~ /\s{2,}$/) {
4232# WARN("SPACING",
4233# "Multiple spaces after return type\n" . $herecurr);
4234# }
Joe Perches31070b52014-01-23 15:54:49 -08004235
4236# unnecessary space "type ( *funcptr)(args...)"
4237 if (defined $pre_pointer_space &&
4238 $pre_pointer_space =~ /^\s/) {
4239 WARN("SPACING",
4240 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4241 }
4242
4243# unnecessary space "type (* funcptr)(args...)"
4244 if (defined $post_pointer_space &&
4245 $post_pointer_space =~ /^\s/) {
4246 WARN("SPACING",
4247 "Unnecessary space before function pointer name\n" . $herecurr);
4248 }
4249
4250# unnecessary space "type (*funcptr )(args...)"
4251 if (defined $post_funcname_space &&
4252 $post_funcname_space =~ /^\s/) {
4253 WARN("SPACING",
4254 "Unnecessary space after function pointer name\n" . $herecurr);
4255 }
4256
4257# unnecessary space "type (*funcptr) (args...)"
4258 if (defined $pre_args_space &&
4259 $pre_args_space =~ /^\s/) {
4260 WARN("SPACING",
4261 "Unnecessary space before function pointer arguments\n" . $herecurr);
4262 }
4263
4264 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004265 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004266 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004267 }
4268 }
4269
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004270# check for spacing round square brackets; allowed:
4271# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004272# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4273# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004274 while ($line =~ /(.*?\s)\[/g) {
4275 my ($where, $prefix) = ($-[1], $1);
4276 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004277 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004278 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004279 if (ERROR("BRACKET_SPACE",
4280 "space prohibited before open square bracket '['\n" . $herecurr) &&
4281 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004282 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004283 s/^(\+.*?)\s+\[/$1\[/;
4284 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004285 }
4286 }
4287
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004288# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004289 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004290 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004291 my $ctx_before = substr($line, 0, $-[1]);
4292 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004293
4294 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004295 if ($name =~ /^(?:
4296 if|for|while|switch|return|case|
4297 volatile|__volatile__|
4298 __attribute__|format|__extension__|
4299 asm|__asm__)$/x)
4300 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004301 # cpp #define statements have non-optional spaces, ie
4302 # if there is a space between the name and the open
4303 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004304 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004305
4306 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004307 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004308
4309 # If this whole things ends with a type its most
4310 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004311 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004312
4313 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004314 if (WARN("SPACING",
4315 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4316 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004317 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004318 s/\b$name\s+\(/$name\(/;
4319 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004320 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004321 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004322
Andy Whitcroft653d4872007-06-23 17:16:34 -07004323# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004324 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004325 my $fixed_line = "";
4326 my $line_fixed = 0;
4327
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004328 my $ops = qr{
4329 <<=|>>=|<=|>=|==|!=|
4330 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4331 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004332 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004333 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004334 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004335 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004336
4337## print("element count: <" . $#elements . ">\n");
4338## foreach my $el (@elements) {
4339## print("el: <$el>\n");
4340## }
4341
4342 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004343 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004344
Joe Perches3705ce52013-07-03 15:05:31 -07004345 foreach my $el (@elements) {
4346 push(@fix_elements, substr($rawline, $off, length($el)));
4347 $off += length($el);
4348 }
4349
4350 $off = 0;
4351
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004352 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004353 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004354
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004355 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004356
4357 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4358
4359## print("n: <$n> good: <$good>\n");
4360
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004361 $off += length($elements[$n]);
4362
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004363 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004364 my $ca = substr($opline, 0, $off);
4365 my $cc = '';
4366 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4367 $cc = substr($opline, $off + length($elements[$n + 1]));
4368 }
4369 my $cb = "$ca$;$cc";
4370
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004371 my $a = '';
4372 $a = 'V' if ($elements[$n] ne '');
4373 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004374 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004375 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4376 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004377 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004378
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004379 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004380
4381 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004382 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004383 $c = 'V' if ($elements[$n + 2] ne '');
4384 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004385 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004386 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4387 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004388 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004389 } else {
4390 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004391 }
4392
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004393 my $ctx = "${a}x${c}";
4394
4395 my $at = "(ctx:$ctx)";
4396
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004397 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004398 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004399
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004400 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004401 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004402
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004403 # Get the full operator variant.
4404 my $opv = $op . substr($curr_vars, $off, 1);
4405
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004406 # Ignore operators passed as parameters.
4407 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004408 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004409
Andy Whitcroftcf655042008-03-04 14:28:20 -08004410# # Ignore comments
4411# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004412
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004413 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004414 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004415 if ($ctx !~ /.x[WEBC]/ &&
4416 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004417 if (ERROR("SPACING",
4418 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004419 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004420 $line_fixed = 1;
4421 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004422 }
4423
4424 # // is a comment
4425 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004426
Joe Perchesb00e4812014-04-03 14:49:33 -07004427 # : when part of a bitfield
4428 } elsif ($opv eq ':B') {
4429 # skip the bitfield test for now
4430
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004431 # No spaces for:
4432 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004433 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004434 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004435 if (ERROR("SPACING",
4436 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004437 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004438 if (defined $fix_elements[$n + 2]) {
4439 $fix_elements[$n + 2] =~ s/^\s+//;
4440 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004441 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004442 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004443 }
4444
Joe Perches23810972014-12-10 15:51:32 -08004445 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004446 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004447 my $rtrim_before = 0;
4448 my $space_after = 0;
4449 if ($ctx =~ /Wx./) {
4450 if (ERROR("SPACING",
4451 "space prohibited before that '$op' $at\n" . $hereptr)) {
4452 $line_fixed = 1;
4453 $rtrim_before = 1;
4454 }
4455 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004456 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004457 if (ERROR("SPACING",
4458 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004459 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004460 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004461 $space_after = 1;
4462 }
4463 }
4464 if ($rtrim_before || $space_after) {
4465 if ($rtrim_before) {
4466 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4467 } else {
4468 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4469 }
4470 if ($space_after) {
4471 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004472 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004473 }
4474
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004475 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004476 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004477 #warn "'*' is part of type\n";
4478
4479 # unary operators should have a space before and
4480 # none after. May be left adjacent to another
4481 # unary operator, or a cast
4482 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004483 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004484 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004485 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004486 if (ERROR("SPACING",
4487 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004488 if ($n != $last_after + 2) {
4489 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4490 $line_fixed = 1;
4491 }
Joe Perches3705ce52013-07-03 15:05:31 -07004492 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004493 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004494 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004495 # A unary '*' may be const
4496
4497 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004498 if (ERROR("SPACING",
4499 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004500 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004501 if (defined $fix_elements[$n + 2]) {
4502 $fix_elements[$n + 2] =~ s/^\s+//;
4503 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004504 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004505 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004506 }
4507
4508 # unary ++ and unary -- are allowed no space on one side.
4509 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004510 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004511 if (ERROR("SPACING",
4512 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004513 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004514 $line_fixed = 1;
4515 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004516 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004517 if ($ctx =~ /Wx[BE]/ ||
4518 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004519 if (ERROR("SPACING",
4520 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004521 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004522 $line_fixed = 1;
4523 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004524 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004525 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004526 if (ERROR("SPACING",
4527 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004528 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004529 if (defined $fix_elements[$n + 2]) {
4530 $fix_elements[$n + 2] =~ s/^\s+//;
4531 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004532 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004533 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004534 }
4535
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004536 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004537 } elsif ($op eq '<<' or $op eq '>>' or
4538 $op eq '&' or $op eq '^' or $op eq '|' or
4539 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004540 $op eq '*' or $op eq '/' or
4541 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004542 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004543 if ($check) {
4544 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4545 if (CHK("SPACING",
4546 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4547 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4548 $fix_elements[$n + 2] =~ s/^\s+//;
4549 $line_fixed = 1;
4550 }
4551 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4552 if (CHK("SPACING",
4553 "space preferred before that '$op' $at\n" . $hereptr)) {
4554 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4555 $line_fixed = 1;
4556 }
4557 }
4558 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004559 if (ERROR("SPACING",
4560 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004561 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4562 if (defined $fix_elements[$n + 2]) {
4563 $fix_elements[$n + 2] =~ s/^\s+//;
4564 }
Joe Perches3705ce52013-07-03 15:05:31 -07004565 $line_fixed = 1;
4566 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004567 }
4568
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004569 # A colon needs no spaces before when it is
4570 # terminating a case value or a label.
4571 } elsif ($opv eq ':C' || $opv eq ':L') {
4572 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004573 if (ERROR("SPACING",
4574 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004575 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004576 $line_fixed = 1;
4577 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004578 }
4579
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004580 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004581 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004582 my $ok = 0;
4583
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004584 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004585 if (($op eq '<' &&
4586 $cc =~ /^\S+\@\S+>/) ||
4587 ($op eq '>' &&
4588 $ca =~ /<\S+\@\S+$/))
4589 {
4590 $ok = 1;
4591 }
4592
Joe Perchese0df7e12015-04-16 12:44:53 -07004593 # for asm volatile statements
4594 # ignore a colon with another
4595 # colon immediately before or after
4596 if (($op eq ':') &&
4597 ($ca =~ /:$/ || $cc =~ /^:/)) {
4598 $ok = 1;
4599 }
4600
Joe Perches84731622013-11-12 15:10:05 -08004601 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004602 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004603 my $msg_level = \&ERROR;
4604 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004605
Jean Delvare0675a8f2017-09-08 16:16:07 -07004606 if (&{$msg_level}("SPACING",
4607 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004608 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4609 if (defined $fix_elements[$n + 2]) {
4610 $fix_elements[$n + 2] =~ s/^\s+//;
4611 }
Joe Perches3705ce52013-07-03 15:05:31 -07004612 $line_fixed = 1;
4613 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004614 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004615 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004616 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004617
4618## print("n: <$n> GOOD: <$good>\n");
4619
4620 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004621 }
Joe Perches3705ce52013-07-03 15:05:31 -07004622
4623 if (($#elements % 2) == 0) {
4624 $fixed_line = $fixed_line . $fix_elements[$#elements];
4625 }
4626
Joe Perches194f66f2014-08-06 16:11:03 -07004627 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4628 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004629 }
4630
4631
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004632 }
4633
Joe Perches786b6322013-07-03 15:05:32 -07004634# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004635 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004636 if (WARN("SPACING",
4637 "space prohibited before semicolon\n" . $herecurr) &&
4638 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004639 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004640 s/^(\+.*\S)\s+;/$1;/;
4641 }
4642 }
4643
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004644# check for multiple assignments
4645 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004646 CHK("MULTIPLE_ASSIGNMENTS",
4647 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004648 }
4649
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004650## # check for multiple declarations, allowing for a function declaration
4651## # continuation.
4652## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4653## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4654##
4655## # Remove any bracketed sections to ensure we do not
4656## # falsly report the parameters of functions.
4657## my $ln = $line;
4658## while ($ln =~ s/\([^\(\)]*\)//g) {
4659## }
4660## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004661## WARN("MULTIPLE_DECLARATION",
4662## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004663## }
4664## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004665
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004666#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004667 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004668 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004669 if (ERROR("SPACING",
4670 "space required before the open brace '{'\n" . $herecurr) &&
4671 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004672 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004673 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004674 }
4675
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004676## # check for blank lines before declarations
4677## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4678## $prevrawline =~ /^.\s*$/) {
4679## WARN("SPACING",
4680## "No blank lines before declarations\n" . $hereprev);
4681## }
4682##
4683
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004684# closing brace should have a space following it when it has anything
4685# on the line
Joe Perches94fb9842019-09-25 16:46:47 -07004686 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004687 if (ERROR("SPACING",
4688 "space required after that close brace '}'\n" . $herecurr) &&
4689 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004690 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004691 s/}((?!(?:,|;|\)))\S)/} $1/;
4692 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004693 }
4694
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004695# check spacing on square brackets
4696 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004697 if (ERROR("SPACING",
4698 "space prohibited after that open 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 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004705 if (ERROR("SPACING",
4706 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4707 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004708 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004709 s/\s+\]/\]/;
4710 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004711 }
4712
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004713# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004714 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4715 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004716 if (ERROR("SPACING",
4717 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4718 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004719 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004720 s/\(\s+/\(/;
4721 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004722 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004723 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004724 $line !~ /for\s*\(.*;\s+\)/ &&
4725 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004726 if (ERROR("SPACING",
4727 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4728 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004729 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004730 s/\s+\)/\)/;
4731 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004732 }
4733
Joe Perchese2826fd2014-08-06 16:10:48 -07004734# check unnecessary parentheses around addressof/dereference single $Lvals
4735# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4736
4737 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004738 my $var = $1;
4739 if (CHK("UNNECESSARY_PARENTHESES",
4740 "Unnecessary parentheses around $var\n" . $herecurr) &&
4741 $fix) {
4742 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4743 }
4744 }
4745
4746# check for unnecessary parentheses around function pointer uses
4747# ie: (foo->bar)(); should be foo->bar();
4748# but not "if (foo->bar) (" to avoid some false positives
4749 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4750 my $var = $2;
4751 if (CHK("UNNECESSARY_PARENTHESES",
4752 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4753 $fix) {
4754 my $var2 = deparenthesize($var);
4755 $var2 =~ s/\s//g;
4756 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4757 }
4758 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004759
Joe Perches63b7c732017-09-08 16:16:01 -07004760# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004761# when !drivers/staging or command-line uses --strict
4762 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07004763 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004764 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4765 my $if_stat = $1;
4766 my $test = substr($2, 1, -1);
4767 my $herectx;
4768 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4769 my $match = $1;
4770 # avoid parentheses around potential macro args
4771 next if ($match =~ /^\s*\w+\s*$/);
4772 if (!defined($herectx)) {
4773 $herectx = $here . "\n";
4774 my $cnt = statement_rawlines($if_stat);
4775 for (my $n = 0; $n < $cnt; $n++) {
4776 my $rl = raw_line($linenr, $n);
4777 $herectx .= $rl . "\n";
4778 last if $rl =~ /^[ \+].*\{/;
4779 }
4780 }
4781 CHK("UNNECESSARY_PARENTHESES",
4782 "Unnecessary parentheses around '$match'\n" . $herectx);
4783 }
4784 }
4785
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004786#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004787 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004788 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004789 if (WARN("INDENTED_LABEL",
4790 "labels should not be indented\n" . $herecurr) &&
4791 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004792 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004793 s/^(.)\s+/$1/;
4794 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004795 }
4796
Joe Perches5b9553a2014-04-03 14:49:21 -07004797# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004798 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004799 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07004800 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004801 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4802 my $value = $1;
4803 $value = deparenthesize($value);
4804 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4805 ERROR("RETURN_PARENTHESES",
4806 "return is not a function, parentheses are not required\n" . $herecurr);
4807 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004808 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004809 ERROR("SPACING",
4810 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004811 }
4812 }
Joe Perches507e5142013-11-12 15:10:13 -08004813
Joe Perchesb43ae212014-06-23 13:22:07 -07004814# unnecessary return in a void function
4815# at end-of-function, with the previous line a single leading tab, then return;
4816# and the line before that not a goto label target like "out:"
4817 if ($sline =~ /^[ \+]}\s*$/ &&
4818 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4819 $linenr >= 3 &&
4820 $lines[$linenr - 3] =~ /^[ +]/ &&
4821 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004822 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004823 "void function return statements are not generally useful\n" . $hereprev);
4824 }
Joe Perches9819cf22014-06-04 16:12:09 -07004825
Joe Perches189248d2014-01-23 15:54:47 -08004826# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07004827 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08004828 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4829 my $openparens = $1;
4830 my $count = $openparens =~ tr@\(@\(@;
4831 my $msg = "";
4832 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4833 my $comp = $4; #Not $1 because of $LvalOrFunc
4834 $msg = " - maybe == should be = ?" if ($comp eq "==");
4835 WARN("UNNECESSARY_PARENTHESES",
4836 "Unnecessary parentheses$msg\n" . $herecurr);
4837 }
4838 }
4839
Joe Perchesc5595fa2015-09-09 15:37:58 -07004840# comparisons with a constant or upper case identifier on the left
4841# avoid cases like "foo + BAR < baz"
4842# only fix matches surrounded by parentheses to avoid incorrect
4843# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07004844 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004845 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4846 my $lead = $1;
4847 my $const = $2;
4848 my $comp = $3;
4849 my $to = $4;
4850 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004851 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004852 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4853 WARN("CONSTANT_COMPARISON",
4854 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4855 $fix) {
4856 if ($comp eq "<") {
4857 $newcomp = ">";
4858 } elsif ($comp eq "<=") {
4859 $newcomp = ">=";
4860 } elsif ($comp eq ">") {
4861 $newcomp = "<";
4862 } elsif ($comp eq ">=") {
4863 $newcomp = "<=";
4864 }
4865 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4866 }
4867 }
4868
Joe Perchesf34e4a42015-04-16 12:44:19 -07004869# Return of what appears to be an errno should normally be negative
4870 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004871 my $name = $1;
4872 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004873 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004874 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004875 }
4876 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004877
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004878# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004879 if ($line =~ /\b(if|while|for|switch)\(/) {
4880 if (ERROR("SPACING",
4881 "space required before the open parenthesis '('\n" . $herecurr) &&
4882 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004883 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004884 s/\b(if|while|for|switch)\(/$1 \(/;
4885 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004886 }
4887
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004888# Check for illegal assignment in if conditional -- and check for trailing
4889# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004890 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004891 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4892 ctx_statement_block($linenr, $realcnt, 0)
4893 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004894 my ($stat_next) = ctx_statement_block($line_nr_next,
4895 $remain_next, $off_next);
4896 $stat_next =~ s/\n./\n /g;
4897 ##print "stat<$stat> stat_next<$stat_next>\n";
4898
4899 if ($stat_next =~ /^\s*while\b/) {
4900 # If the statement carries leading newlines,
4901 # then count those as offsets.
4902 my ($whitespace) =
4903 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4904 my $offset =
4905 statement_rawlines($whitespace) - 1;
4906
4907 $suppress_whiletrailers{$line_nr_next +
4908 $offset} = 1;
4909 }
4910 }
4911 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004912 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004913 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004914 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004915
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004916 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004917 ERROR("ASSIGN_IN_IF",
4918 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004919 }
4920
4921 # Find out what is on the end of the line after the
4922 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004923 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004924 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004925 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004926 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4927 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004928 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004929 # Find out how long the conditional actually is.
4930 my @newlines = ($c =~ /\n/gs);
4931 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004932 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004933
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004934 $stat_real = raw_line($linenr, $cond_lines)
4935 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004936 if (defined($stat_real) && $cond_lines > 1) {
4937 $stat_real = "[...]\n$stat_real";
4938 }
4939
Joe Perches000d1cc12011-07-25 17:13:25 -07004940 ERROR("TRAILING_STATEMENTS",
4941 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004942 }
4943 }
4944
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004945# Check for bitwise tests written as boolean
4946 if ($line =~ /
4947 (?:
4948 (?:\[|\(|\&\&|\|\|)
4949 \s*0[xX][0-9]+\s*
4950 (?:\&\&|\|\|)
4951 |
4952 (?:\&\&|\|\|)
4953 \s*0[xX][0-9]+\s*
4954 (?:\&\&|\|\||\)|\])
4955 )/x)
4956 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004957 WARN("HEXADECIMAL_BOOLEAN_TEST",
4958 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004959 }
4960
Andy Whitcroft8905a672007-11-28 16:21:06 -08004961# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004962 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4963 my $s = $1;
4964 $s =~ s/$;//g; # Remove any comments
4965 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004966 ERROR("TRAILING_STATEMENTS",
4967 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004968 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004969 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004970# if should not continue a brace
4971 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004972 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004973 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004974 $herecurr);
4975 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004976# case and default should not have general statements after them
4977 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4978 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004979 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004980 \s*return\s+
4981 )/xg)
4982 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004983 ERROR("TRAILING_STATEMENTS",
4984 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004985 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004986
4987 # Check for }<nl>else {, these must be at the same
4988 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004989 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4990 $previndent == $indent) {
4991 if (ERROR("ELSE_AFTER_BRACE",
4992 "else should follow close brace '}'\n" . $hereprev) &&
4993 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4994 fix_delete_line($fixlinenr - 1, $prevrawline);
4995 fix_delete_line($fixlinenr, $rawline);
4996 my $fixedline = $prevrawline;
4997 $fixedline =~ s/}\s*$//;
4998 if ($fixedline !~ /^\+\s*$/) {
4999 fix_insert_line($fixlinenr, $fixedline);
5000 }
5001 $fixedline = $rawline;
5002 $fixedline =~ s/^(.\s*)else/$1} else/;
5003 fix_insert_line($fixlinenr, $fixedline);
5004 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005005 }
5006
Joe Perches8b8856f2014-08-06 16:11:14 -07005007 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
5008 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005009 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
5010
5011 # Find out what is on the end of the line after the
5012 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07005013 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005014 $s =~ s/\n.*//g;
5015
5016 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07005017 if (ERROR("WHILE_AFTER_BRACE",
5018 "while should follow close brace '}'\n" . $hereprev) &&
5019 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
5020 fix_delete_line($fixlinenr - 1, $prevrawline);
5021 fix_delete_line($fixlinenr, $rawline);
5022 my $fixedline = $prevrawline;
5023 my $trailing = $rawline;
5024 $trailing =~ s/^\+//;
5025 $trailing = trim($trailing);
5026 $fixedline =~ s/}\s*$/} $trailing/;
5027 fix_insert_line($fixlinenr, $fixedline);
5028 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005029 }
5030 }
5031
Joe Perches95e2c602013-07-03 15:05:20 -07005032#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005033 while ($line =~ m{($Constant|$Lval)}g) {
5034 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005035
Joe Perches95e2c602013-07-03 15:05:20 -07005036#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005037 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005038 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005039#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005040 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005041#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08005042 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
5043#Ignore some three character SI units explicitly, like MiB and KHz
5044 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005045 while ($var =~ m{($Ident)}g) {
5046 my $word = $1;
5047 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005048 if ($check) {
5049 seed_camelcase_includes();
5050 if (!$file && !$camelcase_file_seeded) {
5051 seed_camelcase_file($realfile);
5052 $camelcase_file_seeded = 1;
5053 }
5054 }
Joe Perches7e781f62013-09-11 14:23:55 -07005055 if (!defined $camelcase{$word}) {
5056 $camelcase{$word} = 1;
5057 CHK("CAMELCASE",
5058 "Avoid CamelCase: <$word>\n" . $herecurr);
5059 }
Joe Perches34456862013-07-03 15:05:34 -07005060 }
Joe Perches323c1262012-12-17 16:02:07 -08005061 }
5062 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005063
5064#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005065 if ($line =~ /\#\s*define.*\\\s+$/) {
5066 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5067 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5068 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005069 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005070 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005071 }
5072
Fabian Frederick0e212e02015-04-16 12:44:25 -07005073# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5074# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005075 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005076 my $file = "$1.h";
5077 my $checkfile = "include/linux/$file";
5078 if (-f "$root/$checkfile" &&
5079 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005080 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005081 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005082 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5083 if ($asminclude > 0) {
5084 if ($realfile =~ m{^arch/}) {
5085 CHK("ARCH_INCLUDE_LINUX",
5086 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5087 } else {
5088 WARN("INCLUDE_LINUX",
5089 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5090 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005091 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005092 }
5093 }
5094
Andy Whitcroft653d4872007-06-23 17:16:34 -07005095# multi-statement macros should be enclosed in a do while loop, grab the
5096# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005097# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07005098 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5099 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005100 my $ln = $linenr;
5101 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005102 my ($off, $dstat, $dcond, $rest);
5103 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005104 my $has_flow_statement = 0;
5105 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005106 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005107 ctx_statement_block($linenr, $realcnt, 0);
5108 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005109 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005110 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005111
Joe Perches08a28432014-10-13 15:51:55 -07005112 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005113 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005114
Joe Perchesf59b64b2016-10-11 13:52:08 -07005115 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5116 my $define_args = $1;
5117 my $define_stmt = $dstat;
5118 my @def_args = ();
5119
5120 if (defined $define_args && $define_args ne "") {
5121 $define_args = substr($define_args, 1, length($define_args) - 2);
5122 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005123 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005124 @def_args = split(",", $define_args);
5125 }
5126
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005127 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005128 $dstat =~ s/\\\n.//g;
5129 $dstat =~ s/^\s*//s;
5130 $dstat =~ s/\s*$//s;
5131
5132 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005133 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5134 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005135 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005136 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005137 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005138
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005139 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07005140 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5141 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005142 {
5143 }
5144
Joe Perches42e15292016-03-15 14:58:01 -07005145 # Make asm volatile uses seem like a generic function
5146 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5147
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005148 my $exceptions = qr{
5149 $Declare|
5150 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005151 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005152 DECLARE_PER_CPU|
5153 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005154 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005155 union|
5156 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005157 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005158 ^\"|\"$|
5159 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005160 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005161 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005162
5163 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005164 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005165 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005166
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005167 if ($dstat ne '' &&
5168 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5169 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005170 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005171 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005172 $dstat !~ /$exceptions/ &&
5173 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005174 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005175 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005176 $dstat !~ /^for\s*$Constant$/ && # for (...)
5177 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5178 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005179 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005180 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005181 {
Joe Perchese7955562017-05-08 15:55:48 -07005182 if ($dstat =~ /^\s*if\b/) {
5183 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5184 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5185 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005186 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5187 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5188 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005189 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005190 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005191 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005192
5193 }
Joe Perches52076492016-10-11 13:52:14 -07005194
5195 # Make $define_stmt single line, comment-free, etc
5196 my @stmt_array = split('\n', $define_stmt);
5197 my $first = 1;
5198 $define_stmt = "";
5199 foreach my $l (@stmt_array) {
5200 $l =~ s/\\$//;
5201 if ($first) {
5202 $define_stmt = $l;
5203 $first = 0;
5204 } elsif ($l =~ /^[\+ ]/) {
5205 $define_stmt .= substr($l, 1);
5206 }
5207 }
5208 $define_stmt =~ s/$;//g;
5209 $define_stmt =~ s/\s+/ /g;
5210 $define_stmt = trim($define_stmt);
5211
Joe Perchesf59b64b2016-10-11 13:52:08 -07005212# check if any macro arguments are reused (ignore '...' and 'type')
5213 foreach my $arg (@def_args) {
5214 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005215 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005216 my $tmp_stmt = $define_stmt;
Brendan Jackman6dba8242019-09-25 16:46:41 -07005217 $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 -07005218 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5219 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005220 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005221 if ($use_cnt > 1) {
5222 CHK("MACRO_ARG_REUSE",
5223 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005224 }
5225# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005226 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005227 ((defined($1) && $1 ne ',') ||
5228 (defined($2) && $2 ne ','))) {
5229 CHK("MACRO_ARG_PRECEDENCE",
5230 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005231 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005232 }
Joe Perches5023d342012-12-17 16:01:47 -08005233
Joe Perches08a28432014-10-13 15:51:55 -07005234# check for macros with flow control, but without ## concatenation
5235# ## concatenation is commonly a macro that defines a function so ignore those
5236 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005237 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005238 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005239
Joe Perches08a28432014-10-13 15:51:55 -07005240 WARN("MACRO_WITH_FLOW_CONTROL",
5241 "Macros with flow control statements should be avoided\n" . "$herectx");
5242 }
5243
Joe Perches481eb482012-12-17 16:01:56 -08005244# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005245
5246 } else {
5247 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005248 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5249 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005250 $line =~ /^\+.*\\$/) {
5251 WARN("LINE_CONTINUATIONS",
5252 "Avoid unnecessary line continuations\n" . $herecurr);
5253 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005254 }
5255
Joe Perchesb13edf72012-07-30 14:41:24 -07005256# do {} while (0) macro tests:
5257# single-statement macros do not need to be enclosed in do while (0) loop,
5258# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005259 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005260 $realfile !~ m@/vmlinux.lds.h$@ &&
5261 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5262 my $ln = $linenr;
5263 my $cnt = $realcnt;
5264 my ($off, $dstat, $dcond, $rest);
5265 my $ctx = '';
5266 ($dstat, $dcond, $ln, $cnt, $off) =
5267 ctx_statement_block($linenr, $realcnt, 0);
5268 $ctx = $dstat;
5269
5270 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005271 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005272
5273 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5274 my $stmts = $2;
5275 my $semis = $3;
5276
5277 $ctx =~ s/\n*$//;
5278 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005279 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005280
Joe Perchesac8e97f2012-08-21 16:15:53 -07005281 if (($stmts =~ tr/;/;/) == 1 &&
5282 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005283 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5284 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5285 }
5286 if (defined $semis && $semis ne "") {
5287 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5288 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5289 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005290 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5291 $ctx =~ s/\n*$//;
5292 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005293 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005294
5295 WARN("TRAILING_SEMICOLON",
5296 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005297 }
5298 }
5299
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005300# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005301 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5302 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005303 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005304 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005305 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5306 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005307 my @allowed = ();
5308 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005309 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005310 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005311 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005312 for my $chunk (@chunks) {
5313 my ($cond, $block) = @{$chunk};
5314
Andy Whitcroft773647a2008-03-28 14:15:58 -07005315 # If the condition carries leading newlines, then count those as offsets.
5316 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5317 my $offset = statement_rawlines($whitespace) - 1;
5318
Joe Perchesaad4f612012-03-23 15:02:19 -07005319 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005320 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5321
5322 # We have looked at and allowed this specific line.
5323 $suppress_ifbraces{$ln + $offset} = 1;
5324
5325 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005326 $ln += statement_rawlines($block) - 1;
5327
Andy Whitcroft773647a2008-03-28 14:15:58 -07005328 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005329
5330 $seen++ if ($block =~ /^\s*{/);
5331
Joe Perchesaad4f612012-03-23 15:02:19 -07005332 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005333 if (statement_lines($cond) > 1) {
5334 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005335 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005336 }
5337 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005338 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005339 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005340 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005341 if (statement_block_size($block) > 1) {
5342 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005343 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005344 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005345 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005346 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005347 if ($seen) {
5348 my $sum_allowed = 0;
5349 foreach (@allowed) {
5350 $sum_allowed += $_;
5351 }
5352 if ($sum_allowed == 0) {
5353 WARN("BRACES",
5354 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5355 } elsif ($sum_allowed != $allow &&
5356 $seen != $allow) {
5357 CHK("BRACES",
5358 "braces {} should be used on all arms of this statement\n" . $herectx);
5359 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005360 }
5361 }
5362 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005363 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005364 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005365 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005366
Andy Whitcroftcf655042008-03-04 14:28:20 -08005367 # Check the pre-context.
5368 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5369 #print "APW: ALLOWED: pre<$1>\n";
5370 $allowed = 1;
5371 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005372
5373 my ($level, $endln, @chunks) =
5374 ctx_statement_full($linenr, $realcnt, $-[0]);
5375
Andy Whitcroftcf655042008-03-04 14:28:20 -08005376 # Check the condition.
5377 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005378 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005379 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005380 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005381 }
5382 if (statement_lines($cond) > 1) {
5383 #print "APW: ALLOWED: cond<$cond>\n";
5384 $allowed = 1;
5385 }
5386 if ($block =~/\b(?:if|for|while)\b/) {
5387 #print "APW: ALLOWED: block<$block>\n";
5388 $allowed = 1;
5389 }
5390 if (statement_block_size($block) > 1) {
5391 #print "APW: ALLOWED: lines block<$block>\n";
5392 $allowed = 1;
5393 }
5394 # Check the post-context.
5395 if (defined $chunks[1]) {
5396 my ($cond, $block) = @{$chunks[1]};
5397 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005398 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005399 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005400 if ($block =~ /^\s*\{/) {
5401 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5402 $allowed = 1;
5403 }
5404 }
5405 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005406 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005407 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005408
Joe Perches000d1cc12011-07-25 17:13:25 -07005409 WARN("BRACES",
5410 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005411 }
5412 }
5413
Joe Perchese4c5bab2017-02-24 15:01:41 -08005414# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005415 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5416 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005417 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5418 }
5419
Joe Perches0979ae62012-12-17 16:01:59 -08005420# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005421 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005422 if (CHK("BRACES",
5423 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5424 $fix && $prevrawline =~ /^\+/) {
5425 fix_delete_line($fixlinenr - 1, $prevrawline);
5426 }
Joe Perches0979ae62012-12-17 16:01:59 -08005427 }
Joe Perches77b9a532013-07-03 15:05:29 -07005428 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005429 if (CHK("BRACES",
5430 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5431 $fix) {
5432 fix_delete_line($fixlinenr, $rawline);
5433 }
Joe Perches0979ae62012-12-17 16:01:59 -08005434 }
5435
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005436# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005437 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5438 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005439 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005440 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005441 }
5442
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005443# Check for user-visible strings broken across lines, which breaks the ability
5444# to grep for the string. Make exceptions when the previous string ends in a
5445# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5446# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005447 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005448 $prevline =~ /"\s*$/ &&
5449 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5450 if (WARN("SPLIT_STRING",
5451 "quoted string split across lines\n" . $hereprev) &&
5452 $fix &&
5453 $prevrawline =~ /^\+.*"\s*$/ &&
5454 $last_coalesced_string_linenr != $linenr - 1) {
5455 my $extracted_string = get_quoted_string($line, $rawline);
5456 my $comma_close = "";
5457 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5458 $comma_close = $1;
5459 }
5460
5461 fix_delete_line($fixlinenr - 1, $prevrawline);
5462 fix_delete_line($fixlinenr, $rawline);
5463 my $fixedline = $prevrawline;
5464 $fixedline =~ s/"\s*$//;
5465 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5466 fix_insert_line($fixlinenr - 1, $fixedline);
5467 $fixedline = $rawline;
5468 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5469 if ($fixedline !~ /\+\s*$/) {
5470 fix_insert_line($fixlinenr, $fixedline);
5471 }
5472 $last_coalesced_string_linenr = $linenr;
5473 }
5474 }
5475
5476# check for missing a space in a string concatenation
5477 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5478 WARN('MISSING_SPACE',
5479 "break quoted strings at a space character\n" . $hereprev);
5480 }
5481
Joe Perchese4b7d302017-05-08 15:55:51 -07005482# check for an embedded function name in a string when the function is known
5483# This does not work very well for -f --file checking as it depends on patch
5484# context providing the function name or a single line form for in-file
5485# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005486 if ($line =~ /^\+.*$String/ &&
5487 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005488 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5489 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005490 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005491 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005492 }
5493
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005494# check for spaces before a quoted newline
5495 if ($rawline =~ /^.*\".*\s\\n/) {
5496 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5497 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5498 $fix) {
5499 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5500 }
5501
5502 }
5503
Joe Perchesf17dba42014-10-13 15:51:51 -07005504# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005505 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5506 if (CHK("CONCATENATED_STRING",
5507 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5508 $fix) {
5509 while ($line =~ /($String)/g) {
5510 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5511 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5512 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5513 }
5514 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005515 }
5516
Joe Perches90ad30e2014-12-10 15:51:59 -08005517# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005518 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005519 if (WARN("STRING_FRAGMENTS",
5520 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5521 $fix) {
5522 while ($line =~ /($String)(?=\s*")/g) {
5523 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5524 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5525 }
5526 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005527 }
5528
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005529# check for non-standard and hex prefixed decimal printf formats
5530 my $show_L = 1; #don't show the same defect twice
5531 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005532 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005533 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005534 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005535 # check for %L
5536 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005537 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005538 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5539 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005540 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005541 # check for %Z
5542 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5543 WARN("PRINTF_Z",
5544 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5545 $show_Z = 0;
5546 }
5547 # check for 0x<decimal>
5548 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5549 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005550 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5551 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005552 }
5553
5554# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005555 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005556 WARN("LINE_CONTINUATIONS",
5557 "Avoid line continuations in quoted strings\n" . $herecurr);
5558 }
5559
Andy Whitcroft00df3442007-06-08 13:47:06 -07005560# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005561 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07005562 WARN("IF_0",
5563 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5564 }
5565
5566# warn about #if 1
5567 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5568 WARN("IF_1",
5569 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005570 }
5571
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005572# check for needless "if (<foo>) fn(<foo>)" uses
5573 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005574 my $tested = quotemeta($1);
5575 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5576 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5577 my $func = $1;
5578 if (WARN('NEEDLESS_IF',
5579 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5580 $fix) {
5581 my $do_fix = 1;
5582 my $leading_tabs = "";
5583 my $new_leading_tabs = "";
5584 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5585 $leading_tabs = $1;
5586 } else {
5587 $do_fix = 0;
5588 }
5589 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5590 $new_leading_tabs = $1;
5591 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5592 $do_fix = 0;
5593 }
5594 } else {
5595 $do_fix = 0;
5596 }
5597 if ($do_fix) {
5598 fix_delete_line($fixlinenr - 1, $prevrawline);
5599 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5600 }
5601 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005602 }
5603 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005604
Joe Perchesebfdc402014-08-06 16:10:27 -07005605# check for unnecessary "Out of Memory" messages
5606 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5607 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5608 (defined $1 || defined $3) &&
5609 $linenr > 3) {
5610 my $testval = $2;
5611 my $testline = $lines[$linenr - 3];
5612
5613 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5614# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5615
Joe Perchese29a70f2019-03-07 16:28:35 -08005616 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5617 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005618 WARN("OOM_MESSAGE",
5619 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5620 }
5621 }
5622
Joe Perchesf78d98f2014-10-13 15:52:01 -07005623# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005624 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005625 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5626 my $level = $1;
5627 if (WARN("UNNECESSARY_KERN_LEVEL",
5628 "Possible unnecessary $level\n" . $herecurr) &&
5629 $fix) {
5630 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5631 }
5632 }
5633
Joe Perches45c55e92017-02-24 15:01:31 -08005634# check for logging continuations
5635 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5636 WARN("LOGGING_CONTINUATION",
5637 "Avoid logging continuation uses where feasible\n" . $herecurr);
5638 }
5639
Joe Perchesabb08a52014-12-10 15:51:46 -08005640# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07005641 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08005642 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5643 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5644 WARN("MASK_THEN_SHIFT",
5645 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5646 }
5647
Joe Perchesb75ac612014-12-10 15:52:02 -08005648# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07005649 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08005650 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5651 my $val = $1;
5652 my $equal = "!";
5653 $equal = "" if ($4 eq "!=");
5654 if (CHK("COMPARISON_TO_NULL",
5655 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5656 $fix) {
5657 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5658 }
5659 }
5660 }
5661
Joe Perches8716de32013-09-11 14:24:05 -07005662# check for bad placement of section $InitAttribute (e.g.: __initdata)
5663 if ($line =~ /(\b$InitAttribute\b)/) {
5664 my $attr = $1;
5665 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5666 my $ptr = $1;
5667 my $var = $2;
5668 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5669 ERROR("MISPLACED_INIT",
5670 "$attr should be placed after $var\n" . $herecurr)) ||
5671 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5672 WARN("MISPLACED_INIT",
5673 "$attr should be placed after $var\n" . $herecurr))) &&
5674 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005675 $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 -07005676 }
5677 }
5678 }
5679
Joe Perchese970b8842013-11-12 15:10:10 -08005680# check for $InitAttributeData (ie: __initdata) with const
5681 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5682 my $attr = $1;
5683 $attr =~ /($InitAttributePrefix)(.*)/;
5684 my $attr_prefix = $1;
5685 my $attr_type = $2;
5686 if (ERROR("INIT_ATTRIBUTE",
5687 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5688 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005689 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005690 s/$InitAttributeData/${attr_prefix}initconst/;
5691 }
5692 }
5693
5694# check for $InitAttributeConst (ie: __initconst) without const
5695 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5696 my $attr = $1;
5697 if (ERROR("INIT_ATTRIBUTE",
5698 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5699 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005700 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005701 /(^\+\s*(?:static\s+))/;
5702 $lead = rtrim($1);
5703 $lead = "$lead " if ($lead !~ /^\+$/);
5704 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005705 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005706 }
5707 }
5708
Joe Perchesc17893c2015-04-16 12:44:42 -07005709# check for __read_mostly with const non-pointer (should just be const)
5710 if ($line =~ /\b__read_mostly\b/ &&
5711 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5712 if (ERROR("CONST_READ_MOSTLY",
5713 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5714 $fix) {
5715 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5716 }
5717 }
5718
Joe Perchesfbdb8132014-04-03 14:49:14 -07005719# don't use __constant_<foo> functions outside of include/uapi/
5720 if ($realfile !~ m@^include/uapi/@ &&
5721 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5722 my $constant_func = $1;
5723 my $func = $constant_func;
5724 $func =~ s/^__constant_//;
5725 if (WARN("CONSTANT_CONVERSION",
5726 "$constant_func should be $func\n" . $herecurr) &&
5727 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005728 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005729 }
5730 }
5731
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005732# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005733 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005734 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005735 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005736 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005737 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005738 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07005739 }
5740 if ($delay > 2000) {
5741 WARN("LONG_UDELAY",
5742 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005743 }
5744 }
5745
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005746# warn about unexpectedly long msleep's
5747 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5748 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005749 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005750 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005751 }
5752 }
5753
Joe Perches36ec1932013-07-03 15:05:25 -07005754# check for comparisons of jiffies
5755 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5756 WARN("JIFFIES_COMPARISON",
5757 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5758 }
5759
Joe Perches9d7a34a2013-07-03 15:05:26 -07005760# check for comparisons of get_jiffies_64()
5761 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5762 WARN("JIFFIES_COMPARISON",
5763 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5764 }
5765
Andy Whitcroft00df3442007-06-08 13:47:06 -07005766# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005767# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005768# print "#ifdef in C files should be avoided\n";
5769# print "$herecurr";
5770# $clean = 0;
5771# }
5772
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005773# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005774 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005775 if (ERROR("SPACING",
5776 "exactly one space required after that #$1\n" . $herecurr) &&
5777 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005778 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005779 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5780 }
5781
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005782 }
5783
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005784# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005785 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5786 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005787 my $which = $1;
5788 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005789 CHK("UNCOMMENTED_DEFINITION",
5790 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005791 }
5792 }
5793# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005794
5795 my $barriers = qr{
5796 mb|
5797 rmb|
5798 wmb|
5799 read_barrier_depends
5800 }x;
5801 my $barrier_stems = qr{
5802 mb__before_atomic|
5803 mb__after_atomic|
5804 store_release|
5805 load_acquire|
5806 store_mb|
5807 (?:$barriers)
5808 }x;
5809 my $all_barriers = qr{
5810 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005811 smp_(?:$barrier_stems)|
5812 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005813 }x;
5814
5815 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005816 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005817 WARN("MEMORY_BARRIER",
5818 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005819 }
5820 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005821
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005822 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5823
5824 if ($realfile !~ m@^include/asm-generic/@ &&
5825 $realfile !~ m@/barrier\.h$@ &&
5826 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5827 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5828 WARN("MEMORY_BARRIER",
5829 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5830 }
5831
Joe Perchescb426e92015-06-25 15:02:46 -07005832# check for waitqueue_active without a comment.
5833 if ($line =~ /\bwaitqueue_active\s*\(/) {
5834 if (!ctx_has_comment($first_line, $linenr)) {
5835 WARN("WAITQUEUE_ACTIVE",
5836 "waitqueue_active without comment\n" . $herecurr);
5837 }
5838 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005839
Paul E. McKenney91db2592017-11-27 09:37:35 -08005840# check for smp_read_barrier_depends and read_barrier_depends
5841 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5842 WARN("READ_BARRIER_DEPENDS",
5843 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5844 }
5845
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005846# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005847 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005848 CHK("ARCH_DEFINES",
5849 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005850 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005851
Joe Perches596ed452017-07-12 14:37:02 -07005852# check that the storage class is not after a type
5853 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005854 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005855 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5856 }
5857# Check that the storage class is at the beginning of a declaration
5858 if ($line =~ /\b$Storage\b/ &&
5859 $line !~ /^.\s*$Storage/ &&
5860 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5861 $1 !~ /[\,\)]\s*$/) {
5862 WARN("STORAGE_CLASS",
5863 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005864 }
5865
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005866# check the location of the inline attribute, that it is between
5867# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005868 if ($line =~ /\b$Type\s+$Inline\b/ ||
5869 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005870 ERROR("INLINE_LOCATION",
5871 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005872 }
5873
Andy Whitcroft8905a672007-11-28 16:21:06 -08005874# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005875 if ($realfile !~ m@\binclude/uapi/@ &&
5876 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005877 if (WARN("INLINE",
5878 "plain inline is preferred over $1\n" . $herecurr) &&
5879 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005880 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005881
5882 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005883 }
5884
Joe Perches3d130fd2011-01-12 17:00:00 -08005885# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005886 if ($realfile !~ m@\binclude/uapi/@ &&
5887 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005888 WARN("PREFER_PACKED",
5889 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005890 }
5891
Joe Perches39b7e282011-07-25 17:13:24 -07005892# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005893 if ($realfile !~ m@\binclude/uapi/@ &&
5894 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005895 WARN("PREFER_ALIGNED",
5896 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005897 }
5898
Joe Perches462811d2019-09-25 16:46:44 -07005899# Check for __attribute__ section, prefer __section
5900 if ($realfile !~ m@\binclude/uapi/@ &&
5901 $line =~ /\b__attribute__\s*\(\s*\(.*_*section_*\s*\(\s*("[^"]*")/) {
5902 my $old = substr($rawline, $-[1], $+[1] - $-[1]);
5903 my $new = substr($old, 1, -1);
5904 if (WARN("PREFER_SECTION",
5905 "__section($new) is preferred over __attribute__((section($old)))\n" . $herecurr) &&
5906 $fix) {
5907 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
5908 }
5909 }
5910
Joe Perches5f14d3b2012-01-10 15:09:52 -08005911# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005912 if ($realfile !~ m@\binclude/uapi/@ &&
5913 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005914 if (WARN("PREFER_PRINTF",
5915 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5916 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005917 $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 -07005918
5919 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005920 }
5921
Joe Perches6061d942012-03-23 15:02:16 -07005922# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005923 if ($realfile !~ m@\binclude/uapi/@ &&
5924 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005925 if (WARN("PREFER_SCANF",
5926 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5927 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005928 $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 -07005929 }
Joe Perches6061d942012-03-23 15:02:16 -07005930 }
5931
Joe Perches619a9082014-12-10 15:51:35 -08005932# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07005933 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08005934 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5935 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5936 $line =~ /\b__weak\b/)) {
5937 ERROR("WEAK_DECLARATION",
5938 "Using weak declarations can have unintended link defects\n" . $herecurr);
5939 }
5940
Tomas Winklerfd39f902016-12-12 16:46:34 -08005941# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005942 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005943 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005944 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5945 my $type = $1;
5946 if ($type =~ /\b($typeC99Typedefs)\b/) {
5947 $type = $1;
5948 my $kernel_type = 'u';
5949 $kernel_type = 's' if ($type =~ /^_*[si]/);
5950 $type =~ /(\d+)/;
5951 $kernel_type .= $1;
5952 if (CHK("PREFER_KERNEL_TYPES",
5953 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5954 $fix) {
5955 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5956 }
5957 }
5958 }
5959
Joe Perches938224b2016-01-20 14:59:15 -08005960# check for cast of C90 native int or longer types constants
5961 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5962 my $cast = $1;
5963 my $const = $2;
5964 if (WARN("TYPECAST_INT_CONSTANT",
5965 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5966 $fix) {
5967 my $suffix = "";
5968 my $newconst = $const;
5969 $newconst =~ s/${Int_type}$//;
5970 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5971 if ($cast =~ /\blong\s+long\b/) {
5972 $suffix .= 'LL';
5973 } elsif ($cast =~ /\blong\b/) {
5974 $suffix .= 'L';
5975 }
5976 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5977 }
5978 }
5979
Joe Perches8f53a9b2010-03-05 13:43:48 -08005980# check for sizeof(&)
5981 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005982 WARN("SIZEOF_ADDRESS",
5983 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005984 }
5985
Joe Perches66c80b62012-07-30 14:41:22 -07005986# check for sizeof without parenthesis
5987 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005988 if (WARN("SIZEOF_PARENTHESIS",
5989 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5990 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005991 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005992 }
Joe Perches66c80b62012-07-30 14:41:22 -07005993 }
5994
Joe Perches88982fe2012-12-17 16:02:00 -08005995# check for struct spinlock declarations
5996 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5997 WARN("USE_SPINLOCK_T",
5998 "struct spinlock should be spinlock_t\n" . $herecurr);
5999 }
6000
Joe Perchesa6962d72013-04-29 16:18:13 -07006001# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08006002 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07006003 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08006004 $fmt =~ s/%%//g;
6005 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006006 if (WARN("PREFER_SEQ_PUTS",
6007 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
6008 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006009 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006010 }
Joe Perchesa6962d72013-04-29 16:18:13 -07006011 }
6012 }
6013
Joe Perches478b1792018-04-10 16:33:34 -07006014# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07006015 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07006016 defined $stat &&
6017 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
6018 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006019 my $stat_real;
6020
Joe Perches0b523762017-05-08 15:55:36 -07006021 my $lc = $stat =~ tr@\n@@;
6022 $lc = $lc + $linenr;
6023 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07006024 my $specifier;
6025 my $extension;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006026 my $qualifier;
Joe Perchesffe07512018-07-13 16:59:23 -07006027 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07006028 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
6029 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006030
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006031 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006032 $specifier = $1;
6033 $extension = $2;
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006034 $qualifier = $3;
Linus Torvalds361b0d22019-11-26 19:45:12 -08006035 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ ||
Sakari Ailus3bd32d62019-10-03 15:32:18 +03006036 ($extension eq "f" &&
6037 defined $qualifier && $qualifier !~ /^w/)) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006038 $bad_specifier = $specifier;
6039 last;
6040 }
6041 if ($extension eq "x" && !defined($stat_real)) {
6042 if (!defined($stat_real)) {
6043 $stat_real = get_stat_real($linenr, $lc);
6044 }
6045 WARN("VSPRINTF_SPECIFIER_PX",
6046 "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");
6047 }
6048 }
6049 if ($bad_specifier ne "") {
6050 my $stat_real = get_stat_real($linenr, $lc);
6051 my $ext_type = "Invalid";
6052 my $use = "";
6053 if ($bad_specifier =~ /p[Ff]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006054 $use = " - use %pS instead";
6055 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6056 }
6057
6058 WARN("VSPRINTF_POINTER_EXTENSION",
6059 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6060 }
Joe Perches0b523762017-05-08 15:55:36 -07006061 }
6062 }
6063
Andy Whitcroft554e1652012-01-10 15:09:57 -08006064# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006065 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006066 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006067 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006068
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006069 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006070 my $ms_val = $7;
6071 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006072
Andy Whitcroft554e1652012-01-10 15:09:57 -08006073 if ($ms_size =~ /^(0x|)0$/i) {
6074 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006075 "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 -08006076 } elsif ($ms_size =~ /^(0x|)1$/i) {
6077 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006078 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6079 }
6080 }
6081
Joe Perches98a9bba2014-01-23 15:54:52 -08006082# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006083# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006084# defined $stat &&
6085# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6086# if (WARN("PREFER_ETHER_ADDR_COPY",
6087# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6088# $fix) {
6089# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6090# }
6091# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006092
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006093# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006094# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006095# defined $stat &&
6096# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6097# WARN("PREFER_ETHER_ADDR_EQUAL",
6098# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6099# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006100
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006101# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6102# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006103# if ($perl_version_ok &&
Joe Perchesf333195d2016-10-11 13:51:53 -07006104# defined $stat &&
6105# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6106#
6107# my $ms_val = $7;
6108#
6109# if ($ms_val =~ /^(?:0x|)0+$/i) {
6110# if (WARN("PREFER_ETH_ZERO_ADDR",
6111# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6112# $fix) {
6113# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6114# }
6115# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6116# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6117# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6118# $fix) {
6119# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6120# }
6121# }
6122# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006123
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006124# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006125 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006126 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006127 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006128 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006129 my $call = $1;
6130 my $cast1 = deparenthesize($2);
6131 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006132 my $cast2 = deparenthesize($7);
6133 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006134 my $cast;
6135
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006136 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006137 $cast = "$cast1 or $cast2";
6138 } elsif ($cast1 ne "") {
6139 $cast = $cast1;
6140 } else {
6141 $cast = $cast2;
6142 }
6143 WARN("MINMAX",
6144 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006145 }
6146 }
6147
Joe Perches4a273192012-07-30 14:41:20 -07006148# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006149 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006150 defined $stat &&
6151 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6152 my $min = $1;
6153 my $max = $7;
6154 if ($min eq $max) {
6155 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006156 "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 -07006157 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6158 $min > $max) {
6159 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006160 "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 -07006161 }
6162 }
6163
Joe Perches823b7942013-11-12 15:10:15 -08006164# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006165 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006166 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006167 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006168 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6169 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6170 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
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 Perches823b7942013-11-12 15:10:15 -08006174 WARN("NAKED_SSCANF",
6175 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6176 }
6177
Joe Perchesafc819a2014-06-04 16:12:08 -07006178# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006179 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006180 defined $stat &&
6181 $line =~ /\bsscanf\b/) {
6182 my $lc = $stat =~ tr@\n@@;
6183 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006184 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006185 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6186 my $format = $6;
6187 my $count = $format =~ tr@%@%@;
6188 if ($count == 1 &&
6189 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6190 WARN("SSCANF_TO_KSTRTO",
6191 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6192 }
6193 }
6194 }
6195
Joe Perches70dc8a42013-09-11 14:23:58 -07006196# check for new externs in .h files.
6197 if ($realfile =~ /\.h$/ &&
6198 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006199 if (CHK("AVOID_EXTERNS",
6200 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006201 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006202 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006203 }
6204 }
6205
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006206# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006207 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006208 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006209 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006210 my $function_name = $1;
6211 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006212
6213 my $s = $stat;
6214 if (defined $cond) {
6215 substr($s, 0, length($cond), '');
6216 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006217 if ($s =~ /^\s*;/ &&
6218 $function_name ne 'uninitialized_var')
6219 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006220 WARN("AVOID_EXTERNS",
6221 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006222 }
6223
6224 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006225 WARN("FUNCTION_ARGUMENTS",
6226 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006227 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006228
6229 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6230 $stat =~ /^.\s*extern\s+/)
6231 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006232 WARN("AVOID_EXTERNS",
6233 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006234 }
6235
Joe Perchesa0ad7592017-07-10 15:52:19 -07006236# check for function declarations that have arguments without identifier names
6237 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006238 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006239 $1 ne "void") {
6240 my $args = trim($1);
6241 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6242 my $arg = trim($1);
6243 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6244 WARN("FUNCTION_ARGUMENTS",
6245 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6246 }
6247 }
6248 }
6249
Joe Perchesa0ad7592017-07-10 15:52:19 -07006250# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006251 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006252 defined $stat &&
6253 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6254 $context_function = $1;
6255
6256# check for multiline function definition with misplaced open brace
6257 my $ok = 0;
6258 my $cnt = statement_rawlines($stat);
6259 my $herectx = $here . "\n";
6260 for (my $n = 0; $n < $cnt; $n++) {
6261 my $rl = raw_line($linenr, $n);
6262 $herectx .= $rl . "\n";
6263 $ok = 1 if ($rl =~ /^[ \+]\{/);
6264 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6265 last if $rl =~ /^[ \+].*\{/;
6266 }
6267 if (!$ok) {
6268 ERROR("OPEN_BRACE",
6269 "open brace '{' following function definitions go on the next line\n" . $herectx);
6270 }
6271 }
6272
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006273# checks for new __setup's
6274 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6275 my $name = $1;
6276
6277 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006278 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006279 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006280 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006281 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006282
Joe Perchese29a70f2019-03-07 16:28:35 -08006283# check for pointless casting of alloc functions
6284 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006285 WARN("UNNECESSARY_CASTS",
6286 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006287 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006288
Joe Perchesa640d252013-07-03 15:05:21 -07006289# alloc style
6290# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006291 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006292 $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 -07006293 CHK("ALLOC_SIZEOF_STRUCT",
6294 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6295 }
6296
Joe Perches60a55362014-06-04 16:12:07 -07006297# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006298 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006299 defined $stat &&
6300 $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 -07006301 my $oldfunc = $3;
6302 my $a1 = $4;
6303 my $a2 = $10;
6304 my $newfunc = "kmalloc_array";
6305 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006306 my $r1 = $a1;
6307 my $r2 = $a2;
6308 if ($a1 =~ /^sizeof\s*\S/) {
6309 $r1 = $a2;
6310 $r2 = $a1;
6311 }
6312 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6313 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006314 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006315 my $herectx = get_stat_here($linenr, $cnt, $here);
6316
Joe Perches60a55362014-06-04 16:12:07 -07006317 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006318 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6319 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006320 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006321 $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 -07006322 }
6323 }
6324 }
6325
Joe Perches972fdea2013-04-29 16:18:12 -07006326# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006327 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006328 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6329 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006330 WARN("KREALLOC_ARG_REUSE",
6331 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6332 }
6333
Joe Perches5ce59ae2013-02-21 16:44:18 -08006334# check for alloc argument mismatch
6335 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6336 WARN("ALLOC_ARRAY_ARGS",
6337 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6338 }
6339
Joe Perchescaf2a542011-01-12 16:59:56 -08006340# check for multiple semicolons
6341 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006342 if (WARN("ONE_SEMICOLON",
6343 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6344 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006345 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006346 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006347 }
6348
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006349# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6350 if ($realfile !~ m@^include/uapi/@ &&
6351 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006352 my $ull = "";
6353 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6354 if (CHK("BIT_MACRO",
6355 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6356 $fix) {
6357 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6358 }
6359 }
6360
Joe Perches2d632742016-05-20 17:04:00 -07006361# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6362 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6363 my $config = $1;
6364 if (WARN("PREFER_IS_ENABLED",
6365 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6366 $fix) {
6367 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6368 }
6369 }
6370
Joe Perchese81f2392014-08-06 16:11:25 -07006371# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006372 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6373 my $has_break = 0;
6374 my $has_statement = 0;
6375 my $count = 0;
6376 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006377 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006378 $prevline--;
6379 my $rline = $rawlines[$prevline - 1];
6380 my $fline = $lines[$prevline - 1];
6381 last if ($fline =~ /^\@\@/);
6382 next if ($fline =~ /^\-/);
6383 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6384 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6385 next if ($fline =~ /^.[\s$;]*$/);
6386 $has_statement = 1;
6387 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006388 $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 -08006389 }
6390 if (!$has_break && $has_statement) {
6391 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006392 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006393 }
6394 }
6395
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006396# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006397 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006398 defined $stat &&
6399 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006400 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006401 my $herectx = get_stat_here($linenr, $cnt, $here);
6402
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006403 WARN("DEFAULT_NO_BREAK",
6404 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006405 }
6406
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006407# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006408 if ($line =~ /\b__FUNCTION__\b/) {
6409 if (WARN("USE_FUNC",
6410 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6411 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006412 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006413 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006414 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006415
Joe Perches62ec8182015-02-13 14:38:18 -08006416# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6417 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6418 ERROR("DATE_TIME",
6419 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6420 }
6421
Joe Perches2c924882012-03-23 15:02:20 -07006422# check for use of yield()
6423 if ($line =~ /\byield\s*\(\s*\)/) {
6424 WARN("YIELD",
6425 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6426 }
6427
Joe Perches179f8f42013-07-03 15:05:30 -07006428# check for comparisons against true and false
6429 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6430 my $lead = $1;
6431 my $arg = $2;
6432 my $test = $3;
6433 my $otype = $4;
6434 my $trail = $5;
6435 my $op = "!";
6436
6437 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6438
6439 my $type = lc($otype);
6440 if ($type =~ /^(?:true|false)$/) {
6441 if (("$test" eq "==" && "$type" eq "true") ||
6442 ("$test" eq "!=" && "$type" eq "false")) {
6443 $op = "";
6444 }
6445
6446 CHK("BOOL_COMPARISON",
6447 "Using comparison to $otype is error prone\n" . $herecurr);
6448
6449## maybe suggesting a correct construct would better
6450## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6451
6452 }
6453 }
6454
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006455# check for semaphores initialized locked
6456 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006457 WARN("CONSIDER_COMPLETION",
6458 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006459 }
Joe Perches6712d852012-03-23 15:02:20 -07006460
Joe Perches67d0a072011-10-31 17:13:10 -07006461# recommend kstrto* over simple_strto* and strict_strto*
6462 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006463 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006464 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006465 }
Joe Perches6712d852012-03-23 15:02:20 -07006466
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006467# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006468 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006469 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006470 "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 -07006471 }
Joe Perches6712d852012-03-23 15:02:20 -07006472
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006473# check for spin_is_locked(), suggest lockdep instead
6474 if ($line =~ /\bspin_is_locked\(/) {
6475 WARN("USE_LOCKDEP",
6476 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6477 }
6478
Joe Perches9189c7e2018-09-07 15:26:18 -07006479# check for deprecated apis
6480 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6481 my $deprecated_api = $1;
6482 my $new_api = $deprecated_apis{$deprecated_api};
6483 WARN("DEPRECATED_API",
6484 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6485 }
6486
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006487# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006488# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006489 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006490 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006491 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006492 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006493 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006494
6495# use of NR_CPUS is usually wrong
6496# ignore definitions of NR_CPUS and usage to define arrays as likely right
6497 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006498 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6499 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006500 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6501 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6502 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006503 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006504 WARN("NR_CPUS",
6505 "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 -07006506 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006507
Joe Perches52ea8502013-11-12 15:10:09 -08006508# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6509 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6510 ERROR("DEFINE_ARCH_HAS",
6511 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6512 }
6513
Joe Perchesacd93622015-02-13 14:38:38 -08006514# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07006515 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08006516 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6517 WARN("LIKELY_MISUSE",
6518 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6519 }
6520
Denis Efremovde3f1862019-09-25 16:49:25 -07006521# nested likely/unlikely calls
6522 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) {
6523 WARN("LIKELY_MISUSE",
6524 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr);
6525 }
6526
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006527# whine mightly about in_atomic
6528 if ($line =~ /\bin_atomic\s*\(/) {
6529 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006530 ERROR("IN_ATOMIC",
6531 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006532 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006533 WARN("IN_ATOMIC",
6534 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006535 }
6536 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006537
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006538# check for mutex_trylock_recursive usage
6539 if ($line =~ /mutex_trylock_recursive/) {
6540 ERROR("LOCKING",
6541 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6542 }
6543
Peter Zijlstra1704f472010-03-19 01:37:42 +01006544# check for lockdep_set_novalidate_class
6545 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6546 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6547 if ($realfile !~ m@^kernel/lockdep@ &&
6548 $realfile !~ m@^include/linux/lockdep@ &&
6549 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006550 ERROR("LOCKDEP",
6551 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006552 }
6553 }
Dave Jones88f88312011-01-12 16:59:59 -08006554
Joe Perchesb392c642015-04-16 12:44:16 -07006555 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6556 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006557 WARN("EXPORTED_WORLD_WRITABLE",
6558 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006559 }
Joe Perches24358802014-04-03 14:49:13 -07006560
Joe Perches00180462018-02-06 15:38:55 -08006561# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6562# and whether or not function naming is typical and if
6563# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07006564 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08006565 defined $stat &&
6566 $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*\)/) {
6567 my $var = $1;
6568 my $perms = $2;
6569 my $show = $3;
6570 my $store = $4;
6571 my $octal_perms = perms_to_octal($perms);
6572 if ($show =~ /^${var}_show$/ &&
6573 $store =~ /^${var}_store$/ &&
6574 $octal_perms eq "0644") {
6575 if (WARN("DEVICE_ATTR_RW",
6576 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6577 $fix) {
6578 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6579 }
6580 } elsif ($show =~ /^${var}_show$/ &&
6581 $store =~ /^NULL$/ &&
6582 $octal_perms eq "0444") {
6583 if (WARN("DEVICE_ATTR_RO",
6584 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6585 $fix) {
6586 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6587 }
6588 } elsif ($show =~ /^NULL$/ &&
6589 $store =~ /^${var}_store$/ &&
6590 $octal_perms eq "0200") {
6591 if (WARN("DEVICE_ATTR_WO",
6592 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6593 $fix) {
6594 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6595 }
6596 } elsif ($octal_perms eq "0644" ||
6597 $octal_perms eq "0444" ||
6598 $octal_perms eq "0200") {
6599 my $newshow = "$show";
6600 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6601 my $newstore = $store;
6602 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6603 my $rename = "";
6604 if ($show ne $newshow) {
6605 $rename .= " '$show' to '$newshow'";
6606 }
6607 if ($store ne $newstore) {
6608 $rename .= " '$store' to '$newstore'";
6609 }
6610 WARN("DEVICE_ATTR_FUNCTIONS",
6611 "Consider renaming function(s)$rename\n" . $herecurr);
6612 } else {
6613 WARN("DEVICE_ATTR_PERMS",
6614 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6615 }
6616 }
6617
Joe Perches515a2352014-04-03 14:49:24 -07006618# Mode permission misuses where it seems decimal should be octal
6619# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006620# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6621# specific definition of not visible in sysfs.
6622# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6623# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07006624 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006625 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006626 $line =~ /$mode_perms_search/) {
6627 foreach my $entry (@mode_permission_funcs) {
6628 my $func = $entry->[0];
6629 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006630
Joe Perches459cf0a2016-10-11 13:52:19 -07006631 my $lc = $stat =~ tr@\n@@;
6632 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006633 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006634
Joe Perches515a2352014-04-03 14:49:24 -07006635 my $skip_args = "";
6636 if ($arg_pos > 1) {
6637 $arg_pos--;
6638 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6639 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006640 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006641 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006642 my $val = $1;
6643 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006644 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6645 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6646 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006647 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006648 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006649 }
6650 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006651 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006652 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006653 }
Joe Perches24358802014-04-03 14:49:13 -07006654 }
6655 }
6656 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006657
Joe Perches459cf0a2016-10-11 13:52:19 -07006658# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07006659 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08006660 my $oval = $1;
6661 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006662 if (WARN("SYMBOLIC_PERMS",
6663 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6664 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006665 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006666 }
6667 }
6668
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006669# validate content of MODULE_LICENSE against list from include/linux/module.h
6670 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6671 my $extracted_string = get_quoted_string($line, $rawline);
6672 my $valid_licenses = qr{
6673 GPL|
6674 GPL\ v2|
6675 GPL\ and\ additional\ rights|
6676 Dual\ BSD/GPL|
6677 Dual\ MIT/GPL|
6678 Dual\ MPL/GPL|
6679 Proprietary
6680 }x;
6681 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6682 WARN("MODULE_LICENSE",
6683 "unknown module license " . $extracted_string . "\n" . $herecurr);
6684 }
6685 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07006686
6687# check for sysctl duplicate constants
6688 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6689 WARN("DUPLICATED_SYSCTL_CONST",
6690 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6691 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006692 }
6693
6694 # If we have no input at all, then there is nothing to report on
6695 # so just keep quiet.
6696 if ($#rawlines == -1) {
6697 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006698 }
6699
Andy Whitcroft8905a672007-11-28 16:21:06 -08006700 # In mailback mode only produce a report in the negative, for
6701 # things that appear to be patches.
6702 if ($mailback && ($clean == 1 || !$is_patch)) {
6703 exit(0);
6704 }
6705
6706 # This is not a patch, and we are are in 'no-patch' mode so
6707 # just keep quiet.
6708 if (!$chk_patch && !$is_patch) {
6709 exit(0);
6710 }
6711
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006712 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006713 ERROR("NOT_UNIFIED_DIFF",
6714 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006715 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07006716 if ($is_patch && $has_commit_log && $chk_signoff) {
6717 if ($signoff == 0) {
6718 ERROR("MISSING_SIGN_OFF",
6719 "Missing Signed-off-by: line(s)\n");
6720 } elsif (!$authorsignoff) {
6721 WARN("NO_AUTHOR_SIGN_OFF",
6722 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6723 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006724 }
6725
Andy Whitcroft8905a672007-11-28 16:21:06 -08006726 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006727 if ($summary && !($clean == 1 && $quiet == 1)) {
6728 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006729 print "total: $cnt_error errors, $cnt_warn warnings, " .
6730 (($check)? "$cnt_chk checks, " : "") .
6731 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006732 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006733
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006734 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006735 # If there were any defects found and not already fixing them
6736 if (!$clean and !$fix) {
6737 print << "EOM"
6738
6739NOTE: For some of the reported defects, checkpatch may be able to
6740 mechanically convert to the typical style using --fix or --fix-inplace.
6741EOM
6742 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006743 # If there were whitespace errors which cleanpatch can fix
6744 # then suggest that.
6745 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006746 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006747 print << "EOM"
6748
6749NOTE: Whitespace errors detected.
6750 You may wish to use scripts/cleanpatch or scripts/cleanfile
6751EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006752 }
6753 }
6754
Joe Perchesd752fcc2014-08-06 16:11:05 -07006755 if ($clean == 0 && $fix &&
6756 ("@rawlines" ne "@fixed" ||
6757 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006758 my $newfile = $filename;
6759 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006760 my $linecount = 0;
6761 my $f;
6762
Joe Perchesd752fcc2014-08-06 16:11:05 -07006763 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6764
Joe Perches3705ce52013-07-03 15:05:31 -07006765 open($f, '>', $newfile)
6766 or die "$P: Can't open $newfile for write\n";
6767 foreach my $fixed_line (@fixed) {
6768 $linecount++;
6769 if ($file) {
6770 if ($linecount > 3) {
6771 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006772 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006773 }
6774 } else {
6775 print $f $fixed_line . "\n";
6776 }
6777 }
6778 close($f);
6779
6780 if (!$quiet) {
6781 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006782
Joe Perches3705ce52013-07-03 15:05:31 -07006783Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6784
6785Do _NOT_ trust the results written to this file.
6786Do _NOT_ submit these changes without inspecting them for correctness.
6787
6788This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6789No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006790EOM
6791 }
6792 }
6793
Joe Perchesd8469f12015-06-25 15:03:00 -07006794 if ($quiet == 0) {
6795 print "\n";
6796 if ($clean == 1) {
6797 print "$vname has no obvious style problems and is ready for submission.\n";
6798 } else {
6799 print "$vname has style problems, please review.\n";
6800 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006801 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006802 return $clean;
6803}