blob: a0808e46c6fe30f72b6aaf08a9896fac848cb124 [file] [log] [blame]
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02001#!/usr/bin/env perl
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02009use warnings;
Joe Perchesc707a812013-07-08 16:00:43 -070010use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080011use File::Basename;
12use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070013use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070014
15my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080016my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070017
Joe Perches000d1cc12011-07-25 17:13:25 -070018my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070019
20use Getopt::Long qw(:config no_auto_abbrev);
21
22my $quiet = 0;
23my $tree = 1;
24my $chk_signoff = 1;
25my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070026my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070027my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080028my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070029my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070031my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070032my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070034my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080035my $summary = 1;
36my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080037my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070038my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070039my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070040my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080041my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070042my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080043my %debug;
Joe Perches34456862013-07-03 15:05:34 -070044my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070045my %use_type = ();
46my @use = ();
47my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070048my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070049my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070050my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080051my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070052my $ignore_perl_version = 0;
53my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070054my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070055my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070056my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070057my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070058my $conststructsfile = "$D/const_structs.checkpatch";
Jerome Forissier75ad8c52017-05-08 15:56:00 -070059my $typedefsfile = "";
John Brooks737c0762017-07-10 15:52:24 -070060my $color = "auto";
Joe Perchesdadf6802016-08-02 14:04:33 -070061my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070062
63sub help {
64 my ($exitcode) = @_;
65
66 print << "EOM";
67Usage: $P [OPTION]... [FILE]...
68Version: $V
69
70Options:
71 -q, --quiet quiet
72 --no-tree run without a kernel tree
73 --no-signoff do not check for 'Signed-off-by' line
74 --patch treat FILE as patchfile (default)
75 --emacs emacs compile window format
76 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070077 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070078 -g, --git treat FILE as a single commit or git revision range
79 single git commit with:
80 <rev>
81 <rev>^
82 <rev>~n
83 multiple git commits with:
84 <rev1>..<rev2>
85 <rev1>...<rev2>
86 <rev>-<count>
87 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070088 -f, --file treat FILE as regular source file
89 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070090 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070091 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070092 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070093 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080094 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070095 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070096 --root=PATH PATH to the kernel tree root
97 --no-summary suppress the per-file summary
98 --mailback only produce a report in case of warnings/errors
99 --summary-file include the filename in summary
100 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
101 'values', 'possible', 'type', and 'attr' (default
102 is all off)
103 --test-only=WORD report only warnings/errors containing WORD
104 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700105 --fix EXPERIMENTAL - may create horrible results
106 If correctable single-line errors exist, create
107 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
108 with potential errors corrected to the preferred
109 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800110 --fix-inplace EXPERIMENTAL - may create horrible results
111 Is the same as --fix, but overwrites the input
112 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700113 --ignore-perl-version override checking of perl version. expect
114 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700115 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700116 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700117 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700118 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700119 --color[=WHEN] Use colors 'always', 'never', or only when output
120 is a terminal ('auto'). Default is 'auto'.
Hannes Eder77f5b102009-09-21 17:04:37 -0700121 -h, --help, --version display this help and exit
122
123When FILE is - read standard input.
124EOM
125
126 exit($exitcode);
127}
128
Joe Perches3beb42e2016-05-20 17:04:14 -0700129sub uniq {
130 my %seen;
131 return grep { !$seen{$_}++ } @_;
132}
133
134sub list_types {
135 my ($exitcode) = @_;
136
137 my $count = 0;
138
139 local $/ = undef;
140
141 open(my $script, '<', abs_path($P)) or
142 die "$P: Can't read '$P' $!\n";
143
144 my $text = <$script>;
145 close($script);
146
147 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700148 # Also catch when type or level is passed through a variable
149 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700150 push (@types, $_);
151 }
152 @types = sort(uniq(@types));
153 print("#\tMessage type\n\n");
154 foreach my $type (@types) {
155 print(++$count . "\t" . $type . "\n");
156 }
157
158 exit($exitcode);
159}
160
Joe Perches000d1cc12011-07-25 17:13:25 -0700161my $conf = which_conf($configuration_file);
162if (-f $conf) {
163 my @conf_args;
164 open(my $conffile, '<', "$conf")
165 or warn "$P: Can't find a readable $configuration_file file $!\n";
166
167 while (<$conffile>) {
168 my $line = $_;
169
170 $line =~ s/\s*\n?$//g;
171 $line =~ s/^\s*//g;
172 $line =~ s/\s+/ /g;
173
174 next if ($line =~ m/^\s*#/);
175 next if ($line =~ m/^\s*$/);
176
177 my @words = split(" ", $line);
178 foreach my $word (@words) {
179 last if ($word =~ m/^#/);
180 push (@conf_args, $word);
181 }
182 }
183 close($conffile);
184 unshift(@ARGV, @conf_args) if @conf_args;
185}
186
John Brooks737c0762017-07-10 15:52:24 -0700187# Perl's Getopt::Long allows options to take optional arguments after a space.
188# Prevent --color by itself from consuming other arguments
189foreach (@ARGV) {
190 if ($_ eq "--color" || $_ eq "-color") {
191 $_ = "--color=$color";
192 }
193}
194
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700195GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700196 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700197 'tree!' => \$tree,
198 'signoff!' => \$chk_signoff,
199 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700200 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800201 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700202 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700203 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700204 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700205 'subjective!' => \$check,
206 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700207 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700208 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700209 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700210 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800211 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700212 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700213 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800214 'summary!' => \$summary,
215 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800216 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700217 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800218 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700219 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800220 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700221 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700222 'codespell!' => \$codespell,
223 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700224 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700225 'color=s' => \$color,
226 'no-color' => \$color, #keep old behaviors of -nocolor
227 'nocolor' => \$color, #keep old behaviors of -nocolor
Hannes Eder77f5b102009-09-21 17:04:37 -0700228 'h|help' => \$help,
229 'version' => \$help
230) or help(1);
231
232help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700233
Joe Perches3beb42e2016-05-20 17:04:14 -0700234list_types(0) if ($list_types);
235
Joe Perches9624b8d2014-01-23 15:54:44 -0800236$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700237$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800238
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700239my $exit = 0;
240
Dave Hansend62a2012013-09-11 14:23:56 -0700241if ($^V && $^V lt $minimum_perl_version) {
242 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
243 if (!$ignore_perl_version) {
244 exit(1);
245 }
246}
247
Allen Hubbe45107ff2016-08-02 14:04:47 -0700248#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700249if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700250 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700251}
252
John Brooks737c0762017-07-10 15:52:24 -0700253if ($color =~ /^[01]$/) {
254 $color = !$color;
255} elsif ($color =~ /^always$/i) {
256 $color = 1;
257} elsif ($color =~ /^never$/i) {
258 $color = 0;
259} elsif ($color =~ /^auto$/i) {
260 $color = (-t STDOUT);
261} else {
262 die "Invalid color mode: $color\n";
263}
264
Joe Perches91bfe482013-09-11 14:23:59 -0700265sub hash_save_array_words {
266 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700267
Joe Perches91bfe482013-09-11 14:23:59 -0700268 my @array = split(/,/, join(',', @$arrayRef));
269 foreach my $word (@array) {
270 $word =~ s/\s*\n?$//g;
271 $word =~ s/^\s*//g;
272 $word =~ s/\s+/ /g;
273 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700274
Joe Perches91bfe482013-09-11 14:23:59 -0700275 next if ($word =~ m/^\s*#/);
276 next if ($word =~ m/^\s*$/);
277
278 $hashRef->{$word}++;
279 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700280}
281
Joe Perches91bfe482013-09-11 14:23:59 -0700282sub hash_show_words {
283 my ($hashRef, $prefix) = @_;
284
Joe Perches3c816e42015-06-25 15:03:29 -0700285 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700286 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700287 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700288 print " $word";
289 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700290 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700291 }
292}
293
294hash_save_array_words(\%ignore_type, \@ignore);
295hash_save_array_words(\%use_type, \@use);
296
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800297my $dbg_values = 0;
298my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700299my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700300my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800301for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800302 ## no critic
303 eval "\${dbg_$key} = '$debug{$key}';";
304 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800305}
306
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700307my $rpt_cleaners = 0;
308
Andy Whitcroft8905a672007-11-28 16:21:06 -0800309if ($terse) {
310 $emacs = 1;
311 $quiet++;
312}
313
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700314if ($tree) {
315 if (defined $root) {
316 if (!top_of_kernel_tree($root)) {
317 die "$P: $root: --root does not point at a valid tree\n";
318 }
319 } else {
320 if (top_of_kernel_tree('.')) {
321 $root = '.';
322 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
323 top_of_kernel_tree($1)) {
324 $root = $1;
325 }
326 }
327
328 if (!defined $root) {
329 print "Must be run from the top-level dir. of a kernel tree\n";
330 exit(2);
331 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700332}
333
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700334my $emitted_corrupt = 0;
335
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700336our $Ident = qr{
337 [A-Za-z_][A-Za-z\d_]*
338 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
339 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700340our $Storage = qr{extern|static|asmlinkage};
341our $Sparse = qr{
342 __user|
343 __kernel|
344 __force|
345 __iomem|
346 __must_check|
347 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800348 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700349 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800350 __rcu|
351 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700352 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800353our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
354our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
355our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
356our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
357our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700358
Wolfram Sang52131292010-03-05 13:43:51 -0800359# Notes to $Attribute:
360# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700361our $Attribute = qr{
362 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700363 __percpu|
364 __nocast|
365 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200366 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700367 __packed__|
368 __packed2__|
369 __naked|
370 __maybe_unused|
371 __always_unused|
372 __noreturn|
373 __used|
374 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800375 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700376 __noclone|
377 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700378 __read_mostly|
379 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700380 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700381 ____cacheline_aligned|
382 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800383 ____cacheline_internodealigned_in_smp|
384 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700385 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700386our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700387our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700388our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
389our $Lval = qr{$Ident(?:$Member)*};
390
Joe Perches95e2c602013-07-03 15:05:20 -0700391our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
392our $Binary = qr{(?i)0b[01]+$Int_type?};
393our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
394our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700395our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800396our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800397our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
398our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
399our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800400our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700401our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800402our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700403our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700404our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700405our $Operators = qr{
406 <=|>=|==|!=|
407 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700408 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700409 }x;
410
Joe Perches91cb5192014-04-03 14:49:32 -0700411our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
412
Joe Perchesab7e23f2015-04-16 12:44:22 -0700413our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800414our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700415our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700416our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800417our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700418our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700420our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800421
Joe Perches15662b32011-10-31 17:13:12 -0700422our $NON_ASCII_UTF8 = qr{
423 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700424 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
425 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
426 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
427 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
428 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
429 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
430}x;
431
Joe Perches15662b32011-10-31 17:13:12 -0700432our $UTF8 = qr{
433 [\x09\x0A\x0D\x20-\x7E] # ASCII
434 | $NON_ASCII_UTF8
435}x;
436
Joe Perchese6176fa2015-06-25 15:02:49 -0700437our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800438our $typeOtherOSTypedefs = qr{(?x:
439 u_(?:char|short|int|long) | # bsd
440 u(?:nchar|short|int|long) # sysv
441)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700442our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700443 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700444 atomic_t
445)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700446our $typeTypedefs = qr{(?x:
447 $typeC99Typedefs\b|
448 $typeOtherOSTypedefs\b|
449 $typeKernelTypedefs\b
450)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700451
Joe Perches6d32f7a2015-11-06 16:31:37 -0800452our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
453
Joe Perches691e6692010-03-05 13:43:51 -0800454our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800455 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700456 (?:[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 -0800457 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700458 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700459 panic|
Joe Perches06668722013-11-12 15:10:07 -0800460 MODULE_[A-Z_]+|
461 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800462)};
463
Joe Perches20112472011-07-25 17:13:23 -0700464our $signature_tags = qr{(?xi:
465 Signed-off-by:|
466 Acked-by:|
467 Tested-by:|
468 Reviewed-by:|
469 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700470 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700471 To:|
472 Cc:
473)};
474
Joe Perches18130872014-08-06 16:11:22 -0700475our @typeListMisordered = (
476 qr{char\s+(?:un)?signed},
477 qr{int\s+(?:(?:un)?signed\s+)?short\s},
478 qr{int\s+short(?:\s+(?:un)?signed)},
479 qr{short\s+int(?:\s+(?:un)?signed)},
480 qr{(?:un)?signed\s+int\s+short},
481 qr{short\s+(?:un)?signed},
482 qr{long\s+int\s+(?:un)?signed},
483 qr{int\s+long\s+(?:un)?signed},
484 qr{long\s+(?:un)?signed\s+int},
485 qr{int\s+(?:un)?signed\s+long},
486 qr{int\s+(?:un)?signed},
487 qr{int\s+long\s+long\s+(?:un)?signed},
488 qr{long\s+long\s+int\s+(?:un)?signed},
489 qr{long\s+long\s+(?:un)?signed\s+int},
490 qr{long\s+long\s+(?:un)?signed},
491 qr{long\s+(?:un)?signed},
492);
493
Andy Whitcroft8905a672007-11-28 16:21:06 -0800494our @typeList = (
495 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700496 qr{(?:(?:un)?signed\s+)?char},
497 qr{(?:(?:un)?signed\s+)?short\s+int},
498 qr{(?:(?:un)?signed\s+)?short},
499 qr{(?:(?:un)?signed\s+)?int},
500 qr{(?:(?:un)?signed\s+)?long\s+int},
501 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
502 qr{(?:(?:un)?signed\s+)?long\s+long},
503 qr{(?:(?:un)?signed\s+)?long},
504 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800505 qr{float},
506 qr{double},
507 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800508 qr{struct\s+$Ident},
509 qr{union\s+$Ident},
510 qr{enum\s+$Ident},
511 qr{${Ident}_t},
512 qr{${Ident}_handler},
513 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700514 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800515);
Joe Perches938224b2016-01-20 14:59:15 -0800516
517our $C90_int_types = qr{(?x:
518 long\s+long\s+int\s+(?:un)?signed|
519 long\s+long\s+(?:un)?signed\s+int|
520 long\s+long\s+(?:un)?signed|
521 (?:(?:un)?signed\s+)?long\s+long\s+int|
522 (?:(?:un)?signed\s+)?long\s+long|
523 int\s+long\s+long\s+(?:un)?signed|
524 int\s+(?:(?:un)?signed\s+)?long\s+long|
525
526 long\s+int\s+(?:un)?signed|
527 long\s+(?:un)?signed\s+int|
528 long\s+(?:un)?signed|
529 (?:(?:un)?signed\s+)?long\s+int|
530 (?:(?:un)?signed\s+)?long|
531 int\s+long\s+(?:un)?signed|
532 int\s+(?:(?:un)?signed\s+)?long|
533
534 int\s+(?:un)?signed|
535 (?:(?:un)?signed\s+)?int
536)};
537
Alex Dowad485ff232015-06-25 15:02:52 -0700538our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700539our @typeListWithAttr = (
540 @typeList,
541 qr{struct\s+$InitAttribute\s+$Ident},
542 qr{union\s+$InitAttribute\s+$Ident},
543);
544
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700545our @modifierList = (
546 qr{fastcall},
547);
Alex Dowad485ff232015-06-25 15:02:52 -0700548our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800549
Joe Perches24358802014-04-03 14:49:13 -0700550our @mode_permission_funcs = (
551 ["module_param", 3],
552 ["module_param_(?:array|named|string)", 4],
553 ["module_param_array_named", 5],
554 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
555 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700556 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
557 ["IIO_DEV_ATTR_[A-Z_]+", 1],
558 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
559 ["SENSOR_TEMPLATE(?:_2|)", 3],
560 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700561);
562
Joe Perches515a2352014-04-03 14:49:24 -0700563#Create a search pattern for all these functions to speed up a loop below
564our $mode_perms_search = "";
565foreach my $entry (@mode_permission_funcs) {
566 $mode_perms_search .= '|' if ($mode_perms_search ne "");
567 $mode_perms_search .= $entry->[0];
568}
Joe Perches00180462018-02-06 15:38:55 -0800569$mode_perms_search = "(?:${mode_perms_search})";
Joe Perches515a2352014-04-03 14:49:24 -0700570
Joe Perchesb392c642015-04-16 12:44:16 -0700571our $mode_perms_world_writable = qr{
572 S_IWUGO |
573 S_IWOTH |
574 S_IRWXUGO |
575 S_IALLUGO |
576 0[0-7][0-7][2367]
577}x;
578
Joe Perchesf90774e2016-10-11 13:51:47 -0700579our %mode_permission_string_types = (
580 "S_IRWXU" => 0700,
581 "S_IRUSR" => 0400,
582 "S_IWUSR" => 0200,
583 "S_IXUSR" => 0100,
584 "S_IRWXG" => 0070,
585 "S_IRGRP" => 0040,
586 "S_IWGRP" => 0020,
587 "S_IXGRP" => 0010,
588 "S_IRWXO" => 0007,
589 "S_IROTH" => 0004,
590 "S_IWOTH" => 0002,
591 "S_IXOTH" => 0001,
592 "S_IRWXUGO" => 0777,
593 "S_IRUGO" => 0444,
594 "S_IWUGO" => 0222,
595 "S_IXUGO" => 0111,
596);
597
598#Create a search pattern for all these strings to speed up a loop below
599our $mode_perms_string_search = "";
600foreach my $entry (keys %mode_permission_string_types) {
601 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
602 $mode_perms_string_search .= $entry;
603}
Joe Perches00180462018-02-06 15:38:55 -0800604our $single_mode_perms_string_search = "(?:${mode_perms_string_search})";
605our $multi_mode_perms_string_search = qr{
606 ${single_mode_perms_string_search}
607 (?:\s*\|\s*${single_mode_perms_string_search})*
608}x;
609
610sub perms_to_octal {
611 my ($string) = @_;
612
613 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/);
614
615 my $val = "";
616 my $oval = "";
617 my $to = 0;
618 my $curpos = 0;
619 my $lastpos = 0;
620 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
621 $curpos = pos($string);
622 my $match = $2;
623 my $omatch = $1;
624 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
625 $lastpos = $curpos;
626 $to |= $mode_permission_string_types{$match};
627 $val .= '\s*\|\s*' if ($val ne "");
628 $val .= $match;
629 $oval .= $omatch;
630 }
631 $oval =~ s/^\s*\|\s*//;
632 $oval =~ s/\s*\|\s*$//;
633 return sprintf("%04o", $to);
634}
Joe Perchesf90774e2016-10-11 13:51:47 -0700635
Wolfram Sang7840a942010-08-09 17:20:57 -0700636our $allowed_asm_includes = qr{(?x:
637 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700638 memory|
639 time|
640 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700641)};
642# memory.h: ARM has a custom one
643
Kees Cook66b47b42014-10-13 15:51:57 -0700644# Load common spelling mistakes and build regular expression list.
645my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700646my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700647
Joe Perches36061e32014-12-10 15:51:43 -0800648if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800649 while (<$spelling>) {
650 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700651
Joe Perches36061e32014-12-10 15:51:43 -0800652 $line =~ s/\s*\n?$//g;
653 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700654
Joe Perches36061e32014-12-10 15:51:43 -0800655 next if ($line =~ m/^\s*#/);
656 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700657
Joe Perches36061e32014-12-10 15:51:43 -0800658 my ($suspect, $fix) = split(/\|\|/, $line);
659
Joe Perches36061e32014-12-10 15:51:43 -0800660 $spelling_fix{$suspect} = $fix;
661 }
662 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800663} else {
664 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700665}
Kees Cook66b47b42014-10-13 15:51:57 -0700666
Joe Perchesebfd7d62015-04-16 12:44:14 -0700667if ($codespell) {
668 if (open(my $spelling, '<', $codespellfile)) {
669 while (<$spelling>) {
670 my $line = $_;
671
672 $line =~ s/\s*\n?$//g;
673 $line =~ s/^\s*//g;
674
675 next if ($line =~ m/^\s*#/);
676 next if ($line =~ m/^\s*$/);
677 next if ($line =~ m/, disabled/i);
678
679 $line =~ s/,.*$//;
680
681 my ($suspect, $fix) = split(/->/, $line);
682
683 $spelling_fix{$suspect} = $fix;
684 }
685 close($spelling);
686 } else {
687 warn "No codespell typos will be found - file '$codespellfile': $!\n";
688 }
689}
690
691$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
692
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700693sub read_words {
694 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700695
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700696 if (open(my $words, '<', $file)) {
697 while (<$words>) {
698 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700699
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700700 $line =~ s/\s*\n?$//g;
701 $line =~ s/^\s*//g;
702
703 next if ($line =~ m/^\s*#/);
704 next if ($line =~ m/^\s*$/);
705 if ($line =~ /\s/) {
706 print("$file: '$line' invalid - ignored\n");
707 next;
708 }
709
710 $$wordsRef .= '|' if ($$wordsRef ne "");
711 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700712 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700713 close($file);
714 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700715 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700716
717 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700718}
719
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700720my $const_structs = "";
721read_words(\$const_structs, $conststructsfile)
722 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
723
724my $typeOtherTypedefs = "";
725if (length($typedefsfile)) {
726 read_words(\$typeOtherTypedefs, $typedefsfile)
727 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
728}
729$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
730
Andy Whitcroft8905a672007-11-28 16:21:06 -0800731sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700732 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
733 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700734 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700735 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700736 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700737 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700738 (?:$typeTypedefs\b)|
739 (?:${all}\b)
740 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800741 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700742 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800743 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800744 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700745 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700746 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800747 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700748 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800749 }x;
Joe Perches18130872014-08-06 16:11:22 -0700750 $NonptrTypeMisordered = qr{
751 (?:$Modifier\s+|const\s+)*
752 (?:
753 (?:${Misordered}\b)
754 )
755 (?:\s+$Modifier|\s+const)*
756 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700757 $NonptrTypeWithAttr = qr{
758 (?:$Modifier\s+|const\s+)*
759 (?:
760 (?:typeof|__typeof__)\s*\([^\)]*\)|
761 (?:$typeTypedefs\b)|
762 (?:${allWithAttr}\b)
763 )
764 (?:\s+$Modifier|\s+const)*
765 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800766 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700767 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700768 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700769 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800770 }x;
Joe Perches18130872014-08-06 16:11:22 -0700771 $TypeMisordered = qr{
772 $NonptrTypeMisordered
773 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
774 (?:\s+$Inline|\s+$Modifier)*
775 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700776 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700777 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800778}
779build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700780
Joe Perches7d2367a2011-07-25 17:13:22 -0700781our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700782
783# Using $balanced_parens, $LvalOrFunc, or $FuncArg
784# requires at least perl version v5.10.0
785# Any use must be runtime checked with $^V
786
787our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700788our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800789our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700790
Joe Perchesf8422302014-08-06 16:11:31 -0700791our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700792 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700793 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Gilad Ben-Yossef3d102fc2018-04-10 16:33:17 -0700794 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(|
795 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\(
Joe Perchesf8422302014-08-06 16:11:31 -0700796)};
797
Joe Perches7d2367a2011-07-25 17:13:22 -0700798sub deparenthesize {
799 my ($string) = @_;
800 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700801
802 while ($string =~ /^\s*\(.*\)\s*$/) {
803 $string =~ s@^\s*\(\s*@@;
804 $string =~ s@\s*\)\s*$@@;
805 }
806
Joe Perches7d2367a2011-07-25 17:13:22 -0700807 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700808
Joe Perches7d2367a2011-07-25 17:13:22 -0700809 return $string;
810}
811
Joe Perches34456862013-07-03 15:05:34 -0700812sub seed_camelcase_file {
813 my ($file) = @_;
814
815 return if (!(-f $file));
816
817 local $/;
818
819 open(my $include_file, '<', "$file")
820 or warn "$P: Can't read '$file' $!\n";
821 my $text = <$include_file>;
822 close($include_file);
823
824 my @lines = split('\n', $text);
825
826 foreach my $line (@lines) {
827 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
828 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
829 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800830 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
831 $camelcase{$1} = 1;
832 } 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 -0700833 $camelcase{$1} = 1;
834 }
835 }
836}
837
Joe Perches85b0ee12016-10-11 13:51:44 -0700838sub is_maintained_obsolete {
839 my ($filename) = @_;
840
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800841 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700842
Joe Perches0616efa2016-10-11 13:52:02 -0700843 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 -0700844
845 return $status =~ /obsolete/i;
846}
847
Joe Perches34456862013-07-03 15:05:34 -0700848my $camelcase_seeded = 0;
849sub seed_camelcase_includes {
850 return if ($camelcase_seeded);
851
852 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700853 my $camelcase_cache = "";
854 my @include_files = ();
855
856 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700857
Richard Genoud3645e322014-02-10 14:25:32 -0800858 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700859 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
860 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700861 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700862 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700863 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700864 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700865 @include_files = split('\n', $files);
866 foreach my $file (@include_files) {
867 my $date = POSIX::strftime("%Y%m%d%H%M",
868 localtime((stat $file)[9]));
869 $last_mod_date = $date if ($last_mod_date < $date);
870 }
871 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700872 }
Joe Perchesc707a812013-07-08 16:00:43 -0700873
874 if ($camelcase_cache ne "" && -f $camelcase_cache) {
875 open(my $camelcase_file, '<', "$camelcase_cache")
876 or warn "$P: Can't read '$camelcase_cache' $!\n";
877 while (<$camelcase_file>) {
878 chomp;
879 $camelcase{$_} = 1;
880 }
881 close($camelcase_file);
882
883 return;
884 }
885
Richard Genoud3645e322014-02-10 14:25:32 -0800886 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700887 $files = `git ls-files "include/*.h"`;
888 @include_files = split('\n', $files);
889 }
890
Joe Perches34456862013-07-03 15:05:34 -0700891 foreach my $file (@include_files) {
892 seed_camelcase_file($file);
893 }
Joe Perches351b2a12013-07-03 15:05:36 -0700894
Joe Perchesc707a812013-07-08 16:00:43 -0700895 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700896 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700897 open(my $camelcase_file, '>', "$camelcase_cache")
898 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700899 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
900 print $camelcase_file ("$_\n");
901 }
902 close($camelcase_file);
903 }
Joe Perches34456862013-07-03 15:05:34 -0700904}
905
Joe Perchesd311cd42014-08-06 16:10:57 -0700906sub git_commit_info {
907 my ($commit, $id, $desc) = @_;
908
909 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
910
911 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
912 $output =~ s/^\s*//gm;
913 my @lines = split("\n", $output);
914
Joe Perches0d7835f2015-02-13 14:38:35 -0800915 return ($id, $desc) if ($#lines < 0);
916
Joe Perchesd311cd42014-08-06 16:10:57 -0700917 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
918# Maybe one day convert this block of bash into something that returns
919# all matching commit ids, but it's very slow...
920#
921# echo "checking commits $1..."
922# git rev-list --remotes | grep -i "^$1" |
923# while read line ; do
924# git log --format='%H %s' -1 $line |
925# echo "commit $(cut -c 1-12,41-)"
926# done
927 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700928 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700929 } else {
930 $id = substr($lines[0], 0, 12);
931 $desc = substr($lines[0], 41);
932 }
933
934 return ($id, $desc);
935}
936
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700937$chk_signoff = 0 if ($file);
938
Andy Whitcroft00df3442007-06-08 13:47:06 -0700939my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800940my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700941my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700942my @fixed_inserted = ();
943my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700944my $fixlinenr = -1;
945
Du, Changbin4a593c32016-05-20 17:04:16 -0700946# If input is git commits, extract all commits from the commit expressions.
947# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
948die "$P: No git repository found\n" if ($git && !-e ".git");
949
950if ($git) {
951 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700952 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700953 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700954 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
955 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700956 } elsif ($commit_expr =~ m/\.\./) {
957 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700958 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700959 $git_range = "-1 $commit_expr";
960 }
961 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
962 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700963 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
964 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700965 my $sha1 = $1;
966 my $subject = $2;
967 unshift(@commits, $sha1);
968 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700969 }
970 }
971 die "$P: no git commits after extraction!\n" if (@commits == 0);
972 @ARGV = @commits;
973}
974
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800975my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700976for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800977 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700978 if ($git) {
979 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
980 die "$P: $filename: git format-patch failed - $!\n";
981 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800982 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700983 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800984 } elsif ($filename eq '-') {
985 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700986 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800987 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700988 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700989 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800990 if ($filename eq '-') {
991 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700992 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700993 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800994 } else {
995 $vname = $filename;
996 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800997 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700998 chomp;
999 push(@rawlines, $_);
1000 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001001 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001002
1003 if ($#ARGV > 0 && $quiet == 0) {
1004 print '-' x length($vname) . "\n";
1005 print "$vname\n";
1006 print '-' x length($vname) . "\n";
1007 }
1008
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001009 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001010 $exit = 1;
1011 }
1012 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001013 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001014 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001015 @fixed_inserted = ();
1016 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001017 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001018 @modifierListFile = ();
1019 @typeListFile = ();
1020 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001021}
1022
Joe Perchesd8469f12015-06-25 15:03:00 -07001023if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001024 hash_show_words(\%use_type, "Used");
1025 hash_show_words(\%ignore_type, "Ignored");
1026
Joe Perchesd8469f12015-06-25 15:03:00 -07001027 if ($^V lt 5.10.0) {
1028 print << "EOM"
1029
1030NOTE: perl $^V is not modern enough to detect all possible issues.
1031 An upgrade to at least perl v5.10.0 is suggested.
1032EOM
1033 }
1034 if ($exit) {
1035 print << "EOM"
1036
1037NOTE: If any of the errors are false positives, please report
1038 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1039EOM
1040 }
1041}
1042
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001043exit($exit);
1044
1045sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001046 my ($root) = @_;
1047
1048 my @tree_check = (
1049 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1050 "README", "Documentation", "arch", "include", "drivers",
1051 "fs", "init", "ipc", "kernel", "lib", "scripts",
1052 );
1053
1054 foreach my $check (@tree_check) {
1055 if (! -e $root . '/' . $check) {
1056 return 0;
1057 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001058 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001059 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001060}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001061
Joe Perches20112472011-07-25 17:13:23 -07001062sub parse_email {
1063 my ($formatted_email) = @_;
1064
1065 my $name = "";
1066 my $address = "";
1067 my $comment = "";
1068
1069 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1070 $name = $1;
1071 $address = $2;
1072 $comment = $3 if defined $3;
1073 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1074 $address = $1;
1075 $comment = $2 if defined $2;
1076 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1077 $address = $1;
1078 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001079 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001080 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001081 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001082 $name =~ s/^\"|\"$//g;
1083 # If there's a name left after stripping spaces and
1084 # leading quotes, and the address doesn't have both
1085 # leading and trailing angle brackets, the address
1086 # is invalid. ie:
1087 # "joe smith joe@smith.com" bad
1088 # "joe smith <joe@smith.com" bad
1089 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1090 $name = "";
1091 $address = "";
1092 $comment = "";
1093 }
1094 }
1095
Joe Perches3705ce52013-07-03 15:05:31 -07001096 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001097 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001098 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001099 $address =~ s/^\<|\>$//g;
1100
1101 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1102 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1103 $name = "\"$name\"";
1104 }
1105
1106 return ($name, $address, $comment);
1107}
1108
1109sub format_email {
1110 my ($name, $address) = @_;
1111
1112 my $formatted_email;
1113
Joe Perches3705ce52013-07-03 15:05:31 -07001114 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001115 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001116 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001117
1118 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1119 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1120 $name = "\"$name\"";
1121 }
1122
1123 if ("$name" eq "") {
1124 $formatted_email = "$address";
1125 } else {
1126 $formatted_email = "$name <$address>";
1127 }
1128
1129 return $formatted_email;
1130}
1131
Joe Perchesd311cd42014-08-06 16:10:57 -07001132sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001133 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001134
Joe Perchesbd474ca2014-08-06 16:11:10 -07001135 foreach my $path (split(/:/, $ENV{PATH})) {
1136 if (-e "$path/$bin") {
1137 return "$path/$bin";
1138 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001139 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001140
Joe Perchesbd474ca2014-08-06 16:11:10 -07001141 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001142}
1143
Joe Perches000d1cc12011-07-25 17:13:25 -07001144sub which_conf {
1145 my ($conf) = @_;
1146
1147 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1148 if (-e "$path/$conf") {
1149 return "$path/$conf";
1150 }
1151 }
1152
1153 return "";
1154}
1155
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001156sub expand_tabs {
1157 my ($str) = @_;
1158
1159 my $res = '';
1160 my $n = 0;
1161 for my $c (split(//, $str)) {
1162 if ($c eq "\t") {
1163 $res .= ' ';
1164 $n++;
1165 for (; ($n % 8) != 0; $n++) {
1166 $res .= ' ';
1167 }
1168 next;
1169 }
1170 $res .= $c;
1171 $n++;
1172 }
1173
1174 return $res;
1175}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001176sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001177 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001178 return $res;
1179}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001180
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001181sub line_stats {
1182 my ($line) = @_;
1183
1184 # Drop the diff line leader and expand tabs
1185 $line =~ s/^.//;
1186 $line = expand_tabs($line);
1187
1188 # Pick the indent from the front of the line.
1189 my ($white) = ($line =~ /^(\s*)/);
1190
1191 return (length($line), length($white));
1192}
1193
Andy Whitcroft773647a2008-03-28 14:15:58 -07001194my $sanitise_quote = '';
1195
1196sub sanitise_line_reset {
1197 my ($in_comment) = @_;
1198
1199 if ($in_comment) {
1200 $sanitise_quote = '*/';
1201 } else {
1202 $sanitise_quote = '';
1203 }
1204}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001205sub sanitise_line {
1206 my ($line) = @_;
1207
1208 my $res = '';
1209 my $l = '';
1210
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001211 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001212 my $off = 0;
1213 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001214
Andy Whitcroft773647a2008-03-28 14:15:58 -07001215 # Always copy over the diff marker.
1216 $res = substr($line, 0, 1);
1217
1218 for ($off = 1; $off < length($line); $off++) {
1219 $c = substr($line, $off, 1);
1220
1221 # Comments we are wacking completly including the begin
1222 # and end, all to $;.
1223 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1224 $sanitise_quote = '*/';
1225
1226 substr($res, $off, 2, "$;$;");
1227 $off++;
1228 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001229 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001230 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001231 $sanitise_quote = '';
1232 substr($res, $off, 2, "$;$;");
1233 $off++;
1234 next;
1235 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001236 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1237 $sanitise_quote = '//';
1238
1239 substr($res, $off, 2, $sanitise_quote);
1240 $off++;
1241 next;
1242 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001243
1244 # A \ in a string means ignore the next character.
1245 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1246 $c eq "\\") {
1247 substr($res, $off, 2, 'XX');
1248 $off++;
1249 next;
1250 }
1251 # Regular quotes.
1252 if ($c eq "'" || $c eq '"') {
1253 if ($sanitise_quote eq '') {
1254 $sanitise_quote = $c;
1255
1256 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001257 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001258 } elsif ($sanitise_quote eq $c) {
1259 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001260 }
1261 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001262
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001263 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001264 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1265 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001266 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1267 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001268 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1269 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001270 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001271 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001272 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001273 }
1274
Daniel Walker113f04a2009-09-21 17:04:35 -07001275 if ($sanitise_quote eq '//') {
1276 $sanitise_quote = '';
1277 }
1278
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001279 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001280 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001281 my $clean = 'X' x length($1);
1282 $res =~ s@\<.*\>@<$clean>@;
1283
1284 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001285 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001286 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001287 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001288 }
1289
Joe Perchesdadf6802016-08-02 14:04:33 -07001290 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1291 my $match = $1;
1292 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1293 }
1294
Andy Whitcroft00df3442007-06-08 13:47:06 -07001295 return $res;
1296}
1297
Joe Perchesa6962d72013-04-29 16:18:13 -07001298sub get_quoted_string {
1299 my ($line, $rawline) = @_;
1300
Joe Perches33acb542015-06-25 15:02:54 -07001301 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001302 return substr($rawline, $-[0], $+[0] - $-[0]);
1303}
1304
Andy Whitcroft8905a672007-11-28 16:21:06 -08001305sub ctx_statement_block {
1306 my ($linenr, $remain, $off) = @_;
1307 my $line = $linenr - 1;
1308 my $blk = '';
1309 my $soff = $off;
1310 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001311 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001312
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001313 my $loff = 0;
1314
Andy Whitcroft8905a672007-11-28 16:21:06 -08001315 my $type = '';
1316 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001317 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001318 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001319 my $c;
1320 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001321
1322 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001323 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001324 @stack = (['', 0]) if ($#stack == -1);
1325
Andy Whitcroft773647a2008-03-28 14:15:58 -07001326 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001327 # If we are about to drop off the end, pull in more
1328 # context.
1329 if ($off >= $len) {
1330 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001331 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001332 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001333 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001334 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001335 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001336 $len = length($blk);
1337 $line++;
1338 last;
1339 }
1340 # Bail if there is no further context.
1341 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001342 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001343 last;
1344 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001345 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1346 $level++;
1347 $type = '#';
1348 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001349 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001350 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001351 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001352 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001353
Andy Whitcroft773647a2008-03-28 14:15:58 -07001354 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001355
1356 # Handle nested #if/#else.
1357 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1358 push(@stack, [ $type, $level ]);
1359 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1360 ($type, $level) = @{$stack[$#stack - 1]};
1361 } elsif ($remainder =~ /^#\s*endif\b/) {
1362 ($type, $level) = @{pop(@stack)};
1363 }
1364
Andy Whitcroft8905a672007-11-28 16:21:06 -08001365 # Statement ends at the ';' or a close '}' at the
1366 # outermost level.
1367 if ($level == 0 && $c eq ';') {
1368 last;
1369 }
1370
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001371 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001372 if ($level == 0 && $coff_set == 0 &&
1373 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1374 $remainder =~ /^(else)(?:\s|{)/ &&
1375 $remainder !~ /^else\s+if\b/) {
1376 $coff = $off + length($1) - 1;
1377 $coff_set = 1;
1378 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1379 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001380 }
1381
Andy Whitcroft8905a672007-11-28 16:21:06 -08001382 if (($type eq '' || $type eq '(') && $c eq '(') {
1383 $level++;
1384 $type = '(';
1385 }
1386 if ($type eq '(' && $c eq ')') {
1387 $level--;
1388 $type = ($level != 0)? '(' : '';
1389
1390 if ($level == 0 && $coff < $soff) {
1391 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001392 $coff_set = 1;
1393 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001394 }
1395 }
1396 if (($type eq '' || $type eq '{') && $c eq '{') {
1397 $level++;
1398 $type = '{';
1399 }
1400 if ($type eq '{' && $c eq '}') {
1401 $level--;
1402 $type = ($level != 0)? '{' : '';
1403
1404 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001405 if (substr($blk, $off + 1, 1) eq ';') {
1406 $off++;
1407 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001408 last;
1409 }
1410 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001411 # Preprocessor commands end at the newline unless escaped.
1412 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1413 $level--;
1414 $type = '';
1415 $off++;
1416 last;
1417 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001418 $off++;
1419 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001420 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001421 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001422 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001423 $line++;
1424 $remain--;
1425 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001426
1427 my $statement = substr($blk, $soff, $off - $soff + 1);
1428 my $condition = substr($blk, $soff, $coff - $soff + 1);
1429
1430 #warn "STATEMENT<$statement>\n";
1431 #warn "CONDITION<$condition>\n";
1432
Andy Whitcroft773647a2008-03-28 14:15:58 -07001433 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001434
1435 return ($statement, $condition,
1436 $line, $remain + 1, $off - $loff + 1, $level);
1437}
1438
Andy Whitcroftcf655042008-03-04 14:28:20 -08001439sub statement_lines {
1440 my ($stmt) = @_;
1441
1442 # Strip the diff line prefixes and rip blank lines at start and end.
1443 $stmt =~ s/(^|\n)./$1/g;
1444 $stmt =~ s/^\s*//;
1445 $stmt =~ s/\s*$//;
1446
1447 my @stmt_lines = ($stmt =~ /\n/g);
1448
1449 return $#stmt_lines + 2;
1450}
1451
1452sub statement_rawlines {
1453 my ($stmt) = @_;
1454
1455 my @stmt_lines = ($stmt =~ /\n/g);
1456
1457 return $#stmt_lines + 2;
1458}
1459
1460sub statement_block_size {
1461 my ($stmt) = @_;
1462
1463 $stmt =~ s/(^|\n)./$1/g;
1464 $stmt =~ s/^\s*{//;
1465 $stmt =~ s/}\s*$//;
1466 $stmt =~ s/^\s*//;
1467 $stmt =~ s/\s*$//;
1468
1469 my @stmt_lines = ($stmt =~ /\n/g);
1470 my @stmt_statements = ($stmt =~ /;/g);
1471
1472 my $stmt_lines = $#stmt_lines + 2;
1473 my $stmt_statements = $#stmt_statements + 1;
1474
1475 if ($stmt_lines > $stmt_statements) {
1476 return $stmt_lines;
1477 } else {
1478 return $stmt_statements;
1479 }
1480}
1481
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001482sub ctx_statement_full {
1483 my ($linenr, $remain, $off) = @_;
1484 my ($statement, $condition, $level);
1485
1486 my (@chunks);
1487
Andy Whitcroftcf655042008-03-04 14:28:20 -08001488 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001489 ($statement, $condition, $linenr, $remain, $off, $level) =
1490 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001491 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001492 push(@chunks, [ $condition, $statement ]);
1493 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1494 return ($level, $linenr, @chunks);
1495 }
1496
1497 # Pull in the following conditional/block pairs and see if they
1498 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001499 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001500 ($statement, $condition, $linenr, $remain, $off, $level) =
1501 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001502 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001503 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001504 #print "C: push\n";
1505 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001506 }
1507
1508 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001509}
1510
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001511sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001512 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001513 my $line;
1514 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001515 my $blk = '';
1516 my @o;
1517 my @c;
1518 my @res = ();
1519
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001520 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001521 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001522 for ($line = $start; $remain > 0; $line++) {
1523 next if ($rawlines[$line] =~ /^-/);
1524 $remain--;
1525
1526 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001527
1528 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001529 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001530 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001531 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001532 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001533 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001534 $level = pop(@stack);
1535 }
1536
Andy Whitcroft01464f32010-10-26 14:23:19 -07001537 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001538 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1539 if ($off > 0) {
1540 $off--;
1541 next;
1542 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001543
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001544 if ($c eq $close && $level > 0) {
1545 $level--;
1546 last if ($level == 0);
1547 } elsif ($c eq $open) {
1548 $level++;
1549 }
1550 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001551
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001552 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001553 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001554 }
1555
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001556 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001557 }
1558
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001559 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001560}
1561sub ctx_block_outer {
1562 my ($linenr, $remain) = @_;
1563
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001564 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1565 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001566}
1567sub ctx_block {
1568 my ($linenr, $remain) = @_;
1569
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001570 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1571 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001572}
1573sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001574 my ($linenr, $remain, $off) = @_;
1575
1576 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1577 return @r;
1578}
1579sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001580 my ($linenr, $remain) = @_;
1581
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001582 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001583}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001584sub ctx_statement_level {
1585 my ($linenr, $remain, $off) = @_;
1586
1587 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1588}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001589
1590sub ctx_locate_comment {
1591 my ($first_line, $end_line) = @_;
1592
1593 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001594 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001595 return $current_comment if (defined $current_comment);
1596
1597 # Look through the context and try and figure out if there is a
1598 # comment.
1599 my $in_comment = 0;
1600 $current_comment = '';
1601 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001602 my $line = $rawlines[$linenr - 1];
1603 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001604 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1605 $in_comment = 1;
1606 }
1607 if ($line =~ m@/\*@) {
1608 $in_comment = 1;
1609 }
1610 if (!$in_comment && $current_comment ne '') {
1611 $current_comment = '';
1612 }
1613 $current_comment .= $line . "\n" if ($in_comment);
1614 if ($line =~ m@\*/@) {
1615 $in_comment = 0;
1616 }
1617 }
1618
1619 chomp($current_comment);
1620 return($current_comment);
1621}
1622sub ctx_has_comment {
1623 my ($first_line, $end_line) = @_;
1624 my $cmt = ctx_locate_comment($first_line, $end_line);
1625
Andy Whitcroft00df3442007-06-08 13:47:06 -07001626 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001627 ##print "CMMT: $cmt\n";
1628
1629 return ($cmt ne '');
1630}
1631
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001632sub raw_line {
1633 my ($linenr, $cnt) = @_;
1634
1635 my $offset = $linenr - 1;
1636 $cnt++;
1637
1638 my $line;
1639 while ($cnt) {
1640 $line = $rawlines[$offset++];
1641 next if (defined($line) && $line =~ /^-/);
1642 $cnt--;
1643 }
1644
1645 return $line;
1646}
1647
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001648sub get_stat_real {
1649 my ($linenr, $lc) = @_;
1650
1651 my $stat_real = raw_line($linenr, 0);
1652 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1653 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1654 }
1655
1656 return $stat_real;
1657}
1658
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001659sub cat_vet {
1660 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001661 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001662
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001663 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001664 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1665 $res .= $1;
1666 if ($2 ne '') {
1667 $coded = sprintf("^%c", unpack('C', $2) + 64);
1668 $res .= $coded;
1669 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001670 }
1671 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001672
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001673 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001674}
1675
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001676my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001677my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001678my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001679my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001680
1681sub annotate_reset {
1682 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001683 $av_pending = '_';
1684 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001685 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001686}
1687
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001688sub annotate_values {
1689 my ($stream, $type) = @_;
1690
1691 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001692 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001693 my $cur = $stream;
1694
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001695 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001696
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001697 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001698 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001699 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001700 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001701 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001702 print "WS($1)\n" if ($dbg_values > 1);
1703 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001704 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001705 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001706 }
1707
Florian Micklerc023e4732011-01-12 16:59:58 -08001708 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001709 print "CAST($1)\n" if ($dbg_values > 1);
1710 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001711 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001712
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001713 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001714 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001715 $type = 'T';
1716
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001717 } elsif ($cur =~ /^($Modifier)\s*/) {
1718 print "MODIFIER($1)\n" if ($dbg_values > 1);
1719 $type = 'T';
1720
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001721 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001722 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001723 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001724 push(@av_paren_type, $type);
1725 if ($2 ne '') {
1726 $av_pending = 'N';
1727 }
1728 $type = 'E';
1729
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001730 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001731 print "UNDEF($1)\n" if ($dbg_values > 1);
1732 $av_preprocessor = 1;
1733 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001734
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001735 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001736 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001737 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001738
1739 push(@av_paren_type, $type);
1740 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001741 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001742
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001743 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001744 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1745 $av_preprocessor = 1;
1746
1747 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1748
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001749 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001750
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001751 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001752 print "PRE_END($1)\n" if ($dbg_values > 1);
1753
1754 $av_preprocessor = 1;
1755
1756 # Assume all arms of the conditional end as this
1757 # one does, and continue as if the #endif was not here.
1758 pop(@av_paren_type);
1759 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001760 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761
1762 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001763 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001764
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001765 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1766 print "ATTR($1)\n" if ($dbg_values > 1);
1767 $av_pending = $type;
1768 $type = 'N';
1769
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001770 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001771 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001772 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001773 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001774 }
1775 $type = 'N';
1776
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001777 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001778 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001779 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001780 $type = 'N';
1781
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001782 } elsif ($cur =~/^(case)/o) {
1783 print "CASE($1)\n" if ($dbg_values > 1);
1784 $av_pend_colon = 'C';
1785 $type = 'N';
1786
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001787 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001788 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001789 $type = 'N';
1790
1791 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001792 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001793 push(@av_paren_type, $av_pending);
1794 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001795 $type = 'N';
1796
1797 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001798 my $new_type = pop(@av_paren_type);
1799 if ($new_type ne '_') {
1800 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001801 print "PAREN('$1') -> $type\n"
1802 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001803 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001804 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001805 }
1806
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001807 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001808 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001809 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001810 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001811
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001812 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1813 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001814 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001815 } elsif ($type eq 'E') {
1816 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001817 }
1818 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1819 $type = 'V';
1820
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001821 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001822 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001823 $type = 'V';
1824
1825 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001826 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001827 $type = 'N';
1828
Andy Whitcroftcf655042008-03-04 14:28:20 -08001829 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001830 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001831 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001832 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001833
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001834 } elsif ($cur =~/^(,)/) {
1835 print "COMMA($1)\n" if ($dbg_values > 1);
1836 $type = 'C';
1837
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001838 } elsif ($cur =~ /^(\?)/o) {
1839 print "QUESTION($1)\n" if ($dbg_values > 1);
1840 $type = 'N';
1841
1842 } elsif ($cur =~ /^(:)/o) {
1843 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1844
1845 substr($var, length($res), 1, $av_pend_colon);
1846 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1847 $type = 'E';
1848 } else {
1849 $type = 'N';
1850 }
1851 $av_pend_colon = 'O';
1852
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001853 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001854 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001855 $type = 'N';
1856
Andy Whitcroft0d413862008-10-15 22:02:16 -07001857 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001858 my $variant;
1859
1860 print "OPV($1)\n" if ($dbg_values > 1);
1861 if ($type eq 'V') {
1862 $variant = 'B';
1863 } else {
1864 $variant = 'U';
1865 }
1866
1867 substr($var, length($res), 1, $variant);
1868 $type = 'N';
1869
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001870 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001871 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001872 if ($1 ne '++' && $1 ne '--') {
1873 $type = 'N';
1874 }
1875
1876 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001877 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001878 }
1879 if (defined $1) {
1880 $cur = substr($cur, length($1));
1881 $res .= $type x length($1);
1882 }
1883 }
1884
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001885 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001886}
1887
Andy Whitcroft8905a672007-11-28 16:21:06 -08001888sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001889 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001890 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001891 ^(?:
1892 $Modifier|
1893 $Storage|
1894 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001895 DEFINE_\S+
1896 )$|
1897 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001898 goto|
1899 return|
1900 case|
1901 else|
1902 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001903 do|
1904 \#|
1905 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001906 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001907 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001908 )}x;
1909 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1910 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001911 # Check for modifiers.
1912 $possible =~ s/\s*$Storage\s*//g;
1913 $possible =~ s/\s*$Sparse\s*//g;
1914 if ($possible =~ /^\s*$/) {
1915
1916 } elsif ($possible =~ /\s/) {
1917 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001918 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001919 if ($modifier !~ $notPermitted) {
1920 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001921 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001922 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001923 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001924
1925 } else {
1926 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001927 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001928 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001929 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001930 } else {
1931 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001932 }
1933}
1934
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001935my $prefix = '';
1936
Joe Perches000d1cc12011-07-25 17:13:25 -07001937sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001938 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001939
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001940 $type =~ tr/[a-z]/[A-Z]/;
1941
Joe Perchescbec18a2014-04-03 14:49:19 -07001942 return defined $use_type{$type} if (scalar keys %use_type > 0);
1943
1944 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001945}
1946
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001947sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001948 my ($level, $type, $msg) = @_;
1949
1950 if (!show_type($type) ||
1951 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001952 return 0;
1953 }
Joe Perches57230292015-06-25 15:03:03 -07001954 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001955 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001956 if ($level eq 'ERROR') {
1957 $output .= RED;
1958 } elsif ($level eq 'WARNING') {
1959 $output .= YELLOW;
1960 } else {
1961 $output .= GREEN;
1962 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001963 }
Joe Perches57230292015-06-25 15:03:03 -07001964 $output .= $prefix . $level . ':';
1965 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001966 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001967 $output .= "$type:";
1968 }
John Brooks737c0762017-07-10 15:52:24 -07001969 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001970 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001971
1972 if ($showfile) {
1973 my @lines = split("\n", $output, -1);
1974 splice(@lines, 1, 1);
1975 $output = join("\n", @lines);
1976 }
Joe Perches57230292015-06-25 15:03:03 -07001977 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001978
Joe Perches57230292015-06-25 15:03:03 -07001979 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001980
1981 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001982}
Joe Perchescbec18a2014-04-03 14:49:19 -07001983
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001984sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001985 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001986}
Joe Perches000d1cc12011-07-25 17:13:25 -07001987
Joe Perchesd752fcc2014-08-06 16:11:05 -07001988sub fixup_current_range {
1989 my ($lineRef, $offset, $length) = @_;
1990
1991 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1992 my $o = $1;
1993 my $l = $2;
1994 my $no = $o + $offset;
1995 my $nl = $l + $length;
1996 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1997 }
1998}
1999
2000sub fix_inserted_deleted_lines {
2001 my ($linesRef, $insertedRef, $deletedRef) = @_;
2002
2003 my $range_last_linenr = 0;
2004 my $delta_offset = 0;
2005
2006 my $old_linenr = 0;
2007 my $new_linenr = 0;
2008
2009 my $next_insert = 0;
2010 my $next_delete = 0;
2011
2012 my @lines = ();
2013
2014 my $inserted = @{$insertedRef}[$next_insert++];
2015 my $deleted = @{$deletedRef}[$next_delete++];
2016
2017 foreach my $old_line (@{$linesRef}) {
2018 my $save_line = 1;
2019 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002020 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002021 $delta_offset = 0;
2022 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2023 $range_last_linenr = $new_linenr;
2024 fixup_current_range(\$line, $delta_offset, 0);
2025 }
2026
2027 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2028 $deleted = @{$deletedRef}[$next_delete++];
2029 $save_line = 0;
2030 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2031 }
2032
2033 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2034 push(@lines, ${$inserted}{'LINE'});
2035 $inserted = @{$insertedRef}[$next_insert++];
2036 $new_linenr++;
2037 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2038 }
2039
2040 if ($save_line) {
2041 push(@lines, $line);
2042 $new_linenr++;
2043 }
2044
2045 $old_linenr++;
2046 }
2047
2048 return @lines;
2049}
2050
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002051sub fix_insert_line {
2052 my ($linenr, $line) = @_;
2053
2054 my $inserted = {
2055 LINENR => $linenr,
2056 LINE => $line,
2057 };
2058 push(@fixed_inserted, $inserted);
2059}
2060
2061sub fix_delete_line {
2062 my ($linenr, $line) = @_;
2063
2064 my $deleted = {
2065 LINENR => $linenr,
2066 LINE => $line,
2067 };
2068
2069 push(@fixed_deleted, $deleted);
2070}
2071
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002072sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002073 my ($type, $msg) = @_;
2074
2075 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002076 our $clean = 0;
2077 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002078 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002079 }
Joe Perches3705ce52013-07-03 15:05:31 -07002080 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002081}
2082sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002083 my ($type, $msg) = @_;
2084
2085 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002086 our $clean = 0;
2087 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002088 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002089 }
Joe Perches3705ce52013-07-03 15:05:31 -07002090 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002091}
2092sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002093 my ($type, $msg) = @_;
2094
2095 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002096 our $clean = 0;
2097 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002098 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002099 }
Joe Perches3705ce52013-07-03 15:05:31 -07002100 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002101}
2102
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002103sub check_absolute_file {
2104 my ($absolute, $herecurr) = @_;
2105 my $file = $absolute;
2106
2107 ##print "absolute<$absolute>\n";
2108
2109 # See if any suffix of this path is a path within the tree.
2110 while ($file =~ s@^[^/]*/@@) {
2111 if (-f "$root/$file") {
2112 ##print "file<$file>\n";
2113 last;
2114 }
2115 }
2116 if (! -f _) {
2117 return 0;
2118 }
2119
2120 # It is, so see if the prefix is acceptable.
2121 my $prefix = $absolute;
2122 substr($prefix, -length($file)) = '';
2123
2124 ##print "prefix<$prefix>\n";
2125 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002126 WARN("USE_RELATIVE_PATH",
2127 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002128 }
2129}
2130
Joe Perches3705ce52013-07-03 15:05:31 -07002131sub trim {
2132 my ($string) = @_;
2133
Joe Perchesb34c6482013-09-11 14:24:01 -07002134 $string =~ s/^\s+|\s+$//g;
2135
2136 return $string;
2137}
2138
2139sub ltrim {
2140 my ($string) = @_;
2141
2142 $string =~ s/^\s+//;
2143
2144 return $string;
2145}
2146
2147sub rtrim {
2148 my ($string) = @_;
2149
2150 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002151
2152 return $string;
2153}
2154
Joe Perches52ea8502013-11-12 15:10:09 -08002155sub string_find_replace {
2156 my ($string, $find, $replace) = @_;
2157
2158 $string =~ s/$find/$replace/g;
2159
2160 return $string;
2161}
2162
Joe Perches3705ce52013-07-03 15:05:31 -07002163sub tabify {
2164 my ($leading) = @_;
2165
2166 my $source_indent = 8;
2167 my $max_spaces_before_tab = $source_indent - 1;
2168 my $spaces_to_tab = " " x $source_indent;
2169
2170 #convert leading spaces to tabs
2171 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2172 #Remove spaces before a tab
2173 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2174
2175 return "$leading";
2176}
2177
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002178sub pos_last_openparen {
2179 my ($line) = @_;
2180
2181 my $pos = 0;
2182
2183 my $opens = $line =~ tr/\(/\(/;
2184 my $closes = $line =~ tr/\)/\)/;
2185
2186 my $last_openparen = 0;
2187
2188 if (($opens == 0) || ($closes >= $opens)) {
2189 return -1;
2190 }
2191
2192 my $len = length($line);
2193
2194 for ($pos = 0; $pos < $len; $pos++) {
2195 my $string = substr($line, $pos);
2196 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2197 $pos += length($1) - 1;
2198 } elsif (substr($line, $pos, 1) eq '(') {
2199 $last_openparen = $pos;
2200 } elsif (index($string, '(') == -1) {
2201 last;
2202 }
2203 }
2204
Joe Perches91cb5192014-04-03 14:49:32 -07002205 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002206}
2207
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002208sub process {
2209 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002210
2211 my $linenr=0;
2212 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002213 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002214 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002215 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002216
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002217 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002218 my $indent;
2219 my $previndent=0;
2220 my $stashindent=0;
2221
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002222 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002223 my $signoff = 0;
2224 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002225 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002226 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002227 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002228 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002229 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002230 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002231 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002232 my $non_utf8_charset = 0;
2233
Joe Perches365dd4e2014-08-06 16:10:42 -07002234 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002235 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002236
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002237 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002238 our $cnt_lines = 0;
2239 our $cnt_error = 0;
2240 our $cnt_warn = 0;
2241 our $cnt_chk = 0;
2242
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002243 # Trace the real file/line as we go.
2244 my $realfile = '';
2245 my $realline = 0;
2246 my $realcnt = 0;
2247 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002248 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002249 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002250 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002251 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002252 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002253
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002254 my $prev_values = 'E';
2255
2256 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002257 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002258 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002259 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002260 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002261
Joe Perches7e51f192013-09-11 14:23:57 -07002262 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002263
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002264 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002265 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002266 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002267 my @setup_docs = ();
2268 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002269
Joe Perchesd8b07712013-11-12 15:10:06 -08002270 my $camelcase_file_seeded = 0;
2271
Rob Herring9f3a8992018-04-10 16:33:13 -07002272 my $checklicenseline = 1;
2273
Andy Whitcroft773647a2008-03-28 14:15:58 -07002274 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002275 my $line;
2276 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002277 $linenr++;
2278 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002279
Joe Perches3705ce52013-07-03 15:05:31 -07002280 push(@fixed, $rawline) if ($fix);
2281
Andy Whitcroft773647a2008-03-28 14:15:58 -07002282 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002283 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002284 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002285 $setup_docs = 1;
2286 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002287 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002288 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002289 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002290 $realline=$1-1;
2291 if (defined $2) {
2292 $realcnt=$3+1;
2293 } else {
2294 $realcnt=1+1;
2295 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002296 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002297
2298 # Guestimate if this is a continuing comment. Run
2299 # the context looking for a comment "edge". If this
2300 # edge is a close comment then we must be in a comment
2301 # at context start.
2302 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002303 my $cnt = $realcnt;
2304 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2305 next if (defined $rawlines[$ln - 1] &&
2306 $rawlines[$ln - 1] =~ /^-/);
2307 $cnt--;
2308 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002309 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002310 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2311 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2312 ($edge) = $1;
2313 last;
2314 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002315 }
2316 if (defined $edge && $edge eq '*/') {
2317 $in_comment = 1;
2318 }
2319
2320 # Guestimate if this is a continuing comment. If this
2321 # is the start of a diff block and this line starts
2322 # ' *' then it is very likely a comment.
2323 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002324 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002325 {
2326 $in_comment = 1;
2327 }
2328
2329 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2330 sanitise_line_reset($in_comment);
2331
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002332 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002333 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002334 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002335 $line = sanitise_line($rawline);
2336 }
2337 push(@lines, $line);
2338
2339 if ($realcnt > 1) {
2340 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2341 } else {
2342 $realcnt = 0;
2343 }
2344
2345 #print "==>$rawline\n";
2346 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002347
2348 if ($setup_docs && $line =~ /^\+/) {
2349 push(@setup_docs, $line);
2350 }
2351 }
2352
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002353 $prefix = '';
2354
Andy Whitcroft773647a2008-03-28 14:15:58 -07002355 $realcnt = 0;
2356 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002357 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002358 foreach my $line (@lines) {
2359 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002360 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002361 my $sline = $line; #copy of $line
2362 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002363
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002364 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002365
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002366#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002367 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002368 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2369 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002370 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002371 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002372 $realline=$1-1;
2373 if (defined $2) {
2374 $realcnt=$3+1;
2375 } else {
2376 $realcnt=1+1;
2377 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002378 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002379 $prev_values = 'E';
2380
Andy Whitcroft773647a2008-03-28 14:15:58 -07002381 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002382 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002383 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002384 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002385 if ($context =~ /\b(\w+)\s*\(/) {
2386 $context_function = $1;
2387 } else {
2388 undef $context_function;
2389 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002390 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002391
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002392# track the line number as we move through the hunk, note that
2393# new versions of GNU diff omit the leading space on completely
2394# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002395 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002396 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002397 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002398
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002399 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002400 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002401
2402 # Track the previous line.
2403 ($prevline, $stashline) = ($stashline, $line);
2404 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002405 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2406
Andy Whitcroft773647a2008-03-28 14:15:58 -07002407 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002408
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002409 } elsif ($realcnt == 1) {
2410 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002411 }
2412
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002413 my $hunk_line = ($realcnt != 0);
2414
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002415 $here = "#$linenr: " if (!$file);
2416 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002417
Joe Perches2ac73b42014-06-04 16:12:05 -07002418 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002420 if ($line =~ /^diff --git.*?(\S+)$/) {
2421 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002422 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002423 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002424 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002425 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002426 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002427 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002428 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002429
2430 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002431 if (!$file && $tree && $p1_prefix ne '' &&
2432 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002433 WARN("PATCH_PREFIX",
2434 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002435 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002436
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002437 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002438 ERROR("MODIFIED_INCLUDE_ASM",
2439 "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 -07002440 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002441 $found_file = 1;
2442 }
2443
Joe Perches34d88152015-06-25 15:03:05 -07002444#make up the handle for any error we report on this line
2445 if ($showfile) {
2446 $prefix = "$realfile:$realline: "
2447 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002448 if ($file) {
2449 $prefix = "$filename:$realline: ";
2450 } else {
2451 $prefix = "$filename:$linenr: ";
2452 }
Joe Perches34d88152015-06-25 15:03:05 -07002453 }
2454
Joe Perches2ac73b42014-06-04 16:12:05 -07002455 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002456 if (is_maintained_obsolete($realfile)) {
2457 WARN("OBSOLETE",
2458 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2459 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002460 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002461 $check = 1;
2462 } else {
2463 $check = $check_orig;
2464 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002465 $checklicenseline = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002466 next;
2467 }
2468
Randy Dunlap389834b2007-06-08 13:47:03 -07002469 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002470
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002471 my $hereline = "$here\n$rawline\n";
2472 my $herecurr = "$here\n$rawline\n";
2473 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002474
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002475 $cnt_lines++ if ($realcnt != 0);
2476
Joe Perchese518e9a2015-06-25 15:03:27 -07002477# Check if the commit log has what seems like a diff which can confuse patch
2478 if ($in_commit_log && !$commit_log_has_diff &&
2479 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2480 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2481 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2482 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2483 ERROR("DIFF_IN_COMMIT_MSG",
2484 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2485 $commit_log_has_diff = 1;
2486 }
2487
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002488# Check for incorrect file permissions
2489 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2490 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002491 if ($realfile !~ m@scripts/@ &&
2492 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002493 ERROR("EXECUTE_PERMISSIONS",
2494 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002495 }
2496 }
2497
Joe Perches20112472011-07-25 17:13:23 -07002498# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002499 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002500 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002501 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002502 }
2503
Joe Perchese0d975b2014-12-10 15:51:49 -08002504# Check if MAINTAINERS is being updated. If so, there's probably no need to
2505# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2506 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2507 $reported_maintainer_file = 1;
2508 }
2509
Joe Perches20112472011-07-25 17:13:23 -07002510# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002511 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002512 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002513 my $space_before = $1;
2514 my $sign_off = $2;
2515 my $space_after = $3;
2516 my $email = $4;
2517 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2518
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002519 if ($sign_off !~ /$signature_tags/) {
2520 WARN("BAD_SIGN_OFF",
2521 "Non-standard signature: $sign_off\n" . $herecurr);
2522 }
Joe Perches20112472011-07-25 17:13:23 -07002523 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002524 if (WARN("BAD_SIGN_OFF",
2525 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2526 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002527 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002528 "$ucfirst_sign_off $email";
2529 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002530 }
Joe Perches20112472011-07-25 17:13:23 -07002531 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002532 if (WARN("BAD_SIGN_OFF",
2533 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2534 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002535 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002536 "$ucfirst_sign_off $email";
2537 }
2538
Joe Perches20112472011-07-25 17:13:23 -07002539 }
2540 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002541 if (WARN("BAD_SIGN_OFF",
2542 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2543 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002544 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002545 "$ucfirst_sign_off $email";
2546 }
Joe Perches20112472011-07-25 17:13:23 -07002547 }
2548
2549 my ($email_name, $email_address, $comment) = parse_email($email);
2550 my $suggested_email = format_email(($email_name, $email_address));
2551 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002552 ERROR("BAD_SIGN_OFF",
2553 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002554 } else {
2555 my $dequoted = $suggested_email;
2556 $dequoted =~ s/^"//;
2557 $dequoted =~ s/" </ </;
2558 # Don't force email to have quotes
2559 # Allow just an angle bracketed address
2560 if ("$dequoted$comment" ne $email &&
2561 "<$email_address>$comment" ne $email &&
2562 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002563 WARN("BAD_SIGN_OFF",
2564 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002565 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002566 }
Joe Perches7e51f192013-09-11 14:23:57 -07002567
2568# Check for duplicate signatures
2569 my $sig_nospace = $line;
2570 $sig_nospace =~ s/\s//g;
2571 $sig_nospace = lc($sig_nospace);
2572 if (defined $signatures{$sig_nospace}) {
2573 WARN("BAD_SIGN_OFF",
2574 "Duplicate signature\n" . $herecurr);
2575 } else {
2576 $signatures{$sig_nospace} = 1;
2577 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002578 }
2579
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002580# Check email subject for common tools that don't need to be mentioned
2581 if ($in_header_lines &&
2582 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2583 WARN("EMAIL_SUBJECT",
2584 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2585 }
2586
Joe Perches9b3189e2014-06-04 16:12:10 -07002587# Check for old stable address
2588 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2589 ERROR("STABLE_ADDRESS",
2590 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2591 }
2592
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002593# Check for unwanted Gerrit info
2594 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2595 ERROR("GERRIT_CHANGE_ID",
2596 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2597 }
2598
Joe Perches369c8dd2015-11-06 16:31:34 -08002599# Check if the commit log is in a possible stack dump
2600 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2601 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2602 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2603 # timestamp
2604 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2605 # stack dump address
2606 $commit_log_possible_stack_dump = 1;
2607 }
2608
Joe Perches2a076f42015-04-16 12:44:28 -07002609# Check for line lengths > 75 in commit log, warn once
2610 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002611 length($line) > 75 &&
2612 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2613 # file delta changes
2614 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2615 # filename then :
2616 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2617 # A Fixes: or Link: line
2618 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002619 WARN("COMMIT_LOG_LONG_LINE",
2620 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2621 $commit_log_long_line = 1;
2622 }
2623
Joe Perchesbf4daf12015-09-09 15:37:50 -07002624# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002625 if ($in_commit_log && $commit_log_possible_stack_dump &&
2626 $line =~ /^\s*$/) {
2627 $commit_log_possible_stack_dump = 0;
2628 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002629
Joe Perches0d7835f2015-02-13 14:38:35 -08002630# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002631 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002632 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002633 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002634 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002635 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002636 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2637 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002638 my $init_char = "c";
2639 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002640 my $short = 1;
2641 my $long = 0;
2642 my $case = 1;
2643 my $space = 1;
2644 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002645 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002646 my $id = '0123456789ab';
2647 my $orig_desc = "commit description";
2648 my $description = "";
2649
Joe Perchesfe043ea2015-09-09 15:37:25 -07002650 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2651 $init_char = $1;
2652 $orig_commit = lc($2);
2653 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2654 $orig_commit = lc($1);
2655 }
2656
Joe Perches0d7835f2015-02-13 14:38:35 -08002657 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2658 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2659 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2660 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2661 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2662 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002663 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002664 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2665 defined $rawlines[$linenr] &&
2666 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2667 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002668 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002669 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2670 defined $rawlines[$linenr] &&
2671 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2672 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2673 $orig_desc = $1;
2674 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2675 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002676 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002677 }
2678
2679 ($id, $description) = git_commit_info($orig_commit,
2680 $id, $orig_desc);
2681
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002682 if (defined($id) &&
2683 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002684 ERROR("GIT_COMMIT_ID",
2685 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2686 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002687 }
2688
Joe Perches13f19372014-08-06 16:10:59 -07002689# Check for added, moved or deleted files
2690 if (!$reported_maintainer_file && !$in_commit_log &&
2691 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2692 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2693 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2694 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002695 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002696 $reported_maintainer_file = 1;
2697 WARN("FILE_PATH_CHANGES",
2698 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2699 }
2700
Andy Whitcroft00df3442007-06-08 13:47:06 -07002701# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002702 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002703 ERROR("CORRUPTED_PATCH",
2704 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002705 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002706 }
2707
2708# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2709 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002710 $rawline !~ m/^$UTF8*$/) {
2711 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2712
2713 my $blank = copy_spacing($rawline);
2714 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2715 my $hereptr = "$hereline$ptr\n";
2716
Joe Perches34d99212011-07-25 17:13:26 -07002717 CHK("INVALID_UTF8",
2718 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002719 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002720
Joe Perches15662b32011-10-31 17:13:12 -07002721# Check if it's the start of a commit log
2722# (not a header line and we haven't seen the patch filename)
2723 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002724 !($rawline =~ /^\s+(?:\S|$)/ ||
2725 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002726 $in_header_lines = 0;
2727 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002728 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002729 }
2730
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002731# Check if there is UTF-8 in a commit log when a mail header has explicitly
2732# declined it, i.e defined some charset where it is missing.
2733 if ($in_header_lines &&
2734 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2735 $1 !~ /utf-8/i) {
2736 $non_utf8_charset = 1;
2737 }
2738
2739 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002740 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002741 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002742 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2743 }
2744
Joe Perchesd6430f72016-12-12 16:46:28 -08002745# Check for absolute kernel paths in commit message
2746 if ($tree && $in_commit_log) {
2747 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2748 my $file = $1;
2749
2750 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2751 check_absolute_file($1, $herecurr)) {
2752 #
2753 } else {
2754 check_absolute_file($file, $herecurr);
2755 }
2756 }
2757 }
2758
Kees Cook66b47b42014-10-13 15:51:57 -07002759# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002760 if (defined($misspellings) &&
2761 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002762 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002763 my $typo = $1;
2764 my $typo_fix = $spelling_fix{lc($typo)};
2765 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2766 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002767 my $msg_level = \&WARN;
2768 $msg_level = \&CHK if ($file);
2769 if (&{$msg_level}("TYPO_SPELLING",
2770 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002771 $fix) {
2772 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2773 }
2774 }
2775 }
2776
Andy Whitcroft306708542008-10-15 22:02:28 -07002777# ignore non-hunk lines and lines being removed
2778 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002779
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002780#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002781 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002782 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002783 if (ERROR("DOS_LINE_ENDINGS",
2784 "DOS line endings\n" . $herevet) &&
2785 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002786 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002787 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002788 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2789 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002790 if (ERROR("TRAILING_WHITESPACE",
2791 "trailing whitespace\n" . $herevet) &&
2792 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002793 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002794 }
2795
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002796 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002797 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002798
Josh Triplett4783f892013-11-12 15:10:12 -08002799# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002800 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002801 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002802 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2803 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002804 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002805 my $msg_level = \&ERROR;
2806 $msg_level = \&CHK if ($file);
2807 &{$msg_level}("FSF_MAILING_ADDRESS",
2808 "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 -08002809 }
2810
Andi Kleen33549572010-05-24 14:33:29 -07002811# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002812# Only applies when adding the entry originally, after that we do not have
2813# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002814 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002815 # 'choice' is usually the last thing on the line (though
2816 # Kconfig supports named choices), so use a word boundary
2817 # (\b) rather than a whitespace character (\s)
2818 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002819 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002820 my $cnt = $realcnt;
2821 my $ln = $linenr + 1;
2822 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002823 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002824 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002825 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002826 $f = $lines[$ln - 1];
2827 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2828 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002829
2830 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002831 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002832
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002833 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002834 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002835 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2836 if ($lines[$ln - 1] =~ "---help---") {
2837 WARN("CONFIG_DESCRIPTION",
2838 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2839 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002840 $length = -1;
2841 }
2842
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002843 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002844 $f =~ s/#.*//;
2845 $f =~ s/^\s+//;
2846 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002847
2848 # This only checks context lines in the patch
2849 # and so hopefully shouldn't trigger false
2850 # positives, even though some of these are
2851 # common words in help texts
2852 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2853 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002854 $is_end = 1;
2855 last;
2856 }
Andi Kleen33549572010-05-24 14:33:29 -07002857 $length++;
2858 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002859 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2860 WARN("CONFIG_DESCRIPTION",
2861 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2862 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002863 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002864 }
2865
Joe Perches628f91a2017-07-10 15:52:07 -07002866# check for MAINTAINERS entries that don't have the right form
2867 if ($realfile =~ /^MAINTAINERS$/ &&
2868 $rawline =~ /^\+[A-Z]:/ &&
2869 $rawline !~ /^\+[A-Z]:\t\S/) {
2870 if (WARN("MAINTAINERS_STYLE",
2871 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2872 $fix) {
2873 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2874 }
2875 }
2876
Christoph Jaeger327953e2015-02-13 14:38:29 -08002877# discourage the use of boolean for type definition attributes of Kconfig options
2878 if ($realfile =~ /Kconfig/ &&
2879 $line =~ /^\+\s*\bboolean\b/) {
2880 WARN("CONFIG_TYPE_BOOLEAN",
2881 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2882 }
2883
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002884 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2885 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2886 my $flag = $1;
2887 my $replacement = {
2888 'EXTRA_AFLAGS' => 'asflags-y',
2889 'EXTRA_CFLAGS' => 'ccflags-y',
2890 'EXTRA_CPPFLAGS' => 'cppflags-y',
2891 'EXTRA_LDFLAGS' => 'ldflags-y',
2892 };
2893
2894 WARN("DEPRECATED_VARIABLE",
2895 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2896 }
2897
Rob Herringbff5da42014-01-23 15:54:51 -08002898# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002899 if (defined $root &&
2900 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2901 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2902
Rob Herringbff5da42014-01-23 15:54:51 -08002903 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2904
Florian Vaussardcc933192014-04-03 14:49:27 -07002905 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2906 my $vp_file = $dt_path . "vendor-prefixes.txt";
2907
Rob Herringbff5da42014-01-23 15:54:51 -08002908 foreach my $compat (@compats) {
2909 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002910 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2911 my $compat3 = $compat;
2912 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2913 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002914 if ( $? >> 8 ) {
2915 WARN("UNDOCUMENTED_DT_STRING",
2916 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2917 }
2918
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002919 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2920 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002921 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002922 if ( $? >> 8 ) {
2923 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002924 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002925 }
2926 }
2927 }
2928
Rob Herring9f3a8992018-04-10 16:33:13 -07002929# check for using SPDX license tag at beginning of files
2930 if ($realline == $checklicenseline) {
2931 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2932 $checklicenseline = 2;
2933 } elsif ($rawline =~ /^\+/) {
2934 my $comment = "";
2935 if ($realfile =~ /\.(h|s|S)$/) {
2936 $comment = '/*';
2937 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2938 $comment = '//';
2939 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2940 $comment = '#';
2941 } elsif ($realfile =~ /\.rst$/) {
2942 $comment = '..';
2943 }
2944
2945 if ($comment !~ /^$/ &&
2946 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
2947 WARN("SPDX_LICENSE_TAG",
2948 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
2949 }
2950 }
2951 }
2952
Andy Whitcroft5368df202008-10-15 22:02:27 -07002953# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002954 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002955
Joe Perches47e0c882015-06-25 15:02:57 -07002956# line length limit (with some exclusions)
2957#
2958# There are a few types of lines that may extend beyond $max_line_length:
2959# logging functions like pr_info that end in a string
2960# lines with a single string
2961# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002962# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07002963#
2964# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002965# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002966# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2967# LONG_LINE all other lines longer than $max_line_length
2968#
2969# if LONG_LINE is ignored, the other 2 types are also ignored
2970#
2971
Joe Perchesb4749e92015-07-17 16:24:01 -07002972 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002973 my $msg_type = "LONG_LINE";
2974
2975 # Check the allowed long line types first
2976
2977 # logging functions that end in a string that starts
2978 # before $max_line_length
2979 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2980 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2981 $msg_type = "";
2982
2983 # lines with only strings (w/ possible termination)
2984 # #defines with only strings
2985 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2986 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2987 $msg_type = "";
2988
Joe Perchescc147502017-11-17 15:28:44 -08002989 # More special cases
2990 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
2991 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07002992 $msg_type = "";
2993
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002994 # URL ($rawline is used in case the URL is in a comment)
2995 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
2996 $msg_type = "";
2997
Joe Perches47e0c882015-06-25 15:02:57 -07002998 # Otherwise set the alternate message types
2999
3000 # a comment starts before $max_line_length
3001 } elsif ($line =~ /($;[\s$;]*)$/ &&
3002 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3003 $msg_type = "LONG_LINE_COMMENT"
3004
3005 # a quoted string starts before $max_line_length
3006 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3007 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3008 $msg_type = "LONG_LINE_STRING"
3009 }
3010
3011 if ($msg_type ne "" &&
3012 (show_type("LONG_LINE") || show_type($msg_type))) {
3013 WARN($msg_type,
3014 "line over $max_line_length characters\n" . $herecurr);
3015 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003016 }
3017
Andy Whitcroft8905a672007-11-28 16:21:06 -08003018# check for adding lines without a newline.
3019 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003020 WARN("MISSING_EOF_NEWLINE",
3021 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003022 }
3023
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003024# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003025 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003026
3027# at the beginning of a line any tabs must come first and anything
3028# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003029 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3030 $rawline =~ /^\+\s* \s*/) {
3031 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003032 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003033 if (ERROR("CODE_INDENT",
3034 "code indent should use tabs where possible\n" . $herevet) &&
3035 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003036 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003037 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003038 }
3039
Alberto Panizzo08e44362010-03-05 13:43:54 -08003040# check for space before tabs.
3041 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3042 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003043 if (WARN("SPACE_BEFORE_TAB",
3044 "please, no space before tabs\n" . $herevet) &&
3045 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003046 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003047 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003048 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003049 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003050 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003051 }
3052
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003053# check for && or || at the start of a line
3054 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3055 CHK("LOGICAL_CONTINUATIONS",
3056 "Logical continuations should be on the previous line\n" . $hereprev);
3057 }
3058
Joe Perchesa91e8992016-05-20 17:04:05 -07003059# check indentation starts on a tab stop
3060 if ($^V && $^V ge 5.10.0 &&
Joe Perchesbd491112018-02-06 15:39:06 -08003061 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003062 my $indent = length($1);
3063 if ($indent % 8) {
3064 if (WARN("TABSTOP",
3065 "Statements should start on a tabstop\n" . $herecurr) &&
3066 $fix) {
3067 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3068 }
3069 }
3070 }
3071
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003072# check multi-line statement indentation matches previous line
3073 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003074 $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 -07003075 $prevline =~ /^\+(\t*)(.*)$/;
3076 my $oldindent = $1;
3077 my $rest = $2;
3078
3079 my $pos = pos_last_openparen($rest);
3080 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003081 $line =~ /^(\+| )([ \t]*)/;
3082 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003083
3084 my $goodtabindent = $oldindent .
3085 "\t" x ($pos / 8) .
3086 " " x ($pos % 8);
3087 my $goodspaceindent = $oldindent . " " x $pos;
3088
3089 if ($newindent ne $goodtabindent &&
3090 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003091
3092 if (CHK("PARENTHESIS_ALIGNMENT",
3093 "Alignment should match open parenthesis\n" . $hereprev) &&
3094 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003095 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003096 s/^\+[ \t]*/\+$goodtabindent/;
3097 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003098 }
3099 }
3100 }
3101
Joe Perches6ab3a972015-04-16 12:44:05 -07003102# check for space after cast like "(int) foo" or "(struct foo) bar"
3103# avoid checking a few false positives:
3104# "sizeof(<type>)" or "__alignof__(<type>)"
3105# function pointer declarations like "(*foo)(int) = bar;"
3106# structure definitions like "(struct foo) { 0 };"
3107# multiline macros that define functions
3108# known attributes or the __attribute__ keyword
3109 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3110 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003111 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003112 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003113 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003114 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003115 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003116 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003117 }
3118
Joe Perches86406b12015-09-09 15:37:41 -07003119# Block comment styles
3120# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003121 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003122 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003123 $rawline =~ /^\+[ \t]*\*/ &&
3124 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003125 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3126 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3127 }
3128
Joe Perches86406b12015-09-09 15:37:41 -07003129# Block comments use * on subsequent lines
3130 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3131 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003132 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003133 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003134 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003135 WARN("BLOCK_COMMENT_STYLE",
3136 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003137 }
3138
Joe Perches86406b12015-09-09 15:37:41 -07003139# Block comments use */ on trailing lines
3140 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003141 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3142 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3143 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003144 WARN("BLOCK_COMMENT_STYLE",
3145 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003146 }
3147
Joe Perches08eb9b82016-10-11 13:51:50 -07003148# Block comment * alignment
3149 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003150 $line =~ /^\+[ \t]*$;/ && #leading comment
3151 $rawline =~ /^\+[ \t]*\*/ && #leading *
3152 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003153 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003154 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3155 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003156 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003157 if (defined($1)) {
3158 $oldindent = expand_tabs($1);
3159 } else {
3160 $prevrawline =~ m@^\+(.*/?)\*@;
3161 $oldindent = expand_tabs($1);
3162 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003163 $rawline =~ m@^\+([ \t]*)\*@;
3164 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003165 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003166 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003167 WARN("BLOCK_COMMENT_STYLE",
3168 "Block comments should align the * on each line\n" . $hereprev);
3169 }
3170 }
3171
Joe Perches7f619192014-08-06 16:10:39 -07003172# check for missing blank lines after struct/union declarations
3173# with exceptions for various attributes and macros
3174 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3175 $line =~ /^\+/ &&
3176 !($line =~ /^\+\s*$/ ||
3177 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3178 $line =~ /^\+\s*MODULE_/i ||
3179 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3180 $line =~ /^\+[a-z_]*init/ ||
3181 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3182 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003183 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003184 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003185 if (CHK("LINE_SPACING",
3186 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3187 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003188 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003189 }
Joe Perches7f619192014-08-06 16:10:39 -07003190 }
3191
Joe Perches365dd4e2014-08-06 16:10:42 -07003192# check for multiple consecutive blank lines
3193 if ($prevline =~ /^[\+ ]\s*$/ &&
3194 $line =~ /^\+\s*$/ &&
3195 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003196 if (CHK("LINE_SPACING",
3197 "Please don't use multiple blank lines\n" . $hereprev) &&
3198 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003199 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003200 }
3201
Joe Perches365dd4e2014-08-06 16:10:42 -07003202 $last_blank_line = $linenr;
3203 }
3204
Joe Perches3b617e32014-04-03 14:49:28 -07003205# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003206 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3207 # actual declarations
3208 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003209 # function pointer declarations
3210 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003211 # foo bar; where foo is some local typedef or #define
3212 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3213 # known declaration macros
3214 $prevline =~ /^\+\s+$declaration_macros/) &&
3215 # for "else if" which can look like "$Ident $Ident"
3216 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3217 # other possible extensions of declaration lines
3218 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3219 # not starting a section or a macro "\" extended line
3220 $prevline =~ /(?:\{\s*|\\)$/) &&
3221 # looks like a declaration
3222 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003223 # function pointer declarations
3224 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003225 # foo bar; where foo is some local typedef or #define
3226 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3227 # known declaration macros
3228 $sline =~ /^\+\s+$declaration_macros/ ||
3229 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003230 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003231 # start or end of block or continuation of declaration
3232 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3233 # bitfield continuation
3234 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3235 # other possible extensions of declaration lines
3236 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3237 # indentation of previous and current line are the same
3238 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003239 if (WARN("LINE_SPACING",
3240 "Missing a blank line after declarations\n" . $hereprev) &&
3241 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003242 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003243 }
Joe Perches3b617e32014-04-03 14:49:28 -07003244 }
3245
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003246# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003247# Exceptions:
3248# 1) within comments
3249# 2) indented preprocessor commands
3250# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003251 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003252 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003253 if (WARN("LEADING_SPACE",
3254 "please, no spaces at the start of a line\n" . $herevet) &&
3255 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003256 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003257 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003258 }
3259
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003260# check we are in a valid C source file if not then ignore this hunk
3261 next if ($realfile !~ /\.(h|c)$/);
3262
Joe Perches5751a242017-11-17 15:28:52 -08003263# check for unusual line ending [ or (
3264 if ($line =~ /^\+.*([\[\(])\s*$/) {
3265 CHK("OPEN_ENDED_LINE",
3266 "Lines should not end with a '$1'\n" . $herecurr);
3267 }
3268
Joe Perches4dbed762017-05-08 15:55:39 -07003269# check if this appears to be the start function declaration, save the name
3270 if ($sline =~ /^\+\{\s*$/ &&
3271 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3272 $context_function = $1;
3273 }
3274
3275# check if this appears to be the end of function declaration
3276 if ($sline =~ /^\+\}\s*$/) {
3277 undef $context_function;
3278 }
3279
Joe Perches032a4c02014-08-06 16:10:29 -07003280# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003281# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003282# if the previous line is a break or return and is indented 1 tab more...
3283 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3284 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003285 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3286 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3287 defined $lines[$linenr] &&
3288 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003289 WARN("UNNECESSARY_ELSE",
3290 "else is not generally useful after a break or return\n" . $hereprev);
3291 }
3292 }
3293
Joe Perchesc00df192014-08-06 16:11:01 -07003294# check indentation of a line with a break;
3295# if the previous line is a goto or return and is indented the same # of tabs
3296 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3297 my $tabs = $1;
3298 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3299 WARN("UNNECESSARY_BREAK",
3300 "break is not useful after a goto or return\n" . $hereprev);
3301 }
3302 }
3303
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003304# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003305 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003306 WARN("CVS_KEYWORD",
3307 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003308 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003309
Joe Perches56e77d72013-02-21 16:44:14 -08003310# check for old HOTPLUG __dev<foo> section markings
3311 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3312 WARN("HOTPLUG_SECTION",
3313 "Using $1 is unnecessary\n" . $herecurr);
3314 }
3315
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003316# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003317 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3318 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003319#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003320 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003321 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003322 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003323 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003324 $stat =~ s/\n./\n /g;
3325 $cond =~ s/\n./\n /g;
3326
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003327#print "linenr<$linenr> <$stat>\n";
3328 # If this statement has no statement boundaries within
3329 # it there is no point in retrying a statement scan
3330 # until we hit end of it.
3331 my $frag = $stat; $frag =~ s/;+\s*$//;
3332 if ($frag !~ /(?:{|;)/) {
3333#print "skip<$line_nr_next>\n";
3334 $suppress_statement = $line_nr_next;
3335 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003336
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003337 # Find the real next line.
3338 $realline_next = $line_nr_next;
3339 if (defined $realline_next &&
3340 (!defined $lines[$realline_next - 1] ||
3341 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3342 $realline_next++;
3343 }
3344
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003345 my $s = $stat;
3346 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003347
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003348 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003349 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003350
3351 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003352 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003353
Andy Whitcroft463f2862009-09-21 17:04:34 -07003354 } elsif ($s =~ /^.\s*else\b/s) {
3355
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003356 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003357 } 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 -07003358 my $type = $1;
3359 $type =~ s/\s+/ /g;
3360 possible($type, "A:" . $s);
3361
Andy Whitcroft8905a672007-11-28 16:21:06 -08003362 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003363 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003364 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003365 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003366
3367 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003368 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003369 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003370 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003371
3372 # Check for any sort of function declaration.
3373 # int foo(something bar, other baz);
3374 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003375 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 -08003376 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003377
Andy Whitcroftcf655042008-03-04 14:28:20 -08003378 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003379 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003380 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003381
Andy Whitcroft8905a672007-11-28 16:21:06 -08003382 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003383 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003384
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003385 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003386 }
3387 }
3388 }
3389
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003390 }
3391
Andy Whitcroft653d4872007-06-23 17:16:34 -07003392#
3393# Checks which may be anchored in the context.
3394#
3395
3396# Check for switch () and associated case and default
3397# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003398 if ($line=~/\bswitch\s*\(.*\)/) {
3399 my $err = '';
3400 my $sep = '';
3401 my @ctx = ctx_block_outer($linenr, $realcnt);
3402 shift(@ctx);
3403 for my $ctx (@ctx) {
3404 my ($clen, $cindent) = line_stats($ctx);
3405 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3406 $indent != $cindent) {
3407 $err .= "$sep$ctx\n";
3408 $sep = '';
3409 } else {
3410 $sep = "[...]\n";
3411 }
3412 }
3413 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003414 ERROR("SWITCH_CASE_INDENT_LEVEL",
3415 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003416 }
3417 }
3418
3419# if/while/etc brace do not go on next line, unless defining a do while loop,
3420# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003421 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 -07003422 my $pre_ctx = "$1$2";
3423
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003424 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003425
3426 if ($line =~ /^\+\t{6,}/) {
3427 WARN("DEEP_INDENTATION",
3428 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3429 }
3430
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003431 my $ctx_cnt = $realcnt - $#ctx - 1;
3432 my $ctx = join("\n", @ctx);
3433
Andy Whitcroft548596d2008-07-23 21:29:01 -07003434 my $ctx_ln = $linenr;
3435 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003436
Andy Whitcroft548596d2008-07-23 21:29:01 -07003437 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3438 defined $lines[$ctx_ln - 1] &&
3439 $lines[$ctx_ln - 1] =~ /^-/)) {
3440 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3441 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003442 $ctx_ln++;
3443 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003444
Andy Whitcroft53210162008-07-23 21:29:03 -07003445 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3446 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003447
Joe Perchesd752fcc2014-08-06 16:11:05 -07003448 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003449 ERROR("OPEN_BRACE",
3450 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003451 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003452 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003453 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3454 $ctx =~ /\)\s*\;\s*$/ &&
3455 defined $lines[$ctx_ln - 1])
3456 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003457 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3458 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003459 WARN("TRAILING_SEMICOLON",
3460 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003461 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003462 }
3463 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003464 }
3465
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003466# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003467 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 -08003468 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3469 ctx_statement_block($linenr, $realcnt, 0)
3470 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003471 my ($s, $c) = ($stat, $cond);
3472
3473 substr($s, 0, length($c), '');
3474
Joe Perches9f5af482015-09-09 15:37:30 -07003475 # remove inline comments
3476 $s =~ s/$;/ /g;
3477 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003478
3479 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003480 my @newlines = ($c =~ /\n/gs);
3481 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003482
Joe Perches9f5af482015-09-09 15:37:30 -07003483 # Make sure we remove the line prefixes as we have
3484 # none on the first line, and are going to readd them
3485 # where necessary.
3486 $s =~ s/\n./\n/gs;
3487 while ($s =~ /\n\s+\\\n/) {
3488 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3489 }
3490
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003491 # We want to check the first line inside the block
3492 # starting at the end of the conditional, so remove:
3493 # 1) any blank line termination
3494 # 2) any opening brace { on end of the line
3495 # 3) any do (...) {
3496 my $continuation = 0;
3497 my $check = 0;
3498 $s =~ s/^.*\bdo\b//;
3499 $s =~ s/^\s*{//;
3500 if ($s =~ s/^\s*\\//) {
3501 $continuation = 1;
3502 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003503 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003504 $check = 1;
3505 $cond_lines++;
3506 }
3507
3508 # Also ignore a loop construct at the end of a
3509 # preprocessor statement.
3510 if (($prevline =~ /^.\s*#\s*define\s/ ||
3511 $prevline =~ /\\\s*$/) && $continuation == 0) {
3512 $check = 0;
3513 }
3514
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003515 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003516 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003517 while ($cond_ptr != $cond_lines) {
3518 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003519
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003520 # If we see an #else/#elif then the code
3521 # is not linear.
3522 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3523 $check = 0;
3524 }
3525
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003526 # Ignore:
3527 # 1) blank lines, they should be at 0,
3528 # 2) preprocessor lines, and
3529 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003530 if ($continuation ||
3531 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003532 $s =~ /^\s*#\s*?/ ||
3533 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003534 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003535 if ($s =~ s/^.*?\n//) {
3536 $cond_lines++;
3537 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003538 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003539 }
3540
3541 my (undef, $sindent) = line_stats("+" . $s);
3542 my $stat_real = raw_line($linenr, $cond_lines);
3543
3544 # Check if either of these lines are modified, else
3545 # this is not this patch's fault.
3546 if (!defined($stat_real) ||
3547 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3548 $check = 0;
3549 }
3550 if (defined($stat_real) && $cond_lines > 1) {
3551 $stat_real = "[...]\n$stat_real";
3552 }
3553
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003554 #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 -07003555
Joe Perches9f5af482015-09-09 15:37:30 -07003556 if ($check && $s ne '' &&
3557 (($sindent % 8) != 0 ||
3558 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003559 ($sindent == $indent &&
3560 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003561 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003562 WARN("SUSPECT_CODE_INDENT",
3563 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003564 }
3565 }
3566
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003567 # Track the 'values' across context and added lines.
3568 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003569 my ($curr_values, $curr_vars) =
3570 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003571 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003572 if ($dbg_values) {
3573 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003574 print "$linenr > .$outline\n";
3575 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003576 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003577 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003578 $prev_values = substr($curr_values, -1);
3579
Andy Whitcroft00df3442007-06-08 13:47:06 -07003580#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003581 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003582
Joe Perches11ca40a2016-12-12 16:46:31 -08003583# check for dereferences that span multiple lines
3584 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3585 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3586 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3587 my $ref = $1;
3588 $line =~ /^.\s*($Lval)/;
3589 $ref .= $1;
3590 $ref =~ s/\s//g;
3591 WARN("MULTILINE_DEREFERENCE",
3592 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3593 }
3594
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003595# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003596 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 -07003597 my $type = $1;
3598 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003599 $var = "" if (!defined $var);
3600 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003601 my $sign = $1;
3602 my $pointer = $2;
3603
3604 $pointer = "" if (!defined $pointer);
3605
3606 if (WARN("UNSPECIFIED_INT",
3607 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3608 $fix) {
3609 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003610 my $comp_pointer = $pointer;
3611 $comp_pointer =~ s/\s//g;
3612 $decl .= $comp_pointer;
3613 $decl = rtrim($decl) if ($var eq "");
3614 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003615 }
3616 }
3617 }
3618
Andy Whitcroft653d4872007-06-23 17:16:34 -07003619# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003620 if ($dbg_type) {
3621 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003622 ERROR("TEST_TYPE",
3623 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003624 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003625 ERROR("TEST_NOT_TYPE",
3626 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003627 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003628 next;
3629 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003630# TEST: allow direct testing of the attribute matcher.
3631 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003632 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003633 ERROR("TEST_ATTR",
3634 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003635 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003636 ERROR("TEST_NOT_ATTR",
3637 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003638 }
3639 next;
3640 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003641
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003642# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003643 if ($line =~ /^.\s*{/ &&
3644 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003645 if (ERROR("OPEN_BRACE",
3646 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003647 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3648 fix_delete_line($fixlinenr - 1, $prevrawline);
3649 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003650 my $fixedline = $prevrawline;
3651 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003652 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003653 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003654 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003655 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003656 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003657 }
3658
Andy Whitcroft653d4872007-06-23 17:16:34 -07003659#
3660# Checks which are anchored on the added line.
3661#
3662
3663# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003664 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003665 my $path = $1;
3666 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003667 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003668 "malformed #include filename\n" . $herecurr);
3669 }
3670 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3671 ERROR("UAPI_INCLUDE",
3672 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003673 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003674 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003675
3676# no C99 // comments
3677 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003678 if (ERROR("C99_COMMENTS",
3679 "do not use C99 // comments\n" . $herecurr) &&
3680 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003681 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003682 if ($line =~ /\/\/(.*)$/) {
3683 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003684 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003685 }
3686 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003687 }
3688 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003689 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003690 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003691
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003692# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3693# the whole statement.
3694#print "APW <$lines[$realline_next - 1]>\n";
3695 if (defined $realline_next &&
3696 exists $lines[$realline_next - 1] &&
3697 !defined $suppress_export{$realline_next} &&
3698 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3699 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003700 # Handle definitions which produce identifiers with
3701 # a prefix:
3702 # XXX(foo);
3703 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003704 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003705 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003706 $name =~ /^${Ident}_$2/) {
3707#print "FOO C name<$name>\n";
3708 $suppress_export{$realline_next} = 1;
3709
3710 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003711 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003712 ^.DEFINE_$Ident\(\Q$name\E\)|
3713 ^.DECLARE_$Ident\(\Q$name\E\)|
3714 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003715 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3716 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003717 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003718#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3719 $suppress_export{$realline_next} = 2;
3720 } else {
3721 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003722 }
3723 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003724 if (!defined $suppress_export{$linenr} &&
3725 $prevline =~ /^.\s*$/ &&
3726 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3727 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3728#print "FOO B <$lines[$linenr - 1]>\n";
3729 $suppress_export{$linenr} = 2;
3730 }
3731 if (defined $suppress_export{$linenr} &&
3732 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003733 WARN("EXPORT_SYMBOL",
3734 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003735 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003736
Joe Eloff5150bda2010-08-09 17:21:00 -07003737# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003738 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003739 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003740 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003741 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003742 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003743 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003744 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003745# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003746 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003747 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003748 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003749 $herecurr) &&
3750 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003751 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003752 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003753 }
3754
Joe Perches18130872014-08-06 16:11:22 -07003755# check for misordered declarations of char/short/int/long with signed/unsigned
3756 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3757 my $tmp = trim($1);
3758 WARN("MISORDERED_TYPE",
3759 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3760 }
3761
Joe Perchescb710ec2010-10-26 14:23:20 -07003762# check for static const char * arrays.
3763 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003764 WARN("STATIC_CONST_CHAR_ARRAY",
3765 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003766 $herecurr);
3767 }
3768
3769# check for static char foo[] = "bar" declarations.
3770 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003771 WARN("STATIC_CONST_CHAR_ARRAY",
3772 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003773 $herecurr);
3774 }
3775
Joe Perchesab7e23f2015-04-16 12:44:22 -07003776# check for const <foo> const where <foo> is not a pointer or array type
3777 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3778 my $found = $1;
3779 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3780 WARN("CONST_CONST",
3781 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3782 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3783 WARN("CONST_CONST",
3784 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3785 }
3786 }
3787
Joe Perches9b0fa602014-04-03 14:49:18 -07003788# check for non-global char *foo[] = {"bar", ...} declarations.
3789 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3790 WARN("STATIC_CONST_CHAR_ARRAY",
3791 "char * array declaration might be better as static const\n" .
3792 $herecurr);
3793 }
3794
Joe Perchesb598b672015-04-16 12:44:36 -07003795# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3796 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3797 my $array = $1;
3798 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3799 my $array_div = $1;
3800 if (WARN("ARRAY_SIZE",
3801 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3802 $fix) {
3803 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3804 }
3805 }
3806 }
3807
Joe Perchesb36190c2014-01-27 17:07:18 -08003808# check for function declarations without arguments like "int foo()"
3809 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3810 if (ERROR("FUNCTION_WITHOUT_ARGS",
3811 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3812 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003813 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003814 }
3815 }
3816
Andy Whitcroft653d4872007-06-23 17:16:34 -07003817# check for new typedefs, only function parameters and sparse annotations
3818# make sense.
3819 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003820 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003821 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003822 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003823 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003824 WARN("NEW_TYPEDEFS",
3825 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003826 }
3827
3828# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003829 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003830 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3831 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003832 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003833
Andy Whitcroft65863862009-01-06 14:41:21 -08003834 # Should start with a space.
3835 $to =~ s/^(\S)/ $1/;
3836 # Should not end with a space.
3837 $to =~ s/\s+$//;
3838 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003839 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003840 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003841
Joe Perches3705ce52013-07-03 15:05:31 -07003842## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003843 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003844 if (ERROR("POINTER_LOCATION",
3845 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3846 $fix) {
3847 my $sub_from = $ident;
3848 my $sub_to = $ident;
3849 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003850 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003851 s@\Q$sub_from\E@$sub_to@;
3852 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003853 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003854 }
3855 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3856 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003857 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003858
Andy Whitcroft65863862009-01-06 14:41:21 -08003859 # Should start with a space.
3860 $to =~ s/^(\S)/ $1/;
3861 # Should not end with a space.
3862 $to =~ s/\s+$//;
3863 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003864 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003865 }
3866 # Modifiers should have spaces.
3867 $to =~ s/(\b$Modifier$)/$1 /;
3868
Joe Perches3705ce52013-07-03 15:05:31 -07003869## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003870 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003871 if (ERROR("POINTER_LOCATION",
3872 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3873 $fix) {
3874
3875 my $sub_from = $match;
3876 my $sub_to = $match;
3877 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003878 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003879 s@\Q$sub_from\E@$sub_to@;
3880 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003881 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003882 }
3883
Joe Perches9d3e3c72015-09-09 15:37:27 -07003884# avoid BUG() or BUG_ON()
3885 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003886 my $msg_level = \&WARN;
3887 $msg_level = \&CHK if ($file);
3888 &{$msg_level}("AVOID_BUG",
3889 "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 -07003890 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003891
Joe Perches9d3e3c72015-09-09 15:37:27 -07003892# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003893 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003894 WARN("LINUX_VERSION_CODE",
3895 "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 -08003896 }
3897
Joe Perches17441222011-06-15 15:08:17 -07003898# check for uses of printk_ratelimit
3899 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003900 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003901 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003902 }
3903
Joe Percheseeef5732017-11-17 15:28:41 -08003904# printk should use KERN_* levels
3905 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3906 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3907 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003908 }
3909
Joe Perches243f3802012-05-31 16:26:09 -07003910 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3911 my $orig = $1;
3912 my $level = lc($orig);
3913 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003914 my $level2 = $level;
3915 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003916 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003917 "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 -07003918 }
3919
3920 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003921 if (WARN("PREFER_PR_LEVEL",
3922 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3923 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003924 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003925 s/\bpr_warning\b/pr_warn/;
3926 }
Joe Perches243f3802012-05-31 16:26:09 -07003927 }
3928
Joe Perchesdc139312013-02-21 16:44:13 -08003929 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3930 my $orig = $1;
3931 my $level = lc($orig);
3932 $level = "warn" if ($level eq "warning");
3933 $level = "dbg" if ($level eq "debug");
3934 WARN("PREFER_DEV_LEVEL",
3935 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3936 }
3937
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003938# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3939# number of false positives, but assembly files are not checked, so at
3940# least the arch entry code will not trigger this warning.
3941 if ($line =~ /\bENOSYS\b/) {
3942 WARN("ENOSYS",
3943 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3944 }
3945
Andy Whitcroft653d4872007-06-23 17:16:34 -07003946# function brace can't be on same line, except for #defines of do while,
3947# or if closed on same line
Joe Perches2d453e32018-02-06 15:39:09 -08003948 if ($^V && $^V ge 5.10.0 &&
3949 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3950 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3951 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07003952 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08003953 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07003954 $fix) {
3955 fix_delete_line($fixlinenr, $rawline);
3956 my $fixed_line = $rawline;
3957 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3958 my $line1 = $1;
3959 my $line2 = $2;
3960 fix_insert_line($fixlinenr, ltrim($line1));
3961 fix_insert_line($fixlinenr, "\+{");
3962 if ($line2 !~ /^\s*$/) {
3963 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3964 }
3965 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003966 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003967
Andy Whitcroft8905a672007-11-28 16:21:06 -08003968# open braces for enum, union and struct go on the same line.
3969 if ($line =~ /^.\s*{/ &&
3970 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003971 if (ERROR("OPEN_BRACE",
3972 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3973 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3974 fix_delete_line($fixlinenr - 1, $prevrawline);
3975 fix_delete_line($fixlinenr, $rawline);
3976 my $fixedline = rtrim($prevrawline) . " {";
3977 fix_insert_line($fixlinenr, $fixedline);
3978 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003979 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003980 if ($fixedline !~ /^\+\s*$/) {
3981 fix_insert_line($fixlinenr, $fixedline);
3982 }
3983 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003984 }
3985
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003986# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003987 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3988 if (WARN("SPACING",
3989 "missing space after $1 definition\n" . $herecurr) &&
3990 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003991 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003992 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3993 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003994 }
3995
Joe Perches31070b52014-01-23 15:54:49 -08003996# Function pointer declarations
3997# check spacing between type, funcptr, and args
3998# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003999 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004000 my $declare = $1;
4001 my $pre_pointer_space = $2;
4002 my $post_pointer_space = $3;
4003 my $funcname = $4;
4004 my $post_funcname_space = $5;
4005 my $pre_args_space = $6;
4006
Joe Perches91f72e92014-04-03 14:49:12 -07004007# the $Declare variable will capture all spaces after the type
4008# so check it for a missing trailing missing space but pointer return types
4009# don't need a space so don't warn for those.
4010 my $post_declare_space = "";
4011 if ($declare =~ /(\s+)$/) {
4012 $post_declare_space = $1;
4013 $declare = rtrim($declare);
4014 }
4015 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004016 WARN("SPACING",
4017 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004018 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004019 }
4020
4021# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004022# This test is not currently implemented because these declarations are
4023# equivalent to
4024# int foo(int bar, ...)
4025# and this is form shouldn't/doesn't generate a checkpatch warning.
4026#
4027# elsif ($declare =~ /\s{2,}$/) {
4028# WARN("SPACING",
4029# "Multiple spaces after return type\n" . $herecurr);
4030# }
Joe Perches31070b52014-01-23 15:54:49 -08004031
4032# unnecessary space "type ( *funcptr)(args...)"
4033 if (defined $pre_pointer_space &&
4034 $pre_pointer_space =~ /^\s/) {
4035 WARN("SPACING",
4036 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4037 }
4038
4039# unnecessary space "type (* funcptr)(args...)"
4040 if (defined $post_pointer_space &&
4041 $post_pointer_space =~ /^\s/) {
4042 WARN("SPACING",
4043 "Unnecessary space before function pointer name\n" . $herecurr);
4044 }
4045
4046# unnecessary space "type (*funcptr )(args...)"
4047 if (defined $post_funcname_space &&
4048 $post_funcname_space =~ /^\s/) {
4049 WARN("SPACING",
4050 "Unnecessary space after function pointer name\n" . $herecurr);
4051 }
4052
4053# unnecessary space "type (*funcptr) (args...)"
4054 if (defined $pre_args_space &&
4055 $pre_args_space =~ /^\s/) {
4056 WARN("SPACING",
4057 "Unnecessary space before function pointer arguments\n" . $herecurr);
4058 }
4059
4060 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004061 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004062 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004063 }
4064 }
4065
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004066# check for spacing round square brackets; allowed:
4067# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004068# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4069# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004070 while ($line =~ /(.*?\s)\[/g) {
4071 my ($where, $prefix) = ($-[1], $1);
4072 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004073 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004074 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004075 if (ERROR("BRACKET_SPACE",
4076 "space prohibited before open square bracket '['\n" . $herecurr) &&
4077 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004078 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004079 s/^(\+.*?)\s+\[/$1\[/;
4080 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004081 }
4082 }
4083
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004084# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004085 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004086 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004087 my $ctx_before = substr($line, 0, $-[1]);
4088 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004089
4090 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004091 if ($name =~ /^(?:
4092 if|for|while|switch|return|case|
4093 volatile|__volatile__|
4094 __attribute__|format|__extension__|
4095 asm|__asm__)$/x)
4096 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004097 # cpp #define statements have non-optional spaces, ie
4098 # if there is a space between the name and the open
4099 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004100 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004101
4102 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004103 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004104
4105 # If this whole things ends with a type its most
4106 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004107 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004108
4109 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004110 if (WARN("SPACING",
4111 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4112 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004113 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004114 s/\b$name\s+\(/$name\(/;
4115 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004116 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004117 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004118
Andy Whitcroft653d4872007-06-23 17:16:34 -07004119# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004120 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004121 my $fixed_line = "";
4122 my $line_fixed = 0;
4123
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004124 my $ops = qr{
4125 <<=|>>=|<=|>=|==|!=|
4126 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4127 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004128 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004129 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004130 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004131 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004132
4133## print("element count: <" . $#elements . ">\n");
4134## foreach my $el (@elements) {
4135## print("el: <$el>\n");
4136## }
4137
4138 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004139 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004140
Joe Perches3705ce52013-07-03 15:05:31 -07004141 foreach my $el (@elements) {
4142 push(@fix_elements, substr($rawline, $off, length($el)));
4143 $off += length($el);
4144 }
4145
4146 $off = 0;
4147
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004148 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004149 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004150
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004151 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004152
4153 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4154
4155## print("n: <$n> good: <$good>\n");
4156
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004157 $off += length($elements[$n]);
4158
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004159 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004160 my $ca = substr($opline, 0, $off);
4161 my $cc = '';
4162 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4163 $cc = substr($opline, $off + length($elements[$n + 1]));
4164 }
4165 my $cb = "$ca$;$cc";
4166
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004167 my $a = '';
4168 $a = 'V' if ($elements[$n] ne '');
4169 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004170 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004171 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4172 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004173 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004174
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004175 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004176
4177 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004178 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004179 $c = 'V' if ($elements[$n + 2] ne '');
4180 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004181 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004182 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4183 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004184 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004185 } else {
4186 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004187 }
4188
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004189 my $ctx = "${a}x${c}";
4190
4191 my $at = "(ctx:$ctx)";
4192
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004193 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004194 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004195
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004196 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004197 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004198
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004199 # Get the full operator variant.
4200 my $opv = $op . substr($curr_vars, $off, 1);
4201
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004202 # Ignore operators passed as parameters.
4203 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004204 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004205
Andy Whitcroftcf655042008-03-04 14:28:20 -08004206# # Ignore comments
4207# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004208
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004209 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004210 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004211 if ($ctx !~ /.x[WEBC]/ &&
4212 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004213 if (ERROR("SPACING",
4214 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004215 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004216 $line_fixed = 1;
4217 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004218 }
4219
4220 # // is a comment
4221 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004222
Joe Perchesb00e4812014-04-03 14:49:33 -07004223 # : when part of a bitfield
4224 } elsif ($opv eq ':B') {
4225 # skip the bitfield test for now
4226
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004227 # No spaces for:
4228 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004229 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004230 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004231 if (ERROR("SPACING",
4232 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004233 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004234 if (defined $fix_elements[$n + 2]) {
4235 $fix_elements[$n + 2] =~ s/^\s+//;
4236 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004237 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004238 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004239 }
4240
Joe Perches23810972014-12-10 15:51:32 -08004241 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004242 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004243 my $rtrim_before = 0;
4244 my $space_after = 0;
4245 if ($ctx =~ /Wx./) {
4246 if (ERROR("SPACING",
4247 "space prohibited before that '$op' $at\n" . $hereptr)) {
4248 $line_fixed = 1;
4249 $rtrim_before = 1;
4250 }
4251 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004252 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004253 if (ERROR("SPACING",
4254 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004255 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004256 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004257 $space_after = 1;
4258 }
4259 }
4260 if ($rtrim_before || $space_after) {
4261 if ($rtrim_before) {
4262 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4263 } else {
4264 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4265 }
4266 if ($space_after) {
4267 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004268 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004269 }
4270
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004271 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004272 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004273 #warn "'*' is part of type\n";
4274
4275 # unary operators should have a space before and
4276 # none after. May be left adjacent to another
4277 # unary operator, or a cast
4278 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004279 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004280 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004281 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004282 if (ERROR("SPACING",
4283 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004284 if ($n != $last_after + 2) {
4285 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4286 $line_fixed = 1;
4287 }
Joe Perches3705ce52013-07-03 15:05:31 -07004288 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004289 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004290 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004291 # A unary '*' may be const
4292
4293 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004294 if (ERROR("SPACING",
4295 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004296 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004297 if (defined $fix_elements[$n + 2]) {
4298 $fix_elements[$n + 2] =~ s/^\s+//;
4299 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004300 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004301 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004302 }
4303
4304 # unary ++ and unary -- are allowed no space on one side.
4305 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004306 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004307 if (ERROR("SPACING",
4308 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004309 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004310 $line_fixed = 1;
4311 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004312 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004313 if ($ctx =~ /Wx[BE]/ ||
4314 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004315 if (ERROR("SPACING",
4316 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004317 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004318 $line_fixed = 1;
4319 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004320 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004321 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004322 if (ERROR("SPACING",
4323 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004324 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004325 if (defined $fix_elements[$n + 2]) {
4326 $fix_elements[$n + 2] =~ s/^\s+//;
4327 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004328 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004329 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004330 }
4331
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004332 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004333 } elsif ($op eq '<<' or $op eq '>>' or
4334 $op eq '&' or $op eq '^' or $op eq '|' or
4335 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004336 $op eq '*' or $op eq '/' or
4337 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004338 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004339 if ($check) {
4340 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4341 if (CHK("SPACING",
4342 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4343 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4344 $fix_elements[$n + 2] =~ s/^\s+//;
4345 $line_fixed = 1;
4346 }
4347 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4348 if (CHK("SPACING",
4349 "space preferred before that '$op' $at\n" . $hereptr)) {
4350 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4351 $line_fixed = 1;
4352 }
4353 }
4354 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004355 if (ERROR("SPACING",
4356 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004357 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4358 if (defined $fix_elements[$n + 2]) {
4359 $fix_elements[$n + 2] =~ s/^\s+//;
4360 }
Joe Perches3705ce52013-07-03 15:05:31 -07004361 $line_fixed = 1;
4362 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004363 }
4364
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004365 # A colon needs no spaces before when it is
4366 # terminating a case value or a label.
4367 } elsif ($opv eq ':C' || $opv eq ':L') {
4368 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004369 if (ERROR("SPACING",
4370 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004371 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004372 $line_fixed = 1;
4373 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004374 }
4375
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004376 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004377 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004378 my $ok = 0;
4379
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004380 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004381 if (($op eq '<' &&
4382 $cc =~ /^\S+\@\S+>/) ||
4383 ($op eq '>' &&
4384 $ca =~ /<\S+\@\S+$/))
4385 {
4386 $ok = 1;
4387 }
4388
Joe Perchese0df7e12015-04-16 12:44:53 -07004389 # for asm volatile statements
4390 # ignore a colon with another
4391 # colon immediately before or after
4392 if (($op eq ':') &&
4393 ($ca =~ /:$/ || $cc =~ /^:/)) {
4394 $ok = 1;
4395 }
4396
Joe Perches84731622013-11-12 15:10:05 -08004397 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004398 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004399 my $msg_level = \&ERROR;
4400 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004401
Jean Delvare0675a8f2017-09-08 16:16:07 -07004402 if (&{$msg_level}("SPACING",
4403 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004404 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4405 if (defined $fix_elements[$n + 2]) {
4406 $fix_elements[$n + 2] =~ s/^\s+//;
4407 }
Joe Perches3705ce52013-07-03 15:05:31 -07004408 $line_fixed = 1;
4409 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004410 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004411 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004412 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004413
4414## print("n: <$n> GOOD: <$good>\n");
4415
4416 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004417 }
Joe Perches3705ce52013-07-03 15:05:31 -07004418
4419 if (($#elements % 2) == 0) {
4420 $fixed_line = $fixed_line . $fix_elements[$#elements];
4421 }
4422
Joe Perches194f66f2014-08-06 16:11:03 -07004423 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4424 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004425 }
4426
4427
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004428 }
4429
Joe Perches786b6322013-07-03 15:05:32 -07004430# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004431 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004432 if (WARN("SPACING",
4433 "space prohibited before semicolon\n" . $herecurr) &&
4434 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004435 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004436 s/^(\+.*\S)\s+;/$1;/;
4437 }
4438 }
4439
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004440# check for multiple assignments
4441 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004442 CHK("MULTIPLE_ASSIGNMENTS",
4443 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004444 }
4445
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004446## # check for multiple declarations, allowing for a function declaration
4447## # continuation.
4448## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4449## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4450##
4451## # Remove any bracketed sections to ensure we do not
4452## # falsly report the parameters of functions.
4453## my $ln = $line;
4454## while ($ln =~ s/\([^\(\)]*\)//g) {
4455## }
4456## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004457## WARN("MULTIPLE_DECLARATION",
4458## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004459## }
4460## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004461
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004462#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004463 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004464 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004465 if (ERROR("SPACING",
4466 "space required before the open brace '{'\n" . $herecurr) &&
4467 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004468 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004469 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004470 }
4471
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004472## # check for blank lines before declarations
4473## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4474## $prevrawline =~ /^.\s*$/) {
4475## WARN("SPACING",
4476## "No blank lines before declarations\n" . $hereprev);
4477## }
4478##
4479
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004480# closing brace should have a space following it when it has anything
4481# on the line
4482 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004483 if (ERROR("SPACING",
4484 "space required after that close brace '}'\n" . $herecurr) &&
4485 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004486 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004487 s/}((?!(?:,|;|\)))\S)/} $1/;
4488 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004489 }
4490
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004491# check spacing on square brackets
4492 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004493 if (ERROR("SPACING",
4494 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4495 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004496 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004497 s/\[\s+/\[/;
4498 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004499 }
4500 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004501 if (ERROR("SPACING",
4502 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4503 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004504 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004505 s/\s+\]/\]/;
4506 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004507 }
4508
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004509# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004510 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4511 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004512 if (ERROR("SPACING",
4513 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4514 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004515 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004516 s/\(\s+/\(/;
4517 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004518 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004519 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004520 $line !~ /for\s*\(.*;\s+\)/ &&
4521 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004522 if (ERROR("SPACING",
4523 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4524 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004525 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004526 s/\s+\)/\)/;
4527 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004528 }
4529
Joe Perchese2826fd2014-08-06 16:10:48 -07004530# check unnecessary parentheses around addressof/dereference single $Lvals
4531# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4532
4533 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004534 my $var = $1;
4535 if (CHK("UNNECESSARY_PARENTHESES",
4536 "Unnecessary parentheses around $var\n" . $herecurr) &&
4537 $fix) {
4538 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4539 }
4540 }
4541
4542# check for unnecessary parentheses around function pointer uses
4543# ie: (foo->bar)(); should be foo->bar();
4544# but not "if (foo->bar) (" to avoid some false positives
4545 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4546 my $var = $2;
4547 if (CHK("UNNECESSARY_PARENTHESES",
4548 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4549 $fix) {
4550 my $var2 = deparenthesize($var);
4551 $var2 =~ s/\s//g;
4552 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4553 }
4554 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004555
Joe Perches63b7c732017-09-08 16:16:01 -07004556# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004557# when !drivers/staging or command-line uses --strict
4558 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4559 $^V && $^V ge 5.10.0 && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004560 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4561 my $if_stat = $1;
4562 my $test = substr($2, 1, -1);
4563 my $herectx;
4564 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4565 my $match = $1;
4566 # avoid parentheses around potential macro args
4567 next if ($match =~ /^\s*\w+\s*$/);
4568 if (!defined($herectx)) {
4569 $herectx = $here . "\n";
4570 my $cnt = statement_rawlines($if_stat);
4571 for (my $n = 0; $n < $cnt; $n++) {
4572 my $rl = raw_line($linenr, $n);
4573 $herectx .= $rl . "\n";
4574 last if $rl =~ /^[ \+].*\{/;
4575 }
4576 }
4577 CHK("UNNECESSARY_PARENTHESES",
4578 "Unnecessary parentheses around '$match'\n" . $herectx);
4579 }
4580 }
4581
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004582#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004583 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004584 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004585 if (WARN("INDENTED_LABEL",
4586 "labels should not be indented\n" . $herecurr) &&
4587 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004588 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004589 s/^(.)\s+/$1/;
4590 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004591 }
4592
Joe Perches5b9553a2014-04-03 14:49:21 -07004593# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004594 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004595 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004596 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004597 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4598 my $value = $1;
4599 $value = deparenthesize($value);
4600 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4601 ERROR("RETURN_PARENTHESES",
4602 "return is not a function, parentheses are not required\n" . $herecurr);
4603 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004604 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004605 ERROR("SPACING",
4606 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004607 }
4608 }
Joe Perches507e5142013-11-12 15:10:13 -08004609
Joe Perchesb43ae212014-06-23 13:22:07 -07004610# unnecessary return in a void function
4611# at end-of-function, with the previous line a single leading tab, then return;
4612# and the line before that not a goto label target like "out:"
4613 if ($sline =~ /^[ \+]}\s*$/ &&
4614 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4615 $linenr >= 3 &&
4616 $lines[$linenr - 3] =~ /^[ +]/ &&
4617 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004618 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004619 "void function return statements are not generally useful\n" . $hereprev);
4620 }
Joe Perches9819cf22014-06-04 16:12:09 -07004621
Joe Perches189248d2014-01-23 15:54:47 -08004622# if statements using unnecessary parentheses - ie: if ((foo == bar))
4623 if ($^V && $^V ge 5.10.0 &&
4624 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4625 my $openparens = $1;
4626 my $count = $openparens =~ tr@\(@\(@;
4627 my $msg = "";
4628 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4629 my $comp = $4; #Not $1 because of $LvalOrFunc
4630 $msg = " - maybe == should be = ?" if ($comp eq "==");
4631 WARN("UNNECESSARY_PARENTHESES",
4632 "Unnecessary parentheses$msg\n" . $herecurr);
4633 }
4634 }
4635
Joe Perchesc5595fa2015-09-09 15:37:58 -07004636# comparisons with a constant or upper case identifier on the left
4637# avoid cases like "foo + BAR < baz"
4638# only fix matches surrounded by parentheses to avoid incorrect
4639# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4640 if ($^V && $^V ge 5.10.0 &&
4641 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4642 my $lead = $1;
4643 my $const = $2;
4644 my $comp = $3;
4645 my $to = $4;
4646 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004647 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004648 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4649 WARN("CONSTANT_COMPARISON",
4650 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4651 $fix) {
4652 if ($comp eq "<") {
4653 $newcomp = ">";
4654 } elsif ($comp eq "<=") {
4655 $newcomp = ">=";
4656 } elsif ($comp eq ">") {
4657 $newcomp = "<";
4658 } elsif ($comp eq ">=") {
4659 $newcomp = "<=";
4660 }
4661 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4662 }
4663 }
4664
Joe Perchesf34e4a42015-04-16 12:44:19 -07004665# Return of what appears to be an errno should normally be negative
4666 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004667 my $name = $1;
4668 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004669 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004670 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004671 }
4672 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004673
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004674# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004675 if ($line =~ /\b(if|while|for|switch)\(/) {
4676 if (ERROR("SPACING",
4677 "space required before the open parenthesis '('\n" . $herecurr) &&
4678 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004679 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004680 s/\b(if|while|for|switch)\(/$1 \(/;
4681 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004682 }
4683
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004684# Check for illegal assignment in if conditional -- and check for trailing
4685# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004686 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004687 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4688 ctx_statement_block($linenr, $realcnt, 0)
4689 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004690 my ($stat_next) = ctx_statement_block($line_nr_next,
4691 $remain_next, $off_next);
4692 $stat_next =~ s/\n./\n /g;
4693 ##print "stat<$stat> stat_next<$stat_next>\n";
4694
4695 if ($stat_next =~ /^\s*while\b/) {
4696 # If the statement carries leading newlines,
4697 # then count those as offsets.
4698 my ($whitespace) =
4699 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4700 my $offset =
4701 statement_rawlines($whitespace) - 1;
4702
4703 $suppress_whiletrailers{$line_nr_next +
4704 $offset} = 1;
4705 }
4706 }
4707 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004708 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004709 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004710 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004711
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004712 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004713 ERROR("ASSIGN_IN_IF",
4714 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004715 }
4716
4717 # Find out what is on the end of the line after the
4718 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004719 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004720 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004721 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004722 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4723 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004724 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004725 # Find out how long the conditional actually is.
4726 my @newlines = ($c =~ /\n/gs);
4727 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004728 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004729
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004730 $stat_real = raw_line($linenr, $cond_lines)
4731 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004732 if (defined($stat_real) && $cond_lines > 1) {
4733 $stat_real = "[...]\n$stat_real";
4734 }
4735
Joe Perches000d1cc12011-07-25 17:13:25 -07004736 ERROR("TRAILING_STATEMENTS",
4737 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004738 }
4739 }
4740
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004741# Check for bitwise tests written as boolean
4742 if ($line =~ /
4743 (?:
4744 (?:\[|\(|\&\&|\|\|)
4745 \s*0[xX][0-9]+\s*
4746 (?:\&\&|\|\|)
4747 |
4748 (?:\&\&|\|\|)
4749 \s*0[xX][0-9]+\s*
4750 (?:\&\&|\|\||\)|\])
4751 )/x)
4752 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004753 WARN("HEXADECIMAL_BOOLEAN_TEST",
4754 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004755 }
4756
Andy Whitcroft8905a672007-11-28 16:21:06 -08004757# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004758 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4759 my $s = $1;
4760 $s =~ s/$;//g; # Remove any comments
4761 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004762 ERROR("TRAILING_STATEMENTS",
4763 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004764 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004765 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004766# if should not continue a brace
4767 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004768 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004769 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004770 $herecurr);
4771 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004772# case and default should not have general statements after them
4773 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4774 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004775 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004776 \s*return\s+
4777 )/xg)
4778 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004779 ERROR("TRAILING_STATEMENTS",
4780 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004781 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004782
4783 # Check for }<nl>else {, these must be at the same
4784 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004785 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4786 $previndent == $indent) {
4787 if (ERROR("ELSE_AFTER_BRACE",
4788 "else should follow close brace '}'\n" . $hereprev) &&
4789 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4790 fix_delete_line($fixlinenr - 1, $prevrawline);
4791 fix_delete_line($fixlinenr, $rawline);
4792 my $fixedline = $prevrawline;
4793 $fixedline =~ s/}\s*$//;
4794 if ($fixedline !~ /^\+\s*$/) {
4795 fix_insert_line($fixlinenr, $fixedline);
4796 }
4797 $fixedline = $rawline;
4798 $fixedline =~ s/^(.\s*)else/$1} else/;
4799 fix_insert_line($fixlinenr, $fixedline);
4800 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004801 }
4802
Joe Perches8b8856f2014-08-06 16:11:14 -07004803 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4804 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004805 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4806
4807 # Find out what is on the end of the line after the
4808 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004809 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004810 $s =~ s/\n.*//g;
4811
4812 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004813 if (ERROR("WHILE_AFTER_BRACE",
4814 "while should follow close brace '}'\n" . $hereprev) &&
4815 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4816 fix_delete_line($fixlinenr - 1, $prevrawline);
4817 fix_delete_line($fixlinenr, $rawline);
4818 my $fixedline = $prevrawline;
4819 my $trailing = $rawline;
4820 $trailing =~ s/^\+//;
4821 $trailing = trim($trailing);
4822 $fixedline =~ s/}\s*$/} $trailing/;
4823 fix_insert_line($fixlinenr, $fixedline);
4824 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004825 }
4826 }
4827
Joe Perches95e2c602013-07-03 15:05:20 -07004828#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004829 while ($line =~ m{($Constant|$Lval)}g) {
4830 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004831
4832#gcc binary extension
4833 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004834 if (WARN("GCC_BINARY_CONSTANT",
4835 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4836 $fix) {
4837 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004838 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004839 s/\b$var\b/$hexval/;
4840 }
Joe Perches95e2c602013-07-03 15:05:20 -07004841 }
4842
4843#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004844 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004845 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004846#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004847 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004848#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004849 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4850#Ignore some three character SI units explicitly, like MiB and KHz
4851 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004852 while ($var =~ m{($Ident)}g) {
4853 my $word = $1;
4854 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004855 if ($check) {
4856 seed_camelcase_includes();
4857 if (!$file && !$camelcase_file_seeded) {
4858 seed_camelcase_file($realfile);
4859 $camelcase_file_seeded = 1;
4860 }
4861 }
Joe Perches7e781f62013-09-11 14:23:55 -07004862 if (!defined $camelcase{$word}) {
4863 $camelcase{$word} = 1;
4864 CHK("CAMELCASE",
4865 "Avoid CamelCase: <$word>\n" . $herecurr);
4866 }
Joe Perches34456862013-07-03 15:05:34 -07004867 }
Joe Perches323c1262012-12-17 16:02:07 -08004868 }
4869 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004870
4871#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004872 if ($line =~ /\#\s*define.*\\\s+$/) {
4873 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4874 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4875 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004876 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004877 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004878 }
4879
Fabian Frederick0e212e02015-04-16 12:44:25 -07004880# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4881# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004882 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004883 my $file = "$1.h";
4884 my $checkfile = "include/linux/$file";
4885 if (-f "$root/$checkfile" &&
4886 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004887 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004888 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004889 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4890 if ($asminclude > 0) {
4891 if ($realfile =~ m{^arch/}) {
4892 CHK("ARCH_INCLUDE_LINUX",
4893 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4894 } else {
4895 WARN("INCLUDE_LINUX",
4896 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4897 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004898 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004899 }
4900 }
4901
Andy Whitcroft653d4872007-06-23 17:16:34 -07004902# multi-statement macros should be enclosed in a do while loop, grab the
4903# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004904# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004905 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4906 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004907 my $ln = $linenr;
4908 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004909 my ($off, $dstat, $dcond, $rest);
4910 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004911 my $has_flow_statement = 0;
4912 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004913 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004914 ctx_statement_block($linenr, $realcnt, 0);
4915 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004916 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004917 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004918
Joe Perches08a28432014-10-13 15:51:55 -07004919 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004920 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004921
Joe Perchesf59b64b2016-10-11 13:52:08 -07004922 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4923 my $define_args = $1;
4924 my $define_stmt = $dstat;
4925 my @def_args = ();
4926
4927 if (defined $define_args && $define_args ne "") {
4928 $define_args = substr($define_args, 1, length($define_args) - 2);
4929 $define_args =~ s/\s*//g;
4930 @def_args = split(",", $define_args);
4931 }
4932
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004933 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004934 $dstat =~ s/\\\n.//g;
4935 $dstat =~ s/^\s*//s;
4936 $dstat =~ s/\s*$//s;
4937
4938 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004939 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4940 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004941 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004942 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004943 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004944
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004945 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004946 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4947 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004948 {
4949 }
4950
Joe Perches42e15292016-03-15 14:58:01 -07004951 # Make asm volatile uses seem like a generic function
4952 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4953
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004954 my $exceptions = qr{
4955 $Declare|
4956 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004957 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004958 DECLARE_PER_CPU|
4959 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004960 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004961 union|
4962 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004963 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004964 ^\"|\"$|
4965 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004966 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004967 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004968
4969 $ctx =~ s/\n*$//;
4970 my $herectx = $here . "\n";
4971 my $stmt_cnt = statement_rawlines($ctx);
4972
4973 for (my $n = 0; $n < $stmt_cnt; $n++) {
4974 $herectx .= raw_line($linenr, $n) . "\n";
4975 }
4976
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004977 if ($dstat ne '' &&
4978 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4979 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004980 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004981 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004982 $dstat !~ /$exceptions/ &&
4983 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004984 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004985 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004986 $dstat !~ /^for\s*$Constant$/ && # for (...)
4987 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4988 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004989 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004990 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004991 {
Joe Perchese7955562017-05-08 15:55:48 -07004992 if ($dstat =~ /^\s*if\b/) {
4993 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4994 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4995 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004996 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4997 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4998 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004999 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005000 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005001 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005002
5003 }
Joe Perches52076492016-10-11 13:52:14 -07005004
5005 # Make $define_stmt single line, comment-free, etc
5006 my @stmt_array = split('\n', $define_stmt);
5007 my $first = 1;
5008 $define_stmt = "";
5009 foreach my $l (@stmt_array) {
5010 $l =~ s/\\$//;
5011 if ($first) {
5012 $define_stmt = $l;
5013 $first = 0;
5014 } elsif ($l =~ /^[\+ ]/) {
5015 $define_stmt .= substr($l, 1);
5016 }
5017 }
5018 $define_stmt =~ s/$;//g;
5019 $define_stmt =~ s/\s+/ /g;
5020 $define_stmt = trim($define_stmt);
5021
Joe Perchesf59b64b2016-10-11 13:52:08 -07005022# check if any macro arguments are reused (ignore '...' and 'type')
5023 foreach my $arg (@def_args) {
5024 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005025 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005026 my $tmp_stmt = $define_stmt;
5027 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5028 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5029 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5030 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005031 if ($use_cnt > 1) {
5032 CHK("MACRO_ARG_REUSE",
5033 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005034 }
5035# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005036 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005037 ((defined($1) && $1 ne ',') ||
5038 (defined($2) && $2 ne ','))) {
5039 CHK("MACRO_ARG_PRECEDENCE",
5040 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005041 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005042 }
Joe Perches5023d342012-12-17 16:01:47 -08005043
Joe Perches08a28432014-10-13 15:51:55 -07005044# check for macros with flow control, but without ## concatenation
5045# ## concatenation is commonly a macro that defines a function so ignore those
5046 if ($has_flow_statement && !$has_arg_concat) {
5047 my $herectx = $here . "\n";
5048 my $cnt = statement_rawlines($ctx);
5049
5050 for (my $n = 0; $n < $cnt; $n++) {
5051 $herectx .= raw_line($linenr, $n) . "\n";
5052 }
5053 WARN("MACRO_WITH_FLOW_CONTROL",
5054 "Macros with flow control statements should be avoided\n" . "$herectx");
5055 }
5056
Joe Perches481eb482012-12-17 16:01:56 -08005057# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005058
5059 } else {
5060 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005061 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5062 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005063 $line =~ /^\+.*\\$/) {
5064 WARN("LINE_CONTINUATIONS",
5065 "Avoid unnecessary line continuations\n" . $herecurr);
5066 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005067 }
5068
Joe Perchesb13edf72012-07-30 14:41:24 -07005069# do {} while (0) macro tests:
5070# single-statement macros do not need to be enclosed in do while (0) loop,
5071# macro should not end with a semicolon
5072 if ($^V && $^V ge 5.10.0 &&
5073 $realfile !~ m@/vmlinux.lds.h$@ &&
5074 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5075 my $ln = $linenr;
5076 my $cnt = $realcnt;
5077 my ($off, $dstat, $dcond, $rest);
5078 my $ctx = '';
5079 ($dstat, $dcond, $ln, $cnt, $off) =
5080 ctx_statement_block($linenr, $realcnt, 0);
5081 $ctx = $dstat;
5082
5083 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005084 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005085
5086 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5087 my $stmts = $2;
5088 my $semis = $3;
5089
5090 $ctx =~ s/\n*$//;
5091 my $cnt = statement_rawlines($ctx);
5092 my $herectx = $here . "\n";
5093
5094 for (my $n = 0; $n < $cnt; $n++) {
5095 $herectx .= raw_line($linenr, $n) . "\n";
5096 }
5097
Joe Perchesac8e97f2012-08-21 16:15:53 -07005098 if (($stmts =~ tr/;/;/) == 1 &&
5099 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005100 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5101 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5102 }
5103 if (defined $semis && $semis ne "") {
5104 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5105 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5106 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005107 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5108 $ctx =~ s/\n*$//;
5109 my $cnt = statement_rawlines($ctx);
5110 my $herectx = $here . "\n";
5111
5112 for (my $n = 0; $n < $cnt; $n++) {
5113 $herectx .= raw_line($linenr, $n) . "\n";
5114 }
5115
5116 WARN("TRAILING_SEMICOLON",
5117 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005118 }
5119 }
5120
Mike Frysinger080ba922009-01-06 14:41:25 -08005121# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5122# all assignments may have only one of the following with an assignment:
5123# .
5124# ALIGN(...)
5125# VMLINUX_SYMBOL(...)
5126 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005127 WARN("MISSING_VMLINUX_SYMBOL",
5128 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005129 }
5130
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005131# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005132 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5133 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005134 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005135 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005136 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5137 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005138 my @allowed = ();
5139 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005140 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005141 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005142 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005143 for my $chunk (@chunks) {
5144 my ($cond, $block) = @{$chunk};
5145
Andy Whitcroft773647a2008-03-28 14:15:58 -07005146 # If the condition carries leading newlines, then count those as offsets.
5147 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5148 my $offset = statement_rawlines($whitespace) - 1;
5149
Joe Perchesaad4f612012-03-23 15:02:19 -07005150 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005151 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5152
5153 # We have looked at and allowed this specific line.
5154 $suppress_ifbraces{$ln + $offset} = 1;
5155
5156 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005157 $ln += statement_rawlines($block) - 1;
5158
Andy Whitcroft773647a2008-03-28 14:15:58 -07005159 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005160
5161 $seen++ if ($block =~ /^\s*{/);
5162
Joe Perchesaad4f612012-03-23 15:02:19 -07005163 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005164 if (statement_lines($cond) > 1) {
5165 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005166 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005167 }
5168 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005169 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005170 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005171 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005172 if (statement_block_size($block) > 1) {
5173 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005174 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005175 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005176 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005177 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005178 if ($seen) {
5179 my $sum_allowed = 0;
5180 foreach (@allowed) {
5181 $sum_allowed += $_;
5182 }
5183 if ($sum_allowed == 0) {
5184 WARN("BRACES",
5185 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5186 } elsif ($sum_allowed != $allow &&
5187 $seen != $allow) {
5188 CHK("BRACES",
5189 "braces {} should be used on all arms of this statement\n" . $herectx);
5190 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005191 }
5192 }
5193 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005194 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005195 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005196 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005197
Andy Whitcroftcf655042008-03-04 14:28:20 -08005198 # Check the pre-context.
5199 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5200 #print "APW: ALLOWED: pre<$1>\n";
5201 $allowed = 1;
5202 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005203
5204 my ($level, $endln, @chunks) =
5205 ctx_statement_full($linenr, $realcnt, $-[0]);
5206
Andy Whitcroftcf655042008-03-04 14:28:20 -08005207 # Check the condition.
5208 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005209 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005210 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005211 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005212 }
5213 if (statement_lines($cond) > 1) {
5214 #print "APW: ALLOWED: cond<$cond>\n";
5215 $allowed = 1;
5216 }
5217 if ($block =~/\b(?:if|for|while)\b/) {
5218 #print "APW: ALLOWED: block<$block>\n";
5219 $allowed = 1;
5220 }
5221 if (statement_block_size($block) > 1) {
5222 #print "APW: ALLOWED: lines block<$block>\n";
5223 $allowed = 1;
5224 }
5225 # Check the post-context.
5226 if (defined $chunks[1]) {
5227 my ($cond, $block) = @{$chunks[1]};
5228 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005229 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005230 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005231 if ($block =~ /^\s*\{/) {
5232 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5233 $allowed = 1;
5234 }
5235 }
5236 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005237 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005238 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005239
Andy Whitcroftf0556632008-10-15 22:02:23 -07005240 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005241 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005242 }
5243
Joe Perches000d1cc12011-07-25 17:13:25 -07005244 WARN("BRACES",
5245 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005246 }
5247 }
5248
Joe Perchese4c5bab2017-02-24 15:01:41 -08005249# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005250 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5251 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005252 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5253 }
5254
Joe Perches0979ae62012-12-17 16:01:59 -08005255# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005256 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005257 if (CHK("BRACES",
5258 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5259 $fix && $prevrawline =~ /^\+/) {
5260 fix_delete_line($fixlinenr - 1, $prevrawline);
5261 }
Joe Perches0979ae62012-12-17 16:01:59 -08005262 }
Joe Perches77b9a532013-07-03 15:05:29 -07005263 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005264 if (CHK("BRACES",
5265 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5266 $fix) {
5267 fix_delete_line($fixlinenr, $rawline);
5268 }
Joe Perches0979ae62012-12-17 16:01:59 -08005269 }
5270
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005271# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005272 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5273 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005274 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005275 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005276 }
5277
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005278# Check for user-visible strings broken across lines, which breaks the ability
5279# to grep for the string. Make exceptions when the previous string ends in a
5280# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5281# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005282 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005283 $prevline =~ /"\s*$/ &&
5284 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5285 if (WARN("SPLIT_STRING",
5286 "quoted string split across lines\n" . $hereprev) &&
5287 $fix &&
5288 $prevrawline =~ /^\+.*"\s*$/ &&
5289 $last_coalesced_string_linenr != $linenr - 1) {
5290 my $extracted_string = get_quoted_string($line, $rawline);
5291 my $comma_close = "";
5292 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5293 $comma_close = $1;
5294 }
5295
5296 fix_delete_line($fixlinenr - 1, $prevrawline);
5297 fix_delete_line($fixlinenr, $rawline);
5298 my $fixedline = $prevrawline;
5299 $fixedline =~ s/"\s*$//;
5300 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5301 fix_insert_line($fixlinenr - 1, $fixedline);
5302 $fixedline = $rawline;
5303 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5304 if ($fixedline !~ /\+\s*$/) {
5305 fix_insert_line($fixlinenr, $fixedline);
5306 }
5307 $last_coalesced_string_linenr = $linenr;
5308 }
5309 }
5310
5311# check for missing a space in a string concatenation
5312 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5313 WARN('MISSING_SPACE',
5314 "break quoted strings at a space character\n" . $hereprev);
5315 }
5316
Joe Perchese4b7d302017-05-08 15:55:51 -07005317# check for an embedded function name in a string when the function is known
5318# This does not work very well for -f --file checking as it depends on patch
5319# context providing the function name or a single line form for in-file
5320# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005321 if ($line =~ /^\+.*$String/ &&
5322 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005323 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5324 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005325 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005326 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005327 }
5328
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005329# check for spaces before a quoted newline
5330 if ($rawline =~ /^.*\".*\s\\n/) {
5331 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5332 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5333 $fix) {
5334 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5335 }
5336
5337 }
5338
Joe Perchesf17dba42014-10-13 15:51:51 -07005339# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005340 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005341 CHK("CONCATENATED_STRING",
5342 "Concatenated strings should use spaces between elements\n" . $herecurr);
5343 }
5344
Joe Perches90ad30e2014-12-10 15:51:59 -08005345# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005346 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005347 WARN("STRING_FRAGMENTS",
5348 "Consecutive strings are generally better as a single string\n" . $herecurr);
5349 }
5350
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005351# check for non-standard and hex prefixed decimal printf formats
5352 my $show_L = 1; #don't show the same defect twice
5353 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005354 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005355 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005356 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005357 # check for %L
5358 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005359 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005360 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5361 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005362 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005363 # check for %Z
5364 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5365 WARN("PRINTF_Z",
5366 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5367 $show_Z = 0;
5368 }
5369 # check for 0x<decimal>
5370 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5371 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005372 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5373 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005374 }
5375
5376# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005377 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005378 WARN("LINE_CONTINUATIONS",
5379 "Avoid line continuations in quoted strings\n" . $herecurr);
5380 }
5381
Andy Whitcroft00df3442007-06-08 13:47:06 -07005382# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005383 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005384 CHK("REDUNDANT_CODE",
5385 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005386 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005387 }
5388
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005389# check for needless "if (<foo>) fn(<foo>)" uses
5390 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005391 my $tested = quotemeta($1);
5392 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5393 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5394 my $func = $1;
5395 if (WARN('NEEDLESS_IF',
5396 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5397 $fix) {
5398 my $do_fix = 1;
5399 my $leading_tabs = "";
5400 my $new_leading_tabs = "";
5401 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5402 $leading_tabs = $1;
5403 } else {
5404 $do_fix = 0;
5405 }
5406 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5407 $new_leading_tabs = $1;
5408 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5409 $do_fix = 0;
5410 }
5411 } else {
5412 $do_fix = 0;
5413 }
5414 if ($do_fix) {
5415 fix_delete_line($fixlinenr - 1, $prevrawline);
5416 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5417 }
5418 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005419 }
5420 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005421
Joe Perchesebfdc402014-08-06 16:10:27 -07005422# check for unnecessary "Out of Memory" messages
5423 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5424 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5425 (defined $1 || defined $3) &&
5426 $linenr > 3) {
5427 my $testval = $2;
5428 my $testline = $lines[$linenr - 3];
5429
5430 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5431# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5432
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005433 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
Joe Perchesebfdc402014-08-06 16:10:27 -07005434 WARN("OOM_MESSAGE",
5435 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5436 }
5437 }
5438
Joe Perchesf78d98f2014-10-13 15:52:01 -07005439# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005440 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005441 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5442 my $level = $1;
5443 if (WARN("UNNECESSARY_KERN_LEVEL",
5444 "Possible unnecessary $level\n" . $herecurr) &&
5445 $fix) {
5446 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5447 }
5448 }
5449
Joe Perches45c55e92017-02-24 15:01:31 -08005450# check for logging continuations
5451 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5452 WARN("LOGGING_CONTINUATION",
5453 "Avoid logging continuation uses where feasible\n" . $herecurr);
5454 }
5455
Joe Perchesabb08a52014-12-10 15:51:46 -08005456# check for mask then right shift without a parentheses
5457 if ($^V && $^V ge 5.10.0 &&
5458 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5459 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5460 WARN("MASK_THEN_SHIFT",
5461 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5462 }
5463
Joe Perchesb75ac612014-12-10 15:52:02 -08005464# check for pointer comparisons to NULL
5465 if ($^V && $^V ge 5.10.0) {
5466 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5467 my $val = $1;
5468 my $equal = "!";
5469 $equal = "" if ($4 eq "!=");
5470 if (CHK("COMPARISON_TO_NULL",
5471 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5472 $fix) {
5473 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5474 }
5475 }
5476 }
5477
Joe Perches8716de32013-09-11 14:24:05 -07005478# check for bad placement of section $InitAttribute (e.g.: __initdata)
5479 if ($line =~ /(\b$InitAttribute\b)/) {
5480 my $attr = $1;
5481 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5482 my $ptr = $1;
5483 my $var = $2;
5484 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5485 ERROR("MISPLACED_INIT",
5486 "$attr should be placed after $var\n" . $herecurr)) ||
5487 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5488 WARN("MISPLACED_INIT",
5489 "$attr should be placed after $var\n" . $herecurr))) &&
5490 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005491 $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 -07005492 }
5493 }
5494 }
5495
Joe Perchese970b8842013-11-12 15:10:10 -08005496# check for $InitAttributeData (ie: __initdata) with const
5497 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5498 my $attr = $1;
5499 $attr =~ /($InitAttributePrefix)(.*)/;
5500 my $attr_prefix = $1;
5501 my $attr_type = $2;
5502 if (ERROR("INIT_ATTRIBUTE",
5503 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5504 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005505 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005506 s/$InitAttributeData/${attr_prefix}initconst/;
5507 }
5508 }
5509
5510# check for $InitAttributeConst (ie: __initconst) without const
5511 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5512 my $attr = $1;
5513 if (ERROR("INIT_ATTRIBUTE",
5514 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5515 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005516 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005517 /(^\+\s*(?:static\s+))/;
5518 $lead = rtrim($1);
5519 $lead = "$lead " if ($lead !~ /^\+$/);
5520 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005521 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005522 }
5523 }
5524
Joe Perchesc17893c2015-04-16 12:44:42 -07005525# check for __read_mostly with const non-pointer (should just be const)
5526 if ($line =~ /\b__read_mostly\b/ &&
5527 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5528 if (ERROR("CONST_READ_MOSTLY",
5529 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5530 $fix) {
5531 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5532 }
5533 }
5534
Joe Perchesfbdb8132014-04-03 14:49:14 -07005535# don't use __constant_<foo> functions outside of include/uapi/
5536 if ($realfile !~ m@^include/uapi/@ &&
5537 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5538 my $constant_func = $1;
5539 my $func = $constant_func;
5540 $func =~ s/^__constant_//;
5541 if (WARN("CONSTANT_CONVERSION",
5542 "$constant_func should be $func\n" . $herecurr) &&
5543 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005544 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005545 }
5546 }
5547
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005548# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005549 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005550 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005551 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005552 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005553 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005554 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5555 }
5556 if ($delay > 2000) {
5557 WARN("LONG_UDELAY",
5558 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005559 }
5560 }
5561
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005562# warn about unexpectedly long msleep's
5563 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5564 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005565 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005566 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005567 }
5568 }
5569
Joe Perches36ec1932013-07-03 15:05:25 -07005570# check for comparisons of jiffies
5571 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5572 WARN("JIFFIES_COMPARISON",
5573 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5574 }
5575
Joe Perches9d7a34a2013-07-03 15:05:26 -07005576# check for comparisons of get_jiffies_64()
5577 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5578 WARN("JIFFIES_COMPARISON",
5579 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5580 }
5581
Andy Whitcroft00df3442007-06-08 13:47:06 -07005582# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005583# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005584# print "#ifdef in C files should be avoided\n";
5585# print "$herecurr";
5586# $clean = 0;
5587# }
5588
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005589# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005590 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005591 if (ERROR("SPACING",
5592 "exactly one space required after that #$1\n" . $herecurr) &&
5593 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005594 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005595 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5596 }
5597
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005598 }
5599
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005600# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005601 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5602 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005603 my $which = $1;
5604 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005605 CHK("UNCOMMENTED_DEFINITION",
5606 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005607 }
5608 }
5609# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005610
5611 my $barriers = qr{
5612 mb|
5613 rmb|
5614 wmb|
5615 read_barrier_depends
5616 }x;
5617 my $barrier_stems = qr{
5618 mb__before_atomic|
5619 mb__after_atomic|
5620 store_release|
5621 load_acquire|
5622 store_mb|
5623 (?:$barriers)
5624 }x;
5625 my $all_barriers = qr{
5626 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005627 smp_(?:$barrier_stems)|
5628 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005629 }x;
5630
5631 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005632 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005633 WARN("MEMORY_BARRIER",
5634 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005635 }
5636 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005637
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005638 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5639
5640 if ($realfile !~ m@^include/asm-generic/@ &&
5641 $realfile !~ m@/barrier\.h$@ &&
5642 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5643 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5644 WARN("MEMORY_BARRIER",
5645 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5646 }
5647
Joe Perchescb426e92015-06-25 15:02:46 -07005648# check for waitqueue_active without a comment.
5649 if ($line =~ /\bwaitqueue_active\s*\(/) {
5650 if (!ctx_has_comment($first_line, $linenr)) {
5651 WARN("WAITQUEUE_ACTIVE",
5652 "waitqueue_active without comment\n" . $herecurr);
5653 }
5654 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005655
Paul E. McKenney91db2592017-11-27 09:37:35 -08005656# check for smp_read_barrier_depends and read_barrier_depends
5657 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5658 WARN("READ_BARRIER_DEPENDS",
5659 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5660 }
5661
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005662# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005663 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005664 CHK("ARCH_DEFINES",
5665 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005666 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005667
Joe Perches596ed452017-07-12 14:37:02 -07005668# check that the storage class is not after a type
5669 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005670 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005671 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5672 }
5673# Check that the storage class is at the beginning of a declaration
5674 if ($line =~ /\b$Storage\b/ &&
5675 $line !~ /^.\s*$Storage/ &&
5676 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5677 $1 !~ /[\,\)]\s*$/) {
5678 WARN("STORAGE_CLASS",
5679 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005680 }
5681
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005682# check the location of the inline attribute, that it is between
5683# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005684 if ($line =~ /\b$Type\s+$Inline\b/ ||
5685 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005686 ERROR("INLINE_LOCATION",
5687 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005688 }
5689
Andy Whitcroft8905a672007-11-28 16:21:06 -08005690# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005691 if ($realfile !~ m@\binclude/uapi/@ &&
5692 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005693 if (WARN("INLINE",
5694 "plain inline is preferred over $1\n" . $herecurr) &&
5695 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005696 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005697
5698 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005699 }
5700
Joe Perches3d130fd2011-01-12 17:00:00 -08005701# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005702 if ($realfile !~ m@\binclude/uapi/@ &&
5703 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005704 WARN("PREFER_PACKED",
5705 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005706 }
5707
Joe Perches39b7e282011-07-25 17:13:24 -07005708# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005709 if ($realfile !~ m@\binclude/uapi/@ &&
5710 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005711 WARN("PREFER_ALIGNED",
5712 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005713 }
5714
Joe Perches5f14d3b2012-01-10 15:09:52 -08005715# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005716 if ($realfile !~ m@\binclude/uapi/@ &&
5717 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005718 if (WARN("PREFER_PRINTF",
5719 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5720 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005721 $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 -07005722
5723 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005724 }
5725
Joe Perches6061d942012-03-23 15:02:16 -07005726# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005727 if ($realfile !~ m@\binclude/uapi/@ &&
5728 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005729 if (WARN("PREFER_SCANF",
5730 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5731 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005732 $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 -07005733 }
Joe Perches6061d942012-03-23 15:02:16 -07005734 }
5735
Joe Perches619a9082014-12-10 15:51:35 -08005736# Check for __attribute__ weak, or __weak declarations (may have link issues)
5737 if ($^V && $^V ge 5.10.0 &&
5738 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5739 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5740 $line =~ /\b__weak\b/)) {
5741 ERROR("WEAK_DECLARATION",
5742 "Using weak declarations can have unintended link defects\n" . $herecurr);
5743 }
5744
Tomas Winklerfd39f902016-12-12 16:46:34 -08005745# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005746 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005747 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005748 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5749 my $type = $1;
5750 if ($type =~ /\b($typeC99Typedefs)\b/) {
5751 $type = $1;
5752 my $kernel_type = 'u';
5753 $kernel_type = 's' if ($type =~ /^_*[si]/);
5754 $type =~ /(\d+)/;
5755 $kernel_type .= $1;
5756 if (CHK("PREFER_KERNEL_TYPES",
5757 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5758 $fix) {
5759 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5760 }
5761 }
5762 }
5763
Joe Perches938224b2016-01-20 14:59:15 -08005764# check for cast of C90 native int or longer types constants
5765 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5766 my $cast = $1;
5767 my $const = $2;
5768 if (WARN("TYPECAST_INT_CONSTANT",
5769 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5770 $fix) {
5771 my $suffix = "";
5772 my $newconst = $const;
5773 $newconst =~ s/${Int_type}$//;
5774 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5775 if ($cast =~ /\blong\s+long\b/) {
5776 $suffix .= 'LL';
5777 } elsif ($cast =~ /\blong\b/) {
5778 $suffix .= 'L';
5779 }
5780 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5781 }
5782 }
5783
Joe Perches8f53a9b2010-03-05 13:43:48 -08005784# check for sizeof(&)
5785 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005786 WARN("SIZEOF_ADDRESS",
5787 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005788 }
5789
Joe Perches66c80b62012-07-30 14:41:22 -07005790# check for sizeof without parenthesis
5791 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005792 if (WARN("SIZEOF_PARENTHESIS",
5793 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5794 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005795 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005796 }
Joe Perches66c80b62012-07-30 14:41:22 -07005797 }
5798
Joe Perches88982fe2012-12-17 16:02:00 -08005799# check for struct spinlock declarations
5800 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5801 WARN("USE_SPINLOCK_T",
5802 "struct spinlock should be spinlock_t\n" . $herecurr);
5803 }
5804
Joe Perchesa6962d72013-04-29 16:18:13 -07005805# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005806 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005807 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005808 $fmt =~ s/%%//g;
5809 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005810 if (WARN("PREFER_SEQ_PUTS",
5811 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5812 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005813 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005814 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005815 }
5816 }
5817
Joe Perches0b523762017-05-08 15:55:36 -07005818 # check for vsprintf extension %p<foo> misuses
5819 if ($^V && $^V ge 5.10.0 &&
5820 defined $stat &&
5821 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5822 $1 !~ /^_*volatile_*$/) {
5823 my $bad_extension = "";
5824 my $lc = $stat =~ tr@\n@@;
5825 $lc = $lc + $linenr;
5826 for (my $count = $linenr; $count <= $lc; $count++) {
5827 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5828 $fmt =~ s/%%//g;
Linus Torvaldsab486bc2018-02-01 13:36:15 -08005829 if ($fmt =~ /(\%[\*\d\.]*p(?![\WSsBKRraEhMmIiUDdgVCbGNOx]).)/) {
Joe Perches0b523762017-05-08 15:55:36 -07005830 $bad_extension = $1;
5831 last;
5832 }
5833 }
5834 if ($bad_extension ne "") {
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005835 my $stat_real = get_stat_real($linenr, $lc);
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005836 my $ext_type = "Invalid";
5837 my $use = "";
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005838 if ($bad_extension =~ /p[Ff]/) {
5839 $ext_type = "Deprecated";
5840 $use = " - use %pS instead";
5841 $use =~ s/pS/ps/ if ($bad_extension =~ /pf/);
5842 }
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005843
Joe Perches0b523762017-05-08 15:55:36 -07005844 WARN("VSPRINTF_POINTER_EXTENSION",
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005845 "$ext_type vsprintf pointer extension '$bad_extension'$use\n" . "$here\n$stat_real\n");
Joe Perches0b523762017-05-08 15:55:36 -07005846 }
5847 }
5848
Andy Whitcroft554e1652012-01-10 15:09:57 -08005849# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005850 if ($^V && $^V ge 5.10.0 &&
5851 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005852 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005853
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005854 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005855 my $ms_val = $7;
5856 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005857
Andy Whitcroft554e1652012-01-10 15:09:57 -08005858 if ($ms_size =~ /^(0x|)0$/i) {
5859 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005860 "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 -08005861 } elsif ($ms_size =~ /^(0x|)1$/i) {
5862 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005863 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5864 }
5865 }
5866
Joe Perches98a9bba2014-01-23 15:54:52 -08005867# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005868# if ($^V && $^V ge 5.10.0 &&
5869# defined $stat &&
5870# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5871# if (WARN("PREFER_ETHER_ADDR_COPY",
5872# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5873# $fix) {
5874# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5875# }
5876# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005877
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005878# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005879# if ($^V && $^V ge 5.10.0 &&
5880# defined $stat &&
5881# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5882# WARN("PREFER_ETHER_ADDR_EQUAL",
5883# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5884# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005885
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005886# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5887# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf3331952016-10-11 13:51:53 -07005888# if ($^V && $^V ge 5.10.0 &&
5889# defined $stat &&
5890# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5891#
5892# my $ms_val = $7;
5893#
5894# if ($ms_val =~ /^(?:0x|)0+$/i) {
5895# if (WARN("PREFER_ETH_ZERO_ADDR",
5896# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5897# $fix) {
5898# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5899# }
5900# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5901# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5902# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5903# $fix) {
5904# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5905# }
5906# }
5907# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005908
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005909# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005910 if ($^V && $^V ge 5.10.0 &&
5911 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005912 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005913 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005914 my $call = $1;
5915 my $cast1 = deparenthesize($2);
5916 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005917 my $cast2 = deparenthesize($7);
5918 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005919 my $cast;
5920
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005921 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005922 $cast = "$cast1 or $cast2";
5923 } elsif ($cast1 ne "") {
5924 $cast = $cast1;
5925 } else {
5926 $cast = $cast2;
5927 }
5928 WARN("MINMAX",
5929 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005930 }
5931 }
5932
Joe Perches4a273192012-07-30 14:41:20 -07005933# check usleep_range arguments
5934 if ($^V && $^V ge 5.10.0 &&
5935 defined $stat &&
5936 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5937 my $min = $1;
5938 my $max = $7;
5939 if ($min eq $max) {
5940 WARN("USLEEP_RANGE",
5941 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5942 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5943 $min > $max) {
5944 WARN("USLEEP_RANGE",
5945 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5946 }
5947 }
5948
Joe Perches823b7942013-11-12 15:10:15 -08005949# check for naked sscanf
5950 if ($^V && $^V ge 5.10.0 &&
5951 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005952 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005953 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5954 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5955 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5956 my $lc = $stat =~ tr@\n@@;
5957 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005958 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08005959 WARN("NAKED_SSCANF",
5960 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5961 }
5962
Joe Perchesafc819a2014-06-04 16:12:08 -07005963# check for simple sscanf that should be kstrto<foo>
5964 if ($^V && $^V ge 5.10.0 &&
5965 defined $stat &&
5966 $line =~ /\bsscanf\b/) {
5967 my $lc = $stat =~ tr@\n@@;
5968 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005969 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07005970 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5971 my $format = $6;
5972 my $count = $format =~ tr@%@%@;
5973 if ($count == 1 &&
5974 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5975 WARN("SSCANF_TO_KSTRTO",
5976 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5977 }
5978 }
5979 }
5980
Joe Perches70dc8a42013-09-11 14:23:58 -07005981# check for new externs in .h files.
5982 if ($realfile =~ /\.h$/ &&
5983 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005984 if (CHK("AVOID_EXTERNS",
5985 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005986 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005987 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005988 }
5989 }
5990
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005991# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005992 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005993 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005994 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005995 my $function_name = $1;
5996 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005997
5998 my $s = $stat;
5999 if (defined $cond) {
6000 substr($s, 0, length($cond), '');
6001 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006002 if ($s =~ /^\s*;/ &&
6003 $function_name ne 'uninitialized_var')
6004 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006005 WARN("AVOID_EXTERNS",
6006 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006007 }
6008
6009 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006010 WARN("FUNCTION_ARGUMENTS",
6011 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006012 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006013
6014 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6015 $stat =~ /^.\s*extern\s+/)
6016 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006017 WARN("AVOID_EXTERNS",
6018 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006019 }
6020
Joe Perchesa0ad7592017-07-10 15:52:19 -07006021# check for function declarations that have arguments without identifier names
6022 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006023 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006024 $1 ne "void") {
6025 my $args = trim($1);
6026 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6027 my $arg = trim($1);
6028 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6029 WARN("FUNCTION_ARGUMENTS",
6030 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6031 }
6032 }
6033 }
6034
Joe Perchesa0ad7592017-07-10 15:52:19 -07006035# check for function definitions
6036 if ($^V && $^V ge 5.10.0 &&
6037 defined $stat &&
6038 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6039 $context_function = $1;
6040
6041# check for multiline function definition with misplaced open brace
6042 my $ok = 0;
6043 my $cnt = statement_rawlines($stat);
6044 my $herectx = $here . "\n";
6045 for (my $n = 0; $n < $cnt; $n++) {
6046 my $rl = raw_line($linenr, $n);
6047 $herectx .= $rl . "\n";
6048 $ok = 1 if ($rl =~ /^[ \+]\{/);
6049 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6050 last if $rl =~ /^[ \+].*\{/;
6051 }
6052 if (!$ok) {
6053 ERROR("OPEN_BRACE",
6054 "open brace '{' following function definitions go on the next line\n" . $herectx);
6055 }
6056 }
6057
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006058# checks for new __setup's
6059 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6060 my $name = $1;
6061
6062 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006063 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006064 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006065 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006066 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006067
6068# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08006069 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006070 WARN("UNNECESSARY_CASTS",
6071 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006072 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006073
Joe Perchesa640d252013-07-03 15:05:21 -07006074# alloc style
6075# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6076 if ($^V && $^V ge 5.10.0 &&
6077 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6078 CHK("ALLOC_SIZEOF_STRUCT",
6079 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6080 }
6081
Joe Perches60a55362014-06-04 16:12:07 -07006082# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6083 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006084 defined $stat &&
6085 $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 -07006086 my $oldfunc = $3;
6087 my $a1 = $4;
6088 my $a2 = $10;
6089 my $newfunc = "kmalloc_array";
6090 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006091 my $r1 = $a1;
6092 my $r2 = $a2;
6093 if ($a1 =~ /^sizeof\s*\S/) {
6094 $r1 = $a2;
6095 $r2 = $a1;
6096 }
6097 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6098 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006099 my $ctx = '';
6100 my $herectx = $here . "\n";
6101 my $cnt = statement_rawlines($stat);
6102 for (my $n = 0; $n < $cnt; $n++) {
6103 $herectx .= raw_line($linenr, $n) . "\n";
6104 }
Joe Perches60a55362014-06-04 16:12:07 -07006105 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006106 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6107 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006108 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006109 $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 -07006110 }
6111 }
6112 }
6113
Joe Perches972fdea2013-04-29 16:18:12 -07006114# check for krealloc arg reuse
6115 if ($^V && $^V ge 5.10.0 &&
6116 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6117 WARN("KREALLOC_ARG_REUSE",
6118 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6119 }
6120
Joe Perches5ce59ae2013-02-21 16:44:18 -08006121# check for alloc argument mismatch
6122 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6123 WARN("ALLOC_ARRAY_ARGS",
6124 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6125 }
6126
Joe Perchescaf2a542011-01-12 16:59:56 -08006127# check for multiple semicolons
6128 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006129 if (WARN("ONE_SEMICOLON",
6130 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6131 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006132 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006133 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006134 }
6135
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006136# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6137 if ($realfile !~ m@^include/uapi/@ &&
6138 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006139 my $ull = "";
6140 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6141 if (CHK("BIT_MACRO",
6142 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6143 $fix) {
6144 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6145 }
6146 }
6147
Joe Perches2d632742016-05-20 17:04:00 -07006148# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6149 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6150 my $config = $1;
6151 if (WARN("PREFER_IS_ENABLED",
6152 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6153 $fix) {
6154 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6155 }
6156 }
6157
Joe Perchese81f2392014-08-06 16:11:25 -07006158# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006159 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6160 my $has_break = 0;
6161 my $has_statement = 0;
6162 my $count = 0;
6163 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006164 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006165 $prevline--;
6166 my $rline = $rawlines[$prevline - 1];
6167 my $fline = $lines[$prevline - 1];
6168 last if ($fline =~ /^\@\@/);
6169 next if ($fline =~ /^\-/);
6170 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6171 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6172 next if ($fline =~ /^.[\s$;]*$/);
6173 $has_statement = 1;
6174 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006175 $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 -08006176 }
6177 if (!$has_break && $has_statement) {
6178 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006179 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006180 }
6181 }
6182
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006183# check for switch/default statements without a break;
6184 if ($^V && $^V ge 5.10.0 &&
6185 defined $stat &&
6186 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6187 my $ctx = '';
6188 my $herectx = $here . "\n";
6189 my $cnt = statement_rawlines($stat);
6190 for (my $n = 0; $n < $cnt; $n++) {
6191 $herectx .= raw_line($linenr, $n) . "\n";
6192 }
6193 WARN("DEFAULT_NO_BREAK",
6194 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006195 }
6196
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006197# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006198 if ($line =~ /\b__FUNCTION__\b/) {
6199 if (WARN("USE_FUNC",
6200 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6201 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006202 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006203 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006204 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006205
Joe Perches62ec8182015-02-13 14:38:18 -08006206# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6207 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6208 ERROR("DATE_TIME",
6209 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6210 }
6211
Joe Perches2c924882012-03-23 15:02:20 -07006212# check for use of yield()
6213 if ($line =~ /\byield\s*\(\s*\)/) {
6214 WARN("YIELD",
6215 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6216 }
6217
Joe Perches179f8f42013-07-03 15:05:30 -07006218# check for comparisons against true and false
6219 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6220 my $lead = $1;
6221 my $arg = $2;
6222 my $test = $3;
6223 my $otype = $4;
6224 my $trail = $5;
6225 my $op = "!";
6226
6227 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6228
6229 my $type = lc($otype);
6230 if ($type =~ /^(?:true|false)$/) {
6231 if (("$test" eq "==" && "$type" eq "true") ||
6232 ("$test" eq "!=" && "$type" eq "false")) {
6233 $op = "";
6234 }
6235
6236 CHK("BOOL_COMPARISON",
6237 "Using comparison to $otype is error prone\n" . $herecurr);
6238
6239## maybe suggesting a correct construct would better
6240## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6241
6242 }
6243 }
6244
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006245# check for semaphores initialized locked
6246 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006247 WARN("CONSIDER_COMPLETION",
6248 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006249 }
Joe Perches6712d852012-03-23 15:02:20 -07006250
Joe Perches67d0a072011-10-31 17:13:10 -07006251# recommend kstrto* over simple_strto* and strict_strto*
6252 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006253 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006254 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006255 }
Joe Perches6712d852012-03-23 15:02:20 -07006256
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006257# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006258 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006259 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006260 "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 -07006261 }
Joe Perches6712d852012-03-23 15:02:20 -07006262
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006263# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006264# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006265 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006266 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006267 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006268 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006269 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006270
6271# use of NR_CPUS is usually wrong
6272# ignore definitions of NR_CPUS and usage to define arrays as likely right
6273 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006274 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6275 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006276 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6277 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6278 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006279 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006280 WARN("NR_CPUS",
6281 "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 -07006282 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006283
Joe Perches52ea8502013-11-12 15:10:09 -08006284# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6285 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6286 ERROR("DEFINE_ARCH_HAS",
6287 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6288 }
6289
Joe Perchesacd93622015-02-13 14:38:38 -08006290# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6291 if ($^V && $^V ge 5.10.0 &&
6292 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6293 WARN("LIKELY_MISUSE",
6294 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6295 }
6296
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006297# whine mightly about in_atomic
6298 if ($line =~ /\bin_atomic\s*\(/) {
6299 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006300 ERROR("IN_ATOMIC",
6301 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006302 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006303 WARN("IN_ATOMIC",
6304 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006305 }
6306 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006307
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006308# check for mutex_trylock_recursive usage
6309 if ($line =~ /mutex_trylock_recursive/) {
6310 ERROR("LOCKING",
6311 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6312 }
6313
Peter Zijlstra1704f472010-03-19 01:37:42 +01006314# check for lockdep_set_novalidate_class
6315 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6316 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6317 if ($realfile !~ m@^kernel/lockdep@ &&
6318 $realfile !~ m@^include/linux/lockdep@ &&
6319 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006320 ERROR("LOCKDEP",
6321 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006322 }
6323 }
Dave Jones88f88312011-01-12 16:59:59 -08006324
Joe Perchesb392c642015-04-16 12:44:16 -07006325 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6326 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006327 WARN("EXPORTED_WORLD_WRITABLE",
6328 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006329 }
Joe Perches24358802014-04-03 14:49:13 -07006330
Joe Perches00180462018-02-06 15:38:55 -08006331# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6332# and whether or not function naming is typical and if
6333# DEVICE_ATTR permissions uses are unusual too
6334 if ($^V && $^V ge 5.10.0 &&
6335 defined $stat &&
6336 $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*\)/) {
6337 my $var = $1;
6338 my $perms = $2;
6339 my $show = $3;
6340 my $store = $4;
6341 my $octal_perms = perms_to_octal($perms);
6342 if ($show =~ /^${var}_show$/ &&
6343 $store =~ /^${var}_store$/ &&
6344 $octal_perms eq "0644") {
6345 if (WARN("DEVICE_ATTR_RW",
6346 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6347 $fix) {
6348 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6349 }
6350 } elsif ($show =~ /^${var}_show$/ &&
6351 $store =~ /^NULL$/ &&
6352 $octal_perms eq "0444") {
6353 if (WARN("DEVICE_ATTR_RO",
6354 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6355 $fix) {
6356 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6357 }
6358 } elsif ($show =~ /^NULL$/ &&
6359 $store =~ /^${var}_store$/ &&
6360 $octal_perms eq "0200") {
6361 if (WARN("DEVICE_ATTR_WO",
6362 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6363 $fix) {
6364 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6365 }
6366 } elsif ($octal_perms eq "0644" ||
6367 $octal_perms eq "0444" ||
6368 $octal_perms eq "0200") {
6369 my $newshow = "$show";
6370 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6371 my $newstore = $store;
6372 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6373 my $rename = "";
6374 if ($show ne $newshow) {
6375 $rename .= " '$show' to '$newshow'";
6376 }
6377 if ($store ne $newstore) {
6378 $rename .= " '$store' to '$newstore'";
6379 }
6380 WARN("DEVICE_ATTR_FUNCTIONS",
6381 "Consider renaming function(s)$rename\n" . $herecurr);
6382 } else {
6383 WARN("DEVICE_ATTR_PERMS",
6384 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6385 }
6386 }
6387
Joe Perches515a2352014-04-03 14:49:24 -07006388# Mode permission misuses where it seems decimal should be octal
6389# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006390# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6391# specific definition of not visible in sysfs.
6392# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6393# use the default permissions
Joe Perches515a2352014-04-03 14:49:24 -07006394 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006395 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006396 $line =~ /$mode_perms_search/) {
6397 foreach my $entry (@mode_permission_funcs) {
6398 my $func = $entry->[0];
6399 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006400
Joe Perches459cf0a2016-10-11 13:52:19 -07006401 my $lc = $stat =~ tr@\n@@;
6402 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006403 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006404
Joe Perches515a2352014-04-03 14:49:24 -07006405 my $skip_args = "";
6406 if ($arg_pos > 1) {
6407 $arg_pos--;
6408 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6409 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006410 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006411 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006412 my $val = $1;
6413 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006414 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6415 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6416 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006417 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006418 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006419 }
6420 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006421 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006422 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006423 }
Joe Perches24358802014-04-03 14:49:13 -07006424 }
6425 }
6426 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006427
Joe Perches459cf0a2016-10-11 13:52:19 -07006428# check for uses of S_<PERMS> that could be octal for readability
Joe Perches00180462018-02-06 15:38:55 -08006429 if ($line =~ /\b($multi_mode_perms_string_search)\b/) {
6430 my $oval = $1;
6431 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006432 if (WARN("SYMBOLIC_PERMS",
6433 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6434 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006435 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006436 }
6437 }
6438
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006439# validate content of MODULE_LICENSE against list from include/linux/module.h
6440 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6441 my $extracted_string = get_quoted_string($line, $rawline);
6442 my $valid_licenses = qr{
6443 GPL|
6444 GPL\ v2|
6445 GPL\ and\ additional\ rights|
6446 Dual\ BSD/GPL|
6447 Dual\ MIT/GPL|
6448 Dual\ MPL/GPL|
6449 Proprietary
6450 }x;
6451 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6452 WARN("MODULE_LICENSE",
6453 "unknown module license " . $extracted_string . "\n" . $herecurr);
6454 }
6455 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006456 }
6457
6458 # If we have no input at all, then there is nothing to report on
6459 # so just keep quiet.
6460 if ($#rawlines == -1) {
6461 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006462 }
6463
Andy Whitcroft8905a672007-11-28 16:21:06 -08006464 # In mailback mode only produce a report in the negative, for
6465 # things that appear to be patches.
6466 if ($mailback && ($clean == 1 || !$is_patch)) {
6467 exit(0);
6468 }
6469
6470 # This is not a patch, and we are are in 'no-patch' mode so
6471 # just keep quiet.
6472 if (!$chk_patch && !$is_patch) {
6473 exit(0);
6474 }
6475
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006476 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006477 ERROR("NOT_UNIFIED_DIFF",
6478 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006479 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006480 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006481 ERROR("MISSING_SIGN_OFF",
6482 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006483 }
6484
Andy Whitcroft8905a672007-11-28 16:21:06 -08006485 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006486 if ($summary && !($clean == 1 && $quiet == 1)) {
6487 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006488 print "total: $cnt_error errors, $cnt_warn warnings, " .
6489 (($check)? "$cnt_chk checks, " : "") .
6490 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006491 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006492
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006493 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006494 # If there were any defects found and not already fixing them
6495 if (!$clean and !$fix) {
6496 print << "EOM"
6497
6498NOTE: For some of the reported defects, checkpatch may be able to
6499 mechanically convert to the typical style using --fix or --fix-inplace.
6500EOM
6501 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006502 # If there were whitespace errors which cleanpatch can fix
6503 # then suggest that.
6504 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006505 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006506 print << "EOM"
6507
6508NOTE: Whitespace errors detected.
6509 You may wish to use scripts/cleanpatch or scripts/cleanfile
6510EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006511 }
6512 }
6513
Joe Perchesd752fcc2014-08-06 16:11:05 -07006514 if ($clean == 0 && $fix &&
6515 ("@rawlines" ne "@fixed" ||
6516 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006517 my $newfile = $filename;
6518 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006519 my $linecount = 0;
6520 my $f;
6521
Joe Perchesd752fcc2014-08-06 16:11:05 -07006522 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6523
Joe Perches3705ce52013-07-03 15:05:31 -07006524 open($f, '>', $newfile)
6525 or die "$P: Can't open $newfile for write\n";
6526 foreach my $fixed_line (@fixed) {
6527 $linecount++;
6528 if ($file) {
6529 if ($linecount > 3) {
6530 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006531 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006532 }
6533 } else {
6534 print $f $fixed_line . "\n";
6535 }
6536 }
6537 close($f);
6538
6539 if (!$quiet) {
6540 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006541
Joe Perches3705ce52013-07-03 15:05:31 -07006542Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6543
6544Do _NOT_ trust the results written to this file.
6545Do _NOT_ submit these changes without inspecting them for correctness.
6546
6547This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6548No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006549EOM
6550 }
6551 }
6552
Joe Perchesd8469f12015-06-25 15:03:00 -07006553 if ($quiet == 0) {
6554 print "\n";
6555 if ($clean == 1) {
6556 print "$vname has no obvious style problems and is ready for submission.\n";
6557 } else {
6558 print "$vname has style problems, please review.\n";
6559 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006560 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006561 return $clean;
6562}