blob: 6cb99ec6200085ca271a683b24c095a4b5564a22 [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
Hannes Eder77f5b102009-09-21 17:04:37 -070065
66sub help {
67 my ($exitcode) = @_;
68
69 print << "EOM";
70Usage: $P [OPTION]... [FILE]...
71Version: $V
72
73Options:
74 -q, --quiet quiet
75 --no-tree run without a kernel tree
76 --no-signoff do not check for 'Signed-off-by' line
77 --patch treat FILE as patchfile (default)
78 --emacs emacs compile window format
79 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070080 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070081 -g, --git treat FILE as a single commit or git revision range
82 single git commit with:
83 <rev>
84 <rev>^
85 <rev>~n
86 multiple git commits with:
87 <rev1>..<rev2>
88 <rev1>...<rev2>
89 <rev>-<count>
90 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070091 -f, --file treat FILE as regular source file
92 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070093 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070094 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070095 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070096 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080097 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070098 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070099 --root=PATH PATH to the kernel tree root
100 --no-summary suppress the per-file summary
101 --mailback only produce a report in case of warnings/errors
102 --summary-file include the filename in summary
103 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
104 'values', 'possible', 'type', and 'attr' (default
105 is all off)
106 --test-only=WORD report only warnings/errors containing WORD
107 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700108 --fix EXPERIMENTAL - may create horrible results
109 If correctable single-line errors exist, create
110 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
111 with potential errors corrected to the preferred
112 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800113 --fix-inplace EXPERIMENTAL - may create horrible results
114 Is the same as --fix, but overwrites the input
115 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700116 --ignore-perl-version override checking of perl version. expect
117 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700118 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700119 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700120 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700121 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700122 --color[=WHEN] Use colors 'always', 'never', or only when output
123 is a terminal ('auto'). Default is 'auto'.
Hannes Eder77f5b102009-09-21 17:04:37 -0700124 -h, --help, --version display this help and exit
125
126When FILE is - read standard input.
127EOM
128
129 exit($exitcode);
130}
131
Joe Perches3beb42e2016-05-20 17:04:14 -0700132sub uniq {
133 my %seen;
134 return grep { !$seen{$_}++ } @_;
135}
136
137sub list_types {
138 my ($exitcode) = @_;
139
140 my $count = 0;
141
142 local $/ = undef;
143
144 open(my $script, '<', abs_path($P)) or
145 die "$P: Can't read '$P' $!\n";
146
147 my $text = <$script>;
148 close($script);
149
150 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700151 # Also catch when type or level is passed through a variable
152 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700153 push (@types, $_);
154 }
155 @types = sort(uniq(@types));
156 print("#\tMessage type\n\n");
157 foreach my $type (@types) {
158 print(++$count . "\t" . $type . "\n");
159 }
160
161 exit($exitcode);
162}
163
Joe Perches000d1cc12011-07-25 17:13:25 -0700164my $conf = which_conf($configuration_file);
165if (-f $conf) {
166 my @conf_args;
167 open(my $conffile, '<', "$conf")
168 or warn "$P: Can't find a readable $configuration_file file $!\n";
169
170 while (<$conffile>) {
171 my $line = $_;
172
173 $line =~ s/\s*\n?$//g;
174 $line =~ s/^\s*//g;
175 $line =~ s/\s+/ /g;
176
177 next if ($line =~ m/^\s*#/);
178 next if ($line =~ m/^\s*$/);
179
180 my @words = split(" ", $line);
181 foreach my $word (@words) {
182 last if ($word =~ m/^#/);
183 push (@conf_args, $word);
184 }
185 }
186 close($conffile);
187 unshift(@ARGV, @conf_args) if @conf_args;
188}
189
John Brooks737c0762017-07-10 15:52:24 -0700190# Perl's Getopt::Long allows options to take optional arguments after a space.
191# Prevent --color by itself from consuming other arguments
192foreach (@ARGV) {
193 if ($_ eq "--color" || $_ eq "-color") {
194 $_ = "--color=$color";
195 }
196}
197
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700198GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700199 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700200 'tree!' => \$tree,
201 'signoff!' => \$chk_signoff,
202 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700203 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800204 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700205 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700206 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700207 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700208 'subjective!' => \$check,
209 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700210 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700211 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700212 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700213 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800214 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700215 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700216 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800217 'summary!' => \$summary,
218 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800219 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700220 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800221 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700222 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800223 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700224 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700225 'codespell!' => \$codespell,
226 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700227 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700228 'color=s' => \$color,
229 'no-color' => \$color, #keep old behaviors of -nocolor
230 'nocolor' => \$color, #keep old behaviors of -nocolor
Hannes Eder77f5b102009-09-21 17:04:37 -0700231 'h|help' => \$help,
232 'version' => \$help
233) or help(1);
234
235help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700236
Joe Perches3beb42e2016-05-20 17:04:14 -0700237list_types(0) if ($list_types);
238
Joe Perches9624b8d2014-01-23 15:54:44 -0800239$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700240$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800241
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700242my $exit = 0;
243
Joe Perches5b579802018-08-21 21:57:33 -0700244my $perl_version_ok = 1;
Dave Hansend62a2012013-09-11 14:23:56 -0700245if ($^V && $^V lt $minimum_perl_version) {
Joe Perches5b579802018-08-21 21:57:33 -0700246 $perl_version_ok = 0;
Dave Hansend62a2012013-09-11 14:23:56 -0700247 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
Joe Perches5b579802018-08-21 21:57:33 -0700248 exit(1) if (!$ignore_perl_version);
Dave Hansend62a2012013-09-11 14:23:56 -0700249}
250
Allen Hubbe45107ff2016-08-02 14:04:47 -0700251#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700252if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700253 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700254}
255
John Brooks737c0762017-07-10 15:52:24 -0700256if ($color =~ /^[01]$/) {
257 $color = !$color;
258} elsif ($color =~ /^always$/i) {
259 $color = 1;
260} elsif ($color =~ /^never$/i) {
261 $color = 0;
262} elsif ($color =~ /^auto$/i) {
263 $color = (-t STDOUT);
264} else {
265 die "Invalid color mode: $color\n";
266}
267
Joe Perches91bfe482013-09-11 14:23:59 -0700268sub hash_save_array_words {
269 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700270
Joe Perches91bfe482013-09-11 14:23:59 -0700271 my @array = split(/,/, join(',', @$arrayRef));
272 foreach my $word (@array) {
273 $word =~ s/\s*\n?$//g;
274 $word =~ s/^\s*//g;
275 $word =~ s/\s+/ /g;
276 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700277
Joe Perches91bfe482013-09-11 14:23:59 -0700278 next if ($word =~ m/^\s*#/);
279 next if ($word =~ m/^\s*$/);
280
281 $hashRef->{$word}++;
282 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700283}
284
Joe Perches91bfe482013-09-11 14:23:59 -0700285sub hash_show_words {
286 my ($hashRef, $prefix) = @_;
287
Joe Perches3c816e42015-06-25 15:03:29 -0700288 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700289 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700290 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700291 print " $word";
292 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700293 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700294 }
295}
296
297hash_save_array_words(\%ignore_type, \@ignore);
298hash_save_array_words(\%use_type, \@use);
299
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800300my $dbg_values = 0;
301my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700302my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700303my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800304for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800305 ## no critic
306 eval "\${dbg_$key} = '$debug{$key}';";
307 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800308}
309
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700310my $rpt_cleaners = 0;
311
Andy Whitcroft8905a672007-11-28 16:21:06 -0800312if ($terse) {
313 $emacs = 1;
314 $quiet++;
315}
316
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700317if ($tree) {
318 if (defined $root) {
319 if (!top_of_kernel_tree($root)) {
320 die "$P: $root: --root does not point at a valid tree\n";
321 }
322 } else {
323 if (top_of_kernel_tree('.')) {
324 $root = '.';
325 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
326 top_of_kernel_tree($1)) {
327 $root = $1;
328 }
329 }
330
331 if (!defined $root) {
332 print "Must be run from the top-level dir. of a kernel tree\n";
333 exit(2);
334 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700335}
336
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700337my $emitted_corrupt = 0;
338
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700339our $Ident = qr{
340 [A-Za-z_][A-Za-z\d_]*
341 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
342 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700343our $Storage = qr{extern|static|asmlinkage};
344our $Sparse = qr{
345 __user|
346 __kernel|
347 __force|
348 __iomem|
349 __must_check|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800350 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700351 __ref|
Geert Uytterhoeven33aa4592018-08-21 21:57:36 -0700352 __refconst|
353 __refdata|
Boqun Fengad315452015-12-29 12:18:46 +0800354 __rcu|
355 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700356 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800357our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
358our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
359our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
360our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
361our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700362
Wolfram Sang52131292010-03-05 13:43:51 -0800363# Notes to $Attribute:
364# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700365our $Attribute = qr{
366 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700367 __percpu|
368 __nocast|
369 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200370 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700371 __packed__|
372 __packed2__|
373 __naked|
374 __maybe_unused|
375 __always_unused|
376 __noreturn|
377 __used|
378 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800379 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700380 __noclone|
381 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700382 __read_mostly|
Joe Perchesc5967e92018-09-04 15:46:20 -0700383 __ro_after_init|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700384 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700385 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700386 ____cacheline_aligned|
387 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800388 ____cacheline_internodealigned_in_smp|
389 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700390 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700391our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700392our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700393our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
394our $Lval = qr{$Ident(?:$Member)*};
395
Joe Perches95e2c602013-07-03 15:05:20 -0700396our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
397our $Binary = qr{(?i)0b[01]+$Int_type?};
398our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
399our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700400our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800401our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800402our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
403our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
404our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800405our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700406our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800407our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700408our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700409our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700410our $Operators = qr{
411 <=|>=|==|!=|
412 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700413 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700414 }x;
415
Joe Perches91cb5192014-04-03 14:49:32 -0700416our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
417
Joe Perchesab7e23f2015-04-16 12:44:22 -0700418our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700420our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700421our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800422our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700423our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800424our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700425our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800426
Joe Perches15662b32011-10-31 17:13:12 -0700427our $NON_ASCII_UTF8 = qr{
428 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700429 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
430 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
431 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
432 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
433 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
434 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
435}x;
436
Joe Perches15662b32011-10-31 17:13:12 -0700437our $UTF8 = qr{
438 [\x09\x0A\x0D\x20-\x7E] # ASCII
439 | $NON_ASCII_UTF8
440}x;
441
Joe Perchese6176fa2015-06-25 15:02:49 -0700442our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800443our $typeOtherOSTypedefs = qr{(?x:
444 u_(?:char|short|int|long) | # bsd
445 u(?:nchar|short|int|long) # sysv
446)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700447our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700448 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700449 atomic_t
450)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700451our $typeTypedefs = qr{(?x:
452 $typeC99Typedefs\b|
453 $typeOtherOSTypedefs\b|
454 $typeKernelTypedefs\b
455)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700456
Joe Perches6d32f7a2015-11-06 16:31:37 -0800457our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
458
Joe Perches691e6692010-03-05 13:43:51 -0800459our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800460 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700461 (?:[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 -0800462 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700463 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700464 panic|
Joe Perches06668722013-11-12 15:10:07 -0800465 MODULE_[A-Z_]+|
466 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800467)};
468
Joe Perchese29a70f2019-03-07 16:28:35 -0800469our $allocFunctions = qr{(?x:
470 (?:(?:devm_)?
471 (?:kv|k|v)[czm]alloc(?:_node|_array)? |
472 kstrdup(?:_const)? |
473 kmemdup(?:_nul)?) |
474 (?:\w+)?alloc_skb(?:ip_align)? |
475 # dev_alloc_skb/netdev_alloc_skb, et al
476 dma_alloc_coherent
477)};
478
Joe Perches20112472011-07-25 17:13:23 -0700479our $signature_tags = qr{(?xi:
480 Signed-off-by:|
Jorge Ramirez-Ortizd4994802019-01-03 15:29:12 -0800481 Co-developed-by:|
Joe Perches20112472011-07-25 17:13:23 -0700482 Acked-by:|
483 Tested-by:|
484 Reviewed-by:|
485 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700486 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700487 To:|
488 Cc:
489)};
490
Joe Perches18130872014-08-06 16:11:22 -0700491our @typeListMisordered = (
492 qr{char\s+(?:un)?signed},
493 qr{int\s+(?:(?:un)?signed\s+)?short\s},
494 qr{int\s+short(?:\s+(?:un)?signed)},
495 qr{short\s+int(?:\s+(?:un)?signed)},
496 qr{(?:un)?signed\s+int\s+short},
497 qr{short\s+(?:un)?signed},
498 qr{long\s+int\s+(?:un)?signed},
499 qr{int\s+long\s+(?:un)?signed},
500 qr{long\s+(?:un)?signed\s+int},
501 qr{int\s+(?:un)?signed\s+long},
502 qr{int\s+(?:un)?signed},
503 qr{int\s+long\s+long\s+(?:un)?signed},
504 qr{long\s+long\s+int\s+(?:un)?signed},
505 qr{long\s+long\s+(?:un)?signed\s+int},
506 qr{long\s+long\s+(?:un)?signed},
507 qr{long\s+(?:un)?signed},
508);
509
Andy Whitcroft8905a672007-11-28 16:21:06 -0800510our @typeList = (
511 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700512 qr{(?:(?:un)?signed\s+)?char},
513 qr{(?:(?:un)?signed\s+)?short\s+int},
514 qr{(?:(?:un)?signed\s+)?short},
515 qr{(?:(?:un)?signed\s+)?int},
516 qr{(?:(?:un)?signed\s+)?long\s+int},
517 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
518 qr{(?:(?:un)?signed\s+)?long\s+long},
519 qr{(?:(?:un)?signed\s+)?long},
520 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800521 qr{float},
522 qr{double},
523 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800524 qr{struct\s+$Ident},
525 qr{union\s+$Ident},
526 qr{enum\s+$Ident},
527 qr{${Ident}_t},
528 qr{${Ident}_handler},
529 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700530 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800531);
Joe Perches938224b2016-01-20 14:59:15 -0800532
533our $C90_int_types = qr{(?x:
534 long\s+long\s+int\s+(?:un)?signed|
535 long\s+long\s+(?:un)?signed\s+int|
536 long\s+long\s+(?:un)?signed|
537 (?:(?:un)?signed\s+)?long\s+long\s+int|
538 (?:(?:un)?signed\s+)?long\s+long|
539 int\s+long\s+long\s+(?:un)?signed|
540 int\s+(?:(?:un)?signed\s+)?long\s+long|
541
542 long\s+int\s+(?:un)?signed|
543 long\s+(?:un)?signed\s+int|
544 long\s+(?:un)?signed|
545 (?:(?:un)?signed\s+)?long\s+int|
546 (?:(?:un)?signed\s+)?long|
547 int\s+long\s+(?:un)?signed|
548 int\s+(?:(?:un)?signed\s+)?long|
549
550 int\s+(?:un)?signed|
551 (?:(?:un)?signed\s+)?int
552)};
553
Alex Dowad485ff232015-06-25 15:02:52 -0700554our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700555our @typeListWithAttr = (
556 @typeList,
557 qr{struct\s+$InitAttribute\s+$Ident},
558 qr{union\s+$InitAttribute\s+$Ident},
559);
560
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700561our @modifierList = (
562 qr{fastcall},
563);
Alex Dowad485ff232015-06-25 15:02:52 -0700564our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800565
Joe Perches24358802014-04-03 14:49:13 -0700566our @mode_permission_funcs = (
567 ["module_param", 3],
568 ["module_param_(?:array|named|string)", 4],
569 ["module_param_array_named", 5],
570 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
571 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700572 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
573 ["IIO_DEV_ATTR_[A-Z_]+", 1],
574 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
575 ["SENSOR_TEMPLATE(?:_2|)", 3],
576 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700577);
578
Joe Perches515a2352014-04-03 14:49:24 -0700579#Create a search pattern for all these functions to speed up a loop below
580our $mode_perms_search = "";
581foreach my $entry (@mode_permission_funcs) {
582 $mode_perms_search .= '|' if ($mode_perms_search ne "");
583 $mode_perms_search .= $entry->[0];
584}
Joe Perches00180462018-02-06 15:38:55 -0800585$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700586
Joe Perches9189c7e2018-09-07 15:26:18 -0700587our %deprecated_apis = (
588 "synchronize_rcu_bh" => "synchronize_rcu",
589 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited",
590 "call_rcu_bh" => "call_rcu",
591 "rcu_barrier_bh" => "rcu_barrier",
592 "synchronize_sched" => "synchronize_rcu",
593 "synchronize_sched_expedited" => "synchronize_rcu_expedited",
594 "call_rcu_sched" => "call_rcu",
595 "rcu_barrier_sched" => "rcu_barrier",
596 "get_state_synchronize_sched" => "get_state_synchronize_rcu",
597 "cond_synchronize_sched" => "cond_synchronize_rcu",
598);
599
600#Create a search pattern for all these strings to speed up a loop below
601our $deprecated_apis_search = "";
602foreach my $entry (keys %deprecated_apis) {
603 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne "");
604 $deprecated_apis_search .= $entry;
605}
606$deprecated_apis_search = "(?:${deprecated_apis_search})";
607
Joe Perchesb392c642015-04-16 12:44:16 -0700608our $mode_perms_world_writable = qr{
609 S_IWUGO |
610 S_IWOTH |
611 S_IRWXUGO |
612 S_IALLUGO |
613 0[0-7][0-7][2367]
614}x;
615
Joe Perchesf90774e2016-10-11 13:51:47 -0700616our %mode_permission_string_types = (
617 "S_IRWXU" => 0700,
618 "S_IRUSR" => 0400,
619 "S_IWUSR" => 0200,
620 "S_IXUSR" => 0100,
621 "S_IRWXG" => 0070,
622 "S_IRGRP" => 0040,
623 "S_IWGRP" => 0020,
624 "S_IXGRP" => 0010,
625 "S_IRWXO" => 0007,
626 "S_IROTH" => 0004,
627 "S_IWOTH" => 0002,
628 "S_IXOTH" => 0001,
629 "S_IRWXUGO" => 0777,
630 "S_IRUGO" => 0444,
631 "S_IWUGO" => 0222,
632 "S_IXUGO" => 0111,
633);
634
635#Create a search pattern for all these strings to speed up a loop below
636our $mode_perms_string_search = "";
637foreach my $entry (keys %mode_permission_string_types) {
638 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
639 $mode_perms_string_search .= $entry;
640}
Joe Perches00180462018-02-06 15:38:55 -0800641our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
642our $multi_mode_perms_string_search = qr{
643 ${single_mode_perms_string_search}
644 (?:\s*\|\s*${single_mode_perms_string_search})*
645}x;
646
647sub perms_to_octal {
648 my ($string) = @_;
649
650 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
651
652 my $val = "";
653 my $oval = "";
654 my $to = 0;
655 my $curpos = 0;
656 my $lastpos = 0;
657 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
658 $curpos = pos($string);
659 my $match = $2;
660 my $omatch = $1;
661 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
662 $lastpos = $curpos;
663 $to |= $mode_permission_string_types{$match};
664 $val .= '\s*\|\s*' if ($val ne "");
665 $val .= $match;
666 $oval .= $omatch;
667 }
668 $oval =~ s/^\s*\|\s*//;
669 $oval =~ s/\s*\|\s*$//;
670 return sprintf("%04o", $to);
671}
Joe Perchesf90774e2016-10-11 13:51:47 -0700672
Wolfram Sang7840a942010-08-09 17:20:57 -0700673our $allowed_asm_includes = qr{(?x:
674 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700675 memory|
676 time|
677 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700678)};
679# memory.h: ARM has a custom one
680
Kees Cook66b47b42014-10-13 15:51:57 -0700681# Load common spelling mistakes and build regular expression list.
682my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700683my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700684
Joe Perches36061e32014-12-10 15:51:43 -0800685if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800686 while (<$spelling>) {
687 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700688
Joe Perches36061e32014-12-10 15:51:43 -0800689 $line =~ s/\s*\n?$//g;
690 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700691
Joe Perches36061e32014-12-10 15:51:43 -0800692 next if ($line =~ m/^\s*#/);
693 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700694
Joe Perches36061e32014-12-10 15:51:43 -0800695 my ($suspect, $fix) = split(/\|\|/, $line);
696
Joe Perches36061e32014-12-10 15:51:43 -0800697 $spelling_fix{$suspect} = $fix;
698 }
699 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800700} else {
701 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700702}
Kees Cook66b47b42014-10-13 15:51:57 -0700703
Joe Perchesebfd7d62015-04-16 12:44:14 -0700704if ($codespell) {
705 if (open(my $spelling, '<', $codespellfile)) {
706 while (<$spelling>) {
707 my $line = $_;
708
709 $line =~ s/\s*\n?$//g;
710 $line =~ s/^\s*//g;
711
712 next if ($line =~ m/^\s*#/);
713 next if ($line =~ m/^\s*$/);
714 next if ($line =~ m/, disabled/i);
715
716 $line =~ s/,.*$//;
717
718 my ($suspect, $fix) = split(/->/, $line);
719
720 $spelling_fix{$suspect} = $fix;
721 }
722 close($spelling);
723 } else {
724 warn "No codespell typos will be found - file '$codespellfile': $!\n";
725 }
726}
727
728$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
729
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700730sub read_words {
731 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700732
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700733 if (open(my $words, '<', $file)) {
734 while (<$words>) {
735 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700736
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700737 $line =~ s/\s*\n?$//g;
738 $line =~ s/^\s*//g;
739
740 next if ($line =~ m/^\s*#/);
741 next if ($line =~ m/^\s*$/);
742 if ($line =~ /\s/) {
743 print("$file: '$line' invalid - ignored\n");
744 next;
745 }
746
747 $$wordsRef .= '|' if ($$wordsRef ne "");
748 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700749 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700750 close($file);
751 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700752 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700753
754 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700755}
756
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700757my $const_structs = "";
758read_words(\$const_structs, $conststructsfile)
759 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
760
761my $typeOtherTypedefs = "";
762if (length($typedefsfile)) {
763 read_words(\$typeOtherTypedefs, $typedefsfile)
764 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
765}
766$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
767
Andy Whitcroft8905a672007-11-28 16:21:06 -0800768sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700769 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
770 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700771 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700772 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700773 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700774 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700775 (?:$typeTypedefs\b)|
776 (?:${all}\b)
777 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800778 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700779 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800780 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800781 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700782 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700783 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800784 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700785 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800786 }x;
Joe Perches18130872014-08-06 16:11:22 -0700787 $NonptrTypeMisordered = qr{
788 (?:$Modifier\s+|const\s+)*
789 (?:
790 (?:${Misordered}\b)
791 )
792 (?:\s+$Modifier|\s+const)*
793 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700794 $NonptrTypeWithAttr = qr{
795 (?:$Modifier\s+|const\s+)*
796 (?:
797 (?:typeof|__typeof__)\s*\([^\)]*\)|
798 (?:$typeTypedefs\b)|
799 (?:${allWithAttr}\b)
800 )
801 (?:\s+$Modifier|\s+const)*
802 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800803 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700804 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700805 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700806 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800807 }x;
Joe Perches18130872014-08-06 16:11:22 -0700808 $TypeMisordered = qr{
809 $NonptrTypeMisordered
810 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
811 (?:\s+$Inline|\s+$Modifier)*
812 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700813 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700814 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800815}
816build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700817
Joe Perches7d2367a2011-07-25 17:13:22 -0700818our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700819
820# Using $balanced_parens, $LvalOrFunc, or $FuncArg
821# requires at least perl version v5.10.0
822# Any use must be runtime checked with $^V
823
824our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700825our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800826our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700827
Joe Perchesf8422302014-08-06 16:11:31 -0700828our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700829 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700830 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700831 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
832 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700833)};
834
Joe Perches7d2367a2011-07-25 17:13:22 -0700835sub deparenthesize {
836 my ($string) = @_;
837 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700838
839 while ($string =~ /^\s*\(.*\)\s*$/) {
840 $string =~ s@^\s*\(\s*@@;
841 $string =~ s@\s*\)\s*$@@;
842 }
843
Joe Perches7d2367a2011-07-25 17:13:22 -0700844 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700845
Joe Perches7d2367a2011-07-25 17:13:22 -0700846 return $string;
847}
848
Joe Perches34456862013-07-03 15:05:34 -0700849sub seed_camelcase_file {
850 my ($file) = @_;
851
852 return if (!(-f $file));
853
854 local $/;
855
856 open(my $include_file, '<', "$file")
857 or warn "$P: Can't read '$file' $!\n";
858 my $text = <$include_file>;
859 close($include_file);
860
861 my @lines = split('\n', $text);
862
863 foreach my $line (@lines) {
864 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
865 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
866 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800867 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
868 $camelcase{$1} = 1;
869 } 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 -0700870 $camelcase{$1} = 1;
871 }
872 }
873}
874
Joe Perches85b0ee12016-10-11 13:51:44 -0700875sub is_maintained_obsolete {
876 my ($filename) = @_;
877
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800878 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700879
Joe Perches0616efa2016-10-11 13:52:02 -0700880 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 -0700881
882 return $status =~ /obsolete/i;
883}
884
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700885sub is_SPDX_License_valid {
886 my ($license) = @_;
887
Joe Perches56294112018-08-21 21:58:04 -0700888 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700889
Joe Perches56294112018-08-21 21:58:04 -0700890 my $root_path = abs_path($root);
891 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`;
Joe Perches3b6e8ac2018-08-21 21:57:47 -0700892 return 0 if ($status ne "");
893 return 1;
894}
895
Joe Perches34456862013-07-03 15:05:34 -0700896my $camelcase_seeded = 0;
897sub seed_camelcase_includes {
898 return if ($camelcase_seeded);
899
900 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700901 my $camelcase_cache = "";
902 my @include_files = ();
903
904 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700905
Richard Genoud3645e322014-02-10 14:25:32 -0800906 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700907 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
908 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700909 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700910 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700911 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700912 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700913 @include_files = split('\n', $files);
914 foreach my $file (@include_files) {
915 my $date = POSIX::strftime("%Y%m%d%H%M",
916 localtime((stat $file)[9]));
917 $last_mod_date = $date if ($last_mod_date < $date);
918 }
919 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700920 }
Joe Perchesc707a812013-07-08 16:00:43 -0700921
922 if ($camelcase_cache ne "" && -f $camelcase_cache) {
923 open(my $camelcase_file, '<', "$camelcase_cache")
924 or warn "$P: Can't read '$camelcase_cache' $!\n";
925 while (<$camelcase_file>) {
926 chomp;
927 $camelcase{$_} = 1;
928 }
929 close($camelcase_file);
930
931 return;
932 }
933
Richard Genoud3645e322014-02-10 14:25:32 -0800934 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700935 $files = `git ls-files "include/*.h"`;
936 @include_files = split('\n', $files);
937 }
938
Joe Perches34456862013-07-03 15:05:34 -0700939 foreach my $file (@include_files) {
940 seed_camelcase_file($file);
941 }
Joe Perches351b2a12013-07-03 15:05:36 -0700942
Joe Perchesc707a812013-07-08 16:00:43 -0700943 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700944 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700945 open(my $camelcase_file, '>', "$camelcase_cache")
946 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700947 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
948 print $camelcase_file ("$_\n");
949 }
950 close($camelcase_file);
951 }
Joe Perches34456862013-07-03 15:05:34 -0700952}
953
Joe Perchesd311cd42014-08-06 16:10:57 -0700954sub git_commit_info {
955 my ($commit, $id, $desc) = @_;
956
957 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
958
959 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
960 $output =~ s/^\s*//gm;
961 my @lines = split("\n", $output);
962
Joe Perches0d7835f2015-02-13 14:38:35 -0800963 return ($id, $desc) if ($#lines < 0);
964
Joe Perchesd311cd42014-08-06 16:10:57 -0700965 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
966# Maybe one day convert this block of bash into something that returns
967# all matching commit ids, but it's very slow...
968#
969# echo "checking commits $1..."
970# git rev-list --remotes | grep -i "^$1" |
971# while read line ; do
972# git log --format='%H %s' -1 $line |
973# echo "commit $(cut -c 1-12,41-)"
974# done
975 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700976 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700977 } else {
978 $id = substr($lines[0], 0, 12);
979 $desc = substr($lines[0], 41);
980 }
981
982 return ($id, $desc);
983}
984
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700985$chk_signoff = 0 if ($file);
986
Andy Whitcroft00df3442007-06-08 13:47:06 -0700987my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800988my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700989my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700990my @fixed_inserted = ();
991my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700992my $fixlinenr = -1;
993
Du, Changbin4a593c32016-05-20 17:04:16 -0700994# If input is git commits, extract all commits from the commit expressions.
995# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
996die "$P: No git repository found\n" if ($git && !-e ".git");
997
998if ($git) {
999 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001000 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -07001001 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -07001002 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
1003 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -07001004 } elsif ($commit_expr =~ m/\.\./) {
1005 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -07001006 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001007 $git_range = "-1 $commit_expr";
1008 }
1009 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
1010 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -07001011 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
1012 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001013 my $sha1 = $1;
1014 my $subject = $2;
1015 unshift(@commits, $sha1);
1016 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -07001017 }
1018 }
1019 die "$P: no git commits after extraction!\n" if (@commits == 0);
1020 @ARGV = @commits;
1021}
1022
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001023my $vname;
Vadim Bendebury98005e82019-03-07 16:28:38 -08001024$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001025for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001026 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -07001027 if ($git) {
1028 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
1029 die "$P: $filename: git format-patch failed - $!\n";
1030 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001031 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001032 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -08001033 } elsif ($filename eq '-') {
1034 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001035 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -08001036 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001037 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001038 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001039 if ($filename eq '-') {
1040 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -07001041 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -07001042 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001043 } else {
1044 $vname = $filename;
1045 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001046 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001047 chomp;
1048 push(@rawlines, $_);
1049 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001050 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001051
1052 if ($#ARGV > 0 && $quiet == 0) {
1053 print '-' x length($vname) . "\n";
1054 print "$vname\n";
1055 print '-' x length($vname) . "\n";
1056 }
1057
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001058 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001059 $exit = 1;
1060 }
1061 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001062 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001063 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001064 @fixed_inserted = ();
1065 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001066 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001067 @modifierListFile = ();
1068 @typeListFile = ();
1069 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001070}
1071
Joe Perchesd8469f12015-06-25 15:03:00 -07001072if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001073 hash_show_words(\%use_type, "Used");
1074 hash_show_words(\%ignore_type, "Ignored");
1075
Joe Perches5b579802018-08-21 21:57:33 -07001076 if (!$perl_version_ok) {
Joe Perchesd8469f12015-06-25 15:03:00 -07001077 print << "EOM"
1078
1079NOTE: perl $^V is not modern enough to detect all possible issues.
Joe Perches5b579802018-08-21 21:57:33 -07001080 An upgrade to at least perl $minimum_perl_version is suggested.
Joe Perchesd8469f12015-06-25 15:03:00 -07001081EOM
1082 }
1083 if ($exit) {
1084 print << "EOM"
1085
1086NOTE: If any of the errors are false positives, please report
1087 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1088EOM
1089 }
1090}
1091
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001092exit($exit);
1093
1094sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001095 my ($root) = @_;
1096
1097 my @tree_check = (
1098 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1099 "README", "Documentation", "arch", "include", "drivers",
1100 "fs", "init", "ipc", "kernel", "lib", "scripts",
1101 );
1102
1103 foreach my $check (@tree_check) {
1104 if (! -e $root . '/' . $check) {
1105 return 0;
1106 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001107 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001108 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001109}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001110
Joe Perches20112472011-07-25 17:13:23 -07001111sub parse_email {
1112 my ($formatted_email) = @_;
1113
1114 my $name = "";
1115 my $address = "";
1116 my $comment = "";
1117
1118 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1119 $name = $1;
1120 $address = $2;
1121 $comment = $3 if defined $3;
1122 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1123 $address = $1;
1124 $comment = $2 if defined $2;
1125 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1126 $address = $1;
1127 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001128 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001129 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001130 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001131 $name =~ s/^\"|\"$//g;
1132 # If there's a name left after stripping spaces and
1133 # leading quotes, and the address doesn't have both
1134 # leading and trailing angle brackets, the address
1135 # is invalid. ie:
1136 # "joe smith joe@smith.com" bad
1137 # "joe smith <joe@smith.com" bad
1138 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1139 $name = "";
1140 $address = "";
1141 $comment = "";
1142 }
1143 }
1144
Joe Perches3705ce52013-07-03 15:05:31 -07001145 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001146 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001147 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001148 $address =~ s/^\<|\>$//g;
1149
1150 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1151 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1152 $name = "\"$name\"";
1153 }
1154
1155 return ($name, $address, $comment);
1156}
1157
1158sub format_email {
1159 my ($name, $address) = @_;
1160
1161 my $formatted_email;
1162
Joe Perches3705ce52013-07-03 15:05:31 -07001163 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001164 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001165 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001166
1167 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1168 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1169 $name = "\"$name\"";
1170 }
1171
1172 if ("$name" eq "") {
1173 $formatted_email = "$address";
1174 } else {
1175 $formatted_email = "$name <$address>";
1176 }
1177
1178 return $formatted_email;
1179}
1180
Joe Perchesd311cd42014-08-06 16:10:57 -07001181sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001182 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001183
Joe Perchesbd474ca2014-08-06 16:11:10 -07001184 foreach my $path (split(/:/, $ENV{PATH})) {
1185 if (-e "$path/$bin") {
1186 return "$path/$bin";
1187 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001188 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001189
Joe Perchesbd474ca2014-08-06 16:11:10 -07001190 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001191}
1192
Joe Perches000d1cc12011-07-25 17:13:25 -07001193sub which_conf {
1194 my ($conf) = @_;
1195
1196 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1197 if (-e "$path/$conf") {
1198 return "$path/$conf";
1199 }
1200 }
1201
1202 return "";
1203}
1204
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001205sub expand_tabs {
1206 my ($str) = @_;
1207
1208 my $res = '';
1209 my $n = 0;
1210 for my $c (split(//, $str)) {
1211 if ($c eq "\t") {
1212 $res .= ' ';
1213 $n++;
1214 for (; ($n % 8) != 0; $n++) {
1215 $res .= ' ';
1216 }
1217 next;
1218 }
1219 $res .= $c;
1220 $n++;
1221 }
1222
1223 return $res;
1224}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001225sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001226 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001227 return $res;
1228}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001229
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001230sub line_stats {
1231 my ($line) = @_;
1232
1233 # Drop the diff line leader and expand tabs
1234 $line =~ s/^.//;
1235 $line = expand_tabs($line);
1236
1237 # Pick the indent from the front of the line.
1238 my ($white) = ($line =~ /^(\s*)/);
1239
1240 return (length($line), length($white));
1241}
1242
Andy Whitcroft773647a2008-03-28 14:15:58 -07001243my $sanitise_quote = '';
1244
1245sub sanitise_line_reset {
1246 my ($in_comment) = @_;
1247
1248 if ($in_comment) {
1249 $sanitise_quote = '*/';
1250 } else {
1251 $sanitise_quote = '';
1252 }
1253}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001254sub sanitise_line {
1255 my ($line) = @_;
1256
1257 my $res = '';
1258 my $l = '';
1259
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001260 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001261 my $off = 0;
1262 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001263
Andy Whitcroft773647a2008-03-28 14:15:58 -07001264 # Always copy over the diff marker.
1265 $res = substr($line, 0, 1);
1266
1267 for ($off = 1; $off < length($line); $off++) {
1268 $c = substr($line, $off, 1);
1269
Claudio Fontana8d2e11b2018-04-10 16:33:42 -07001270 # Comments we are whacking completely including the begin
Andy Whitcroft773647a2008-03-28 14:15:58 -07001271 # and end, all to $;.
1272 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1273 $sanitise_quote = '*/';
1274
1275 substr($res, $off, 2, "$;$;");
1276 $off++;
1277 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001278 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001279 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001280 $sanitise_quote = '';
1281 substr($res, $off, 2, "$;$;");
1282 $off++;
1283 next;
1284 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001285 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1286 $sanitise_quote = '//';
1287
1288 substr($res, $off, 2, $sanitise_quote);
1289 $off++;
1290 next;
1291 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001292
1293 # A \ in a string means ignore the next character.
1294 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1295 $c eq "\\") {
1296 substr($res, $off, 2, 'XX');
1297 $off++;
1298 next;
1299 }
1300 # Regular quotes.
1301 if ($c eq "'" || $c eq '"') {
1302 if ($sanitise_quote eq '') {
1303 $sanitise_quote = $c;
1304
1305 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001306 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001307 } elsif ($sanitise_quote eq $c) {
1308 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001309 }
1310 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001311
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001312 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001313 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1314 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001315 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1316 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001317 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1318 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001319 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001320 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001321 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001322 }
1323
Daniel Walker113f04a2009-09-21 17:04:35 -07001324 if ($sanitise_quote eq '//') {
1325 $sanitise_quote = '';
1326 }
1327
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001328 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001329 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001330 my $clean = 'X' x length($1);
1331 $res =~ s@\<.*\>@<$clean>@;
1332
1333 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001334 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001335 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001336 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001337 }
1338
Joe Perchesdadf6802016-08-02 14:04:33 -07001339 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1340 my $match = $1;
1341 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1342 }
1343
Andy Whitcroft00df3442007-06-08 13:47:06 -07001344 return $res;
1345}
1346
Joe Perchesa6962d72013-04-29 16:18:13 -07001347sub get_quoted_string {
1348 my ($line, $rawline) = @_;
1349
Joe Perches478b1792018-04-10 16:33:34 -07001350 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001351 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001352 return substr($rawline, $-[0], $+[0] - $-[0]);
1353}
1354
Andy Whitcroft8905a672007-11-28 16:21:06 -08001355sub ctx_statement_block {
1356 my ($linenr, $remain, $off) = @_;
1357 my $line = $linenr - 1;
1358 my $blk = '';
1359 my $soff = $off;
1360 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001361 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001362
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001363 my $loff = 0;
1364
Andy Whitcroft8905a672007-11-28 16:21:06 -08001365 my $type = '';
1366 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001367 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001368 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001369 my $c;
1370 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001371
1372 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001373 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001374 @stack = (['', 0]) if ($#stack == -1);
1375
Andy Whitcroft773647a2008-03-28 14:15:58 -07001376 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001377 # If we are about to drop off the end, pull in more
1378 # context.
1379 if ($off >= $len) {
1380 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001381 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001382 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001383 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001384 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001385 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001386 $len = length($blk);
1387 $line++;
1388 last;
1389 }
1390 # Bail if there is no further context.
1391 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001392 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001393 last;
1394 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001395 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1396 $level++;
1397 $type = '#';
1398 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001399 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001400 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001401 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001402 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001403
Andy Whitcroft773647a2008-03-28 14:15:58 -07001404 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001405
1406 # Handle nested #if/#else.
1407 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1408 push(@stack, [ $type, $level ]);
1409 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1410 ($type, $level) = @{$stack[$#stack - 1]};
1411 } elsif ($remainder =~ /^#\s*endif\b/) {
1412 ($type, $level) = @{pop(@stack)};
1413 }
1414
Andy Whitcroft8905a672007-11-28 16:21:06 -08001415 # Statement ends at the ';' or a close '}' at the
1416 # outermost level.
1417 if ($level == 0 && $c eq ';') {
1418 last;
1419 }
1420
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001421 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001422 if ($level == 0 && $coff_set == 0 &&
1423 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1424 $remainder =~ /^(else)(?:\s|{)/ &&
1425 $remainder !~ /^else\s+if\b/) {
1426 $coff = $off + length($1) - 1;
1427 $coff_set = 1;
1428 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1429 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001430 }
1431
Andy Whitcroft8905a672007-11-28 16:21:06 -08001432 if (($type eq '' || $type eq '(') && $c eq '(') {
1433 $level++;
1434 $type = '(';
1435 }
1436 if ($type eq '(' && $c eq ')') {
1437 $level--;
1438 $type = ($level != 0)? '(' : '';
1439
1440 if ($level == 0 && $coff < $soff) {
1441 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001442 $coff_set = 1;
1443 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001444 }
1445 }
1446 if (($type eq '' || $type eq '{') && $c eq '{') {
1447 $level++;
1448 $type = '{';
1449 }
1450 if ($type eq '{' && $c eq '}') {
1451 $level--;
1452 $type = ($level != 0)? '{' : '';
1453
1454 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001455 if (substr($blk, $off + 1, 1) eq ';') {
1456 $off++;
1457 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001458 last;
1459 }
1460 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001461 # Preprocessor commands end at the newline unless escaped.
1462 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1463 $level--;
1464 $type = '';
1465 $off++;
1466 last;
1467 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001468 $off++;
1469 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001470 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001471 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001472 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001473 $line++;
1474 $remain--;
1475 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001476
1477 my $statement = substr($blk, $soff, $off - $soff + 1);
1478 my $condition = substr($blk, $soff, $coff - $soff + 1);
1479
1480 #warn "STATEMENT<$statement>\n";
1481 #warn "CONDITION<$condition>\n";
1482
Andy Whitcroft773647a2008-03-28 14:15:58 -07001483 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001484
1485 return ($statement, $condition,
1486 $line, $remain + 1, $off - $loff + 1, $level);
1487}
1488
Andy Whitcroftcf655042008-03-04 14:28:20 -08001489sub statement_lines {
1490 my ($stmt) = @_;
1491
1492 # Strip the diff line prefixes and rip blank lines at start and end.
1493 $stmt =~ s/(^|\n)./$1/g;
1494 $stmt =~ s/^\s*//;
1495 $stmt =~ s/\s*$//;
1496
1497 my @stmt_lines = ($stmt =~ /\n/g);
1498
1499 return $#stmt_lines + 2;
1500}
1501
1502sub statement_rawlines {
1503 my ($stmt) = @_;
1504
1505 my @stmt_lines = ($stmt =~ /\n/g);
1506
1507 return $#stmt_lines + 2;
1508}
1509
1510sub statement_block_size {
1511 my ($stmt) = @_;
1512
1513 $stmt =~ s/(^|\n)./$1/g;
1514 $stmt =~ s/^\s*{//;
1515 $stmt =~ s/}\s*$//;
1516 $stmt =~ s/^\s*//;
1517 $stmt =~ s/\s*$//;
1518
1519 my @stmt_lines = ($stmt =~ /\n/g);
1520 my @stmt_statements = ($stmt =~ /;/g);
1521
1522 my $stmt_lines = $#stmt_lines + 2;
1523 my $stmt_statements = $#stmt_statements + 1;
1524
1525 if ($stmt_lines > $stmt_statements) {
1526 return $stmt_lines;
1527 } else {
1528 return $stmt_statements;
1529 }
1530}
1531
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001532sub ctx_statement_full {
1533 my ($linenr, $remain, $off) = @_;
1534 my ($statement, $condition, $level);
1535
1536 my (@chunks);
1537
Andy Whitcroftcf655042008-03-04 14:28:20 -08001538 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001539 ($statement, $condition, $linenr, $remain, $off, $level) =
1540 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001541 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001542 push(@chunks, [ $condition, $statement ]);
1543 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1544 return ($level, $linenr, @chunks);
1545 }
1546
1547 # Pull in the following conditional/block pairs and see if they
1548 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001549 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001550 ($statement, $condition, $linenr, $remain, $off, $level) =
1551 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001552 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001553 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001554 #print "C: push\n";
1555 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001556 }
1557
1558 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001559}
1560
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001561sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001562 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001563 my $line;
1564 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001565 my $blk = '';
1566 my @o;
1567 my @c;
1568 my @res = ();
1569
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001570 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001571 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001572 for ($line = $start; $remain > 0; $line++) {
1573 next if ($rawlines[$line] =~ /^-/);
1574 $remain--;
1575
1576 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001577
1578 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001579 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001580 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001581 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001582 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001583 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001584 $level = pop(@stack);
1585 }
1586
Andy Whitcroft01464f32010-10-26 14:23:19 -07001587 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001588 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1589 if ($off > 0) {
1590 $off--;
1591 next;
1592 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001593
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001594 if ($c eq $close && $level > 0) {
1595 $level--;
1596 last if ($level == 0);
1597 } elsif ($c eq $open) {
1598 $level++;
1599 }
1600 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001601
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001602 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001603 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001604 }
1605
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001606 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001607 }
1608
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001609 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001610}
1611sub ctx_block_outer {
1612 my ($linenr, $remain) = @_;
1613
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001614 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1615 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001616}
1617sub ctx_block {
1618 my ($linenr, $remain) = @_;
1619
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001620 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1621 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001622}
1623sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001624 my ($linenr, $remain, $off) = @_;
1625
1626 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1627 return @r;
1628}
1629sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001630 my ($linenr, $remain) = @_;
1631
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001632 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001633}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001634sub ctx_statement_level {
1635 my ($linenr, $remain, $off) = @_;
1636
1637 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1638}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001639
1640sub ctx_locate_comment {
1641 my ($first_line, $end_line) = @_;
1642
1643 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001644 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001645 return $current_comment if (defined $current_comment);
1646
1647 # Look through the context and try and figure out if there is a
1648 # comment.
1649 my $in_comment = 0;
1650 $current_comment = '';
1651 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001652 my $line = $rawlines[$linenr - 1];
1653 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001654 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1655 $in_comment = 1;
1656 }
1657 if ($line =~ m@/\*@) {
1658 $in_comment = 1;
1659 }
1660 if (!$in_comment && $current_comment ne '') {
1661 $current_comment = '';
1662 }
1663 $current_comment .= $line . "\n" if ($in_comment);
1664 if ($line =~ m@\*/@) {
1665 $in_comment = 0;
1666 }
1667 }
1668
1669 chomp($current_comment);
1670 return($current_comment);
1671}
1672sub ctx_has_comment {
1673 my ($first_line, $end_line) = @_;
1674 my $cmt = ctx_locate_comment($first_line, $end_line);
1675
Andy Whitcroft00df3442007-06-08 13:47:06 -07001676 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001677 ##print "CMMT: $cmt\n";
1678
1679 return ($cmt ne '');
1680}
1681
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001682sub raw_line {
1683 my ($linenr, $cnt) = @_;
1684
1685 my $offset = $linenr - 1;
1686 $cnt++;
1687
1688 my $line;
1689 while ($cnt) {
1690 $line = $rawlines[$offset++];
1691 next if (defined($line) && $line =~ /^-/);
1692 $cnt--;
1693 }
1694
1695 return $line;
1696}
1697
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001698sub get_stat_real {
1699 my ($linenr, $lc) = @_;
1700
1701 my $stat_real = raw_line($linenr, 0);
1702 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1703 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1704 }
1705
1706 return $stat_real;
1707}
1708
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001709sub get_stat_here {
1710 my ($linenr, $cnt, $here) = @_;
1711
1712 my $herectx = $here . "\n";
1713 for (my $n = 0; $n < $cnt; $n++) {
1714 $herectx .= raw_line($linenr, $n) . "\n";
1715 }
1716
1717 return $herectx;
1718}
1719
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001720sub cat_vet {
1721 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001722 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001723
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001724 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001725 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1726 $res .= $1;
1727 if ($2 ne '') {
1728 $coded = sprintf("^%c", unpack('C', $2) + 64);
1729 $res .= $coded;
1730 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001731 }
1732 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001733
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001734 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001735}
1736
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001737my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001738my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001739my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001740my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001741
1742sub annotate_reset {
1743 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001744 $av_pending = '_';
1745 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001746 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001747}
1748
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001749sub annotate_values {
1750 my ($stream, $type) = @_;
1751
1752 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001753 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001754 my $cur = $stream;
1755
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001756 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001757
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001758 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001759 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001760 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001761 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001762 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001763 print "WS($1)\n" if ($dbg_values > 1);
1764 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001765 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001766 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001767 }
1768
Florian Micklerc023e4732011-01-12 16:59:58 -08001769 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001770 print "CAST($1)\n" if ($dbg_values > 1);
1771 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001772 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001773
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001774 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001775 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001776 $type = 'T';
1777
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001778 } elsif ($cur =~ /^($Modifier)\s*/) {
1779 print "MODIFIER($1)\n" if ($dbg_values > 1);
1780 $type = 'T';
1781
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001782 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001783 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001784 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001785 push(@av_paren_type, $type);
1786 if ($2 ne '') {
1787 $av_pending = 'N';
1788 }
1789 $type = 'E';
1790
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001791 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001792 print "UNDEF($1)\n" if ($dbg_values > 1);
1793 $av_preprocessor = 1;
1794 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001795
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001796 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001797 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001798 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001799
1800 push(@av_paren_type, $type);
1801 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001802 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001803
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001804 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001805 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1806 $av_preprocessor = 1;
1807
1808 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1809
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001810 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001811
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001812 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001813 print "PRE_END($1)\n" if ($dbg_values > 1);
1814
1815 $av_preprocessor = 1;
1816
1817 # Assume all arms of the conditional end as this
1818 # one does, and continue as if the #endif was not here.
1819 pop(@av_paren_type);
1820 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001821 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001822
1823 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001824 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001825
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001826 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1827 print "ATTR($1)\n" if ($dbg_values > 1);
1828 $av_pending = $type;
1829 $type = 'N';
1830
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001831 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001832 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001833 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001834 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001835 }
1836 $type = 'N';
1837
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001838 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001839 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001840 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001841 $type = 'N';
1842
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001843 } elsif ($cur =~/^(case)/o) {
1844 print "CASE($1)\n" if ($dbg_values > 1);
1845 $av_pend_colon = 'C';
1846 $type = 'N';
1847
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001848 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001849 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001850 $type = 'N';
1851
1852 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001853 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001854 push(@av_paren_type, $av_pending);
1855 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001856 $type = 'N';
1857
1858 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001859 my $new_type = pop(@av_paren_type);
1860 if ($new_type ne '_') {
1861 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001862 print "PAREN('$1') -> $type\n"
1863 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001864 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001865 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001866 }
1867
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001868 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001869 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001870 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001871 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001872
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001873 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1874 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001875 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001876 } elsif ($type eq 'E') {
1877 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001878 }
1879 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1880 $type = 'V';
1881
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001882 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001883 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001884 $type = 'V';
1885
1886 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001887 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001888 $type = 'N';
1889
Andy Whitcroftcf655042008-03-04 14:28:20 -08001890 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001891 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001892 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001893 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001894
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001895 } elsif ($cur =~/^(,)/) {
1896 print "COMMA($1)\n" if ($dbg_values > 1);
1897 $type = 'C';
1898
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001899 } elsif ($cur =~ /^(\?)/o) {
1900 print "QUESTION($1)\n" if ($dbg_values > 1);
1901 $type = 'N';
1902
1903 } elsif ($cur =~ /^(:)/o) {
1904 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1905
1906 substr($var, length($res), 1, $av_pend_colon);
1907 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1908 $type = 'E';
1909 } else {
1910 $type = 'N';
1911 }
1912 $av_pend_colon = 'O';
1913
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001914 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001915 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001916 $type = 'N';
1917
Andy Whitcroft0d413862008-10-15 22:02:16 -07001918 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001919 my $variant;
1920
1921 print "OPV($1)\n" if ($dbg_values > 1);
1922 if ($type eq 'V') {
1923 $variant = 'B';
1924 } else {
1925 $variant = 'U';
1926 }
1927
1928 substr($var, length($res), 1, $variant);
1929 $type = 'N';
1930
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001931 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001932 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001933 if ($1 ne '++' && $1 ne '--') {
1934 $type = 'N';
1935 }
1936
1937 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001938 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001939 }
1940 if (defined $1) {
1941 $cur = substr($cur, length($1));
1942 $res .= $type x length($1);
1943 }
1944 }
1945
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001946 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001947}
1948
Andy Whitcroft8905a672007-11-28 16:21:06 -08001949sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001950 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001951 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001952 ^(?:
1953 $Modifier|
1954 $Storage|
1955 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001956 DEFINE_\S+
1957 )$|
1958 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001959 goto|
1960 return|
1961 case|
1962 else|
1963 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001964 do|
1965 \#|
1966 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001967 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001968 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001969 )}x;
1970 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1971 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001972 # Check for modifiers.
1973 $possible =~ s/\s*$Storage\s*//g;
1974 $possible =~ s/\s*$Sparse\s*//g;
1975 if ($possible =~ /^\s*$/) {
1976
1977 } elsif ($possible =~ /\s/) {
1978 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001979 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001980 if ($modifier !~ $notPermitted) {
1981 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001982 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001983 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001984 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001985
1986 } else {
1987 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001988 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001989 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001990 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001991 } else {
1992 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001993 }
1994}
1995
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001996my $prefix = '';
1997
Joe Perches000d1cc12011-07-25 17:13:25 -07001998sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001999 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07002000
Alexey Dobriyan522b8372017-02-27 14:30:05 -08002001 $type =~ tr/[a-z]/[A-Z]/;
2002
Joe Perchescbec18a2014-04-03 14:49:19 -07002003 return defined $use_type{$type} if (scalar keys %use_type > 0);
2004
2005 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07002006}
2007
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002008sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07002009 my ($level, $type, $msg) = @_;
2010
2011 if (!show_type($type) ||
2012 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002013 return 0;
2014 }
Joe Perches57230292015-06-25 15:03:03 -07002015 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07002016 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07002017 if ($level eq 'ERROR') {
2018 $output .= RED;
2019 } elsif ($level eq 'WARNING') {
2020 $output .= YELLOW;
2021 } else {
2022 $output .= GREEN;
2023 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002024 }
Joe Perches57230292015-06-25 15:03:03 -07002025 $output .= $prefix . $level . ':';
2026 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07002027 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002028 $output .= "$type:";
2029 }
John Brooks737c0762017-07-10 15:52:24 -07002030 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07002031 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07002032
2033 if ($showfile) {
2034 my @lines = split("\n", $output, -1);
2035 splice(@lines, 1, 1);
2036 $output = join("\n", @lines);
2037 }
Joe Perches57230292015-06-25 15:03:03 -07002038 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002039
Joe Perches57230292015-06-25 15:03:03 -07002040 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002041
2042 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002043}
Joe Perchescbec18a2014-04-03 14:49:19 -07002044
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002045sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002046 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002047}
Joe Perches000d1cc12011-07-25 17:13:25 -07002048
Joe Perchesd752fcc2014-08-06 16:11:05 -07002049sub fixup_current_range {
2050 my ($lineRef, $offset, $length) = @_;
2051
2052 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2053 my $o = $1;
2054 my $l = $2;
2055 my $no = $o + $offset;
2056 my $nl = $l + $length;
2057 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2058 }
2059}
2060
2061sub fix_inserted_deleted_lines {
2062 my ($linesRef, $insertedRef, $deletedRef) = @_;
2063
2064 my $range_last_linenr = 0;
2065 my $delta_offset = 0;
2066
2067 my $old_linenr = 0;
2068 my $new_linenr = 0;
2069
2070 my $next_insert = 0;
2071 my $next_delete = 0;
2072
2073 my @lines = ();
2074
2075 my $inserted = @{$insertedRef}[$next_insert++];
2076 my $deleted = @{$deletedRef}[$next_delete++];
2077
2078 foreach my $old_line (@{$linesRef}) {
2079 my $save_line = 1;
2080 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002081 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002082 $delta_offset = 0;
2083 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2084 $range_last_linenr = $new_linenr;
2085 fixup_current_range(\$line, $delta_offset, 0);
2086 }
2087
2088 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2089 $deleted = @{$deletedRef}[$next_delete++];
2090 $save_line = 0;
2091 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2092 }
2093
2094 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2095 push(@lines, ${$inserted}{'LINE'});
2096 $inserted = @{$insertedRef}[$next_insert++];
2097 $new_linenr++;
2098 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2099 }
2100
2101 if ($save_line) {
2102 push(@lines, $line);
2103 $new_linenr++;
2104 }
2105
2106 $old_linenr++;
2107 }
2108
2109 return @lines;
2110}
2111
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002112sub fix_insert_line {
2113 my ($linenr, $line) = @_;
2114
2115 my $inserted = {
2116 LINENR => $linenr,
2117 LINE => $line,
2118 };
2119 push(@fixed_inserted, $inserted);
2120}
2121
2122sub fix_delete_line {
2123 my ($linenr, $line) = @_;
2124
2125 my $deleted = {
2126 LINENR => $linenr,
2127 LINE => $line,
2128 };
2129
2130 push(@fixed_deleted, $deleted);
2131}
2132
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002133sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002134 my ($type, $msg) = @_;
2135
2136 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002137 our $clean = 0;
2138 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002139 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002140 }
Joe Perches3705ce52013-07-03 15:05:31 -07002141 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002142}
2143sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002144 my ($type, $msg) = @_;
2145
2146 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002147 our $clean = 0;
2148 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002149 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002150 }
Joe Perches3705ce52013-07-03 15:05:31 -07002151 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002152}
2153sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002154 my ($type, $msg) = @_;
2155
2156 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002157 our $clean = 0;
2158 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002159 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002160 }
Joe Perches3705ce52013-07-03 15:05:31 -07002161 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002162}
2163
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002164sub check_absolute_file {
2165 my ($absolute, $herecurr) = @_;
2166 my $file = $absolute;
2167
2168 ##print "absolute<$absolute>\n";
2169
2170 # See if any suffix of this path is a path within the tree.
2171 while ($file =~ s@^[^/]*/@@) {
2172 if (-f "$root/$file") {
2173 ##print "file<$file>\n";
2174 last;
2175 }
2176 }
2177 if (! -f _) {
2178 return 0;
2179 }
2180
2181 # It is, so see if the prefix is acceptable.
2182 my $prefix = $absolute;
2183 substr($prefix, -length($file)) = '';
2184
2185 ##print "prefix<$prefix>\n";
2186 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002187 WARN("USE_RELATIVE_PATH",
2188 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002189 }
2190}
2191
Joe Perches3705ce52013-07-03 15:05:31 -07002192sub trim {
2193 my ($string) = @_;
2194
Joe Perchesb34c6482013-09-11 14:24:01 -07002195 $string =~ s/^\s+|\s+$//g;
2196
2197 return $string;
2198}
2199
2200sub ltrim {
2201 my ($string) = @_;
2202
2203 $string =~ s/^\s+//;
2204
2205 return $string;
2206}
2207
2208sub rtrim {
2209 my ($string) = @_;
2210
2211 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002212
2213 return $string;
2214}
2215
Joe Perches52ea8502013-11-12 15:10:09 -08002216sub string_find_replace {
2217 my ($string, $find, $replace) = @_;
2218
2219 $string =~ s/$find/$replace/g;
2220
2221 return $string;
2222}
2223
Joe Perches3705ce52013-07-03 15:05:31 -07002224sub tabify {
2225 my ($leading) = @_;
2226
2227 my $source_indent = 8;
2228 my $max_spaces_before_tab = $source_indent - 1;
2229 my $spaces_to_tab = " " x $source_indent;
2230
2231 #convert leading spaces to tabs
2232 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2233 #Remove spaces before a tab
2234 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2235
2236 return "$leading";
2237}
2238
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002239sub pos_last_openparen {
2240 my ($line) = @_;
2241
2242 my $pos = 0;
2243
2244 my $opens = $line =~ tr/\(/\(/;
2245 my $closes = $line =~ tr/\)/\)/;
2246
2247 my $last_openparen = 0;
2248
2249 if (($opens == 0) || ($closes >= $opens)) {
2250 return -1;
2251 }
2252
2253 my $len = length($line);
2254
2255 for ($pos = 0; $pos < $len; $pos++) {
2256 my $string = substr($line, $pos);
2257 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2258 $pos += length($1) - 1;
2259 } elsif (substr($line, $pos, 1) eq '(') {
2260 $last_openparen = $pos;
2261 } elsif (index($string, '(') == -1) {
2262 last;
2263 }
2264 }
2265
Joe Perches91cb5192014-04-03 14:49:32 -07002266 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002267}
2268
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002269sub process {
2270 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002271
2272 my $linenr=0;
2273 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002274 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002275 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002276 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002277
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002278 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002279 my $indent;
2280 my $previndent=0;
2281 my $stashindent=0;
2282
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002283 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002284 my $signoff = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002285 my $author = '';
2286 my $authorsignoff = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002287 my $is_patch = 0;
Rob Herring133712a2018-08-21 21:58:16 -07002288 my $is_binding_patch = -1;
Joe Perches29ee1b02014-08-06 16:10:35 -07002289 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002290 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002291 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches490b2922018-08-21 21:58:01 -07002292 my $commit_log_lines = 0; #Number of commit log lines
Joe Perches77cb8542017-02-24 15:01:28 -08002293 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002294 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002295 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002296 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002297 my $non_utf8_charset = 0;
2298
Joe Perches365dd4e2014-08-06 16:10:42 -07002299 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002300 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002301
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002302 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002303 our $cnt_lines = 0;
2304 our $cnt_error = 0;
2305 our $cnt_warn = 0;
2306 our $cnt_chk = 0;
2307
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002308 # Trace the real file/line as we go.
2309 my $realfile = '';
2310 my $realline = 0;
2311 my $realcnt = 0;
2312 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002313 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002314 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002315 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002316 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002317 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002318
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002319 my $prev_values = 'E';
2320
2321 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002322 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002323 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002324 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002325 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002326
Joe Perches7e51f192013-09-11 14:23:57 -07002327 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002328
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002329 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002330 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002331 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002332 my @setup_docs = ();
2333 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002334
Joe Perchesd8b07712013-11-12 15:10:06 -08002335 my $camelcase_file_seeded = 0;
2336
Rob Herring9f3a8992018-04-10 16:33:13 -07002337 my $checklicenseline = 1;
2338
Andy Whitcroft773647a2008-03-28 14:15:58 -07002339 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002340 my $line;
2341 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002342 $linenr++;
2343 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002344
Joe Perches3705ce52013-07-03 15:05:31 -07002345 push(@fixed, $rawline) if ($fix);
2346
Andy Whitcroft773647a2008-03-28 14:15:58 -07002347 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002348 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002349 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002350 $setup_docs = 1;
2351 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002352 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002353 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002354 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002355 $realline=$1-1;
2356 if (defined $2) {
2357 $realcnt=$3+1;
2358 } else {
2359 $realcnt=1+1;
2360 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002361 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002362
2363 # Guestimate if this is a continuing comment. Run
2364 # the context looking for a comment "edge". If this
2365 # edge is a close comment then we must be in a comment
2366 # at context start.
2367 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002368 my $cnt = $realcnt;
2369 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2370 next if (defined $rawlines[$ln - 1] &&
2371 $rawlines[$ln - 1] =~ /^-/);
2372 $cnt--;
2373 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002374 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002375 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2376 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2377 ($edge) = $1;
2378 last;
2379 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002380 }
2381 if (defined $edge && $edge eq '*/') {
2382 $in_comment = 1;
2383 }
2384
2385 # Guestimate if this is a continuing comment. If this
2386 # is the start of a diff block and this line starts
2387 # ' *' then it is very likely a comment.
2388 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002389 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002390 {
2391 $in_comment = 1;
2392 }
2393
2394 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2395 sanitise_line_reset($in_comment);
2396
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002397 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002398 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002399 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002400 $line = sanitise_line($rawline);
2401 }
2402 push(@lines, $line);
2403
2404 if ($realcnt > 1) {
2405 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2406 } else {
2407 $realcnt = 0;
2408 }
2409
2410 #print "==>$rawline\n";
2411 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002412
2413 if ($setup_docs && $line =~ /^\+/) {
2414 push(@setup_docs, $line);
2415 }
2416 }
2417
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002418 $prefix = '';
2419
Andy Whitcroft773647a2008-03-28 14:15:58 -07002420 $realcnt = 0;
2421 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002422 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002423 foreach my $line (@lines) {
2424 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002425 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002426 my $sline = $line; #copy of $line
2427 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002428
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002429 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002430
Joe Perches12c253a2018-06-07 17:10:58 -07002431# check if it's a mode change, rename or start of a patch
2432 if (!$in_commit_log &&
2433 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ ||
2434 ($line =~ /^rename (?:from|to) \S+\s*$/ ||
2435 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) {
2436 $is_patch = 1;
2437 }
2438
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002439#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002440 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002441 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2442 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002443 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002444 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002445 $realline=$1-1;
2446 if (defined $2) {
2447 $realcnt=$3+1;
2448 } else {
2449 $realcnt=1+1;
2450 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002451 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002452 $prev_values = 'E';
2453
Andy Whitcroft773647a2008-03-28 14:15:58 -07002454 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002455 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002456 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002457 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002458 if ($context =~ /\b(\w+)\s*\(/) {
2459 $context_function = $1;
2460 } else {
2461 undef $context_function;
2462 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002463 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002464
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002465# track the line number as we move through the hunk, note that
2466# new versions of GNU diff omit the leading space on completely
2467# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002468 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002469 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002470 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002471
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002472 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002473 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002474
2475 # Track the previous line.
2476 ($prevline, $stashline) = ($stashline, $line);
2477 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002478 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2479
Andy Whitcroft773647a2008-03-28 14:15:58 -07002480 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002481
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002482 } elsif ($realcnt == 1) {
2483 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002484 }
2485
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002486 my $hunk_line = ($realcnt != 0);
2487
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002488 $here = "#$linenr: " if (!$file);
2489 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002490
Joe Perches2ac73b42014-06-04 16:12:05 -07002491 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002492 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002493 if ($line =~ /^diff --git.*?(\S+)$/) {
2494 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002495 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002496 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002497 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002498 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002499 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002500 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002501 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002502
2503 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002504 if (!$file && $tree && $p1_prefix ne '' &&
2505 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002506 WARN("PATCH_PREFIX",
2507 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002508 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002509
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002510 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002511 ERROR("MODIFIED_INCLUDE_ASM",
2512 "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 -07002513 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002514 $found_file = 1;
2515 }
2516
Joe Perches34d88152015-06-25 15:03:05 -07002517#make up the handle for any error we report on this line
2518 if ($showfile) {
2519 $prefix = "$realfile:$realline: "
2520 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002521 if ($file) {
2522 $prefix = "$filename:$realline: ";
2523 } else {
2524 $prefix = "$filename:$linenr: ";
2525 }
Joe Perches34d88152015-06-25 15:03:05 -07002526 }
2527
Joe Perches2ac73b42014-06-04 16:12:05 -07002528 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002529 if (is_maintained_obsolete($realfile)) {
2530 WARN("OBSOLETE",
2531 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2532 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002533 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002534 $check = 1;
2535 } else {
2536 $check = $check_orig;
2537 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002538 $checklicenseline = 1;
Rob Herring133712a2018-08-21 21:58:16 -07002539
2540 if ($realfile !~ /^MAINTAINERS/) {
2541 my $last_binding_patch = $is_binding_patch;
2542
2543 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@;
2544
2545 if (($last_binding_patch != -1) &&
2546 ($last_binding_patch ^ $is_binding_patch)) {
2547 WARN("DT_SPLIT_BINDING_PATCH",
2548 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2549 }
2550 }
2551
Andy Whitcroft773647a2008-03-28 14:15:58 -07002552 next;
2553 }
2554
Randy Dunlap389834b2007-06-08 13:47:03 -07002555 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002556
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002557 my $hereline = "$here\n$rawline\n";
2558 my $herecurr = "$here\n$rawline\n";
2559 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002560
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002561 $cnt_lines++ if ($realcnt != 0);
2562
Joe Perches490b2922018-08-21 21:58:01 -07002563# Verify the existence of a commit log if appropriate
2564# 2 is used because a $signature is counted in $commit_log_lines
2565 if ($in_commit_log) {
2566 if ($line !~ /^\s*$/) {
2567 $commit_log_lines++; #could be a $signature
2568 }
2569 } elsif ($has_commit_log && $commit_log_lines < 2) {
2570 WARN("COMMIT_MESSAGE",
2571 "Missing commit description - Add an appropriate one\n");
2572 $commit_log_lines = 2; #warn only once
2573 }
2574
Joe Perchese518e9a2015-06-25 15:03:27 -07002575# Check if the commit log has what seems like a diff which can confuse patch
2576 if ($in_commit_log && !$commit_log_has_diff &&
2577 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2578 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2579 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2580 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2581 ERROR("DIFF_IN_COMMIT_MSG",
2582 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2583 $commit_log_has_diff = 1;
2584 }
2585
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002586# Check for incorrect file permissions
2587 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2588 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002589 if ($realfile !~ m@scripts/@ &&
2590 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002591 ERROR("EXECUTE_PERMISSIONS",
2592 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002593 }
2594 }
2595
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002596# Check the patch for a From:
2597 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) {
2598 $author = $1;
2599 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i);
2600 $author =~ s/"//g;
2601 }
2602
Joe Perches20112472011-07-25 17:13:23 -07002603# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002604 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002605 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002606 $in_commit_log = 0;
Geert Uytterhoevencd261492018-08-21 21:57:40 -07002607 if ($author ne '') {
2608 my $l = $line;
2609 $l =~ s/"//g;
2610 if ($l =~ /^\s*signed-off-by:\s*\Q$author\E/i) {
2611 $authorsignoff = 1;
2612 }
2613 }
Joe Perches20112472011-07-25 17:13:23 -07002614 }
2615
Joe Perchese0d975b2014-12-10 15:51:49 -08002616# Check if MAINTAINERS is being updated. If so, there's probably no need to
2617# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2618 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2619 $reported_maintainer_file = 1;
2620 }
2621
Joe Perches20112472011-07-25 17:13:23 -07002622# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002623 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002624 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002625 my $space_before = $1;
2626 my $sign_off = $2;
2627 my $space_after = $3;
2628 my $email = $4;
2629 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2630
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002631 if ($sign_off !~ /$signature_tags/) {
2632 WARN("BAD_SIGN_OFF",
2633 "Non-standard signature: $sign_off\n" . $herecurr);
2634 }
Joe Perches20112472011-07-25 17:13:23 -07002635 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002636 if (WARN("BAD_SIGN_OFF",
2637 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2638 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002639 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002640 "$ucfirst_sign_off $email";
2641 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002642 }
Joe Perches20112472011-07-25 17:13:23 -07002643 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002644 if (WARN("BAD_SIGN_OFF",
2645 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2646 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002647 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002648 "$ucfirst_sign_off $email";
2649 }
2650
Joe Perches20112472011-07-25 17:13:23 -07002651 }
2652 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002653 if (WARN("BAD_SIGN_OFF",
2654 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2655 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002656 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002657 "$ucfirst_sign_off $email";
2658 }
Joe Perches20112472011-07-25 17:13:23 -07002659 }
2660
2661 my ($email_name, $email_address, $comment) = parse_email($email);
2662 my $suggested_email = format_email(($email_name, $email_address));
2663 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002664 ERROR("BAD_SIGN_OFF",
2665 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002666 } else {
2667 my $dequoted = $suggested_email;
2668 $dequoted =~ s/^"//;
2669 $dequoted =~ s/" </ </;
2670 # Don't force email to have quotes
2671 # Allow just an angle bracketed address
2672 if ("$dequoted$comment" ne $email &&
2673 "<$email_address>$comment" ne $email &&
2674 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002675 WARN("BAD_SIGN_OFF",
2676 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002677 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002678 }
Joe Perches7e51f192013-09-11 14:23:57 -07002679
2680# Check for duplicate signatures
2681 my $sig_nospace = $line;
2682 $sig_nospace =~ s/\s//g;
2683 $sig_nospace = lc($sig_nospace);
2684 if (defined $signatures{$sig_nospace}) {
2685 WARN("BAD_SIGN_OFF",
2686 "Duplicate signature\n" . $herecurr);
2687 } else {
2688 $signatures{$sig_nospace} = 1;
2689 }
Sean Christopherson6c5d24e2019-03-22 14:11:37 -07002690
2691# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2692 if ($sign_off =~ /^co-developed-by:$/i) {
2693 if ($email eq $author) {
2694 WARN("BAD_SIGN_OFF",
2695 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2696 }
2697 if (!defined $lines[$linenr]) {
2698 WARN("BAD_SIGN_OFF",
2699 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline);
2700 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) {
2701 WARN("BAD_SIGN_OFF",
2702 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2703 } elsif ($1 ne $email) {
2704 WARN("BAD_SIGN_OFF",
2705 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2706 }
2707 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002708 }
2709
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002710# Check email subject for common tools that don't need to be mentioned
2711 if ($in_header_lines &&
2712 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2713 WARN("EMAIL_SUBJECT",
2714 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2715 }
2716
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002717# Check for unwanted Gerrit info
2718 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2719 ERROR("GERRIT_CHANGE_ID",
2720 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2721 }
2722
Joe Perches369c8dd2015-11-06 16:31:34 -08002723# Check if the commit log is in a possible stack dump
2724 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2725 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2726 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2727 # timestamp
Joe Perches634cffc2019-09-25 16:46:32 -07002728 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) ||
2729 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ ||
2730 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) {
2731 # stack dump address styles
Joe Perches369c8dd2015-11-06 16:31:34 -08002732 $commit_log_possible_stack_dump = 1;
2733 }
2734
Joe Perches2a076f42015-04-16 12:44:28 -07002735# Check for line lengths > 75 in commit log, warn once
2736 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002737 length($line) > 75 &&
2738 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2739 # file delta changes
2740 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2741 # filename then :
2742 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2743 # A Fixes: or Link: line
2744 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002745 WARN("COMMIT_LOG_LONG_LINE",
2746 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2747 $commit_log_long_line = 1;
2748 }
2749
Joe Perchesbf4daf12015-09-09 15:37:50 -07002750# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002751 if ($in_commit_log && $commit_log_possible_stack_dump &&
2752 $line =~ /^\s*$/) {
2753 $commit_log_possible_stack_dump = 0;
2754 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002755
Joe Perches0d7835f2015-02-13 14:38:35 -08002756# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002757 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002758 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002759 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002760 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002761 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002762 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2763 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002764 my $init_char = "c";
2765 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002766 my $short = 1;
2767 my $long = 0;
2768 my $case = 1;
2769 my $space = 1;
2770 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002771 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002772 my $id = '0123456789ab';
2773 my $orig_desc = "commit description";
2774 my $description = "";
2775
Joe Perchesfe043ea2015-09-09 15:37:25 -07002776 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2777 $init_char = $1;
2778 $orig_commit = lc($2);
2779 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2780 $orig_commit = lc($1);
2781 }
2782
Joe Perches0d7835f2015-02-13 14:38:35 -08002783 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2784 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2785 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2786 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2787 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2788 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002789 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002790 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2791 defined $rawlines[$linenr] &&
2792 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2793 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002794 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002795 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2796 defined $rawlines[$linenr] &&
2797 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2798 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2799 $orig_desc = $1;
2800 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2801 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002802 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002803 }
2804
2805 ($id, $description) = git_commit_info($orig_commit,
2806 $id, $orig_desc);
2807
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002808 if (defined($id) &&
2809 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002810 ERROR("GIT_COMMIT_ID",
2811 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2812 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002813 }
2814
Joe Perches13f19372014-08-06 16:10:59 -07002815# Check for added, moved or deleted files
2816 if (!$reported_maintainer_file && !$in_commit_log &&
2817 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2818 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2819 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2820 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002821 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002822 $reported_maintainer_file = 1;
2823 WARN("FILE_PATH_CHANGES",
2824 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2825 }
2826
Andy Whitcroft00df3442007-06-08 13:47:06 -07002827# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002828 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002829 ERROR("CORRUPTED_PATCH",
2830 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002831 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002832 }
2833
2834# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2835 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002836 $rawline !~ m/^$UTF8*$/) {
2837 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2838
2839 my $blank = copy_spacing($rawline);
2840 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2841 my $hereptr = "$hereline$ptr\n";
2842
Joe Perches34d99212011-07-25 17:13:26 -07002843 CHK("INVALID_UTF8",
2844 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002845 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002846
Joe Perches15662b32011-10-31 17:13:12 -07002847# Check if it's the start of a commit log
2848# (not a header line and we haven't seen the patch filename)
2849 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002850 !($rawline =~ /^\s+(?:\S|$)/ ||
2851 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002852 $in_header_lines = 0;
2853 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002854 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002855 }
2856
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002857# Check if there is UTF-8 in a commit log when a mail header has explicitly
2858# declined it, i.e defined some charset where it is missing.
2859 if ($in_header_lines &&
2860 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2861 $1 !~ /utf-8/i) {
2862 $non_utf8_charset = 1;
2863 }
2864
2865 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002866 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002867 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002868 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2869 }
2870
Joe Perchesd6430f72016-12-12 16:46:28 -08002871# Check for absolute kernel paths in commit message
2872 if ($tree && $in_commit_log) {
2873 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2874 my $file = $1;
2875
2876 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2877 check_absolute_file($1, $herecurr)) {
2878 #
2879 } else {
2880 check_absolute_file($file, $herecurr);
2881 }
2882 }
2883 }
2884
Kees Cook66b47b42014-10-13 15:51:57 -07002885# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002886 if (defined($misspellings) &&
2887 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002888 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002889 my $typo = $1;
2890 my $typo_fix = $spelling_fix{lc($typo)};
2891 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2892 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002893 my $msg_level = \&WARN;
2894 $msg_level = \&CHK if ($file);
2895 if (&{$msg_level}("TYPO_SPELLING",
2896 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002897 $fix) {
2898 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2899 }
2900 }
2901 }
2902
Andy Whitcroft306708542008-10-15 22:02:28 -07002903# ignore non-hunk lines and lines being removed
2904 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002905
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002906#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002907 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002908 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002909 if (ERROR("DOS_LINE_ENDINGS",
2910 "DOS line endings\n" . $herevet) &&
2911 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002912 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002913 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002914 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2915 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002916 if (ERROR("TRAILING_WHITESPACE",
2917 "trailing whitespace\n" . $herevet) &&
2918 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002919 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002920 }
2921
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002922 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002923 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002924
Josh Triplett4783f892013-11-12 15:10:12 -08002925# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002926 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002927 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002928 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2929 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002930 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002931 my $msg_level = \&ERROR;
2932 $msg_level = \&CHK if ($file);
2933 &{$msg_level}("FSF_MAILING_ADDRESS",
2934 "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 -08002935 }
2936
Andi Kleen33549572010-05-24 14:33:29 -07002937# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002938# Only applies when adding the entry originally, after that we do not have
2939# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002940 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002941 # 'choice' is usually the last thing on the line (though
2942 # Kconfig supports named choices), so use a word boundary
2943 # (\b) rather than a whitespace character (\s)
2944 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002945 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002946 my $cnt = $realcnt;
2947 my $ln = $linenr + 1;
2948 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002949 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002950 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002951 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002952 $f = $lines[$ln - 1];
2953 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2954 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002955
2956 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002957 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002958
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002959 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002960 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002961 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2962 if ($lines[$ln - 1] =~ "---help---") {
2963 WARN("CONFIG_DESCRIPTION",
2964 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2965 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002966 $length = -1;
2967 }
2968
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002969 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002970 $f =~ s/#.*//;
2971 $f =~ s/^\s+//;
2972 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002973
2974 # This only checks context lines in the patch
2975 # and so hopefully shouldn't trigger false
2976 # positives, even though some of these are
2977 # common words in help texts
2978 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2979 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002980 $is_end = 1;
2981 last;
2982 }
Andi Kleen33549572010-05-24 14:33:29 -07002983 $length++;
2984 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002985 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2986 WARN("CONFIG_DESCRIPTION",
2987 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2988 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002989 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002990 }
2991
Joe Perches628f91a2017-07-10 15:52:07 -07002992# check for MAINTAINERS entries that don't have the right form
2993 if ($realfile =~ /^MAINTAINERS$/ &&
2994 $rawline =~ /^\+[A-Z]:/ &&
2995 $rawline !~ /^\+[A-Z]:\t\S/) {
2996 if (WARN("MAINTAINERS_STYLE",
2997 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2998 $fix) {
2999 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
3000 }
3001 }
3002
Christoph Jaeger327953e2015-02-13 14:38:29 -08003003# discourage the use of boolean for type definition attributes of Kconfig options
3004 if ($realfile =~ /Kconfig/ &&
3005 $line =~ /^\+\s*\bboolean\b/) {
3006 WARN("CONFIG_TYPE_BOOLEAN",
3007 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
3008 }
3009
Arnaud Lacombec68e5872011-08-15 01:07:14 -04003010 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
3011 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
3012 my $flag = $1;
3013 my $replacement = {
3014 'EXTRA_AFLAGS' => 'asflags-y',
3015 'EXTRA_CFLAGS' => 'ccflags-y',
3016 'EXTRA_CPPFLAGS' => 'cppflags-y',
3017 'EXTRA_LDFLAGS' => 'ldflags-y',
3018 };
3019
3020 WARN("DEPRECATED_VARIABLE",
3021 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3022 }
3023
Rob Herringbff5da42014-01-23 15:54:51 -08003024# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07003025 if (defined $root &&
3026 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
3027 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
3028
Rob Herringbff5da42014-01-23 15:54:51 -08003029 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
3030
Florian Vaussardcc933192014-04-03 14:49:27 -07003031 my $dt_path = $root . "/Documentation/devicetree/bindings/";
Rob Herring852d0952019-05-22 09:55:34 -05003032 my $vp_file = $dt_path . "vendor-prefixes.yaml";
Florian Vaussardcc933192014-04-03 14:49:27 -07003033
Rob Herringbff5da42014-01-23 15:54:51 -08003034 foreach my $compat (@compats) {
3035 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07003036 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
3037 my $compat3 = $compat;
3038 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
3039 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08003040 if ( $? >> 8 ) {
3041 WARN("UNDOCUMENTED_DT_STRING",
3042 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
3043 }
3044
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07003045 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
3046 my $vendor = $1;
Rob Herring852d0952019-05-22 09:55:34 -05003047 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08003048 if ( $? >> 8 ) {
3049 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07003050 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08003051 }
3052 }
3053 }
3054
Rob Herring9f3a8992018-04-10 16:33:13 -07003055# check for using SPDX license tag at beginning of files
3056 if ($realline == $checklicenseline) {
3057 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
3058 $checklicenseline = 2;
3059 } elsif ($rawline =~ /^\+/) {
3060 my $comment = "";
3061 if ($realfile =~ /\.(h|s|S)$/) {
3062 $comment = '/*';
3063 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
3064 $comment = '//';
3065 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
3066 $comment = '#';
3067 } elsif ($realfile =~ /\.rst$/) {
3068 $comment = '..';
3069 }
3070
Joe Perchesfdf13692019-03-07 16:28:32 -08003071# check SPDX comment style for .[chsS] files
3072 if ($realfile =~ /\.[chsS]$/ &&
3073 $rawline =~ /SPDX-License-Identifier:/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003074 $rawline !~ m@^\+\s*\Q$comment\E\s*@) {
Joe Perchesfdf13692019-03-07 16:28:32 -08003075 WARN("SPDX_LICENSE_TAG",
3076 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr);
3077 }
3078
Rob Herring9f3a8992018-04-10 16:33:13 -07003079 if ($comment !~ /^$/ &&
Joe Perchesffbce892019-09-25 16:46:35 -07003080 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) {
3081 WARN("SPDX_LICENSE_TAG",
3082 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
Joe Perches3b6e8ac2018-08-21 21:57:47 -07003083 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) {
Joe Perchesffbce892019-09-25 16:46:35 -07003084 my $spdx_license = $1;
3085 if (!is_SPDX_License_valid($spdx_license)) {
3086 WARN("SPDX_LICENSE_TAG",
3087 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr);
3088 }
Rob Herring9f3a8992018-04-10 16:33:13 -07003089 }
3090 }
3091 }
3092
Andy Whitcroft5368df22008-10-15 22:02:27 -07003093# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08003094 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07003095
Joe Perchesa8da38a2019-03-07 16:28:42 -08003096# check for using SPDX-License-Identifier on the wrong line number
3097 if ($realline != $checklicenseline &&
3098 $rawline =~ /\bSPDX-License-Identifier:/ &&
3099 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) {
3100 WARN("SPDX_LICENSE_TAG",
3101 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr);
3102 }
3103
Joe Perches47e0c882015-06-25 15:02:57 -07003104# line length limit (with some exclusions)
3105#
3106# There are a few types of lines that may extend beyond $max_line_length:
3107# logging functions like pr_info that end in a string
3108# lines with a single string
3109# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003110# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07003111#
3112# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07003113# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07003114# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3115# LONG_LINE all other lines longer than $max_line_length
3116#
3117# if LONG_LINE is ignored, the other 2 types are also ignored
3118#
3119
Joe Perchesb4749e92015-07-17 16:24:01 -07003120 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07003121 my $msg_type = "LONG_LINE";
3122
3123 # Check the allowed long line types first
3124
3125 # logging functions that end in a string that starts
3126 # before $max_line_length
3127 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3128 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3129 $msg_type = "";
3130
3131 # lines with only strings (w/ possible termination)
3132 # #defines with only strings
3133 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
3134 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
3135 $msg_type = "";
3136
Joe Perchescc147502017-11-17 15:28:44 -08003137 # More special cases
3138 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3139 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003140 $msg_type = "";
3141
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003142 # URL ($rawline is used in case the URL is in a comment)
3143 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3144 $msg_type = "";
3145
Joe Perches47e0c882015-06-25 15:02:57 -07003146 # Otherwise set the alternate message types
3147
3148 # a comment starts before $max_line_length
3149 } elsif ($line =~ /($;[\s$;]*)$/ &&
3150 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3151 $msg_type = "LONG_LINE_COMMENT"
3152
3153 # a quoted string starts before $max_line_length
3154 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3155 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3156 $msg_type = "LONG_LINE_STRING"
3157 }
3158
3159 if ($msg_type ne "" &&
3160 (show_type("LONG_LINE") || show_type($msg_type))) {
3161 WARN($msg_type,
3162 "line over $max_line_length characters\n" . $herecurr);
3163 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003164 }
3165
Andy Whitcroft8905a672007-11-28 16:21:06 -08003166# check for adding lines without a newline.
3167 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003168 WARN("MISSING_EOF_NEWLINE",
3169 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003170 }
3171
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003172# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003173 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003174
3175# at the beginning of a line any tabs must come first and anything
3176# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003177 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3178 $rawline =~ /^\+\s* \s*/) {
3179 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003180 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003181 if (ERROR("CODE_INDENT",
3182 "code indent should use tabs where possible\n" . $herevet) &&
3183 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003184 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003185 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003186 }
3187
Alberto Panizzo08e44362010-03-05 13:43:54 -08003188# check for space before tabs.
3189 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3190 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003191 if (WARN("SPACE_BEFORE_TAB",
3192 "please, no space before tabs\n" . $herevet) &&
3193 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003194 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003195 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003196 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003197 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003198 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003199 }
3200
Joe Perches6a487212018-04-10 16:34:04 -07003201# check for assignments on the start of a line
3202 if ($sline =~ /^\+\s+($Assignment)[^=]/) {
3203 CHK("ASSIGNMENT_CONTINUATIONS",
3204 "Assignment operator '$1' should be on the previous line\n" . $hereprev);
3205 }
3206
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003207# check for && or || at the start of a line
3208 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3209 CHK("LOGICAL_CONTINUATIONS",
3210 "Logical continuations should be on the previous line\n" . $hereprev);
3211 }
3212
Joe Perchesa91e8992016-05-20 17:04:05 -07003213# check indentation starts on a tab stop
Joe Perches5b579802018-08-21 21:57:33 -07003214 if ($perl_version_ok &&
Joe Perchesbd491112018-02-06 15:39:06 -08003215 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003216 my $indent = length($1);
3217 if ($indent % 8) {
3218 if (WARN("TABSTOP",
3219 "Statements should start on a tabstop\n" . $herecurr) &&
3220 $fix) {
3221 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3222 }
3223 }
3224 }
3225
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003226# check multi-line statement indentation matches previous line
Joe Perches5b579802018-08-21 21:57:33 -07003227 if ($perl_version_ok &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003228 $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 -07003229 $prevline =~ /^\+(\t*)(.*)$/;
3230 my $oldindent = $1;
3231 my $rest = $2;
3232
3233 my $pos = pos_last_openparen($rest);
3234 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003235 $line =~ /^(\+| )([ \t]*)/;
3236 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003237
3238 my $goodtabindent = $oldindent .
3239 "\t" x ($pos / 8) .
3240 " " x ($pos % 8);
3241 my $goodspaceindent = $oldindent . " " x $pos;
3242
3243 if ($newindent ne $goodtabindent &&
3244 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003245
3246 if (CHK("PARENTHESIS_ALIGNMENT",
3247 "Alignment should match open parenthesis\n" . $hereprev) &&
3248 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003249 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003250 s/^\+[ \t]*/\+$goodtabindent/;
3251 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003252 }
3253 }
3254 }
3255
Joe Perches6ab3a972015-04-16 12:44:05 -07003256# check for space after cast like "(int) foo" or "(struct foo) bar"
3257# avoid checking a few false positives:
3258# "sizeof(<type>)" or "__alignof__(<type>)"
3259# function pointer declarations like "(*foo)(int) = bar;"
3260# structure definitions like "(struct foo) { 0 };"
3261# multiline macros that define functions
3262# known attributes or the __attribute__ keyword
3263 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3264 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003265 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003266 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003267 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003268 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003269 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003270 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003271 }
3272
Joe Perches86406b12015-09-09 15:37:41 -07003273# Block comment styles
3274# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003275 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003276 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003277 $rawline =~ /^\+[ \t]*\*/ &&
3278 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003279 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3280 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3281 }
3282
Joe Perches86406b12015-09-09 15:37:41 -07003283# Block comments use * on subsequent lines
3284 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3285 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003286 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003287 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003288 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003289 WARN("BLOCK_COMMENT_STYLE",
3290 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003291 }
3292
Joe Perches86406b12015-09-09 15:37:41 -07003293# Block comments use */ on trailing lines
3294 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003295 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3296 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3297 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003298 WARN("BLOCK_COMMENT_STYLE",
3299 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003300 }
3301
Joe Perches08eb9b82016-10-11 13:51:50 -07003302# Block comment * alignment
3303 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003304 $line =~ /^\+[ \t]*$;/ && #leading comment
3305 $rawline =~ /^\+[ \t]*\*/ && #leading *
3306 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003307 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003308 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3309 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003310 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003311 if (defined($1)) {
3312 $oldindent = expand_tabs($1);
3313 } else {
3314 $prevrawline =~ m@^\+(.*/?)\*@;
3315 $oldindent = expand_tabs($1);
3316 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003317 $rawline =~ m@^\+([ \t]*)\*@;
3318 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003319 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003320 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003321 WARN("BLOCK_COMMENT_STYLE",
3322 "Block comments should align the * on each line\n" . $hereprev);
3323 }
3324 }
3325
Joe Perches7f619192014-08-06 16:10:39 -07003326# check for missing blank lines after struct/union declarations
3327# with exceptions for various attributes and macros
3328 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3329 $line =~ /^\+/ &&
3330 !($line =~ /^\+\s*$/ ||
3331 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3332 $line =~ /^\+\s*MODULE_/i ||
3333 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3334 $line =~ /^\+[a-z_]*init/ ||
3335 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3336 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003337 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003338 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003339 if (CHK("LINE_SPACING",
3340 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3341 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003342 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003343 }
Joe Perches7f619192014-08-06 16:10:39 -07003344 }
3345
Joe Perches365dd4e2014-08-06 16:10:42 -07003346# check for multiple consecutive blank lines
3347 if ($prevline =~ /^[\+ ]\s*$/ &&
3348 $line =~ /^\+\s*$/ &&
3349 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003350 if (CHK("LINE_SPACING",
3351 "Please don't use multiple blank lines\n" . $hereprev) &&
3352 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003353 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003354 }
3355
Joe Perches365dd4e2014-08-06 16:10:42 -07003356 $last_blank_line = $linenr;
3357 }
3358
Joe Perches3b617e32014-04-03 14:49:28 -07003359# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003360 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3361 # actual declarations
3362 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003363 # function pointer declarations
3364 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003365 # foo bar; where foo is some local typedef or #define
3366 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3367 # known declaration macros
3368 $prevline =~ /^\+\s+$declaration_macros/) &&
3369 # for "else if" which can look like "$Ident $Ident"
3370 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3371 # other possible extensions of declaration lines
3372 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3373 # not starting a section or a macro "\" extended line
3374 $prevline =~ /(?:\{\s*|\\)$/) &&
3375 # looks like a declaration
3376 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003377 # function pointer declarations
3378 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003379 # foo bar; where foo is some local typedef or #define
3380 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3381 # known declaration macros
3382 $sline =~ /^\+\s+$declaration_macros/ ||
3383 # start of struct or union or enum
Joe Perches328b5f42018-09-04 15:46:06 -07003384 $sline =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003385 # start or end of block or continuation of declaration
3386 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3387 # bitfield continuation
3388 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3389 # other possible extensions of declaration lines
3390 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3391 # indentation of previous and current line are the same
3392 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003393 if (WARN("LINE_SPACING",
3394 "Missing a blank line after declarations\n" . $hereprev) &&
3395 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003396 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003397 }
Joe Perches3b617e32014-04-03 14:49:28 -07003398 }
3399
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003400# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003401# Exceptions:
3402# 1) within comments
3403# 2) indented preprocessor commands
3404# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003405 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003406 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003407 if (WARN("LEADING_SPACE",
3408 "please, no spaces at the start of a line\n" . $herevet) &&
3409 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003410 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003411 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003412 }
3413
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003414# check we are in a valid C source file if not then ignore this hunk
3415 next if ($realfile !~ /\.(h|c)$/);
3416
Joe Perches5751a242017-11-17 15:28:52 -08003417# check for unusual line ending [ or (
3418 if ($line =~ /^\+.*([\[\(])\s*$/) {
3419 CHK("OPEN_ENDED_LINE",
3420 "Lines should not end with a '$1'\n" . $herecurr);
3421 }
3422
Joe Perches4dbed762017-05-08 15:55:39 -07003423# check if this appears to be the start function declaration, save the name
3424 if ($sline =~ /^\+\{\s*$/ &&
3425 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3426 $context_function = $1;
3427 }
3428
3429# check if this appears to be the end of function declaration
3430 if ($sline =~ /^\+\}\s*$/) {
3431 undef $context_function;
3432 }
3433
Joe Perches032a4c02014-08-06 16:10:29 -07003434# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003435# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003436# if the previous line is a break or return and is indented 1 tab more...
3437 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3438 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003439 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3440 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3441 defined $lines[$linenr] &&
3442 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003443 WARN("UNNECESSARY_ELSE",
3444 "else is not generally useful after a break or return\n" . $hereprev);
3445 }
3446 }
3447
Joe Perchesc00df192014-08-06 16:11:01 -07003448# check indentation of a line with a break;
3449# if the previous line is a goto or return and is indented the same # of tabs
3450 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3451 my $tabs = $1;
3452 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3453 WARN("UNNECESSARY_BREAK",
3454 "break is not useful after a goto or return\n" . $hereprev);
3455 }
3456 }
3457
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003458# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003459 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003460 WARN("CVS_KEYWORD",
3461 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003462 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003463
Joe Perches56e77d72013-02-21 16:44:14 -08003464# check for old HOTPLUG __dev<foo> section markings
3465 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3466 WARN("HOTPLUG_SECTION",
3467 "Using $1 is unnecessary\n" . $herecurr);
3468 }
3469
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003470# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003471 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3472 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003473#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003474 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003475 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003476 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003477 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003478 $stat =~ s/\n./\n /g;
3479 $cond =~ s/\n./\n /g;
3480
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003481#print "linenr<$linenr> <$stat>\n";
3482 # If this statement has no statement boundaries within
3483 # it there is no point in retrying a statement scan
3484 # until we hit end of it.
3485 my $frag = $stat; $frag =~ s/;+\s*$//;
3486 if ($frag !~ /(?:{|;)/) {
3487#print "skip<$line_nr_next>\n";
3488 $suppress_statement = $line_nr_next;
3489 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003490
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003491 # Find the real next line.
3492 $realline_next = $line_nr_next;
3493 if (defined $realline_next &&
3494 (!defined $lines[$realline_next - 1] ||
3495 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3496 $realline_next++;
3497 }
3498
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003499 my $s = $stat;
3500 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003501
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003502 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003503 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003504
3505 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003506 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003507
Andy Whitcroft463f2862009-09-21 17:04:34 -07003508 } elsif ($s =~ /^.\s*else\b/s) {
3509
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003510 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003511 } 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 -07003512 my $type = $1;
3513 $type =~ s/\s+/ /g;
3514 possible($type, "A:" . $s);
3515
Andy Whitcroft8905a672007-11-28 16:21:06 -08003516 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003517 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003518 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003519 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003520
3521 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003522 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003523 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003524 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003525
3526 # Check for any sort of function declaration.
3527 # int foo(something bar, other baz);
3528 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003529 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 -08003530 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003531
Andy Whitcroftcf655042008-03-04 14:28:20 -08003532 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003533 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003534 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003535
Andy Whitcroft8905a672007-11-28 16:21:06 -08003536 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003537 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003538
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003539 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003540 }
3541 }
3542 }
3543
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003544 }
3545
Andy Whitcroft653d4872007-06-23 17:16:34 -07003546#
3547# Checks which may be anchored in the context.
3548#
3549
3550# Check for switch () and associated case and default
3551# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003552 if ($line=~/\bswitch\s*\(.*\)/) {
3553 my $err = '';
3554 my $sep = '';
3555 my @ctx = ctx_block_outer($linenr, $realcnt);
3556 shift(@ctx);
3557 for my $ctx (@ctx) {
3558 my ($clen, $cindent) = line_stats($ctx);
3559 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3560 $indent != $cindent) {
3561 $err .= "$sep$ctx\n";
3562 $sep = '';
3563 } else {
3564 $sep = "[...]\n";
3565 }
3566 }
3567 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003568 ERROR("SWITCH_CASE_INDENT_LEVEL",
3569 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003570 }
3571 }
3572
3573# if/while/etc brace do not go on next line, unless defining a do while loop,
3574# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003575 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 -07003576 my $pre_ctx = "$1$2";
3577
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003578 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003579
3580 if ($line =~ /^\+\t{6,}/) {
3581 WARN("DEEP_INDENTATION",
3582 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3583 }
3584
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003585 my $ctx_cnt = $realcnt - $#ctx - 1;
3586 my $ctx = join("\n", @ctx);
3587
Andy Whitcroft548596d2008-07-23 21:29:01 -07003588 my $ctx_ln = $linenr;
3589 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003590
Andy Whitcroft548596d2008-07-23 21:29:01 -07003591 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3592 defined $lines[$ctx_ln - 1] &&
3593 $lines[$ctx_ln - 1] =~ /^-/)) {
3594 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3595 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003596 $ctx_ln++;
3597 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003598
Andy Whitcroft53210162008-07-23 21:29:03 -07003599 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3600 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003601
Joe Perchesd752fcc2014-08-06 16:11:05 -07003602 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003603 ERROR("OPEN_BRACE",
3604 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003605 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003606 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003607 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3608 $ctx =~ /\)\s*\;\s*$/ &&
3609 defined $lines[$ctx_ln - 1])
3610 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003611 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3612 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003613 WARN("TRAILING_SEMICOLON",
3614 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003615 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003616 }
3617 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003618 }
3619
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003620# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003621 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 -08003622 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3623 ctx_statement_block($linenr, $realcnt, 0)
3624 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003625 my ($s, $c) = ($stat, $cond);
3626
3627 substr($s, 0, length($c), '');
3628
Joe Perches9f5af482015-09-09 15:37:30 -07003629 # remove inline comments
3630 $s =~ s/$;/ /g;
3631 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003632
3633 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003634 my @newlines = ($c =~ /\n/gs);
3635 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003636
Joe Perches9f5af482015-09-09 15:37:30 -07003637 # Make sure we remove the line prefixes as we have
3638 # none on the first line, and are going to readd them
3639 # where necessary.
3640 $s =~ s/\n./\n/gs;
3641 while ($s =~ /\n\s+\\\n/) {
3642 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3643 }
3644
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003645 # We want to check the first line inside the block
3646 # starting at the end of the conditional, so remove:
3647 # 1) any blank line termination
3648 # 2) any opening brace { on end of the line
3649 # 3) any do (...) {
3650 my $continuation = 0;
3651 my $check = 0;
3652 $s =~ s/^.*\bdo\b//;
3653 $s =~ s/^\s*{//;
3654 if ($s =~ s/^\s*\\//) {
3655 $continuation = 1;
3656 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003657 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003658 $check = 1;
3659 $cond_lines++;
3660 }
3661
3662 # Also ignore a loop construct at the end of a
3663 # preprocessor statement.
3664 if (($prevline =~ /^.\s*#\s*define\s/ ||
3665 $prevline =~ /\\\s*$/) && $continuation == 0) {
3666 $check = 0;
3667 }
3668
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003669 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003670 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003671 while ($cond_ptr != $cond_lines) {
3672 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003673
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003674 # If we see an #else/#elif then the code
3675 # is not linear.
3676 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3677 $check = 0;
3678 }
3679
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003680 # Ignore:
3681 # 1) blank lines, they should be at 0,
3682 # 2) preprocessor lines, and
3683 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003684 if ($continuation ||
3685 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003686 $s =~ /^\s*#\s*?/ ||
3687 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003688 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003689 if ($s =~ s/^.*?\n//) {
3690 $cond_lines++;
3691 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003692 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003693 }
3694
3695 my (undef, $sindent) = line_stats("+" . $s);
3696 my $stat_real = raw_line($linenr, $cond_lines);
3697
3698 # Check if either of these lines are modified, else
3699 # this is not this patch's fault.
3700 if (!defined($stat_real) ||
3701 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3702 $check = 0;
3703 }
3704 if (defined($stat_real) && $cond_lines > 1) {
3705 $stat_real = "[...]\n$stat_real";
3706 }
3707
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003708 #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 -07003709
Joe Perches9f5af482015-09-09 15:37:30 -07003710 if ($check && $s ne '' &&
3711 (($sindent % 8) != 0 ||
3712 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003713 ($sindent == $indent &&
3714 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003715 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003716 WARN("SUSPECT_CODE_INDENT",
3717 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003718 }
3719 }
3720
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003721 # Track the 'values' across context and added lines.
3722 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003723 my ($curr_values, $curr_vars) =
3724 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003725 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003726 if ($dbg_values) {
3727 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003728 print "$linenr > .$outline\n";
3729 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003730 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003731 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003732 $prev_values = substr($curr_values, -1);
3733
Andy Whitcroft00df3442007-06-08 13:47:06 -07003734#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003735 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003736
Joe Perches11ca40a2016-12-12 16:46:31 -08003737# check for dereferences that span multiple lines
3738 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3739 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3740 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3741 my $ref = $1;
3742 $line =~ /^.\s*($Lval)/;
3743 $ref .= $1;
3744 $ref =~ s/\s//g;
3745 WARN("MULTILINE_DEREFERENCE",
3746 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3747 }
3748
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003749# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003750 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 -07003751 my $type = $1;
3752 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003753 $var = "" if (!defined $var);
3754 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003755 my $sign = $1;
3756 my $pointer = $2;
3757
3758 $pointer = "" if (!defined $pointer);
3759
3760 if (WARN("UNSPECIFIED_INT",
3761 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3762 $fix) {
3763 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003764 my $comp_pointer = $pointer;
3765 $comp_pointer =~ s/\s//g;
3766 $decl .= $comp_pointer;
3767 $decl = rtrim($decl) if ($var eq "");
3768 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003769 }
3770 }
3771 }
3772
Andy Whitcroft653d4872007-06-23 17:16:34 -07003773# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003774 if ($dbg_type) {
3775 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003776 ERROR("TEST_TYPE",
3777 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003778 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003779 ERROR("TEST_NOT_TYPE",
3780 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003781 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003782 next;
3783 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003784# TEST: allow direct testing of the attribute matcher.
3785 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003786 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003787 ERROR("TEST_ATTR",
3788 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003789 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003790 ERROR("TEST_NOT_ATTR",
3791 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003792 }
3793 next;
3794 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003795
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003796# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003797 if ($line =~ /^.\s*{/ &&
3798 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003799 if (ERROR("OPEN_BRACE",
3800 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003801 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3802 fix_delete_line($fixlinenr - 1, $prevrawline);
3803 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003804 my $fixedline = $prevrawline;
3805 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003806 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003807 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003808 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003809 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003810 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003811 }
3812
Andy Whitcroft653d4872007-06-23 17:16:34 -07003813#
3814# Checks which are anchored on the added line.
3815#
3816
3817# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003818 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003819 my $path = $1;
3820 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003821 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003822 "malformed #include filename\n" . $herecurr);
3823 }
3824 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3825 ERROR("UAPI_INCLUDE",
3826 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003827 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003828 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003829
3830# no C99 // comments
3831 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003832 if (ERROR("C99_COMMENTS",
3833 "do not use C99 // comments\n" . $herecurr) &&
3834 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003835 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003836 if ($line =~ /\/\/(.*)$/) {
3837 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003838 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003839 }
3840 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003841 }
3842 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003843 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003844 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003845
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003846# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3847# the whole statement.
3848#print "APW <$lines[$realline_next - 1]>\n";
3849 if (defined $realline_next &&
3850 exists $lines[$realline_next - 1] &&
3851 !defined $suppress_export{$realline_next} &&
3852 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3853 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003854 # Handle definitions which produce identifiers with
3855 # a prefix:
3856 # XXX(foo);
3857 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003858 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003859 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003860 $name =~ /^${Ident}_$2/) {
3861#print "FOO C name<$name>\n";
3862 $suppress_export{$realline_next} = 1;
3863
3864 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003865 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003866 ^.DEFINE_$Ident\(\Q$name\E\)|
3867 ^.DECLARE_$Ident\(\Q$name\E\)|
3868 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003869 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3870 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003871 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003872#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3873 $suppress_export{$realline_next} = 2;
3874 } else {
3875 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003876 }
3877 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003878 if (!defined $suppress_export{$linenr} &&
3879 $prevline =~ /^.\s*$/ &&
3880 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3881 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3882#print "FOO B <$lines[$linenr - 1]>\n";
3883 $suppress_export{$linenr} = 2;
3884 }
3885 if (defined $suppress_export{$linenr} &&
3886 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003887 WARN("EXPORT_SYMBOL",
3888 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003889 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003890
Joe Eloff5150bda2010-08-09 17:21:00 -07003891# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003892 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003893 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003894 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003895 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003896 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003897 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003898 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003899# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003900 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003901 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003902 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003903 $herecurr) &&
3904 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003905 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003906 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003907 }
3908
Joe Perches18130872014-08-06 16:11:22 -07003909# check for misordered declarations of char/short/int/long with signed/unsigned
3910 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3911 my $tmp = trim($1);
3912 WARN("MISORDERED_TYPE",
3913 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3914 }
3915
Joe Perches809e0822018-08-21 21:58:12 -07003916# check for unnecessary <signed> int declarations of short/long/long long
3917 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) {
3918 my $type = trim($1);
3919 next if ($type !~ /\bint\b/);
3920 next if ($type !~ /\b(?:short|long\s+long|long)\b/);
3921 my $new_type = $type;
3922 $new_type =~ s/\b\s*int\s*\b/ /;
3923 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /;
3924 $new_type =~ s/^const\s+//;
3925 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/);
3926 $new_type = "const $new_type" if ($type =~ /^const\b/);
3927 $new_type =~ s/\s+/ /g;
3928 $new_type = trim($new_type);
3929 if (WARN("UNNECESSARY_INT",
3930 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) &&
3931 $fix) {
3932 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/;
3933 }
3934 }
3935
Joe Perchescb710ec2010-10-26 14:23:20 -07003936# check for static const char * arrays.
3937 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003938 WARN("STATIC_CONST_CHAR_ARRAY",
3939 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003940 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08003941 }
3942
3943# check for initialized const char arrays that should be static const
3944 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3945 if (WARN("STATIC_CONST_CHAR_ARRAY",
3946 "const array should probably be static const\n" . $herecurr) &&
3947 $fix) {
3948 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/;
3949 }
3950 }
Joe Perchescb710ec2010-10-26 14:23:20 -07003951
3952# check for static char foo[] = "bar" declarations.
3953 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003954 WARN("STATIC_CONST_CHAR_ARRAY",
3955 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003956 $herecurr);
Joe Perches77b8c0a2019-01-03 15:26:59 -08003957 }
Joe Perchescb710ec2010-10-26 14:23:20 -07003958
Joe Perchesab7e23f2015-04-16 12:44:22 -07003959# check for const <foo> const where <foo> is not a pointer or array type
3960 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3961 my $found = $1;
3962 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3963 WARN("CONST_CONST",
3964 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3965 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3966 WARN("CONST_CONST",
3967 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3968 }
3969 }
3970
Joe Perches9b0fa602014-04-03 14:49:18 -07003971# check for non-global char *foo[] = {"bar", ...} declarations.
3972 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3973 WARN("STATIC_CONST_CHAR_ARRAY",
3974 "char * array declaration might be better as static const\n" .
3975 $herecurr);
3976 }
3977
Joe Perchesb598b672015-04-16 12:44:36 -07003978# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3979 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3980 my $array = $1;
3981 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3982 my $array_div = $1;
3983 if (WARN("ARRAY_SIZE",
3984 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3985 $fix) {
3986 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3987 }
3988 }
3989 }
3990
Joe Perchesb36190c2014-01-27 17:07:18 -08003991# check for function declarations without arguments like "int foo()"
3992 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3993 if (ERROR("FUNCTION_WITHOUT_ARGS",
3994 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3995 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003996 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003997 }
3998 }
3999
Andy Whitcroft653d4872007-06-23 17:16:34 -07004000# check for new typedefs, only function parameters and sparse annotations
4001# make sense.
4002 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08004003 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004004 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07004005 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02004006 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004007 WARN("NEW_TYPEDEFS",
4008 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004009 }
4010
4011# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08004012 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004013 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
4014 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004015 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004016
Andy Whitcroft65863862009-01-06 14:41:21 -08004017 # Should start with a space.
4018 $to =~ s/^(\S)/ $1/;
4019 # Should not end with a space.
4020 $to =~ s/\s+$//;
4021 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004022 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004023 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004024
Joe Perches3705ce52013-07-03 15:05:31 -07004025## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08004026 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07004027 if (ERROR("POINTER_LOCATION",
4028 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
4029 $fix) {
4030 my $sub_from = $ident;
4031 my $sub_to = $ident;
4032 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004033 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004034 s@\Q$sub_from\E@$sub_to@;
4035 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004036 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08004037 }
4038 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
4039 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07004040 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004041
Andy Whitcroft65863862009-01-06 14:41:21 -08004042 # Should start with a space.
4043 $to =~ s/^(\S)/ $1/;
4044 # Should not end with a space.
4045 $to =~ s/\s+$//;
4046 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08004047 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08004048 }
4049 # Modifiers should have spaces.
4050 $to =~ s/(\b$Modifier$)/$1 /;
4051
Joe Perches3705ce52013-07-03 15:05:31 -07004052## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08004053 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004054 if (ERROR("POINTER_LOCATION",
4055 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
4056 $fix) {
4057
4058 my $sub_from = $match;
4059 my $sub_to = $match;
4060 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07004061 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004062 s@\Q$sub_from\E@$sub_to@;
4063 }
Andy Whitcroft65863862009-01-06 14:41:21 -08004064 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004065 }
4066
Joe Perches9d3e3c72015-09-09 15:37:27 -07004067# avoid BUG() or BUG_ON()
4068 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004069 my $msg_level = \&WARN;
4070 $msg_level = \&CHK if ($file);
4071 &{$msg_level}("AVOID_BUG",
4072 "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 -07004073 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004074
Joe Perches9d3e3c72015-09-09 15:37:27 -07004075# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08004076 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004077 WARN("LINUX_VERSION_CODE",
4078 "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 -08004079 }
4080
Joe Perches17441222011-06-15 15:08:17 -07004081# check for uses of printk_ratelimit
4082 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004083 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08004084 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07004085 }
4086
Joe Percheseeef5732017-11-17 15:28:41 -08004087# printk should use KERN_* levels
4088 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
4089 WARN("PRINTK_WITHOUT_KERN_LEVEL",
4090 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004091 }
4092
Joe Perches243f3802012-05-31 16:26:09 -07004093 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
4094 my $orig = $1;
4095 my $level = lc($orig);
4096 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07004097 my $level2 = $level;
4098 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07004099 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07004100 "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 -07004101 }
4102
4103 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004104 if (WARN("PREFER_PR_LEVEL",
4105 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
4106 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004107 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004108 s/\bpr_warning\b/pr_warn/;
4109 }
Joe Perches243f3802012-05-31 16:26:09 -07004110 }
4111
Joe Perchesdc139312013-02-21 16:44:13 -08004112 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
4113 my $orig = $1;
4114 my $level = lc($orig);
4115 $level = "warn" if ($level eq "warning");
4116 $level = "dbg" if ($level eq "debug");
4117 WARN("PREFER_DEV_LEVEL",
4118 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
4119 }
4120
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07004121# ENOSYS means "bad syscall nr" and nothing else. This will have a small
4122# number of false positives, but assembly files are not checked, so at
4123# least the arch entry code will not trigger this warning.
4124 if ($line =~ /\bENOSYS\b/) {
4125 WARN("ENOSYS",
4126 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
4127 }
4128
Andy Whitcroft653d4872007-06-23 17:16:34 -07004129# function brace can't be on same line, except for #defines of do while,
4130# or if closed on same line
Joe Perches5b579802018-08-21 21:57:33 -07004131 if ($perl_version_ok &&
Joe Perches2d453e32018-02-06 15:39:09 -08004132 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
4133 $sline !~ /\#\s*define\b.*do\s*\{/ &&
4134 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07004135 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08004136 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07004137 $fix) {
4138 fix_delete_line($fixlinenr, $rawline);
4139 my $fixed_line = $rawline;
4140 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
4141 my $line1 = $1;
4142 my $line2 = $2;
4143 fix_insert_line($fixlinenr, ltrim($line1));
4144 fix_insert_line($fixlinenr, "\+{");
4145 if ($line2 !~ /^\s*$/) {
4146 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
4147 }
4148 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004149 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004150
Andy Whitcroft8905a672007-11-28 16:21:06 -08004151# open braces for enum, union and struct go on the same line.
4152 if ($line =~ /^.\s*{/ &&
4153 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07004154 if (ERROR("OPEN_BRACE",
4155 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
4156 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4157 fix_delete_line($fixlinenr - 1, $prevrawline);
4158 fix_delete_line($fixlinenr, $rawline);
4159 my $fixedline = rtrim($prevrawline) . " {";
4160 fix_insert_line($fixlinenr, $fixedline);
4161 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07004162 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07004163 if ($fixedline !~ /^\+\s*$/) {
4164 fix_insert_line($fixlinenr, $fixedline);
4165 }
4166 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004167 }
4168
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004169# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07004170 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4171 if (WARN("SPACING",
4172 "missing space after $1 definition\n" . $herecurr) &&
4173 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004174 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004175 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4176 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004177 }
4178
Joe Perches31070b52014-01-23 15:54:49 -08004179# Function pointer declarations
4180# check spacing between type, funcptr, and args
4181# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004182 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004183 my $declare = $1;
4184 my $pre_pointer_space = $2;
4185 my $post_pointer_space = $3;
4186 my $funcname = $4;
4187 my $post_funcname_space = $5;
4188 my $pre_args_space = $6;
4189
Joe Perches91f72e92014-04-03 14:49:12 -07004190# the $Declare variable will capture all spaces after the type
4191# so check it for a missing trailing missing space but pointer return types
4192# don't need a space so don't warn for those.
4193 my $post_declare_space = "";
4194 if ($declare =~ /(\s+)$/) {
4195 $post_declare_space = $1;
4196 $declare = rtrim($declare);
4197 }
4198 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004199 WARN("SPACING",
4200 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004201 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004202 }
4203
4204# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004205# This test is not currently implemented because these declarations are
4206# equivalent to
4207# int foo(int bar, ...)
4208# and this is form shouldn't/doesn't generate a checkpatch warning.
4209#
4210# elsif ($declare =~ /\s{2,}$/) {
4211# WARN("SPACING",
4212# "Multiple spaces after return type\n" . $herecurr);
4213# }
Joe Perches31070b52014-01-23 15:54:49 -08004214
4215# unnecessary space "type ( *funcptr)(args...)"
4216 if (defined $pre_pointer_space &&
4217 $pre_pointer_space =~ /^\s/) {
4218 WARN("SPACING",
4219 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4220 }
4221
4222# unnecessary space "type (* funcptr)(args...)"
4223 if (defined $post_pointer_space &&
4224 $post_pointer_space =~ /^\s/) {
4225 WARN("SPACING",
4226 "Unnecessary space before function pointer name\n" . $herecurr);
4227 }
4228
4229# unnecessary space "type (*funcptr )(args...)"
4230 if (defined $post_funcname_space &&
4231 $post_funcname_space =~ /^\s/) {
4232 WARN("SPACING",
4233 "Unnecessary space after function pointer name\n" . $herecurr);
4234 }
4235
4236# unnecessary space "type (*funcptr) (args...)"
4237 if (defined $pre_args_space &&
4238 $pre_args_space =~ /^\s/) {
4239 WARN("SPACING",
4240 "Unnecessary space before function pointer arguments\n" . $herecurr);
4241 }
4242
4243 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004244 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004245 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004246 }
4247 }
4248
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004249# check for spacing round square brackets; allowed:
4250# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004251# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4252# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004253 while ($line =~ /(.*?\s)\[/g) {
4254 my ($where, $prefix) = ($-[1], $1);
4255 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004256 ($where != 0 || $prefix !~ /^.\s+$/) &&
Heinrich Schuchardt38dca982018-04-10 16:34:14 -07004257 $prefix !~ /[{,:]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004258 if (ERROR("BRACKET_SPACE",
4259 "space prohibited before open square bracket '['\n" . $herecurr) &&
4260 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004261 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004262 s/^(\+.*?)\s+\[/$1\[/;
4263 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004264 }
4265 }
4266
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004267# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004268 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004269 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004270 my $ctx_before = substr($line, 0, $-[1]);
4271 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004272
4273 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004274 if ($name =~ /^(?:
4275 if|for|while|switch|return|case|
4276 volatile|__volatile__|
4277 __attribute__|format|__extension__|
4278 asm|__asm__)$/x)
4279 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004280 # cpp #define statements have non-optional spaces, ie
4281 # if there is a space between the name and the open
4282 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004283 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004284
4285 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004286 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004287
4288 # If this whole things ends with a type its most
4289 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004290 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004291
4292 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004293 if (WARN("SPACING",
4294 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4295 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004296 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004297 s/\b$name\s+\(/$name\(/;
4298 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004299 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004300 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004301
Andy Whitcroft653d4872007-06-23 17:16:34 -07004302# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004303 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004304 my $fixed_line = "";
4305 my $line_fixed = 0;
4306
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004307 my $ops = qr{
4308 <<=|>>=|<=|>=|==|!=|
4309 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4310 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004311 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004312 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004313 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004314 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004315
4316## print("element count: <" . $#elements . ">\n");
4317## foreach my $el (@elements) {
4318## print("el: <$el>\n");
4319## }
4320
4321 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004322 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004323
Joe Perches3705ce52013-07-03 15:05:31 -07004324 foreach my $el (@elements) {
4325 push(@fix_elements, substr($rawline, $off, length($el)));
4326 $off += length($el);
4327 }
4328
4329 $off = 0;
4330
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004331 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004332 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004333
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004334 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004335
4336 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4337
4338## print("n: <$n> good: <$good>\n");
4339
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004340 $off += length($elements[$n]);
4341
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004342 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004343 my $ca = substr($opline, 0, $off);
4344 my $cc = '';
4345 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4346 $cc = substr($opline, $off + length($elements[$n + 1]));
4347 }
4348 my $cb = "$ca$;$cc";
4349
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004350 my $a = '';
4351 $a = 'V' if ($elements[$n] ne '');
4352 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004353 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004354 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4355 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004356 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004357
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004358 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004359
4360 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004361 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004362 $c = 'V' if ($elements[$n + 2] ne '');
4363 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004364 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004365 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4366 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004367 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004368 } else {
4369 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004370 }
4371
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004372 my $ctx = "${a}x${c}";
4373
4374 my $at = "(ctx:$ctx)";
4375
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004376 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004377 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004378
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004379 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004380 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004381
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004382 # Get the full operator variant.
4383 my $opv = $op . substr($curr_vars, $off, 1);
4384
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004385 # Ignore operators passed as parameters.
4386 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004387 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004388
Andy Whitcroftcf655042008-03-04 14:28:20 -08004389# # Ignore comments
4390# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004391
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004392 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004393 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004394 if ($ctx !~ /.x[WEBC]/ &&
4395 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004396 if (ERROR("SPACING",
4397 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004398 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004399 $line_fixed = 1;
4400 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004401 }
4402
4403 # // is a comment
4404 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004405
Joe Perchesb00e4812014-04-03 14:49:33 -07004406 # : when part of a bitfield
4407 } elsif ($opv eq ':B') {
4408 # skip the bitfield test for now
4409
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004410 # No spaces for:
4411 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004412 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004413 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004414 if (ERROR("SPACING",
4415 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004416 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004417 if (defined $fix_elements[$n + 2]) {
4418 $fix_elements[$n + 2] =~ s/^\s+//;
4419 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004420 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004421 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004422 }
4423
Joe Perches23810972014-12-10 15:51:32 -08004424 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004425 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004426 my $rtrim_before = 0;
4427 my $space_after = 0;
4428 if ($ctx =~ /Wx./) {
4429 if (ERROR("SPACING",
4430 "space prohibited before that '$op' $at\n" . $hereptr)) {
4431 $line_fixed = 1;
4432 $rtrim_before = 1;
4433 }
4434 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004435 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004436 if (ERROR("SPACING",
4437 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004438 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004439 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004440 $space_after = 1;
4441 }
4442 }
4443 if ($rtrim_before || $space_after) {
4444 if ($rtrim_before) {
4445 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4446 } else {
4447 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4448 }
4449 if ($space_after) {
4450 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004451 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004452 }
4453
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004454 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004455 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004456 #warn "'*' is part of type\n";
4457
4458 # unary operators should have a space before and
4459 # none after. May be left adjacent to another
4460 # unary operator, or a cast
4461 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004462 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004463 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004464 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004465 if (ERROR("SPACING",
4466 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004467 if ($n != $last_after + 2) {
4468 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4469 $line_fixed = 1;
4470 }
Joe Perches3705ce52013-07-03 15:05:31 -07004471 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004472 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004473 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004474 # A unary '*' may be const
4475
4476 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004477 if (ERROR("SPACING",
4478 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004479 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004480 if (defined $fix_elements[$n + 2]) {
4481 $fix_elements[$n + 2] =~ s/^\s+//;
4482 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004483 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004484 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004485 }
4486
4487 # unary ++ and unary -- are allowed no space on one side.
4488 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004489 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004490 if (ERROR("SPACING",
4491 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004492 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004493 $line_fixed = 1;
4494 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004495 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004496 if ($ctx =~ /Wx[BE]/ ||
4497 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004498 if (ERROR("SPACING",
4499 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004500 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004501 $line_fixed = 1;
4502 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004503 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004504 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004505 if (ERROR("SPACING",
4506 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004507 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004508 if (defined $fix_elements[$n + 2]) {
4509 $fix_elements[$n + 2] =~ s/^\s+//;
4510 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004511 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004512 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004513 }
4514
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004515 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004516 } elsif ($op eq '<<' or $op eq '>>' or
4517 $op eq '&' or $op eq '^' or $op eq '|' or
4518 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004519 $op eq '*' or $op eq '/' or
4520 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004521 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004522 if ($check) {
4523 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4524 if (CHK("SPACING",
4525 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4526 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4527 $fix_elements[$n + 2] =~ s/^\s+//;
4528 $line_fixed = 1;
4529 }
4530 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4531 if (CHK("SPACING",
4532 "space preferred before that '$op' $at\n" . $hereptr)) {
4533 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4534 $line_fixed = 1;
4535 }
4536 }
4537 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004538 if (ERROR("SPACING",
4539 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004540 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4541 if (defined $fix_elements[$n + 2]) {
4542 $fix_elements[$n + 2] =~ s/^\s+//;
4543 }
Joe Perches3705ce52013-07-03 15:05:31 -07004544 $line_fixed = 1;
4545 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004546 }
4547
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004548 # A colon needs no spaces before when it is
4549 # terminating a case value or a label.
4550 } elsif ($opv eq ':C' || $opv eq ':L') {
4551 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004552 if (ERROR("SPACING",
4553 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004554 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004555 $line_fixed = 1;
4556 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004557 }
4558
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004559 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004560 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004561 my $ok = 0;
4562
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004563 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004564 if (($op eq '<' &&
4565 $cc =~ /^\S+\@\S+>/) ||
4566 ($op eq '>' &&
4567 $ca =~ /<\S+\@\S+$/))
4568 {
4569 $ok = 1;
4570 }
4571
Joe Perchese0df7e12015-04-16 12:44:53 -07004572 # for asm volatile statements
4573 # ignore a colon with another
4574 # colon immediately before or after
4575 if (($op eq ':') &&
4576 ($ca =~ /:$/ || $cc =~ /^:/)) {
4577 $ok = 1;
4578 }
4579
Joe Perches84731622013-11-12 15:10:05 -08004580 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004581 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004582 my $msg_level = \&ERROR;
4583 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004584
Jean Delvare0675a8f2017-09-08 16:16:07 -07004585 if (&{$msg_level}("SPACING",
4586 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004587 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4588 if (defined $fix_elements[$n + 2]) {
4589 $fix_elements[$n + 2] =~ s/^\s+//;
4590 }
Joe Perches3705ce52013-07-03 15:05:31 -07004591 $line_fixed = 1;
4592 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004593 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004594 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004595 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004596
4597## print("n: <$n> GOOD: <$good>\n");
4598
4599 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004600 }
Joe Perches3705ce52013-07-03 15:05:31 -07004601
4602 if (($#elements % 2) == 0) {
4603 $fixed_line = $fixed_line . $fix_elements[$#elements];
4604 }
4605
Joe Perches194f66f2014-08-06 16:11:03 -07004606 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4607 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004608 }
4609
4610
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004611 }
4612
Joe Perches786b6322013-07-03 15:05:32 -07004613# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004614 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004615 if (WARN("SPACING",
4616 "space prohibited before semicolon\n" . $herecurr) &&
4617 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004618 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004619 s/^(\+.*\S)\s+;/$1;/;
4620 }
4621 }
4622
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004623# check for multiple assignments
4624 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004625 CHK("MULTIPLE_ASSIGNMENTS",
4626 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004627 }
4628
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004629## # check for multiple declarations, allowing for a function declaration
4630## # continuation.
4631## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4632## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4633##
4634## # Remove any bracketed sections to ensure we do not
4635## # falsly report the parameters of functions.
4636## my $ln = $line;
4637## while ($ln =~ s/\([^\(\)]*\)//g) {
4638## }
4639## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004640## WARN("MULTIPLE_DECLARATION",
4641## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004642## }
4643## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004644
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004645#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004646 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004647 $line =~ /\b(?:else|do)\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004648 if (ERROR("SPACING",
4649 "space required before the open brace '{'\n" . $herecurr) &&
4650 $fix) {
Michal Zylowski6ad724e2018-08-21 21:58:08 -07004651 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004652 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004653 }
4654
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004655## # check for blank lines before declarations
4656## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4657## $prevrawline =~ /^.\s*$/) {
4658## WARN("SPACING",
4659## "No blank lines before declarations\n" . $hereprev);
4660## }
4661##
4662
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004663# closing brace should have a space following it when it has anything
4664# on the line
4665 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004666 if (ERROR("SPACING",
4667 "space required after that close brace '}'\n" . $herecurr) &&
4668 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004669 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004670 s/}((?!(?:,|;|\)))\S)/} $1/;
4671 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004672 }
4673
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004674# check spacing on square brackets
4675 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004676 if (ERROR("SPACING",
4677 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4678 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004679 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004680 s/\[\s+/\[/;
4681 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004682 }
4683 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004684 if (ERROR("SPACING",
4685 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4686 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004687 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004688 s/\s+\]/\]/;
4689 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004690 }
4691
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004692# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004693 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4694 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004695 if (ERROR("SPACING",
4696 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4697 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004698 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004699 s/\(\s+/\(/;
4700 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004701 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004702 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004703 $line !~ /for\s*\(.*;\s+\)/ &&
4704 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004705 if (ERROR("SPACING",
4706 "space prohibited before that close parenthesis ')'\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
Joe Perchese2826fd2014-08-06 16:10:48 -07004713# check unnecessary parentheses around addressof/dereference single $Lvals
4714# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4715
4716 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004717 my $var = $1;
4718 if (CHK("UNNECESSARY_PARENTHESES",
4719 "Unnecessary parentheses around $var\n" . $herecurr) &&
4720 $fix) {
4721 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4722 }
4723 }
4724
4725# check for unnecessary parentheses around function pointer uses
4726# ie: (foo->bar)(); should be foo->bar();
4727# but not "if (foo->bar) (" to avoid some false positives
4728 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4729 my $var = $2;
4730 if (CHK("UNNECESSARY_PARENTHESES",
4731 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4732 $fix) {
4733 my $var2 = deparenthesize($var);
4734 $var2 =~ s/\s//g;
4735 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4736 }
4737 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004738
Joe Perches63b7c732017-09-08 16:16:01 -07004739# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004740# when !drivers/staging or command-line uses --strict
4741 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
Joe Perches5b579802018-08-21 21:57:33 -07004742 $perl_version_ok && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004743 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4744 my $if_stat = $1;
4745 my $test = substr($2, 1, -1);
4746 my $herectx;
4747 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4748 my $match = $1;
4749 # avoid parentheses around potential macro args
4750 next if ($match =~ /^\s*\w+\s*$/);
4751 if (!defined($herectx)) {
4752 $herectx = $here . "\n";
4753 my $cnt = statement_rawlines($if_stat);
4754 for (my $n = 0; $n < $cnt; $n++) {
4755 my $rl = raw_line($linenr, $n);
4756 $herectx .= $rl . "\n";
4757 last if $rl =~ /^[ \+].*\{/;
4758 }
4759 }
4760 CHK("UNNECESSARY_PARENTHESES",
4761 "Unnecessary parentheses around '$match'\n" . $herectx);
4762 }
4763 }
4764
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004765#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004766 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004767 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004768 if (WARN("INDENTED_LABEL",
4769 "labels should not be indented\n" . $herecurr) &&
4770 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004771 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004772 s/^(.)\s+/$1/;
4773 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004774 }
4775
Joe Perches5b9553a2014-04-03 14:49:21 -07004776# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004777 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004778 my $spacing = $1;
Joe Perches5b579802018-08-21 21:57:33 -07004779 if ($perl_version_ok &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004780 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4781 my $value = $1;
4782 $value = deparenthesize($value);
4783 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4784 ERROR("RETURN_PARENTHESES",
4785 "return is not a function, parentheses are not required\n" . $herecurr);
4786 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004787 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004788 ERROR("SPACING",
4789 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004790 }
4791 }
Joe Perches507e5142013-11-12 15:10:13 -08004792
Joe Perchesb43ae212014-06-23 13:22:07 -07004793# unnecessary return in a void function
4794# at end-of-function, with the previous line a single leading tab, then return;
4795# and the line before that not a goto label target like "out:"
4796 if ($sline =~ /^[ \+]}\s*$/ &&
4797 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4798 $linenr >= 3 &&
4799 $lines[$linenr - 3] =~ /^[ +]/ &&
4800 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004801 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004802 "void function return statements are not generally useful\n" . $hereprev);
4803 }
Joe Perches9819cf22014-06-04 16:12:09 -07004804
Joe Perches189248d2014-01-23 15:54:47 -08004805# if statements using unnecessary parentheses - ie: if ((foo == bar))
Joe Perches5b579802018-08-21 21:57:33 -07004806 if ($perl_version_ok &&
Joe Perches189248d2014-01-23 15:54:47 -08004807 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4808 my $openparens = $1;
4809 my $count = $openparens =~ tr@\(@\(@;
4810 my $msg = "";
4811 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4812 my $comp = $4; #Not $1 because of $LvalOrFunc
4813 $msg = " - maybe == should be = ?" if ($comp eq "==");
4814 WARN("UNNECESSARY_PARENTHESES",
4815 "Unnecessary parentheses$msg\n" . $herecurr);
4816 }
4817 }
4818
Joe Perchesc5595fa2015-09-09 15:37:58 -07004819# comparisons with a constant or upper case identifier on the left
4820# avoid cases like "foo + BAR < baz"
4821# only fix matches surrounded by parentheses to avoid incorrect
4822# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
Joe Perches5b579802018-08-21 21:57:33 -07004823 if ($perl_version_ok &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004824 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4825 my $lead = $1;
4826 my $const = $2;
4827 my $comp = $3;
4828 my $to = $4;
4829 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004830 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004831 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4832 WARN("CONSTANT_COMPARISON",
4833 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4834 $fix) {
4835 if ($comp eq "<") {
4836 $newcomp = ">";
4837 } elsif ($comp eq "<=") {
4838 $newcomp = ">=";
4839 } elsif ($comp eq ">") {
4840 $newcomp = "<";
4841 } elsif ($comp eq ">=") {
4842 $newcomp = "<=";
4843 }
4844 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4845 }
4846 }
4847
Joe Perchesf34e4a42015-04-16 12:44:19 -07004848# Return of what appears to be an errno should normally be negative
4849 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004850 my $name = $1;
4851 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004852 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004853 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004854 }
4855 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004856
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004857# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004858 if ($line =~ /\b(if|while|for|switch)\(/) {
4859 if (ERROR("SPACING",
4860 "space required before the open parenthesis '('\n" . $herecurr) &&
4861 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004862 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004863 s/\b(if|while|for|switch)\(/$1 \(/;
4864 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004865 }
4866
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004867# Check for illegal assignment in if conditional -- and check for trailing
4868# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004869 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004870 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4871 ctx_statement_block($linenr, $realcnt, 0)
4872 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004873 my ($stat_next) = ctx_statement_block($line_nr_next,
4874 $remain_next, $off_next);
4875 $stat_next =~ s/\n./\n /g;
4876 ##print "stat<$stat> stat_next<$stat_next>\n";
4877
4878 if ($stat_next =~ /^\s*while\b/) {
4879 # If the statement carries leading newlines,
4880 # then count those as offsets.
4881 my ($whitespace) =
4882 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4883 my $offset =
4884 statement_rawlines($whitespace) - 1;
4885
4886 $suppress_whiletrailers{$line_nr_next +
4887 $offset} = 1;
4888 }
4889 }
4890 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004891 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004892 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004893 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004894
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004895 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004896 ERROR("ASSIGN_IN_IF",
4897 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004898 }
4899
4900 # Find out what is on the end of the line after the
4901 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004902 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004903 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004904 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004905 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4906 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004907 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004908 # Find out how long the conditional actually is.
4909 my @newlines = ($c =~ /\n/gs);
4910 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004911 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004912
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004913 $stat_real = raw_line($linenr, $cond_lines)
4914 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004915 if (defined($stat_real) && $cond_lines > 1) {
4916 $stat_real = "[...]\n$stat_real";
4917 }
4918
Joe Perches000d1cc12011-07-25 17:13:25 -07004919 ERROR("TRAILING_STATEMENTS",
4920 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004921 }
4922 }
4923
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004924# Check for bitwise tests written as boolean
4925 if ($line =~ /
4926 (?:
4927 (?:\[|\(|\&\&|\|\|)
4928 \s*0[xX][0-9]+\s*
4929 (?:\&\&|\|\|)
4930 |
4931 (?:\&\&|\|\|)
4932 \s*0[xX][0-9]+\s*
4933 (?:\&\&|\|\||\)|\])
4934 )/x)
4935 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004936 WARN("HEXADECIMAL_BOOLEAN_TEST",
4937 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004938 }
4939
Andy Whitcroft8905a672007-11-28 16:21:06 -08004940# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004941 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4942 my $s = $1;
4943 $s =~ s/$;//g; # Remove any comments
4944 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004945 ERROR("TRAILING_STATEMENTS",
4946 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004947 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004948 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004949# if should not continue a brace
4950 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004951 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004952 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004953 $herecurr);
4954 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004955# case and default should not have general statements after them
4956 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4957 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004958 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004959 \s*return\s+
4960 )/xg)
4961 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004962 ERROR("TRAILING_STATEMENTS",
4963 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004964 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004965
4966 # Check for }<nl>else {, these must be at the same
4967 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004968 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4969 $previndent == $indent) {
4970 if (ERROR("ELSE_AFTER_BRACE",
4971 "else should follow close brace '}'\n" . $hereprev) &&
4972 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4973 fix_delete_line($fixlinenr - 1, $prevrawline);
4974 fix_delete_line($fixlinenr, $rawline);
4975 my $fixedline = $prevrawline;
4976 $fixedline =~ s/}\s*$//;
4977 if ($fixedline !~ /^\+\s*$/) {
4978 fix_insert_line($fixlinenr, $fixedline);
4979 }
4980 $fixedline = $rawline;
4981 $fixedline =~ s/^(.\s*)else/$1} else/;
4982 fix_insert_line($fixlinenr, $fixedline);
4983 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004984 }
4985
Joe Perches8b8856f2014-08-06 16:11:14 -07004986 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4987 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004988 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4989
4990 # Find out what is on the end of the line after the
4991 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004992 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004993 $s =~ s/\n.*//g;
4994
4995 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004996 if (ERROR("WHILE_AFTER_BRACE",
4997 "while should follow close brace '}'\n" . $hereprev) &&
4998 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4999 fix_delete_line($fixlinenr - 1, $prevrawline);
5000 fix_delete_line($fixlinenr, $rawline);
5001 my $fixedline = $prevrawline;
5002 my $trailing = $rawline;
5003 $trailing =~ s/^\+//;
5004 $trailing = trim($trailing);
5005 $fixedline =~ s/}\s*$/} $trailing/;
5006 fix_insert_line($fixlinenr, $fixedline);
5007 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08005008 }
5009 }
5010
Joe Perches95e2c602013-07-03 15:05:20 -07005011#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08005012 while ($line =~ m{($Constant|$Lval)}g) {
5013 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07005014
Joe Perches95e2c602013-07-03 15:05:20 -07005015#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07005016 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07005017 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005018#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07005019 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07005020#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08005021 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
5022#Ignore some three character SI units explicitly, like MiB and KHz
5023 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07005024 while ($var =~ m{($Ident)}g) {
5025 my $word = $1;
5026 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08005027 if ($check) {
5028 seed_camelcase_includes();
5029 if (!$file && !$camelcase_file_seeded) {
5030 seed_camelcase_file($realfile);
5031 $camelcase_file_seeded = 1;
5032 }
5033 }
Joe Perches7e781f62013-09-11 14:23:55 -07005034 if (!defined $camelcase{$word}) {
5035 $camelcase{$word} = 1;
5036 CHK("CAMELCASE",
5037 "Avoid CamelCase: <$word>\n" . $herecurr);
5038 }
Joe Perches34456862013-07-03 15:05:34 -07005039 }
Joe Perches323c1262012-12-17 16:02:07 -08005040 }
5041 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005042
5043#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07005044 if ($line =~ /\#\s*define.*\\\s+$/) {
5045 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
5046 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
5047 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005048 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005049 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005050 }
5051
Fabian Frederick0e212e02015-04-16 12:44:25 -07005052# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5053# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005054 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005055 my $file = "$1.h";
5056 my $checkfile = "include/linux/$file";
5057 if (-f "$root/$checkfile" &&
5058 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07005059 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005060 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07005061 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
5062 if ($asminclude > 0) {
5063 if ($realfile =~ m{^arch/}) {
5064 CHK("ARCH_INCLUDE_LINUX",
5065 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5066 } else {
5067 WARN("INCLUDE_LINUX",
5068 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
5069 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07005070 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005071 }
5072 }
5073
Andy Whitcroft653d4872007-06-23 17:16:34 -07005074# multi-statement macros should be enclosed in a do while loop, grab the
5075# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08005076# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07005077 if ($realfile !~ m@/vmlinux.lds.h$@ &&
5078 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005079 my $ln = $linenr;
5080 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005081 my ($off, $dstat, $dcond, $rest);
5082 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07005083 my $has_flow_statement = 0;
5084 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005085 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005086 ctx_statement_block($linenr, $realcnt, 0);
5087 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005088 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07005089 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005090
Joe Perches08a28432014-10-13 15:51:55 -07005091 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08005092 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07005093
Joe Perchesf59b64b2016-10-11 13:52:08 -07005094 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
5095 my $define_args = $1;
5096 my $define_stmt = $dstat;
5097 my @def_args = ();
5098
5099 if (defined $define_args && $define_args ne "") {
5100 $define_args = substr($define_args, 1, length($define_args) - 2);
5101 $define_args =~ s/\s*//g;
Joe Perches8c8c45c2018-08-21 21:57:43 -07005102 $define_args =~ s/\\\+?//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005103 @def_args = split(",", $define_args);
5104 }
5105
Andy Whitcroft292f1a92008-07-23 21:29:11 -07005106 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005107 $dstat =~ s/\\\n.//g;
5108 $dstat =~ s/^\s*//s;
5109 $dstat =~ s/\s*$//s;
5110
5111 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005112 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
5113 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005114 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07005115 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005116 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005117
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005118 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07005119 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
5120 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07005121 {
5122 }
5123
Joe Perches42e15292016-03-15 14:58:01 -07005124 # Make asm volatile uses seem like a generic function
5125 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
5126
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005127 my $exceptions = qr{
5128 $Declare|
5129 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07005130 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005131 DECLARE_PER_CPU|
5132 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08005133 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08005134 union|
5135 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07005136 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08005137 ^\"|\"$|
5138 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005139 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07005140 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07005141
5142 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005143 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005144 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07005145
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005146 if ($dstat ne '' &&
5147 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
5148 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07005149 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07005150 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005151 $dstat !~ /$exceptions/ &&
5152 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07005153 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08005154 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005155 $dstat !~ /^for\s*$Constant$/ && # for (...)
5156 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
5157 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07005158 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07005159 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005160 {
Joe Perchese7955562017-05-08 15:55:48 -07005161 if ($dstat =~ /^\s*if\b/) {
5162 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5163 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5164 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005165 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5166 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5167 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005168 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005169 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005170 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005171
5172 }
Joe Perches52076492016-10-11 13:52:14 -07005173
5174 # Make $define_stmt single line, comment-free, etc
5175 my @stmt_array = split('\n', $define_stmt);
5176 my $first = 1;
5177 $define_stmt = "";
5178 foreach my $l (@stmt_array) {
5179 $l =~ s/\\$//;
5180 if ($first) {
5181 $define_stmt = $l;
5182 $first = 0;
5183 } elsif ($l =~ /^[\+ ]/) {
5184 $define_stmt .= substr($l, 1);
5185 }
5186 }
5187 $define_stmt =~ s/$;//g;
5188 $define_stmt =~ s/\s+/ /g;
5189 $define_stmt = trim($define_stmt);
5190
Joe Perchesf59b64b2016-10-11 13:52:08 -07005191# check if any macro arguments are reused (ignore '...' and 'type')
5192 foreach my $arg (@def_args) {
5193 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005194 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005195 my $tmp_stmt = $define_stmt;
5196 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5197 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5198 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
Joe Perchesd41362e2018-05-25 14:48:04 -07005199 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005200 if ($use_cnt > 1) {
5201 CHK("MACRO_ARG_REUSE",
5202 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005203 }
5204# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005205 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005206 ((defined($1) && $1 ne ',') ||
5207 (defined($2) && $2 ne ','))) {
5208 CHK("MACRO_ARG_PRECEDENCE",
5209 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005210 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005211 }
Joe Perches5023d342012-12-17 16:01:47 -08005212
Joe Perches08a28432014-10-13 15:51:55 -07005213# check for macros with flow control, but without ## concatenation
5214# ## concatenation is commonly a macro that defines a function so ignore those
5215 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005216 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005217 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005218
Joe Perches08a28432014-10-13 15:51:55 -07005219 WARN("MACRO_WITH_FLOW_CONTROL",
5220 "Macros with flow control statements should be avoided\n" . "$herectx");
5221 }
5222
Joe Perches481eb482012-12-17 16:01:56 -08005223# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005224
5225 } else {
5226 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005227 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5228 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005229 $line =~ /^\+.*\\$/) {
5230 WARN("LINE_CONTINUATIONS",
5231 "Avoid unnecessary line continuations\n" . $herecurr);
5232 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005233 }
5234
Joe Perchesb13edf72012-07-30 14:41:24 -07005235# do {} while (0) macro tests:
5236# single-statement macros do not need to be enclosed in do while (0) loop,
5237# macro should not end with a semicolon
Joe Perches5b579802018-08-21 21:57:33 -07005238 if ($perl_version_ok &&
Joe Perchesb13edf72012-07-30 14:41:24 -07005239 $realfile !~ m@/vmlinux.lds.h$@ &&
5240 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5241 my $ln = $linenr;
5242 my $cnt = $realcnt;
5243 my ($off, $dstat, $dcond, $rest);
5244 my $ctx = '';
5245 ($dstat, $dcond, $ln, $cnt, $off) =
5246 ctx_statement_block($linenr, $realcnt, 0);
5247 $ctx = $dstat;
5248
5249 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005250 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005251
5252 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5253 my $stmts = $2;
5254 my $semis = $3;
5255
5256 $ctx =~ s/\n*$//;
5257 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005258 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005259
Joe Perchesac8e97f2012-08-21 16:15:53 -07005260 if (($stmts =~ tr/;/;/) == 1 &&
5261 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005262 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5263 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5264 }
5265 if (defined $semis && $semis ne "") {
5266 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5267 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5268 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005269 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5270 $ctx =~ s/\n*$//;
5271 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005272 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005273
5274 WARN("TRAILING_SEMICOLON",
5275 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005276 }
5277 }
5278
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005279# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005280 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5281 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005282 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005283 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005284 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5285 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005286 my @allowed = ();
5287 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005288 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005289 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005290 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005291 for my $chunk (@chunks) {
5292 my ($cond, $block) = @{$chunk};
5293
Andy Whitcroft773647a2008-03-28 14:15:58 -07005294 # If the condition carries leading newlines, then count those as offsets.
5295 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5296 my $offset = statement_rawlines($whitespace) - 1;
5297
Joe Perchesaad4f612012-03-23 15:02:19 -07005298 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005299 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5300
5301 # We have looked at and allowed this specific line.
5302 $suppress_ifbraces{$ln + $offset} = 1;
5303
5304 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005305 $ln += statement_rawlines($block) - 1;
5306
Andy Whitcroft773647a2008-03-28 14:15:58 -07005307 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005308
5309 $seen++ if ($block =~ /^\s*{/);
5310
Joe Perchesaad4f612012-03-23 15:02:19 -07005311 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005312 if (statement_lines($cond) > 1) {
5313 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005314 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005315 }
5316 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005317 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005318 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005319 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005320 if (statement_block_size($block) > 1) {
5321 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005322 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005323 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005324 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005325 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005326 if ($seen) {
5327 my $sum_allowed = 0;
5328 foreach (@allowed) {
5329 $sum_allowed += $_;
5330 }
5331 if ($sum_allowed == 0) {
5332 WARN("BRACES",
5333 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5334 } elsif ($sum_allowed != $allow &&
5335 $seen != $allow) {
5336 CHK("BRACES",
5337 "braces {} should be used on all arms of this statement\n" . $herectx);
5338 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005339 }
5340 }
5341 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005342 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005343 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005344 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005345
Andy Whitcroftcf655042008-03-04 14:28:20 -08005346 # Check the pre-context.
5347 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5348 #print "APW: ALLOWED: pre<$1>\n";
5349 $allowed = 1;
5350 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005351
5352 my ($level, $endln, @chunks) =
5353 ctx_statement_full($linenr, $realcnt, $-[0]);
5354
Andy Whitcroftcf655042008-03-04 14:28:20 -08005355 # Check the condition.
5356 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005357 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005358 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005359 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005360 }
5361 if (statement_lines($cond) > 1) {
5362 #print "APW: ALLOWED: cond<$cond>\n";
5363 $allowed = 1;
5364 }
5365 if ($block =~/\b(?:if|for|while)\b/) {
5366 #print "APW: ALLOWED: block<$block>\n";
5367 $allowed = 1;
5368 }
5369 if (statement_block_size($block) > 1) {
5370 #print "APW: ALLOWED: lines block<$block>\n";
5371 $allowed = 1;
5372 }
5373 # Check the post-context.
5374 if (defined $chunks[1]) {
5375 my ($cond, $block) = @{$chunks[1]};
5376 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005377 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005378 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005379 if ($block =~ /^\s*\{/) {
5380 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5381 $allowed = 1;
5382 }
5383 }
5384 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005385 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005386 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005387
Joe Perches000d1cc12011-07-25 17:13:25 -07005388 WARN("BRACES",
5389 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005390 }
5391 }
5392
Joe Perchese4c5bab2017-02-24 15:01:41 -08005393# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005394 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5395 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005396 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5397 }
5398
Joe Perches0979ae62012-12-17 16:01:59 -08005399# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005400 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005401 if (CHK("BRACES",
5402 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5403 $fix && $prevrawline =~ /^\+/) {
5404 fix_delete_line($fixlinenr - 1, $prevrawline);
5405 }
Joe Perches0979ae62012-12-17 16:01:59 -08005406 }
Joe Perches77b9a532013-07-03 15:05:29 -07005407 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005408 if (CHK("BRACES",
5409 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5410 $fix) {
5411 fix_delete_line($fixlinenr, $rawline);
5412 }
Joe Perches0979ae62012-12-17 16:01:59 -08005413 }
5414
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005415# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005416 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5417 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005418 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005419 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005420 }
5421
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005422# Check for user-visible strings broken across lines, which breaks the ability
5423# to grep for the string. Make exceptions when the previous string ends in a
5424# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5425# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005426 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005427 $prevline =~ /"\s*$/ &&
5428 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5429 if (WARN("SPLIT_STRING",
5430 "quoted string split across lines\n" . $hereprev) &&
5431 $fix &&
5432 $prevrawline =~ /^\+.*"\s*$/ &&
5433 $last_coalesced_string_linenr != $linenr - 1) {
5434 my $extracted_string = get_quoted_string($line, $rawline);
5435 my $comma_close = "";
5436 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5437 $comma_close = $1;
5438 }
5439
5440 fix_delete_line($fixlinenr - 1, $prevrawline);
5441 fix_delete_line($fixlinenr, $rawline);
5442 my $fixedline = $prevrawline;
5443 $fixedline =~ s/"\s*$//;
5444 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5445 fix_insert_line($fixlinenr - 1, $fixedline);
5446 $fixedline = $rawline;
5447 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5448 if ($fixedline !~ /\+\s*$/) {
5449 fix_insert_line($fixlinenr, $fixedline);
5450 }
5451 $last_coalesced_string_linenr = $linenr;
5452 }
5453 }
5454
5455# check for missing a space in a string concatenation
5456 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5457 WARN('MISSING_SPACE',
5458 "break quoted strings at a space character\n" . $hereprev);
5459 }
5460
Joe Perchese4b7d302017-05-08 15:55:51 -07005461# check for an embedded function name in a string when the function is known
5462# This does not work very well for -f --file checking as it depends on patch
5463# context providing the function name or a single line form for in-file
5464# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005465 if ($line =~ /^\+.*$String/ &&
5466 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005467 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5468 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005469 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005470 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005471 }
5472
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005473# check for spaces before a quoted newline
5474 if ($rawline =~ /^.*\".*\s\\n/) {
5475 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5476 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5477 $fix) {
5478 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5479 }
5480
5481 }
5482
Joe Perchesf17dba42014-10-13 15:51:51 -07005483# concatenated string without spaces between elements
Joe Perches79682c02018-08-21 21:57:29 -07005484 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) {
5485 if (CHK("CONCATENATED_STRING",
5486 "Concatenated strings should use spaces between elements\n" . $herecurr) &&
5487 $fix) {
5488 while ($line =~ /($String)/g) {
5489 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5490 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/;
5491 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/;
5492 }
5493 }
Joe Perchesf17dba42014-10-13 15:51:51 -07005494 }
5495
Joe Perches90ad30e2014-12-10 15:51:59 -08005496# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005497 if ($line =~ /$String\s*"/) {
Joe Perches79682c02018-08-21 21:57:29 -07005498 if (WARN("STRING_FRAGMENTS",
5499 "Consecutive strings are generally better as a single string\n" . $herecurr) &&
5500 $fix) {
5501 while ($line =~ /($String)(?=\s*")/g) {
5502 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]);
5503 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e;
5504 }
5505 }
Joe Perches90ad30e2014-12-10 15:51:59 -08005506 }
5507
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005508# check for non-standard and hex prefixed decimal printf formats
5509 my $show_L = 1; #don't show the same defect twice
5510 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005511 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005512 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005513 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005514 # check for %L
5515 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005516 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005517 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5518 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005519 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005520 # check for %Z
5521 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5522 WARN("PRINTF_Z",
5523 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5524 $show_Z = 0;
5525 }
5526 # check for 0x<decimal>
5527 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5528 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005529 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5530 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005531 }
5532
5533# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005534 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005535 WARN("LINE_CONTINUATIONS",
5536 "Avoid line continuations in quoted strings\n" . $herecurr);
5537 }
5538
Andy Whitcroft00df3442007-06-08 13:47:06 -07005539# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005540 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Prakruthi Deepak Heragu60f89012018-08-21 21:57:57 -07005541 WARN("IF_0",
5542 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr);
5543 }
5544
5545# warn about #if 1
5546 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5547 WARN("IF_1",
5548 "Consider removing the #if 1 and its #endif\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005549 }
5550
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005551# check for needless "if (<foo>) fn(<foo>)" uses
5552 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005553 my $tested = quotemeta($1);
5554 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5555 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5556 my $func = $1;
5557 if (WARN('NEEDLESS_IF',
5558 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5559 $fix) {
5560 my $do_fix = 1;
5561 my $leading_tabs = "";
5562 my $new_leading_tabs = "";
5563 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5564 $leading_tabs = $1;
5565 } else {
5566 $do_fix = 0;
5567 }
5568 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5569 $new_leading_tabs = $1;
5570 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5571 $do_fix = 0;
5572 }
5573 } else {
5574 $do_fix = 0;
5575 }
5576 if ($do_fix) {
5577 fix_delete_line($fixlinenr - 1, $prevrawline);
5578 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5579 }
5580 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005581 }
5582 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005583
Joe Perchesebfdc402014-08-06 16:10:27 -07005584# check for unnecessary "Out of Memory" messages
5585 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5586 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5587 (defined $1 || defined $3) &&
5588 $linenr > 3) {
5589 my $testval = $2;
5590 my $testline = $lines[$linenr - 3];
5591
5592 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5593# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5594
Joe Perchese29a70f2019-03-07 16:28:35 -08005595 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5596 $s !~ /\b__GFP_NOWARN\b/ ) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005597 WARN("OOM_MESSAGE",
5598 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5599 }
5600 }
5601
Joe Perchesf78d98f2014-10-13 15:52:01 -07005602# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005603 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005604 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5605 my $level = $1;
5606 if (WARN("UNNECESSARY_KERN_LEVEL",
5607 "Possible unnecessary $level\n" . $herecurr) &&
5608 $fix) {
5609 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5610 }
5611 }
5612
Joe Perches45c55e92017-02-24 15:01:31 -08005613# check for logging continuations
5614 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5615 WARN("LOGGING_CONTINUATION",
5616 "Avoid logging continuation uses where feasible\n" . $herecurr);
5617 }
5618
Joe Perchesabb08a52014-12-10 15:51:46 -08005619# check for mask then right shift without a parentheses
Joe Perches5b579802018-08-21 21:57:33 -07005620 if ($perl_version_ok &&
Joe Perchesabb08a52014-12-10 15:51:46 -08005621 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5622 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5623 WARN("MASK_THEN_SHIFT",
5624 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5625 }
5626
Joe Perchesb75ac612014-12-10 15:52:02 -08005627# check for pointer comparisons to NULL
Joe Perches5b579802018-08-21 21:57:33 -07005628 if ($perl_version_ok) {
Joe Perchesb75ac612014-12-10 15:52:02 -08005629 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5630 my $val = $1;
5631 my $equal = "!";
5632 $equal = "" if ($4 eq "!=");
5633 if (CHK("COMPARISON_TO_NULL",
5634 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5635 $fix) {
5636 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5637 }
5638 }
5639 }
5640
Joe Perches8716de32013-09-11 14:24:05 -07005641# check for bad placement of section $InitAttribute (e.g.: __initdata)
5642 if ($line =~ /(\b$InitAttribute\b)/) {
5643 my $attr = $1;
5644 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5645 my $ptr = $1;
5646 my $var = $2;
5647 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5648 ERROR("MISPLACED_INIT",
5649 "$attr should be placed after $var\n" . $herecurr)) ||
5650 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5651 WARN("MISPLACED_INIT",
5652 "$attr should be placed after $var\n" . $herecurr))) &&
5653 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005654 $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 -07005655 }
5656 }
5657 }
5658
Joe Perchese970b8842013-11-12 15:10:10 -08005659# check for $InitAttributeData (ie: __initdata) with const
5660 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5661 my $attr = $1;
5662 $attr =~ /($InitAttributePrefix)(.*)/;
5663 my $attr_prefix = $1;
5664 my $attr_type = $2;
5665 if (ERROR("INIT_ATTRIBUTE",
5666 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5667 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005668 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005669 s/$InitAttributeData/${attr_prefix}initconst/;
5670 }
5671 }
5672
5673# check for $InitAttributeConst (ie: __initconst) without const
5674 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5675 my $attr = $1;
5676 if (ERROR("INIT_ATTRIBUTE",
5677 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5678 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005679 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005680 /(^\+\s*(?:static\s+))/;
5681 $lead = rtrim($1);
5682 $lead = "$lead " if ($lead !~ /^\+$/);
5683 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005684 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005685 }
5686 }
5687
Joe Perchesc17893c2015-04-16 12:44:42 -07005688# check for __read_mostly with const non-pointer (should just be const)
5689 if ($line =~ /\b__read_mostly\b/ &&
5690 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5691 if (ERROR("CONST_READ_MOSTLY",
5692 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5693 $fix) {
5694 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5695 }
5696 }
5697
Joe Perchesfbdb8132014-04-03 14:49:14 -07005698# don't use __constant_<foo> functions outside of include/uapi/
5699 if ($realfile !~ m@^include/uapi/@ &&
5700 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5701 my $constant_func = $1;
5702 my $func = $constant_func;
5703 $func =~ s/^__constant_//;
5704 if (WARN("CONSTANT_CONVERSION",
5705 "$constant_func should be $func\n" . $herecurr) &&
5706 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005707 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005708 }
5709 }
5710
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005711# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005712 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005713 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005714 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005715 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005716 CHK("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005717 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Joe Perches43c1d772014-04-03 14:49:11 -07005718 }
5719 if ($delay > 2000) {
5720 WARN("LONG_UDELAY",
5721 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005722 }
5723 }
5724
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005725# warn about unexpectedly long msleep's
5726 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5727 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005728 WARN("MSLEEP",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03005729 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005730 }
5731 }
5732
Joe Perches36ec1932013-07-03 15:05:25 -07005733# check for comparisons of jiffies
5734 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5735 WARN("JIFFIES_COMPARISON",
5736 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5737 }
5738
Joe Perches9d7a34a2013-07-03 15:05:26 -07005739# check for comparisons of get_jiffies_64()
5740 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5741 WARN("JIFFIES_COMPARISON",
5742 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5743 }
5744
Andy Whitcroft00df3442007-06-08 13:47:06 -07005745# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005746# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005747# print "#ifdef in C files should be avoided\n";
5748# print "$herecurr";
5749# $clean = 0;
5750# }
5751
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005752# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005753 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005754 if (ERROR("SPACING",
5755 "exactly one space required after that #$1\n" . $herecurr) &&
5756 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005757 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005758 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5759 }
5760
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005761 }
5762
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005763# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005764 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5765 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005766 my $which = $1;
5767 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005768 CHK("UNCOMMENTED_DEFINITION",
5769 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005770 }
5771 }
5772# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005773
5774 my $barriers = qr{
5775 mb|
5776 rmb|
5777 wmb|
5778 read_barrier_depends
5779 }x;
5780 my $barrier_stems = qr{
5781 mb__before_atomic|
5782 mb__after_atomic|
5783 store_release|
5784 load_acquire|
5785 store_mb|
5786 (?:$barriers)
5787 }x;
5788 my $all_barriers = qr{
5789 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005790 smp_(?:$barrier_stems)|
5791 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005792 }x;
5793
5794 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005795 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005796 WARN("MEMORY_BARRIER",
5797 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005798 }
5799 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005800
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005801 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5802
5803 if ($realfile !~ m@^include/asm-generic/@ &&
5804 $realfile !~ m@/barrier\.h$@ &&
5805 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5806 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5807 WARN("MEMORY_BARRIER",
5808 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5809 }
5810
Joe Perchescb426e92015-06-25 15:02:46 -07005811# check for waitqueue_active without a comment.
5812 if ($line =~ /\bwaitqueue_active\s*\(/) {
5813 if (!ctx_has_comment($first_line, $linenr)) {
5814 WARN("WAITQUEUE_ACTIVE",
5815 "waitqueue_active without comment\n" . $herecurr);
5816 }
5817 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005818
Paul E. McKenney91db2592017-11-27 09:37:35 -08005819# check for smp_read_barrier_depends and read_barrier_depends
5820 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5821 WARN("READ_BARRIER_DEPENDS",
5822 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5823 }
5824
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005825# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005826 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005827 CHK("ARCH_DEFINES",
5828 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005829 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005830
Joe Perches596ed452017-07-12 14:37:02 -07005831# check that the storage class is not after a type
5832 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005833 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005834 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5835 }
5836# Check that the storage class is at the beginning of a declaration
5837 if ($line =~ /\b$Storage\b/ &&
5838 $line !~ /^.\s*$Storage/ &&
5839 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5840 $1 !~ /[\,\)]\s*$/) {
5841 WARN("STORAGE_CLASS",
5842 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005843 }
5844
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005845# check the location of the inline attribute, that it is between
5846# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005847 if ($line =~ /\b$Type\s+$Inline\b/ ||
5848 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005849 ERROR("INLINE_LOCATION",
5850 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005851 }
5852
Andy Whitcroft8905a672007-11-28 16:21:06 -08005853# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005854 if ($realfile !~ m@\binclude/uapi/@ &&
5855 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005856 if (WARN("INLINE",
5857 "plain inline is preferred over $1\n" . $herecurr) &&
5858 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005859 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005860
5861 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005862 }
5863
Joe Perches3d130fd2011-01-12 17:00:00 -08005864# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005865 if ($realfile !~ m@\binclude/uapi/@ &&
5866 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005867 WARN("PREFER_PACKED",
5868 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005869 }
5870
Joe Perches39b7e282011-07-25 17:13:24 -07005871# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005872 if ($realfile !~ m@\binclude/uapi/@ &&
5873 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005874 WARN("PREFER_ALIGNED",
5875 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005876 }
5877
Joe Perches5f14d3b2012-01-10 15:09:52 -08005878# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005879 if ($realfile !~ m@\binclude/uapi/@ &&
5880 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005881 if (WARN("PREFER_PRINTF",
5882 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5883 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005884 $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 -07005885
5886 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005887 }
5888
Joe Perches6061d942012-03-23 15:02:16 -07005889# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005890 if ($realfile !~ m@\binclude/uapi/@ &&
5891 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005892 if (WARN("PREFER_SCANF",
5893 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5894 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005895 $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 -07005896 }
Joe Perches6061d942012-03-23 15:02:16 -07005897 }
5898
Joe Perches619a9082014-12-10 15:51:35 -08005899# Check for __attribute__ weak, or __weak declarations (may have link issues)
Joe Perches5b579802018-08-21 21:57:33 -07005900 if ($perl_version_ok &&
Joe Perches619a9082014-12-10 15:51:35 -08005901 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5902 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5903 $line =~ /\b__weak\b/)) {
5904 ERROR("WEAK_DECLARATION",
5905 "Using weak declarations can have unintended link defects\n" . $herecurr);
5906 }
5907
Tomas Winklerfd39f902016-12-12 16:46:34 -08005908# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005909 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005910 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005911 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5912 my $type = $1;
5913 if ($type =~ /\b($typeC99Typedefs)\b/) {
5914 $type = $1;
5915 my $kernel_type = 'u';
5916 $kernel_type = 's' if ($type =~ /^_*[si]/);
5917 $type =~ /(\d+)/;
5918 $kernel_type .= $1;
5919 if (CHK("PREFER_KERNEL_TYPES",
5920 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5921 $fix) {
5922 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5923 }
5924 }
5925 }
5926
Joe Perches938224b2016-01-20 14:59:15 -08005927# check for cast of C90 native int or longer types constants
5928 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5929 my $cast = $1;
5930 my $const = $2;
5931 if (WARN("TYPECAST_INT_CONSTANT",
5932 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5933 $fix) {
5934 my $suffix = "";
5935 my $newconst = $const;
5936 $newconst =~ s/${Int_type}$//;
5937 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5938 if ($cast =~ /\blong\s+long\b/) {
5939 $suffix .= 'LL';
5940 } elsif ($cast =~ /\blong\b/) {
5941 $suffix .= 'L';
5942 }
5943 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5944 }
5945 }
5946
Joe Perches8f53a9b2010-03-05 13:43:48 -08005947# check for sizeof(&)
5948 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005949 WARN("SIZEOF_ADDRESS",
5950 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005951 }
5952
Joe Perches66c80b62012-07-30 14:41:22 -07005953# check for sizeof without parenthesis
5954 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005955 if (WARN("SIZEOF_PARENTHESIS",
5956 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5957 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005958 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005959 }
Joe Perches66c80b62012-07-30 14:41:22 -07005960 }
5961
Joe Perches88982fe2012-12-17 16:02:00 -08005962# check for struct spinlock declarations
5963 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5964 WARN("USE_SPINLOCK_T",
5965 "struct spinlock should be spinlock_t\n" . $herecurr);
5966 }
5967
Joe Perchesa6962d72013-04-29 16:18:13 -07005968# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005969 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005970 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005971 $fmt =~ s/%%//g;
5972 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005973 if (WARN("PREFER_SEQ_PUTS",
5974 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5975 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005976 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005977 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005978 }
5979 }
5980
Joe Perches478b1792018-04-10 16:33:34 -07005981# check for vsprintf extension %p<foo> misuses
Joe Perches5b579802018-08-21 21:57:33 -07005982 if ($perl_version_ok &&
Joe Perches0b523762017-05-08 15:55:36 -07005983 defined $stat &&
5984 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5985 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07005986 my $stat_real;
5987
Joe Perches0b523762017-05-08 15:55:36 -07005988 my $lc = $stat =~ tr@\n@@;
5989 $lc = $lc + $linenr;
5990 for (my $count = $linenr; $count <= $lc; $count++) {
Joe Perchesffe07512018-07-13 16:59:23 -07005991 my $specifier;
5992 my $extension;
5993 my $bad_specifier = "";
Joe Perches0b523762017-05-08 15:55:36 -07005994 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5995 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005996
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07005997 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
5998 $specifier = $1;
5999 $extension = $2;
Alexandre Belloni44629962019-03-28 20:44:32 -07006000 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOxt]/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07006001 $bad_specifier = $specifier;
6002 last;
6003 }
6004 if ($extension eq "x" && !defined($stat_real)) {
6005 if (!defined($stat_real)) {
6006 $stat_real = get_stat_real($linenr, $lc);
6007 }
6008 WARN("VSPRINTF_SPECIFIER_PX",
6009 "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");
6010 }
6011 }
6012 if ($bad_specifier ne "") {
6013 my $stat_real = get_stat_real($linenr, $lc);
6014 my $ext_type = "Invalid";
6015 my $use = "";
6016 if ($bad_specifier =~ /p[Ff]/) {
6017 $ext_type = "Deprecated";
6018 $use = " - use %pS instead";
6019 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
6020 }
6021
6022 WARN("VSPRINTF_POINTER_EXTENSION",
6023 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
6024 }
Joe Perches0b523762017-05-08 15:55:36 -07006025 }
6026 }
6027
Andy Whitcroft554e1652012-01-10 15:09:57 -08006028# Check for misused memsets
Joe Perches5b579802018-08-21 21:57:33 -07006029 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006030 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07006031 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08006032
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006033 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006034 my $ms_val = $7;
6035 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006036
Andy Whitcroft554e1652012-01-10 15:09:57 -08006037 if ($ms_size =~ /^(0x|)0$/i) {
6038 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006039 "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 -08006040 } elsif ($ms_size =~ /^(0x|)1$/i) {
6041 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006042 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
6043 }
6044 }
6045
Joe Perches98a9bba2014-01-23 15:54:52 -08006046# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006047# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006048# defined $stat &&
6049# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6050# if (WARN("PREFER_ETHER_ADDR_COPY",
6051# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6052# $fix) {
6053# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6054# }
6055# }
Joe Perches98a9bba2014-01-23 15:54:52 -08006056
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006057# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perches5b579802018-08-21 21:57:33 -07006058# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006059# defined $stat &&
6060# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6061# WARN("PREFER_ETHER_ADDR_EQUAL",
6062# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6063# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07006064
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006065# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6066# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perches5b579802018-08-21 21:57:33 -07006067# if ($perl_version_ok &&
Joe Perchesf3331952016-10-11 13:51:53 -07006068# defined $stat &&
6069# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6070#
6071# my $ms_val = $7;
6072#
6073# if ($ms_val =~ /^(?:0x|)0+$/i) {
6074# if (WARN("PREFER_ETH_ZERO_ADDR",
6075# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6076# $fix) {
6077# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6078# }
6079# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6080# if (WARN("PREFER_ETH_BROADCAST_ADDR",
6081# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6082# $fix) {
6083# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6084# }
6085# }
6086# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07006087
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006088# typecasts on min/max could be min_t/max_t
Joe Perches5b579802018-08-21 21:57:33 -07006089 if ($perl_version_ok &&
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006090 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006091 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006092 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006093 my $call = $1;
6094 my $cast1 = deparenthesize($2);
6095 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006096 my $cast2 = deparenthesize($7);
6097 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006098 my $cast;
6099
Joe Perchesd1fe9c02012-03-23 15:02:16 -07006100 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08006101 $cast = "$cast1 or $cast2";
6102 } elsif ($cast1 ne "") {
6103 $cast = $cast1;
6104 } else {
6105 $cast = $cast2;
6106 }
6107 WARN("MINMAX",
6108 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08006109 }
6110 }
6111
Joe Perches4a273192012-07-30 14:41:20 -07006112# check usleep_range arguments
Joe Perches5b579802018-08-21 21:57:33 -07006113 if ($perl_version_ok &&
Joe Perches4a273192012-07-30 14:41:20 -07006114 defined $stat &&
6115 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
6116 my $min = $1;
6117 my $max = $7;
6118 if ($min eq $max) {
6119 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006120 "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 -07006121 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
6122 $min > $max) {
6123 WARN("USLEEP_RANGE",
Mauro Carvalho Chehab458f69e2019-06-12 14:53:00 -03006124 "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 -07006125 }
6126 }
6127
Joe Perches823b7942013-11-12 15:10:15 -08006128# check for naked sscanf
Joe Perches5b579802018-08-21 21:57:33 -07006129 if ($perl_version_ok &&
Joe Perches823b7942013-11-12 15:10:15 -08006130 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07006131 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08006132 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
6133 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
6134 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
6135 my $lc = $stat =~ tr@\n@@;
6136 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006137 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08006138 WARN("NAKED_SSCANF",
6139 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
6140 }
6141
Joe Perchesafc819a2014-06-04 16:12:08 -07006142# check for simple sscanf that should be kstrto<foo>
Joe Perches5b579802018-08-21 21:57:33 -07006143 if ($perl_version_ok &&
Joe Perchesafc819a2014-06-04 16:12:08 -07006144 defined $stat &&
6145 $line =~ /\bsscanf\b/) {
6146 my $lc = $stat =~ tr@\n@@;
6147 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006148 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07006149 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
6150 my $format = $6;
6151 my $count = $format =~ tr@%@%@;
6152 if ($count == 1 &&
6153 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
6154 WARN("SSCANF_TO_KSTRTO",
6155 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
6156 }
6157 }
6158 }
6159
Joe Perches70dc8a42013-09-11 14:23:58 -07006160# check for new externs in .h files.
6161 if ($realfile =~ /\.h$/ &&
6162 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07006163 if (CHK("AVOID_EXTERNS",
6164 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07006165 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006166 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07006167 }
6168 }
6169
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006170# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006171 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006172 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006173 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006174 my $function_name = $1;
6175 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006176
6177 my $s = $stat;
6178 if (defined $cond) {
6179 substr($s, 0, length($cond), '');
6180 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006181 if ($s =~ /^\s*;/ &&
6182 $function_name ne 'uninitialized_var')
6183 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006184 WARN("AVOID_EXTERNS",
6185 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006186 }
6187
6188 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006189 WARN("FUNCTION_ARGUMENTS",
6190 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006191 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006192
6193 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6194 $stat =~ /^.\s*extern\s+/)
6195 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006196 WARN("AVOID_EXTERNS",
6197 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006198 }
6199
Joe Perchesa0ad7592017-07-10 15:52:19 -07006200# check for function declarations that have arguments without identifier names
6201 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006202 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006203 $1 ne "void") {
6204 my $args = trim($1);
6205 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6206 my $arg = trim($1);
6207 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6208 WARN("FUNCTION_ARGUMENTS",
6209 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6210 }
6211 }
6212 }
6213
Joe Perchesa0ad7592017-07-10 15:52:19 -07006214# check for function definitions
Joe Perches5b579802018-08-21 21:57:33 -07006215 if ($perl_version_ok &&
Joe Perchesa0ad7592017-07-10 15:52:19 -07006216 defined $stat &&
6217 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6218 $context_function = $1;
6219
6220# check for multiline function definition with misplaced open brace
6221 my $ok = 0;
6222 my $cnt = statement_rawlines($stat);
6223 my $herectx = $here . "\n";
6224 for (my $n = 0; $n < $cnt; $n++) {
6225 my $rl = raw_line($linenr, $n);
6226 $herectx .= $rl . "\n";
6227 $ok = 1 if ($rl =~ /^[ \+]\{/);
6228 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6229 last if $rl =~ /^[ \+].*\{/;
6230 }
6231 if (!$ok) {
6232 ERROR("OPEN_BRACE",
6233 "open brace '{' following function definitions go on the next line\n" . $herectx);
6234 }
6235 }
6236
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006237# checks for new __setup's
6238 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6239 my $name = $1;
6240
6241 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006242 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006243 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006244 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006245 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006246
Joe Perchese29a70f2019-03-07 16:28:35 -08006247# check for pointless casting of alloc functions
6248 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006249 WARN("UNNECESSARY_CASTS",
6250 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006251 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006252
Joe Perchesa640d252013-07-03 15:05:21 -07006253# alloc style
6254# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
Joe Perches5b579802018-08-21 21:57:33 -07006255 if ($perl_version_ok &&
Joe Perchese29a70f2019-03-07 16:28:35 -08006256 $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 -07006257 CHK("ALLOC_SIZEOF_STRUCT",
6258 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6259 }
6260
Joe Perches60a55362014-06-04 16:12:07 -07006261# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
Joe Perches5b579802018-08-21 21:57:33 -07006262 if ($perl_version_ok &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006263 defined $stat &&
6264 $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 -07006265 my $oldfunc = $3;
6266 my $a1 = $4;
6267 my $a2 = $10;
6268 my $newfunc = "kmalloc_array";
6269 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006270 my $r1 = $a1;
6271 my $r2 = $a2;
6272 if ($a1 =~ /^sizeof\s*\S/) {
6273 $r1 = $a2;
6274 $r2 = $a1;
6275 }
6276 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6277 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006278 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006279 my $herectx = get_stat_here($linenr, $cnt, $here);
6280
Joe Perches60a55362014-06-04 16:12:07 -07006281 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006282 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6283 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006284 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006285 $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 -07006286 }
6287 }
6288 }
6289
Joe Perches972fdea2013-04-29 16:18:12 -07006290# check for krealloc arg reuse
Joe Perches5b579802018-08-21 21:57:33 -07006291 if ($perl_version_ok &&
Joe Perches4cab63c2018-08-21 21:57:50 -07006292 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ &&
6293 $1 eq $3) {
Joe Perches972fdea2013-04-29 16:18:12 -07006294 WARN("KREALLOC_ARG_REUSE",
6295 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6296 }
6297
Joe Perches5ce59ae2013-02-21 16:44:18 -08006298# check for alloc argument mismatch
6299 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6300 WARN("ALLOC_ARRAY_ARGS",
6301 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6302 }
6303
Joe Perchescaf2a542011-01-12 16:59:56 -08006304# check for multiple semicolons
6305 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006306 if (WARN("ONE_SEMICOLON",
6307 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6308 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006309 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006310 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006311 }
6312
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006313# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6314 if ($realfile !~ m@^include/uapi/@ &&
6315 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006316 my $ull = "";
6317 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6318 if (CHK("BIT_MACRO",
6319 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6320 $fix) {
6321 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6322 }
6323 }
6324
Joe Perches2d632742016-05-20 17:04:00 -07006325# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6326 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6327 my $config = $1;
6328 if (WARN("PREFER_IS_ENABLED",
6329 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6330 $fix) {
6331 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6332 }
6333 }
6334
Joe Perchese81f2392014-08-06 16:11:25 -07006335# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006336 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6337 my $has_break = 0;
6338 my $has_statement = 0;
6339 my $count = 0;
6340 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006341 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006342 $prevline--;
6343 my $rline = $rawlines[$prevline - 1];
6344 my $fline = $lines[$prevline - 1];
6345 last if ($fline =~ /^\@\@/);
6346 next if ($fline =~ /^\-/);
6347 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6348 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6349 next if ($fline =~ /^.[\s$;]*$/);
6350 $has_statement = 1;
6351 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006352 $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 -08006353 }
6354 if (!$has_break && $has_statement) {
6355 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006356 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006357 }
6358 }
6359
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006360# check for switch/default statements without a break;
Joe Perches5b579802018-08-21 21:57:33 -07006361 if ($perl_version_ok &&
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006362 defined $stat &&
6363 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006364 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006365 my $herectx = get_stat_here($linenr, $cnt, $here);
6366
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006367 WARN("DEFAULT_NO_BREAK",
6368 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006369 }
6370
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006371# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006372 if ($line =~ /\b__FUNCTION__\b/) {
6373 if (WARN("USE_FUNC",
6374 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6375 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006376 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006377 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006378 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006379
Joe Perches62ec8182015-02-13 14:38:18 -08006380# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6381 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6382 ERROR("DATE_TIME",
6383 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6384 }
6385
Joe Perches2c924882012-03-23 15:02:20 -07006386# check for use of yield()
6387 if ($line =~ /\byield\s*\(\s*\)/) {
6388 WARN("YIELD",
6389 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6390 }
6391
Joe Perches179f8f42013-07-03 15:05:30 -07006392# check for comparisons against true and false
6393 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6394 my $lead = $1;
6395 my $arg = $2;
6396 my $test = $3;
6397 my $otype = $4;
6398 my $trail = $5;
6399 my $op = "!";
6400
6401 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6402
6403 my $type = lc($otype);
6404 if ($type =~ /^(?:true|false)$/) {
6405 if (("$test" eq "==" && "$type" eq "true") ||
6406 ("$test" eq "!=" && "$type" eq "false")) {
6407 $op = "";
6408 }
6409
6410 CHK("BOOL_COMPARISON",
6411 "Using comparison to $otype is error prone\n" . $herecurr);
6412
6413## maybe suggesting a correct construct would better
6414## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6415
6416 }
6417 }
6418
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006419# check for semaphores initialized locked
6420 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006421 WARN("CONSIDER_COMPLETION",
6422 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006423 }
Joe Perches6712d852012-03-23 15:02:20 -07006424
Joe Perches67d0a072011-10-31 17:13:10 -07006425# recommend kstrto* over simple_strto* and strict_strto*
6426 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006427 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006428 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006429 }
Joe Perches6712d852012-03-23 15:02:20 -07006430
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006431# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006432 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006433 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006434 "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 -07006435 }
Joe Perches6712d852012-03-23 15:02:20 -07006436
Paul E. McKenney3d709ab2018-11-11 10:49:10 -08006437# check for spin_is_locked(), suggest lockdep instead
6438 if ($line =~ /\bspin_is_locked\(/) {
6439 WARN("USE_LOCKDEP",
6440 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6441 }
6442
Joe Perches9189c7e2018-09-07 15:26:18 -07006443# check for deprecated apis
6444 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) {
6445 my $deprecated_api = $1;
6446 my $new_api = $deprecated_apis{$deprecated_api};
6447 WARN("DEPRECATED_API",
6448 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr);
6449 }
6450
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006451# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006452# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006453 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006454 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006455 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006456 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006457 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006458
6459# use of NR_CPUS is usually wrong
6460# ignore definitions of NR_CPUS and usage to define arrays as likely right
6461 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006462 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6463 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006464 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6465 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6466 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006467 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006468 WARN("NR_CPUS",
6469 "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 -07006470 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006471
Joe Perches52ea8502013-11-12 15:10:09 -08006472# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6473 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6474 ERROR("DEFINE_ARCH_HAS",
6475 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6476 }
6477
Joe Perchesacd93622015-02-13 14:38:38 -08006478# likely/unlikely comparisons similar to "(likely(foo) > 0)"
Joe Perches5b579802018-08-21 21:57:33 -07006479 if ($perl_version_ok &&
Joe Perchesacd93622015-02-13 14:38:38 -08006480 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6481 WARN("LIKELY_MISUSE",
6482 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6483 }
6484
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006485# whine mightly about in_atomic
6486 if ($line =~ /\bin_atomic\s*\(/) {
6487 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006488 ERROR("IN_ATOMIC",
6489 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006490 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006491 WARN("IN_ATOMIC",
6492 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006493 }
6494 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006495
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006496# check for mutex_trylock_recursive usage
6497 if ($line =~ /mutex_trylock_recursive/) {
6498 ERROR("LOCKING",
6499 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6500 }
6501
Peter Zijlstra1704f472010-03-19 01:37:42 +01006502# check for lockdep_set_novalidate_class
6503 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6504 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6505 if ($realfile !~ m@^kernel/lockdep@ &&
6506 $realfile !~ m@^include/linux/lockdep@ &&
6507 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006508 ERROR("LOCKDEP",
6509 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006510 }
6511 }
Dave Jones88f88312011-01-12 16:59:59 -08006512
Joe Perchesb392c642015-04-16 12:44:16 -07006513 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6514 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006515 WARN("EXPORTED_WORLD_WRITABLE",
6516 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006517 }
Joe Perches24358802014-04-03 14:49:13 -07006518
Joe Perches00180462018-02-06 15:38:55 -08006519# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6520# and whether or not function naming is typical and if
6521# DEVICE_ATTR permissions uses are unusual too
Joe Perches5b579802018-08-21 21:57:33 -07006522 if ($perl_version_ok &&
Joe Perches00180462018-02-06 15:38:55 -08006523 defined $stat &&
6524 $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*\)/) {
6525 my $var = $1;
6526 my $perms = $2;
6527 my $show = $3;
6528 my $store = $4;
6529 my $octal_perms = perms_to_octal($perms);
6530 if ($show =~ /^${var}_show$/ &&
6531 $store =~ /^${var}_store$/ &&
6532 $octal_perms eq "0644") {
6533 if (WARN("DEVICE_ATTR_RW",
6534 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6535 $fix) {
6536 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6537 }
6538 } elsif ($show =~ /^${var}_show$/ &&
6539 $store =~ /^NULL$/ &&
6540 $octal_perms eq "0444") {
6541 if (WARN("DEVICE_ATTR_RO",
6542 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6543 $fix) {
6544 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6545 }
6546 } elsif ($show =~ /^NULL$/ &&
6547 $store =~ /^${var}_store$/ &&
6548 $octal_perms eq "0200") {
6549 if (WARN("DEVICE_ATTR_WO",
6550 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6551 $fix) {
6552 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6553 }
6554 } elsif ($octal_perms eq "0644" ||
6555 $octal_perms eq "0444" ||
6556 $octal_perms eq "0200") {
6557 my $newshow = "$show";
6558 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6559 my $newstore = $store;
6560 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6561 my $rename = "";
6562 if ($show ne $newshow) {
6563 $rename .= " '$show' to '$newshow'";
6564 }
6565 if ($store ne $newstore) {
6566 $rename .= " '$store' to '$newstore'";
6567 }
6568 WARN("DEVICE_ATTR_FUNCTIONS",
6569 "Consider renaming function(s)$rename\n" . $herecurr);
6570 } else {
6571 WARN("DEVICE_ATTR_PERMS",
6572 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6573 }
6574 }
6575
Joe Perches515a2352014-04-03 14:49:24 -07006576# Mode permission misuses where it seems decimal should be octal
6577# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006578# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6579# specific definition of not visible in sysfs.
6580# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6581# use the default permissions
Joe Perches5b579802018-08-21 21:57:33 -07006582 if ($perl_version_ok &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006583 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006584 $line =~ /$mode_perms_search/) {
6585 foreach my $entry (@mode_permission_funcs) {
6586 my $func = $entry->[0];
6587 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006588
Joe Perches459cf0a2016-10-11 13:52:19 -07006589 my $lc = $stat =~ tr@\n@@;
6590 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006591 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006592
Joe Perches515a2352014-04-03 14:49:24 -07006593 my $skip_args = "";
6594 if ($arg_pos > 1) {
6595 $arg_pos--;
6596 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6597 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006598 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006599 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006600 my $val = $1;
6601 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006602 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6603 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6604 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006605 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006606 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006607 }
6608 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006609 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006610 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006611 }
Joe Perches24358802014-04-03 14:49:13 -07006612 }
6613 }
6614 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006615
Joe Perches459cf0a2016-10-11 13:52:19 -07006616# check for uses of S_<PERMS> that could be octal for readability
Joe Perchesbc22d9a2018-04-10 16:33:53 -07006617 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) {
Joe Perches00180462018-02-06 15:38:55 -08006618 my $oval = $1;
6619 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006620 if (WARN("SYMBOLIC_PERMS",
6621 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6622 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006623 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006624 }
6625 }
6626
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006627# validate content of MODULE_LICENSE against list from include/linux/module.h
6628 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6629 my $extracted_string = get_quoted_string($line, $rawline);
6630 my $valid_licenses = qr{
6631 GPL|
6632 GPL\ v2|
6633 GPL\ and\ additional\ rights|
6634 Dual\ BSD/GPL|
6635 Dual\ MIT/GPL|
6636 Dual\ MPL/GPL|
6637 Proprietary
6638 }x;
6639 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6640 WARN("MODULE_LICENSE",
6641 "unknown module license " . $extracted_string . "\n" . $herecurr);
6642 }
6643 }
Matteo Croce6a8d76c2019-07-16 16:27:48 -07006644
6645# check for sysctl duplicate constants
6646 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) {
6647 WARN("DUPLICATED_SYSCTL_CONST",
6648 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6649 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006650 }
6651
6652 # If we have no input at all, then there is nothing to report on
6653 # so just keep quiet.
6654 if ($#rawlines == -1) {
6655 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006656 }
6657
Andy Whitcroft8905a672007-11-28 16:21:06 -08006658 # In mailback mode only produce a report in the negative, for
6659 # things that appear to be patches.
6660 if ($mailback && ($clean == 1 || !$is_patch)) {
6661 exit(0);
6662 }
6663
6664 # This is not a patch, and we are are in 'no-patch' mode so
6665 # just keep quiet.
6666 if (!$chk_patch && !$is_patch) {
6667 exit(0);
6668 }
6669
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006670 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006671 ERROR("NOT_UNIFIED_DIFF",
6672 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006673 }
Geert Uytterhoevencd261492018-08-21 21:57:40 -07006674 if ($is_patch && $has_commit_log && $chk_signoff) {
6675 if ($signoff == 0) {
6676 ERROR("MISSING_SIGN_OFF",
6677 "Missing Signed-off-by: line(s)\n");
6678 } elsif (!$authorsignoff) {
6679 WARN("NO_AUTHOR_SIGN_OFF",
6680 "Missing Signed-off-by: line by nominal patch author '$author'\n");
6681 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006682 }
6683
Andy Whitcroft8905a672007-11-28 16:21:06 -08006684 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006685 if ($summary && !($clean == 1 && $quiet == 1)) {
6686 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006687 print "total: $cnt_error errors, $cnt_warn warnings, " .
6688 (($check)? "$cnt_chk checks, " : "") .
6689 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006690 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006691
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006692 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006693 # If there were any defects found and not already fixing them
6694 if (!$clean and !$fix) {
6695 print << "EOM"
6696
6697NOTE: For some of the reported defects, checkpatch may be able to
6698 mechanically convert to the typical style using --fix or --fix-inplace.
6699EOM
6700 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006701 # If there were whitespace errors which cleanpatch can fix
6702 # then suggest that.
6703 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006704 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006705 print << "EOM"
6706
6707NOTE: Whitespace errors detected.
6708 You may wish to use scripts/cleanpatch or scripts/cleanfile
6709EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006710 }
6711 }
6712
Joe Perchesd752fcc2014-08-06 16:11:05 -07006713 if ($clean == 0 && $fix &&
6714 ("@rawlines" ne "@fixed" ||
6715 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006716 my $newfile = $filename;
6717 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006718 my $linecount = 0;
6719 my $f;
6720
Joe Perchesd752fcc2014-08-06 16:11:05 -07006721 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6722
Joe Perches3705ce52013-07-03 15:05:31 -07006723 open($f, '>', $newfile)
6724 or die "$P: Can't open $newfile for write\n";
6725 foreach my $fixed_line (@fixed) {
6726 $linecount++;
6727 if ($file) {
6728 if ($linecount > 3) {
6729 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006730 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006731 }
6732 } else {
6733 print $f $fixed_line . "\n";
6734 }
6735 }
6736 close($f);
6737
6738 if (!$quiet) {
6739 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006740
Joe Perches3705ce52013-07-03 15:05:31 -07006741Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6742
6743Do _NOT_ trust the results written to this file.
6744Do _NOT_ submit these changes without inspecting them for correctness.
6745
6746This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6747No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006748EOM
6749 }
6750 }
6751
Joe Perchesd8469f12015-06-25 15:03:00 -07006752 if ($quiet == 0) {
6753 print "\n";
6754 if ($clean == 1) {
6755 print "$vname has no obvious style problems and is ready for submission.\n";
6756 } else {
6757 print "$vname has style problems, please review.\n";
6758 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006759 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006760 return $clean;
6761}