blob: 788c90c1ae2a732ef670135784e9c3af96562de6 [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
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001659sub get_stat_here {
1660 my ($linenr, $cnt, $here) = @_;
1661
1662 my $herectx = $here . "\n";
1663 for (my $n = 0; $n < $cnt; $n++) {
1664 $herectx .= raw_line($linenr, $n) . "\n";
1665 }
1666
1667 return $herectx;
1668}
1669
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001670sub cat_vet {
1671 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001672 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001673
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001674 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001675 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1676 $res .= $1;
1677 if ($2 ne '') {
1678 $coded = sprintf("^%c", unpack('C', $2) + 64);
1679 $res .= $coded;
1680 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001681 }
1682 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001683
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001684 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001685}
1686
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001687my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001688my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001689my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001690my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001691
1692sub annotate_reset {
1693 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001694 $av_pending = '_';
1695 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001696 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001697}
1698
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001699sub annotate_values {
1700 my ($stream, $type) = @_;
1701
1702 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001703 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001704 my $cur = $stream;
1705
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001706 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001707
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001708 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001709 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001710 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001711 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001712 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001713 print "WS($1)\n" if ($dbg_values > 1);
1714 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001715 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001716 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001717 }
1718
Florian Micklerc023e4732011-01-12 16:59:58 -08001719 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001720 print "CAST($1)\n" if ($dbg_values > 1);
1721 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001722 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001723
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001724 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001725 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001726 $type = 'T';
1727
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001728 } elsif ($cur =~ /^($Modifier)\s*/) {
1729 print "MODIFIER($1)\n" if ($dbg_values > 1);
1730 $type = 'T';
1731
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001732 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001733 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001734 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001735 push(@av_paren_type, $type);
1736 if ($2 ne '') {
1737 $av_pending = 'N';
1738 }
1739 $type = 'E';
1740
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001741 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001742 print "UNDEF($1)\n" if ($dbg_values > 1);
1743 $av_preprocessor = 1;
1744 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001745
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001746 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001747 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001748 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001749
1750 push(@av_paren_type, $type);
1751 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001752 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001753
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001754 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001755 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1756 $av_preprocessor = 1;
1757
1758 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1759
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001760 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001761
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001762 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001763 print "PRE_END($1)\n" if ($dbg_values > 1);
1764
1765 $av_preprocessor = 1;
1766
1767 # Assume all arms of the conditional end as this
1768 # one does, and continue as if the #endif was not here.
1769 pop(@av_paren_type);
1770 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001771 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001772
1773 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001774 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001775
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001776 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1777 print "ATTR($1)\n" if ($dbg_values > 1);
1778 $av_pending = $type;
1779 $type = 'N';
1780
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001781 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001782 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001783 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001784 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001785 }
1786 $type = 'N';
1787
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001788 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001789 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001790 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001791 $type = 'N';
1792
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001793 } elsif ($cur =~/^(case)/o) {
1794 print "CASE($1)\n" if ($dbg_values > 1);
1795 $av_pend_colon = 'C';
1796 $type = 'N';
1797
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001798 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001799 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001800 $type = 'N';
1801
1802 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001803 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001804 push(@av_paren_type, $av_pending);
1805 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001806 $type = 'N';
1807
1808 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001809 my $new_type = pop(@av_paren_type);
1810 if ($new_type ne '_') {
1811 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001812 print "PAREN('$1') -> $type\n"
1813 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001814 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001815 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001816 }
1817
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001818 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001819 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001820 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001821 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001822
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001823 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1824 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001825 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001826 } elsif ($type eq 'E') {
1827 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001828 }
1829 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1830 $type = 'V';
1831
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001832 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001833 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001834 $type = 'V';
1835
1836 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001837 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001838 $type = 'N';
1839
Andy Whitcroftcf655042008-03-04 14:28:20 -08001840 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001841 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001842 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001843 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001844
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001845 } elsif ($cur =~/^(,)/) {
1846 print "COMMA($1)\n" if ($dbg_values > 1);
1847 $type = 'C';
1848
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001849 } elsif ($cur =~ /^(\?)/o) {
1850 print "QUESTION($1)\n" if ($dbg_values > 1);
1851 $type = 'N';
1852
1853 } elsif ($cur =~ /^(:)/o) {
1854 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1855
1856 substr($var, length($res), 1, $av_pend_colon);
1857 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1858 $type = 'E';
1859 } else {
1860 $type = 'N';
1861 }
1862 $av_pend_colon = 'O';
1863
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001864 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001865 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001866 $type = 'N';
1867
Andy Whitcroft0d413862008-10-15 22:02:16 -07001868 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001869 my $variant;
1870
1871 print "OPV($1)\n" if ($dbg_values > 1);
1872 if ($type eq 'V') {
1873 $variant = 'B';
1874 } else {
1875 $variant = 'U';
1876 }
1877
1878 substr($var, length($res), 1, $variant);
1879 $type = 'N';
1880
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001881 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001882 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001883 if ($1 ne '++' && $1 ne '--') {
1884 $type = 'N';
1885 }
1886
1887 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001888 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001889 }
1890 if (defined $1) {
1891 $cur = substr($cur, length($1));
1892 $res .= $type x length($1);
1893 }
1894 }
1895
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001896 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001897}
1898
Andy Whitcroft8905a672007-11-28 16:21:06 -08001899sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001900 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001901 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001902 ^(?:
1903 $Modifier|
1904 $Storage|
1905 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001906 DEFINE_\S+
1907 )$|
1908 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001909 goto|
1910 return|
1911 case|
1912 else|
1913 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001914 do|
1915 \#|
1916 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001917 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001918 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001919 )}x;
1920 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1921 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001922 # Check for modifiers.
1923 $possible =~ s/\s*$Storage\s*//g;
1924 $possible =~ s/\s*$Sparse\s*//g;
1925 if ($possible =~ /^\s*$/) {
1926
1927 } elsif ($possible =~ /\s/) {
1928 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001929 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001930 if ($modifier !~ $notPermitted) {
1931 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001932 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001933 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001934 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001935
1936 } else {
1937 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001938 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001939 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001940 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001941 } else {
1942 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001943 }
1944}
1945
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001946my $prefix = '';
1947
Joe Perches000d1cc12011-07-25 17:13:25 -07001948sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001949 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001950
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001951 $type =~ tr/[a-z]/[A-Z]/;
1952
Joe Perchescbec18a2014-04-03 14:49:19 -07001953 return defined $use_type{$type} if (scalar keys %use_type > 0);
1954
1955 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001956}
1957
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001958sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001959 my ($level, $type, $msg) = @_;
1960
1961 if (!show_type($type) ||
1962 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001963 return 0;
1964 }
Joe Perches57230292015-06-25 15:03:03 -07001965 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001966 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001967 if ($level eq 'ERROR') {
1968 $output .= RED;
1969 } elsif ($level eq 'WARNING') {
1970 $output .= YELLOW;
1971 } else {
1972 $output .= GREEN;
1973 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001974 }
Joe Perches57230292015-06-25 15:03:03 -07001975 $output .= $prefix . $level . ':';
1976 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001977 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001978 $output .= "$type:";
1979 }
John Brooks737c0762017-07-10 15:52:24 -07001980 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001981 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001982
1983 if ($showfile) {
1984 my @lines = split("\n", $output, -1);
1985 splice(@lines, 1, 1);
1986 $output = join("\n", @lines);
1987 }
Joe Perches57230292015-06-25 15:03:03 -07001988 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001989
Joe Perches57230292015-06-25 15:03:03 -07001990 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001991
1992 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001993}
Joe Perchescbec18a2014-04-03 14:49:19 -07001994
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001995sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001996 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001997}
Joe Perches000d1cc12011-07-25 17:13:25 -07001998
Joe Perchesd752fcc2014-08-06 16:11:05 -07001999sub fixup_current_range {
2000 my ($lineRef, $offset, $length) = @_;
2001
2002 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2003 my $o = $1;
2004 my $l = $2;
2005 my $no = $o + $offset;
2006 my $nl = $l + $length;
2007 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2008 }
2009}
2010
2011sub fix_inserted_deleted_lines {
2012 my ($linesRef, $insertedRef, $deletedRef) = @_;
2013
2014 my $range_last_linenr = 0;
2015 my $delta_offset = 0;
2016
2017 my $old_linenr = 0;
2018 my $new_linenr = 0;
2019
2020 my $next_insert = 0;
2021 my $next_delete = 0;
2022
2023 my @lines = ();
2024
2025 my $inserted = @{$insertedRef}[$next_insert++];
2026 my $deleted = @{$deletedRef}[$next_delete++];
2027
2028 foreach my $old_line (@{$linesRef}) {
2029 my $save_line = 1;
2030 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002031 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002032 $delta_offset = 0;
2033 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2034 $range_last_linenr = $new_linenr;
2035 fixup_current_range(\$line, $delta_offset, 0);
2036 }
2037
2038 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2039 $deleted = @{$deletedRef}[$next_delete++];
2040 $save_line = 0;
2041 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2042 }
2043
2044 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2045 push(@lines, ${$inserted}{'LINE'});
2046 $inserted = @{$insertedRef}[$next_insert++];
2047 $new_linenr++;
2048 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2049 }
2050
2051 if ($save_line) {
2052 push(@lines, $line);
2053 $new_linenr++;
2054 }
2055
2056 $old_linenr++;
2057 }
2058
2059 return @lines;
2060}
2061
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002062sub fix_insert_line {
2063 my ($linenr, $line) = @_;
2064
2065 my $inserted = {
2066 LINENR => $linenr,
2067 LINE => $line,
2068 };
2069 push(@fixed_inserted, $inserted);
2070}
2071
2072sub fix_delete_line {
2073 my ($linenr, $line) = @_;
2074
2075 my $deleted = {
2076 LINENR => $linenr,
2077 LINE => $line,
2078 };
2079
2080 push(@fixed_deleted, $deleted);
2081}
2082
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002083sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002084 my ($type, $msg) = @_;
2085
2086 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002087 our $clean = 0;
2088 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002089 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002090 }
Joe Perches3705ce52013-07-03 15:05:31 -07002091 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002092}
2093sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002094 my ($type, $msg) = @_;
2095
2096 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002097 our $clean = 0;
2098 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002099 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002100 }
Joe Perches3705ce52013-07-03 15:05:31 -07002101 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002102}
2103sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002104 my ($type, $msg) = @_;
2105
2106 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002107 our $clean = 0;
2108 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002109 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002110 }
Joe Perches3705ce52013-07-03 15:05:31 -07002111 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002112}
2113
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002114sub check_absolute_file {
2115 my ($absolute, $herecurr) = @_;
2116 my $file = $absolute;
2117
2118 ##print "absolute<$absolute>\n";
2119
2120 # See if any suffix of this path is a path within the tree.
2121 while ($file =~ s@^[^/]*/@@) {
2122 if (-f "$root/$file") {
2123 ##print "file<$file>\n";
2124 last;
2125 }
2126 }
2127 if (! -f _) {
2128 return 0;
2129 }
2130
2131 # It is, so see if the prefix is acceptable.
2132 my $prefix = $absolute;
2133 substr($prefix, -length($file)) = '';
2134
2135 ##print "prefix<$prefix>\n";
2136 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002137 WARN("USE_RELATIVE_PATH",
2138 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002139 }
2140}
2141
Joe Perches3705ce52013-07-03 15:05:31 -07002142sub trim {
2143 my ($string) = @_;
2144
Joe Perchesb34c6482013-09-11 14:24:01 -07002145 $string =~ s/^\s+|\s+$//g;
2146
2147 return $string;
2148}
2149
2150sub ltrim {
2151 my ($string) = @_;
2152
2153 $string =~ s/^\s+//;
2154
2155 return $string;
2156}
2157
2158sub rtrim {
2159 my ($string) = @_;
2160
2161 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002162
2163 return $string;
2164}
2165
Joe Perches52ea8502013-11-12 15:10:09 -08002166sub string_find_replace {
2167 my ($string, $find, $replace) = @_;
2168
2169 $string =~ s/$find/$replace/g;
2170
2171 return $string;
2172}
2173
Joe Perches3705ce52013-07-03 15:05:31 -07002174sub tabify {
2175 my ($leading) = @_;
2176
2177 my $source_indent = 8;
2178 my $max_spaces_before_tab = $source_indent - 1;
2179 my $spaces_to_tab = " " x $source_indent;
2180
2181 #convert leading spaces to tabs
2182 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2183 #Remove spaces before a tab
2184 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2185
2186 return "$leading";
2187}
2188
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002189sub pos_last_openparen {
2190 my ($line) = @_;
2191
2192 my $pos = 0;
2193
2194 my $opens = $line =~ tr/\(/\(/;
2195 my $closes = $line =~ tr/\)/\)/;
2196
2197 my $last_openparen = 0;
2198
2199 if (($opens == 0) || ($closes >= $opens)) {
2200 return -1;
2201 }
2202
2203 my $len = length($line);
2204
2205 for ($pos = 0; $pos < $len; $pos++) {
2206 my $string = substr($line, $pos);
2207 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2208 $pos += length($1) - 1;
2209 } elsif (substr($line, $pos, 1) eq '(') {
2210 $last_openparen = $pos;
2211 } elsif (index($string, '(') == -1) {
2212 last;
2213 }
2214 }
2215
Joe Perches91cb5192014-04-03 14:49:32 -07002216 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002217}
2218
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002219sub process {
2220 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002221
2222 my $linenr=0;
2223 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002224 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002225 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002226 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002227
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002228 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002229 my $indent;
2230 my $previndent=0;
2231 my $stashindent=0;
2232
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002233 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002234 my $signoff = 0;
2235 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002236 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002237 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002238 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002239 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002240 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002241 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002242 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002243 my $non_utf8_charset = 0;
2244
Joe Perches365dd4e2014-08-06 16:10:42 -07002245 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002246 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002247
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002248 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002249 our $cnt_lines = 0;
2250 our $cnt_error = 0;
2251 our $cnt_warn = 0;
2252 our $cnt_chk = 0;
2253
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002254 # Trace the real file/line as we go.
2255 my $realfile = '';
2256 my $realline = 0;
2257 my $realcnt = 0;
2258 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002259 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002260 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002261 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002262 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002263 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002264
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002265 my $prev_values = 'E';
2266
2267 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002268 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002269 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002270 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002271 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002272
Joe Perches7e51f192013-09-11 14:23:57 -07002273 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002274
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002275 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002276 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002277 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002278 my @setup_docs = ();
2279 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002280
Joe Perchesd8b07712013-11-12 15:10:06 -08002281 my $camelcase_file_seeded = 0;
2282
Rob Herring9f3a8992018-04-10 16:33:13 -07002283 my $checklicenseline = 1;
2284
Andy Whitcroft773647a2008-03-28 14:15:58 -07002285 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002286 my $line;
2287 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002288 $linenr++;
2289 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002290
Joe Perches3705ce52013-07-03 15:05:31 -07002291 push(@fixed, $rawline) if ($fix);
2292
Andy Whitcroft773647a2008-03-28 14:15:58 -07002293 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002294 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002295 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002296 $setup_docs = 1;
2297 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002298 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002299 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002300 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002301 $realline=$1-1;
2302 if (defined $2) {
2303 $realcnt=$3+1;
2304 } else {
2305 $realcnt=1+1;
2306 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002307 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002308
2309 # Guestimate if this is a continuing comment. Run
2310 # the context looking for a comment "edge". If this
2311 # edge is a close comment then we must be in a comment
2312 # at context start.
2313 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002314 my $cnt = $realcnt;
2315 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2316 next if (defined $rawlines[$ln - 1] &&
2317 $rawlines[$ln - 1] =~ /^-/);
2318 $cnt--;
2319 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002320 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002321 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2322 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2323 ($edge) = $1;
2324 last;
2325 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002326 }
2327 if (defined $edge && $edge eq '*/') {
2328 $in_comment = 1;
2329 }
2330
2331 # Guestimate if this is a continuing comment. If this
2332 # is the start of a diff block and this line starts
2333 # ' *' then it is very likely a comment.
2334 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002335 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002336 {
2337 $in_comment = 1;
2338 }
2339
2340 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2341 sanitise_line_reset($in_comment);
2342
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002343 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002344 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002345 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002346 $line = sanitise_line($rawline);
2347 }
2348 push(@lines, $line);
2349
2350 if ($realcnt > 1) {
2351 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2352 } else {
2353 $realcnt = 0;
2354 }
2355
2356 #print "==>$rawline\n";
2357 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002358
2359 if ($setup_docs && $line =~ /^\+/) {
2360 push(@setup_docs, $line);
2361 }
2362 }
2363
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002364 $prefix = '';
2365
Andy Whitcroft773647a2008-03-28 14:15:58 -07002366 $realcnt = 0;
2367 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002368 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002369 foreach my $line (@lines) {
2370 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002371 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002372 my $sline = $line; #copy of $line
2373 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002374
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002375 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002376
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002377#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002378 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002379 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2380 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002381 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002382 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002383 $realline=$1-1;
2384 if (defined $2) {
2385 $realcnt=$3+1;
2386 } else {
2387 $realcnt=1+1;
2388 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002389 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002390 $prev_values = 'E';
2391
Andy Whitcroft773647a2008-03-28 14:15:58 -07002392 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002393 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002394 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002395 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002396 if ($context =~ /\b(\w+)\s*\(/) {
2397 $context_function = $1;
2398 } else {
2399 undef $context_function;
2400 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002401 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002402
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002403# track the line number as we move through the hunk, note that
2404# new versions of GNU diff omit the leading space on completely
2405# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002406 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002407 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002408 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002409
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002410 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002411 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002412
2413 # Track the previous line.
2414 ($prevline, $stashline) = ($stashline, $line);
2415 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002416 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2417
Andy Whitcroft773647a2008-03-28 14:15:58 -07002418 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002419
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002420 } elsif ($realcnt == 1) {
2421 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002422 }
2423
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002424 my $hunk_line = ($realcnt != 0);
2425
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002426 $here = "#$linenr: " if (!$file);
2427 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002428
Joe Perches2ac73b42014-06-04 16:12:05 -07002429 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002430 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002431 if ($line =~ /^diff --git.*?(\S+)$/) {
2432 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002433 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002434 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002435 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002436 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002437 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002438 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002439 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002440
2441 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002442 if (!$file && $tree && $p1_prefix ne '' &&
2443 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002444 WARN("PATCH_PREFIX",
2445 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002446 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002447
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002448 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002449 ERROR("MODIFIED_INCLUDE_ASM",
2450 "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 -07002451 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002452 $found_file = 1;
2453 }
2454
Joe Perches34d88152015-06-25 15:03:05 -07002455#make up the handle for any error we report on this line
2456 if ($showfile) {
2457 $prefix = "$realfile:$realline: "
2458 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002459 if ($file) {
2460 $prefix = "$filename:$realline: ";
2461 } else {
2462 $prefix = "$filename:$linenr: ";
2463 }
Joe Perches34d88152015-06-25 15:03:05 -07002464 }
2465
Joe Perches2ac73b42014-06-04 16:12:05 -07002466 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002467 if (is_maintained_obsolete($realfile)) {
2468 WARN("OBSOLETE",
2469 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2470 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002471 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002472 $check = 1;
2473 } else {
2474 $check = $check_orig;
2475 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002476 $checklicenseline = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002477 next;
2478 }
2479
Randy Dunlap389834b2007-06-08 13:47:03 -07002480 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002481
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002482 my $hereline = "$here\n$rawline\n";
2483 my $herecurr = "$here\n$rawline\n";
2484 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002485
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002486 $cnt_lines++ if ($realcnt != 0);
2487
Joe Perchese518e9a2015-06-25 15:03:27 -07002488# Check if the commit log has what seems like a diff which can confuse patch
2489 if ($in_commit_log && !$commit_log_has_diff &&
2490 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2491 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2492 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2493 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2494 ERROR("DIFF_IN_COMMIT_MSG",
2495 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2496 $commit_log_has_diff = 1;
2497 }
2498
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002499# Check for incorrect file permissions
2500 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2501 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002502 if ($realfile !~ m@scripts/@ &&
2503 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002504 ERROR("EXECUTE_PERMISSIONS",
2505 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002506 }
2507 }
2508
Joe Perches20112472011-07-25 17:13:23 -07002509# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002510 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002511 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002512 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002513 }
2514
Joe Perchese0d975b2014-12-10 15:51:49 -08002515# Check if MAINTAINERS is being updated. If so, there's probably no need to
2516# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2517 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2518 $reported_maintainer_file = 1;
2519 }
2520
Joe Perches20112472011-07-25 17:13:23 -07002521# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002522 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002523 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002524 my $space_before = $1;
2525 my $sign_off = $2;
2526 my $space_after = $3;
2527 my $email = $4;
2528 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2529
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002530 if ($sign_off !~ /$signature_tags/) {
2531 WARN("BAD_SIGN_OFF",
2532 "Non-standard signature: $sign_off\n" . $herecurr);
2533 }
Joe Perches20112472011-07-25 17:13:23 -07002534 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002535 if (WARN("BAD_SIGN_OFF",
2536 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2537 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002538 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002539 "$ucfirst_sign_off $email";
2540 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002541 }
Joe Perches20112472011-07-25 17:13:23 -07002542 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002543 if (WARN("BAD_SIGN_OFF",
2544 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2545 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002546 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002547 "$ucfirst_sign_off $email";
2548 }
2549
Joe Perches20112472011-07-25 17:13:23 -07002550 }
2551 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002552 if (WARN("BAD_SIGN_OFF",
2553 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2554 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002555 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002556 "$ucfirst_sign_off $email";
2557 }
Joe Perches20112472011-07-25 17:13:23 -07002558 }
2559
2560 my ($email_name, $email_address, $comment) = parse_email($email);
2561 my $suggested_email = format_email(($email_name, $email_address));
2562 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002563 ERROR("BAD_SIGN_OFF",
2564 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002565 } else {
2566 my $dequoted = $suggested_email;
2567 $dequoted =~ s/^"//;
2568 $dequoted =~ s/" </ </;
2569 # Don't force email to have quotes
2570 # Allow just an angle bracketed address
2571 if ("$dequoted$comment" ne $email &&
2572 "<$email_address>$comment" ne $email &&
2573 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002574 WARN("BAD_SIGN_OFF",
2575 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002576 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002577 }
Joe Perches7e51f192013-09-11 14:23:57 -07002578
2579# Check for duplicate signatures
2580 my $sig_nospace = $line;
2581 $sig_nospace =~ s/\s//g;
2582 $sig_nospace = lc($sig_nospace);
2583 if (defined $signatures{$sig_nospace}) {
2584 WARN("BAD_SIGN_OFF",
2585 "Duplicate signature\n" . $herecurr);
2586 } else {
2587 $signatures{$sig_nospace} = 1;
2588 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002589 }
2590
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002591# Check email subject for common tools that don't need to be mentioned
2592 if ($in_header_lines &&
2593 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2594 WARN("EMAIL_SUBJECT",
2595 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2596 }
2597
Joe Perches9b3189e2014-06-04 16:12:10 -07002598# Check for old stable address
2599 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2600 ERROR("STABLE_ADDRESS",
2601 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2602 }
2603
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002604# Check for unwanted Gerrit info
2605 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2606 ERROR("GERRIT_CHANGE_ID",
2607 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2608 }
2609
Joe Perches369c8dd2015-11-06 16:31:34 -08002610# Check if the commit log is in a possible stack dump
2611 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2612 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2613 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2614 # timestamp
2615 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2616 # stack dump address
2617 $commit_log_possible_stack_dump = 1;
2618 }
2619
Joe Perches2a076f42015-04-16 12:44:28 -07002620# Check for line lengths > 75 in commit log, warn once
2621 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002622 length($line) > 75 &&
2623 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2624 # file delta changes
2625 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2626 # filename then :
2627 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2628 # A Fixes: or Link: line
2629 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002630 WARN("COMMIT_LOG_LONG_LINE",
2631 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2632 $commit_log_long_line = 1;
2633 }
2634
Joe Perchesbf4daf12015-09-09 15:37:50 -07002635# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002636 if ($in_commit_log && $commit_log_possible_stack_dump &&
2637 $line =~ /^\s*$/) {
2638 $commit_log_possible_stack_dump = 0;
2639 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002640
Joe Perches0d7835f2015-02-13 14:38:35 -08002641# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002642 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002643 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002644 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002645 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002646 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002647 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2648 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002649 my $init_char = "c";
2650 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002651 my $short = 1;
2652 my $long = 0;
2653 my $case = 1;
2654 my $space = 1;
2655 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002656 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002657 my $id = '0123456789ab';
2658 my $orig_desc = "commit description";
2659 my $description = "";
2660
Joe Perchesfe043ea2015-09-09 15:37:25 -07002661 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2662 $init_char = $1;
2663 $orig_commit = lc($2);
2664 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2665 $orig_commit = lc($1);
2666 }
2667
Joe Perches0d7835f2015-02-13 14:38:35 -08002668 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2669 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2670 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2671 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2672 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2673 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002674 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002675 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2676 defined $rawlines[$linenr] &&
2677 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2678 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002679 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002680 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2681 defined $rawlines[$linenr] &&
2682 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2683 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2684 $orig_desc = $1;
2685 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2686 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002687 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002688 }
2689
2690 ($id, $description) = git_commit_info($orig_commit,
2691 $id, $orig_desc);
2692
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002693 if (defined($id) &&
2694 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002695 ERROR("GIT_COMMIT_ID",
2696 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2697 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002698 }
2699
Joe Perches13f19372014-08-06 16:10:59 -07002700# Check for added, moved or deleted files
2701 if (!$reported_maintainer_file && !$in_commit_log &&
2702 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2703 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2704 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2705 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002706 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002707 $reported_maintainer_file = 1;
2708 WARN("FILE_PATH_CHANGES",
2709 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2710 }
2711
Andy Whitcroft00df3442007-06-08 13:47:06 -07002712# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002713 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002714 ERROR("CORRUPTED_PATCH",
2715 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002716 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002717 }
2718
2719# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2720 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002721 $rawline !~ m/^$UTF8*$/) {
2722 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2723
2724 my $blank = copy_spacing($rawline);
2725 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2726 my $hereptr = "$hereline$ptr\n";
2727
Joe Perches34d99212011-07-25 17:13:26 -07002728 CHK("INVALID_UTF8",
2729 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002730 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002731
Joe Perches15662b32011-10-31 17:13:12 -07002732# Check if it's the start of a commit log
2733# (not a header line and we haven't seen the patch filename)
2734 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002735 !($rawline =~ /^\s+(?:\S|$)/ ||
2736 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002737 $in_header_lines = 0;
2738 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002739 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002740 }
2741
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002742# Check if there is UTF-8 in a commit log when a mail header has explicitly
2743# declined it, i.e defined some charset where it is missing.
2744 if ($in_header_lines &&
2745 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2746 $1 !~ /utf-8/i) {
2747 $non_utf8_charset = 1;
2748 }
2749
2750 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002751 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002752 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002753 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2754 }
2755
Joe Perchesd6430f72016-12-12 16:46:28 -08002756# Check for absolute kernel paths in commit message
2757 if ($tree && $in_commit_log) {
2758 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2759 my $file = $1;
2760
2761 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2762 check_absolute_file($1, $herecurr)) {
2763 #
2764 } else {
2765 check_absolute_file($file, $herecurr);
2766 }
2767 }
2768 }
2769
Kees Cook66b47b42014-10-13 15:51:57 -07002770# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002771 if (defined($misspellings) &&
2772 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002773 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002774 my $typo = $1;
2775 my $typo_fix = $spelling_fix{lc($typo)};
2776 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2777 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002778 my $msg_level = \&WARN;
2779 $msg_level = \&CHK if ($file);
2780 if (&{$msg_level}("TYPO_SPELLING",
2781 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002782 $fix) {
2783 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2784 }
2785 }
2786 }
2787
Andy Whitcroft306708542008-10-15 22:02:28 -07002788# ignore non-hunk lines and lines being removed
2789 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002790
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002791#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002792 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002793 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002794 if (ERROR("DOS_LINE_ENDINGS",
2795 "DOS line endings\n" . $herevet) &&
2796 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002797 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002798 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002799 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2800 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002801 if (ERROR("TRAILING_WHITESPACE",
2802 "trailing whitespace\n" . $herevet) &&
2803 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002804 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002805 }
2806
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002807 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002808 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002809
Josh Triplett4783f892013-11-12 15:10:12 -08002810# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002811 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002812 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002813 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2814 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002815 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002816 my $msg_level = \&ERROR;
2817 $msg_level = \&CHK if ($file);
2818 &{$msg_level}("FSF_MAILING_ADDRESS",
2819 "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 -08002820 }
2821
Andi Kleen33549572010-05-24 14:33:29 -07002822# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002823# Only applies when adding the entry originally, after that we do not have
2824# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002825 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002826 # 'choice' is usually the last thing on the line (though
2827 # Kconfig supports named choices), so use a word boundary
2828 # (\b) rather than a whitespace character (\s)
2829 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002830 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002831 my $cnt = $realcnt;
2832 my $ln = $linenr + 1;
2833 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002834 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002835 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002836 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002837 $f = $lines[$ln - 1];
2838 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2839 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002840
2841 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002842 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002843
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002844 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002845 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002846 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2847 if ($lines[$ln - 1] =~ "---help---") {
2848 WARN("CONFIG_DESCRIPTION",
2849 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2850 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002851 $length = -1;
2852 }
2853
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002854 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002855 $f =~ s/#.*//;
2856 $f =~ s/^\s+//;
2857 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002858
2859 # This only checks context lines in the patch
2860 # and so hopefully shouldn't trigger false
2861 # positives, even though some of these are
2862 # common words in help texts
2863 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2864 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002865 $is_end = 1;
2866 last;
2867 }
Andi Kleen33549572010-05-24 14:33:29 -07002868 $length++;
2869 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002870 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2871 WARN("CONFIG_DESCRIPTION",
2872 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2873 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002874 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002875 }
2876
Joe Perches628f91a2017-07-10 15:52:07 -07002877# check for MAINTAINERS entries that don't have the right form
2878 if ($realfile =~ /^MAINTAINERS$/ &&
2879 $rawline =~ /^\+[A-Z]:/ &&
2880 $rawline !~ /^\+[A-Z]:\t\S/) {
2881 if (WARN("MAINTAINERS_STYLE",
2882 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2883 $fix) {
2884 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2885 }
2886 }
2887
Christoph Jaeger327953e2015-02-13 14:38:29 -08002888# discourage the use of boolean for type definition attributes of Kconfig options
2889 if ($realfile =~ /Kconfig/ &&
2890 $line =~ /^\+\s*\bboolean\b/) {
2891 WARN("CONFIG_TYPE_BOOLEAN",
2892 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2893 }
2894
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002895 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2896 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2897 my $flag = $1;
2898 my $replacement = {
2899 'EXTRA_AFLAGS' => 'asflags-y',
2900 'EXTRA_CFLAGS' => 'ccflags-y',
2901 'EXTRA_CPPFLAGS' => 'cppflags-y',
2902 'EXTRA_LDFLAGS' => 'ldflags-y',
2903 };
2904
2905 WARN("DEPRECATED_VARIABLE",
2906 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2907 }
2908
Rob Herringbff5da42014-01-23 15:54:51 -08002909# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002910 if (defined $root &&
2911 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2912 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2913
Rob Herringbff5da42014-01-23 15:54:51 -08002914 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2915
Florian Vaussardcc933192014-04-03 14:49:27 -07002916 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2917 my $vp_file = $dt_path . "vendor-prefixes.txt";
2918
Rob Herringbff5da42014-01-23 15:54:51 -08002919 foreach my $compat (@compats) {
2920 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002921 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2922 my $compat3 = $compat;
2923 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2924 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002925 if ( $? >> 8 ) {
2926 WARN("UNDOCUMENTED_DT_STRING",
2927 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2928 }
2929
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002930 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2931 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002932 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002933 if ( $? >> 8 ) {
2934 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002935 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002936 }
2937 }
2938 }
2939
Rob Herring9f3a8992018-04-10 16:33:13 -07002940# check for using SPDX license tag at beginning of files
2941 if ($realline == $checklicenseline) {
2942 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2943 $checklicenseline = 2;
2944 } elsif ($rawline =~ /^\+/) {
2945 my $comment = "";
2946 if ($realfile =~ /\.(h|s|S)$/) {
2947 $comment = '/*';
2948 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2949 $comment = '//';
2950 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2951 $comment = '#';
2952 } elsif ($realfile =~ /\.rst$/) {
2953 $comment = '..';
2954 }
2955
2956 if ($comment !~ /^$/ &&
2957 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
2958 WARN("SPDX_LICENSE_TAG",
2959 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
2960 }
2961 }
2962 }
2963
Andy Whitcroft5368df22008-10-15 22:02:27 -07002964# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002965 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002966
Joe Perches47e0c882015-06-25 15:02:57 -07002967# line length limit (with some exclusions)
2968#
2969# There are a few types of lines that may extend beyond $max_line_length:
2970# logging functions like pr_info that end in a string
2971# lines with a single string
2972# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002973# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07002974#
2975# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002976# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002977# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2978# LONG_LINE all other lines longer than $max_line_length
2979#
2980# if LONG_LINE is ignored, the other 2 types are also ignored
2981#
2982
Joe Perchesb4749e92015-07-17 16:24:01 -07002983 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002984 my $msg_type = "LONG_LINE";
2985
2986 # Check the allowed long line types first
2987
2988 # logging functions that end in a string that starts
2989 # before $max_line_length
2990 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2991 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2992 $msg_type = "";
2993
2994 # lines with only strings (w/ possible termination)
2995 # #defines with only strings
2996 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2997 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2998 $msg_type = "";
2999
Joe Perchescc147502017-11-17 15:28:44 -08003000 # More special cases
3001 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3002 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003003 $msg_type = "";
3004
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003005 # URL ($rawline is used in case the URL is in a comment)
3006 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3007 $msg_type = "";
3008
Joe Perches47e0c882015-06-25 15:02:57 -07003009 # Otherwise set the alternate message types
3010
3011 # a comment starts before $max_line_length
3012 } elsif ($line =~ /($;[\s$;]*)$/ &&
3013 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3014 $msg_type = "LONG_LINE_COMMENT"
3015
3016 # a quoted string starts before $max_line_length
3017 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3018 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3019 $msg_type = "LONG_LINE_STRING"
3020 }
3021
3022 if ($msg_type ne "" &&
3023 (show_type("LONG_LINE") || show_type($msg_type))) {
3024 WARN($msg_type,
3025 "line over $max_line_length characters\n" . $herecurr);
3026 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003027 }
3028
Andy Whitcroft8905a672007-11-28 16:21:06 -08003029# check for adding lines without a newline.
3030 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003031 WARN("MISSING_EOF_NEWLINE",
3032 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003033 }
3034
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003035# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003036 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003037
3038# at the beginning of a line any tabs must come first and anything
3039# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003040 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3041 $rawline =~ /^\+\s* \s*/) {
3042 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003043 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003044 if (ERROR("CODE_INDENT",
3045 "code indent should use tabs where possible\n" . $herevet) &&
3046 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003047 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003048 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003049 }
3050
Alberto Panizzo08e44362010-03-05 13:43:54 -08003051# check for space before tabs.
3052 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3053 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003054 if (WARN("SPACE_BEFORE_TAB",
3055 "please, no space before tabs\n" . $herevet) &&
3056 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003057 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003058 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003059 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003060 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003061 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003062 }
3063
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003064# check for && or || at the start of a line
3065 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3066 CHK("LOGICAL_CONTINUATIONS",
3067 "Logical continuations should be on the previous line\n" . $hereprev);
3068 }
3069
Joe Perchesa91e8992016-05-20 17:04:05 -07003070# check indentation starts on a tab stop
3071 if ($^V && $^V ge 5.10.0 &&
Joe Perchesbd491112018-02-06 15:39:06 -08003072 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003073 my $indent = length($1);
3074 if ($indent % 8) {
3075 if (WARN("TABSTOP",
3076 "Statements should start on a tabstop\n" . $herecurr) &&
3077 $fix) {
3078 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3079 }
3080 }
3081 }
3082
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003083# check multi-line statement indentation matches previous line
3084 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003085 $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 -07003086 $prevline =~ /^\+(\t*)(.*)$/;
3087 my $oldindent = $1;
3088 my $rest = $2;
3089
3090 my $pos = pos_last_openparen($rest);
3091 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003092 $line =~ /^(\+| )([ \t]*)/;
3093 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003094
3095 my $goodtabindent = $oldindent .
3096 "\t" x ($pos / 8) .
3097 " " x ($pos % 8);
3098 my $goodspaceindent = $oldindent . " " x $pos;
3099
3100 if ($newindent ne $goodtabindent &&
3101 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003102
3103 if (CHK("PARENTHESIS_ALIGNMENT",
3104 "Alignment should match open parenthesis\n" . $hereprev) &&
3105 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003106 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003107 s/^\+[ \t]*/\+$goodtabindent/;
3108 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003109 }
3110 }
3111 }
3112
Joe Perches6ab3a972015-04-16 12:44:05 -07003113# check for space after cast like "(int) foo" or "(struct foo) bar"
3114# avoid checking a few false positives:
3115# "sizeof(<type>)" or "__alignof__(<type>)"
3116# function pointer declarations like "(*foo)(int) = bar;"
3117# structure definitions like "(struct foo) { 0 };"
3118# multiline macros that define functions
3119# known attributes or the __attribute__ keyword
3120 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3121 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003122 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003123 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003124 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003125 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003126 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003127 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003128 }
3129
Joe Perches86406b12015-09-09 15:37:41 -07003130# Block comment styles
3131# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003132 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003133 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003134 $rawline =~ /^\+[ \t]*\*/ &&
3135 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003136 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3137 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3138 }
3139
Joe Perches86406b12015-09-09 15:37:41 -07003140# Block comments use * on subsequent lines
3141 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3142 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003143 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003144 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003145 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003146 WARN("BLOCK_COMMENT_STYLE",
3147 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003148 }
3149
Joe Perches86406b12015-09-09 15:37:41 -07003150# Block comments use */ on trailing lines
3151 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003152 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3153 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3154 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003155 WARN("BLOCK_COMMENT_STYLE",
3156 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003157 }
3158
Joe Perches08eb9b82016-10-11 13:51:50 -07003159# Block comment * alignment
3160 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003161 $line =~ /^\+[ \t]*$;/ && #leading comment
3162 $rawline =~ /^\+[ \t]*\*/ && #leading *
3163 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003164 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003165 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3166 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003167 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003168 if (defined($1)) {
3169 $oldindent = expand_tabs($1);
3170 } else {
3171 $prevrawline =~ m@^\+(.*/?)\*@;
3172 $oldindent = expand_tabs($1);
3173 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003174 $rawline =~ m@^\+([ \t]*)\*@;
3175 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003176 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003177 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003178 WARN("BLOCK_COMMENT_STYLE",
3179 "Block comments should align the * on each line\n" . $hereprev);
3180 }
3181 }
3182
Joe Perches7f619192014-08-06 16:10:39 -07003183# check for missing blank lines after struct/union declarations
3184# with exceptions for various attributes and macros
3185 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3186 $line =~ /^\+/ &&
3187 !($line =~ /^\+\s*$/ ||
3188 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3189 $line =~ /^\+\s*MODULE_/i ||
3190 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3191 $line =~ /^\+[a-z_]*init/ ||
3192 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3193 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003194 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003195 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003196 if (CHK("LINE_SPACING",
3197 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3198 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003199 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003200 }
Joe Perches7f619192014-08-06 16:10:39 -07003201 }
3202
Joe Perches365dd4e2014-08-06 16:10:42 -07003203# check for multiple consecutive blank lines
3204 if ($prevline =~ /^[\+ ]\s*$/ &&
3205 $line =~ /^\+\s*$/ &&
3206 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003207 if (CHK("LINE_SPACING",
3208 "Please don't use multiple blank lines\n" . $hereprev) &&
3209 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003210 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003211 }
3212
Joe Perches365dd4e2014-08-06 16:10:42 -07003213 $last_blank_line = $linenr;
3214 }
3215
Joe Perches3b617e32014-04-03 14:49:28 -07003216# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003217 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3218 # actual declarations
3219 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003220 # function pointer declarations
3221 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003222 # foo bar; where foo is some local typedef or #define
3223 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3224 # known declaration macros
3225 $prevline =~ /^\+\s+$declaration_macros/) &&
3226 # for "else if" which can look like "$Ident $Ident"
3227 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3228 # other possible extensions of declaration lines
3229 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3230 # not starting a section or a macro "\" extended line
3231 $prevline =~ /(?:\{\s*|\\)$/) &&
3232 # looks like a declaration
3233 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003234 # function pointer declarations
3235 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003236 # foo bar; where foo is some local typedef or #define
3237 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3238 # known declaration macros
3239 $sline =~ /^\+\s+$declaration_macros/ ||
3240 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003241 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003242 # start or end of block or continuation of declaration
3243 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3244 # bitfield continuation
3245 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3246 # other possible extensions of declaration lines
3247 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3248 # indentation of previous and current line are the same
3249 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003250 if (WARN("LINE_SPACING",
3251 "Missing a blank line after declarations\n" . $hereprev) &&
3252 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003253 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003254 }
Joe Perches3b617e32014-04-03 14:49:28 -07003255 }
3256
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003257# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003258# Exceptions:
3259# 1) within comments
3260# 2) indented preprocessor commands
3261# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003262 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003263 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003264 if (WARN("LEADING_SPACE",
3265 "please, no spaces at the start of a line\n" . $herevet) &&
3266 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003267 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003268 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003269 }
3270
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003271# check we are in a valid C source file if not then ignore this hunk
3272 next if ($realfile !~ /\.(h|c)$/);
3273
Joe Perches5751a242017-11-17 15:28:52 -08003274# check for unusual line ending [ or (
3275 if ($line =~ /^\+.*([\[\(])\s*$/) {
3276 CHK("OPEN_ENDED_LINE",
3277 "Lines should not end with a '$1'\n" . $herecurr);
3278 }
3279
Joe Perches4dbed762017-05-08 15:55:39 -07003280# check if this appears to be the start function declaration, save the name
3281 if ($sline =~ /^\+\{\s*$/ &&
3282 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3283 $context_function = $1;
3284 }
3285
3286# check if this appears to be the end of function declaration
3287 if ($sline =~ /^\+\}\s*$/) {
3288 undef $context_function;
3289 }
3290
Joe Perches032a4c02014-08-06 16:10:29 -07003291# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003292# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003293# if the previous line is a break or return and is indented 1 tab more...
3294 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3295 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003296 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3297 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3298 defined $lines[$linenr] &&
3299 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003300 WARN("UNNECESSARY_ELSE",
3301 "else is not generally useful after a break or return\n" . $hereprev);
3302 }
3303 }
3304
Joe Perchesc00df192014-08-06 16:11:01 -07003305# check indentation of a line with a break;
3306# if the previous line is a goto or return and is indented the same # of tabs
3307 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3308 my $tabs = $1;
3309 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3310 WARN("UNNECESSARY_BREAK",
3311 "break is not useful after a goto or return\n" . $hereprev);
3312 }
3313 }
3314
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003315# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003316 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003317 WARN("CVS_KEYWORD",
3318 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003319 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003320
Joe Perches56e77d72013-02-21 16:44:14 -08003321# check for old HOTPLUG __dev<foo> section markings
3322 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3323 WARN("HOTPLUG_SECTION",
3324 "Using $1 is unnecessary\n" . $herecurr);
3325 }
3326
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003327# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003328 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3329 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003330#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003331 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003332 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003333 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003334 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003335 $stat =~ s/\n./\n /g;
3336 $cond =~ s/\n./\n /g;
3337
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003338#print "linenr<$linenr> <$stat>\n";
3339 # If this statement has no statement boundaries within
3340 # it there is no point in retrying a statement scan
3341 # until we hit end of it.
3342 my $frag = $stat; $frag =~ s/;+\s*$//;
3343 if ($frag !~ /(?:{|;)/) {
3344#print "skip<$line_nr_next>\n";
3345 $suppress_statement = $line_nr_next;
3346 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003347
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003348 # Find the real next line.
3349 $realline_next = $line_nr_next;
3350 if (defined $realline_next &&
3351 (!defined $lines[$realline_next - 1] ||
3352 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3353 $realline_next++;
3354 }
3355
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003356 my $s = $stat;
3357 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003358
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003359 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003360 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003361
3362 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003363 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003364
Andy Whitcroft463f2862009-09-21 17:04:34 -07003365 } elsif ($s =~ /^.\s*else\b/s) {
3366
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003367 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003368 } 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 -07003369 my $type = $1;
3370 $type =~ s/\s+/ /g;
3371 possible($type, "A:" . $s);
3372
Andy Whitcroft8905a672007-11-28 16:21:06 -08003373 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003374 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003375 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003376 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003377
3378 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003379 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003380 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003381 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003382
3383 # Check for any sort of function declaration.
3384 # int foo(something bar, other baz);
3385 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003386 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 -08003387 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003388
Andy Whitcroftcf655042008-03-04 14:28:20 -08003389 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003390 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003391 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003392
Andy Whitcroft8905a672007-11-28 16:21:06 -08003393 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003394 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003395
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003396 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003397 }
3398 }
3399 }
3400
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003401 }
3402
Andy Whitcroft653d4872007-06-23 17:16:34 -07003403#
3404# Checks which may be anchored in the context.
3405#
3406
3407# Check for switch () and associated case and default
3408# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003409 if ($line=~/\bswitch\s*\(.*\)/) {
3410 my $err = '';
3411 my $sep = '';
3412 my @ctx = ctx_block_outer($linenr, $realcnt);
3413 shift(@ctx);
3414 for my $ctx (@ctx) {
3415 my ($clen, $cindent) = line_stats($ctx);
3416 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3417 $indent != $cindent) {
3418 $err .= "$sep$ctx\n";
3419 $sep = '';
3420 } else {
3421 $sep = "[...]\n";
3422 }
3423 }
3424 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003425 ERROR("SWITCH_CASE_INDENT_LEVEL",
3426 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003427 }
3428 }
3429
3430# if/while/etc brace do not go on next line, unless defining a do while loop,
3431# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003432 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 -07003433 my $pre_ctx = "$1$2";
3434
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003435 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003436
3437 if ($line =~ /^\+\t{6,}/) {
3438 WARN("DEEP_INDENTATION",
3439 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3440 }
3441
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003442 my $ctx_cnt = $realcnt - $#ctx - 1;
3443 my $ctx = join("\n", @ctx);
3444
Andy Whitcroft548596d2008-07-23 21:29:01 -07003445 my $ctx_ln = $linenr;
3446 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003447
Andy Whitcroft548596d2008-07-23 21:29:01 -07003448 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3449 defined $lines[$ctx_ln - 1] &&
3450 $lines[$ctx_ln - 1] =~ /^-/)) {
3451 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3452 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003453 $ctx_ln++;
3454 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003455
Andy Whitcroft53210162008-07-23 21:29:03 -07003456 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3457 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003458
Joe Perchesd752fcc2014-08-06 16:11:05 -07003459 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003460 ERROR("OPEN_BRACE",
3461 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003462 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003463 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003464 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3465 $ctx =~ /\)\s*\;\s*$/ &&
3466 defined $lines[$ctx_ln - 1])
3467 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003468 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3469 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003470 WARN("TRAILING_SEMICOLON",
3471 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003472 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003473 }
3474 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003475 }
3476
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003477# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003478 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 -08003479 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3480 ctx_statement_block($linenr, $realcnt, 0)
3481 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003482 my ($s, $c) = ($stat, $cond);
3483
3484 substr($s, 0, length($c), '');
3485
Joe Perches9f5af482015-09-09 15:37:30 -07003486 # remove inline comments
3487 $s =~ s/$;/ /g;
3488 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003489
3490 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003491 my @newlines = ($c =~ /\n/gs);
3492 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003493
Joe Perches9f5af482015-09-09 15:37:30 -07003494 # Make sure we remove the line prefixes as we have
3495 # none on the first line, and are going to readd them
3496 # where necessary.
3497 $s =~ s/\n./\n/gs;
3498 while ($s =~ /\n\s+\\\n/) {
3499 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3500 }
3501
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003502 # We want to check the first line inside the block
3503 # starting at the end of the conditional, so remove:
3504 # 1) any blank line termination
3505 # 2) any opening brace { on end of the line
3506 # 3) any do (...) {
3507 my $continuation = 0;
3508 my $check = 0;
3509 $s =~ s/^.*\bdo\b//;
3510 $s =~ s/^\s*{//;
3511 if ($s =~ s/^\s*\\//) {
3512 $continuation = 1;
3513 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003514 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003515 $check = 1;
3516 $cond_lines++;
3517 }
3518
3519 # Also ignore a loop construct at the end of a
3520 # preprocessor statement.
3521 if (($prevline =~ /^.\s*#\s*define\s/ ||
3522 $prevline =~ /\\\s*$/) && $continuation == 0) {
3523 $check = 0;
3524 }
3525
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003526 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003527 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003528 while ($cond_ptr != $cond_lines) {
3529 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003530
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003531 # If we see an #else/#elif then the code
3532 # is not linear.
3533 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3534 $check = 0;
3535 }
3536
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003537 # Ignore:
3538 # 1) blank lines, they should be at 0,
3539 # 2) preprocessor lines, and
3540 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003541 if ($continuation ||
3542 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003543 $s =~ /^\s*#\s*?/ ||
3544 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003545 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003546 if ($s =~ s/^.*?\n//) {
3547 $cond_lines++;
3548 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003549 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003550 }
3551
3552 my (undef, $sindent) = line_stats("+" . $s);
3553 my $stat_real = raw_line($linenr, $cond_lines);
3554
3555 # Check if either of these lines are modified, else
3556 # this is not this patch's fault.
3557 if (!defined($stat_real) ||
3558 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3559 $check = 0;
3560 }
3561 if (defined($stat_real) && $cond_lines > 1) {
3562 $stat_real = "[...]\n$stat_real";
3563 }
3564
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003565 #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 -07003566
Joe Perches9f5af482015-09-09 15:37:30 -07003567 if ($check && $s ne '' &&
3568 (($sindent % 8) != 0 ||
3569 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003570 ($sindent == $indent &&
3571 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003572 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003573 WARN("SUSPECT_CODE_INDENT",
3574 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003575 }
3576 }
3577
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003578 # Track the 'values' across context and added lines.
3579 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003580 my ($curr_values, $curr_vars) =
3581 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003582 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003583 if ($dbg_values) {
3584 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003585 print "$linenr > .$outline\n";
3586 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003587 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003588 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003589 $prev_values = substr($curr_values, -1);
3590
Andy Whitcroft00df3442007-06-08 13:47:06 -07003591#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003592 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003593
Joe Perches11ca40a2016-12-12 16:46:31 -08003594# check for dereferences that span multiple lines
3595 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3596 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3597 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3598 my $ref = $1;
3599 $line =~ /^.\s*($Lval)/;
3600 $ref .= $1;
3601 $ref =~ s/\s//g;
3602 WARN("MULTILINE_DEREFERENCE",
3603 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3604 }
3605
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003606# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003607 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 -07003608 my $type = $1;
3609 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003610 $var = "" if (!defined $var);
3611 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003612 my $sign = $1;
3613 my $pointer = $2;
3614
3615 $pointer = "" if (!defined $pointer);
3616
3617 if (WARN("UNSPECIFIED_INT",
3618 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3619 $fix) {
3620 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003621 my $comp_pointer = $pointer;
3622 $comp_pointer =~ s/\s//g;
3623 $decl .= $comp_pointer;
3624 $decl = rtrim($decl) if ($var eq "");
3625 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003626 }
3627 }
3628 }
3629
Andy Whitcroft653d4872007-06-23 17:16:34 -07003630# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003631 if ($dbg_type) {
3632 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003633 ERROR("TEST_TYPE",
3634 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003635 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003636 ERROR("TEST_NOT_TYPE",
3637 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003638 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003639 next;
3640 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003641# TEST: allow direct testing of the attribute matcher.
3642 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003643 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003644 ERROR("TEST_ATTR",
3645 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003646 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003647 ERROR("TEST_NOT_ATTR",
3648 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003649 }
3650 next;
3651 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003652
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003653# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003654 if ($line =~ /^.\s*{/ &&
3655 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003656 if (ERROR("OPEN_BRACE",
3657 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003658 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3659 fix_delete_line($fixlinenr - 1, $prevrawline);
3660 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003661 my $fixedline = $prevrawline;
3662 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003663 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003664 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003665 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003666 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003667 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003668 }
3669
Andy Whitcroft653d4872007-06-23 17:16:34 -07003670#
3671# Checks which are anchored on the added line.
3672#
3673
3674# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003675 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003676 my $path = $1;
3677 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003678 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003679 "malformed #include filename\n" . $herecurr);
3680 }
3681 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3682 ERROR("UAPI_INCLUDE",
3683 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003684 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003685 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003686
3687# no C99 // comments
3688 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003689 if (ERROR("C99_COMMENTS",
3690 "do not use C99 // comments\n" . $herecurr) &&
3691 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003692 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003693 if ($line =~ /\/\/(.*)$/) {
3694 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003695 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003696 }
3697 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003698 }
3699 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003700 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003701 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003702
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003703# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3704# the whole statement.
3705#print "APW <$lines[$realline_next - 1]>\n";
3706 if (defined $realline_next &&
3707 exists $lines[$realline_next - 1] &&
3708 !defined $suppress_export{$realline_next} &&
3709 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3710 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003711 # Handle definitions which produce identifiers with
3712 # a prefix:
3713 # XXX(foo);
3714 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003715 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003716 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003717 $name =~ /^${Ident}_$2/) {
3718#print "FOO C name<$name>\n";
3719 $suppress_export{$realline_next} = 1;
3720
3721 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003722 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003723 ^.DEFINE_$Ident\(\Q$name\E\)|
3724 ^.DECLARE_$Ident\(\Q$name\E\)|
3725 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003726 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3727 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003728 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003729#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3730 $suppress_export{$realline_next} = 2;
3731 } else {
3732 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003733 }
3734 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003735 if (!defined $suppress_export{$linenr} &&
3736 $prevline =~ /^.\s*$/ &&
3737 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3738 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3739#print "FOO B <$lines[$linenr - 1]>\n";
3740 $suppress_export{$linenr} = 2;
3741 }
3742 if (defined $suppress_export{$linenr} &&
3743 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003744 WARN("EXPORT_SYMBOL",
3745 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003746 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003747
Joe Eloff5150bda2010-08-09 17:21:00 -07003748# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003749 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003750 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003751 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003752 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003753 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003754 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003755 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003756# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003757 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003758 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003759 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003760 $herecurr) &&
3761 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003762 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003763 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003764 }
3765
Joe Perches18130872014-08-06 16:11:22 -07003766# check for misordered declarations of char/short/int/long with signed/unsigned
3767 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3768 my $tmp = trim($1);
3769 WARN("MISORDERED_TYPE",
3770 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3771 }
3772
Joe Perchescb710ec2010-10-26 14:23:20 -07003773# check for static const char * arrays.
3774 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003775 WARN("STATIC_CONST_CHAR_ARRAY",
3776 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003777 $herecurr);
3778 }
3779
3780# check for static char foo[] = "bar" declarations.
3781 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003782 WARN("STATIC_CONST_CHAR_ARRAY",
3783 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003784 $herecurr);
3785 }
3786
Joe Perchesab7e23f2015-04-16 12:44:22 -07003787# check for const <foo> const where <foo> is not a pointer or array type
3788 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3789 my $found = $1;
3790 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3791 WARN("CONST_CONST",
3792 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3793 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3794 WARN("CONST_CONST",
3795 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3796 }
3797 }
3798
Joe Perches9b0fa602014-04-03 14:49:18 -07003799# check for non-global char *foo[] = {"bar", ...} declarations.
3800 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3801 WARN("STATIC_CONST_CHAR_ARRAY",
3802 "char * array declaration might be better as static const\n" .
3803 $herecurr);
3804 }
3805
Joe Perchesb598b672015-04-16 12:44:36 -07003806# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3807 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3808 my $array = $1;
3809 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3810 my $array_div = $1;
3811 if (WARN("ARRAY_SIZE",
3812 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3813 $fix) {
3814 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3815 }
3816 }
3817 }
3818
Joe Perchesb36190c2014-01-27 17:07:18 -08003819# check for function declarations without arguments like "int foo()"
3820 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3821 if (ERROR("FUNCTION_WITHOUT_ARGS",
3822 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3823 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003824 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003825 }
3826 }
3827
Andy Whitcroft653d4872007-06-23 17:16:34 -07003828# check for new typedefs, only function parameters and sparse annotations
3829# make sense.
3830 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003831 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003832 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003833 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003834 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003835 WARN("NEW_TYPEDEFS",
3836 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003837 }
3838
3839# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003840 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003841 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3842 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003843 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003844
Andy Whitcroft65863862009-01-06 14:41:21 -08003845 # Should start with a space.
3846 $to =~ s/^(\S)/ $1/;
3847 # Should not end with a space.
3848 $to =~ s/\s+$//;
3849 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003850 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003851 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003852
Joe Perches3705ce52013-07-03 15:05:31 -07003853## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003854 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003855 if (ERROR("POINTER_LOCATION",
3856 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3857 $fix) {
3858 my $sub_from = $ident;
3859 my $sub_to = $ident;
3860 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003861 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003862 s@\Q$sub_from\E@$sub_to@;
3863 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003864 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003865 }
3866 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3867 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003868 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003869
Andy Whitcroft65863862009-01-06 14:41:21 -08003870 # Should start with a space.
3871 $to =~ s/^(\S)/ $1/;
3872 # Should not end with a space.
3873 $to =~ s/\s+$//;
3874 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003875 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003876 }
3877 # Modifiers should have spaces.
3878 $to =~ s/(\b$Modifier$)/$1 /;
3879
Joe Perches3705ce52013-07-03 15:05:31 -07003880## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003881 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003882 if (ERROR("POINTER_LOCATION",
3883 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3884 $fix) {
3885
3886 my $sub_from = $match;
3887 my $sub_to = $match;
3888 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003889 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003890 s@\Q$sub_from\E@$sub_to@;
3891 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003892 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003893 }
3894
Joe Perches9d3e3c72015-09-09 15:37:27 -07003895# avoid BUG() or BUG_ON()
3896 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003897 my $msg_level = \&WARN;
3898 $msg_level = \&CHK if ($file);
3899 &{$msg_level}("AVOID_BUG",
3900 "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 -07003901 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003902
Joe Perches9d3e3c72015-09-09 15:37:27 -07003903# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003904 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003905 WARN("LINUX_VERSION_CODE",
3906 "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 -08003907 }
3908
Joe Perches17441222011-06-15 15:08:17 -07003909# check for uses of printk_ratelimit
3910 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003911 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003912 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003913 }
3914
Joe Percheseeef5732017-11-17 15:28:41 -08003915# printk should use KERN_* levels
3916 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3917 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3918 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003919 }
3920
Joe Perches243f3802012-05-31 16:26:09 -07003921 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3922 my $orig = $1;
3923 my $level = lc($orig);
3924 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003925 my $level2 = $level;
3926 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003927 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003928 "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 -07003929 }
3930
3931 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003932 if (WARN("PREFER_PR_LEVEL",
3933 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3934 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003935 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003936 s/\bpr_warning\b/pr_warn/;
3937 }
Joe Perches243f3802012-05-31 16:26:09 -07003938 }
3939
Joe Perchesdc139312013-02-21 16:44:13 -08003940 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3941 my $orig = $1;
3942 my $level = lc($orig);
3943 $level = "warn" if ($level eq "warning");
3944 $level = "dbg" if ($level eq "debug");
3945 WARN("PREFER_DEV_LEVEL",
3946 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3947 }
3948
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003949# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3950# number of false positives, but assembly files are not checked, so at
3951# least the arch entry code will not trigger this warning.
3952 if ($line =~ /\bENOSYS\b/) {
3953 WARN("ENOSYS",
3954 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3955 }
3956
Andy Whitcroft653d4872007-06-23 17:16:34 -07003957# function brace can't be on same line, except for #defines of do while,
3958# or if closed on same line
Joe Perches2d453e32018-02-06 15:39:09 -08003959 if ($^V && $^V ge 5.10.0 &&
3960 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3961 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3962 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07003963 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08003964 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07003965 $fix) {
3966 fix_delete_line($fixlinenr, $rawline);
3967 my $fixed_line = $rawline;
3968 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3969 my $line1 = $1;
3970 my $line2 = $2;
3971 fix_insert_line($fixlinenr, ltrim($line1));
3972 fix_insert_line($fixlinenr, "\+{");
3973 if ($line2 !~ /^\s*$/) {
3974 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3975 }
3976 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003977 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003978
Andy Whitcroft8905a672007-11-28 16:21:06 -08003979# open braces for enum, union and struct go on the same line.
3980 if ($line =~ /^.\s*{/ &&
3981 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003982 if (ERROR("OPEN_BRACE",
3983 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3984 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3985 fix_delete_line($fixlinenr - 1, $prevrawline);
3986 fix_delete_line($fixlinenr, $rawline);
3987 my $fixedline = rtrim($prevrawline) . " {";
3988 fix_insert_line($fixlinenr, $fixedline);
3989 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003990 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003991 if ($fixedline !~ /^\+\s*$/) {
3992 fix_insert_line($fixlinenr, $fixedline);
3993 }
3994 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003995 }
3996
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003997# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003998 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3999 if (WARN("SPACING",
4000 "missing space after $1 definition\n" . $herecurr) &&
4001 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004002 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004003 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4004 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004005 }
4006
Joe Perches31070b52014-01-23 15:54:49 -08004007# Function pointer declarations
4008# check spacing between type, funcptr, and args
4009# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004010 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004011 my $declare = $1;
4012 my $pre_pointer_space = $2;
4013 my $post_pointer_space = $3;
4014 my $funcname = $4;
4015 my $post_funcname_space = $5;
4016 my $pre_args_space = $6;
4017
Joe Perches91f72e92014-04-03 14:49:12 -07004018# the $Declare variable will capture all spaces after the type
4019# so check it for a missing trailing missing space but pointer return types
4020# don't need a space so don't warn for those.
4021 my $post_declare_space = "";
4022 if ($declare =~ /(\s+)$/) {
4023 $post_declare_space = $1;
4024 $declare = rtrim($declare);
4025 }
4026 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004027 WARN("SPACING",
4028 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004029 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004030 }
4031
4032# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004033# This test is not currently implemented because these declarations are
4034# equivalent to
4035# int foo(int bar, ...)
4036# and this is form shouldn't/doesn't generate a checkpatch warning.
4037#
4038# elsif ($declare =~ /\s{2,}$/) {
4039# WARN("SPACING",
4040# "Multiple spaces after return type\n" . $herecurr);
4041# }
Joe Perches31070b52014-01-23 15:54:49 -08004042
4043# unnecessary space "type ( *funcptr)(args...)"
4044 if (defined $pre_pointer_space &&
4045 $pre_pointer_space =~ /^\s/) {
4046 WARN("SPACING",
4047 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4048 }
4049
4050# unnecessary space "type (* funcptr)(args...)"
4051 if (defined $post_pointer_space &&
4052 $post_pointer_space =~ /^\s/) {
4053 WARN("SPACING",
4054 "Unnecessary space before function pointer name\n" . $herecurr);
4055 }
4056
4057# unnecessary space "type (*funcptr )(args...)"
4058 if (defined $post_funcname_space &&
4059 $post_funcname_space =~ /^\s/) {
4060 WARN("SPACING",
4061 "Unnecessary space after function pointer name\n" . $herecurr);
4062 }
4063
4064# unnecessary space "type (*funcptr) (args...)"
4065 if (defined $pre_args_space &&
4066 $pre_args_space =~ /^\s/) {
4067 WARN("SPACING",
4068 "Unnecessary space before function pointer arguments\n" . $herecurr);
4069 }
4070
4071 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004072 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004073 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004074 }
4075 }
4076
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004077# check for spacing round square brackets; allowed:
4078# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004079# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4080# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004081 while ($line =~ /(.*?\s)\[/g) {
4082 my ($where, $prefix) = ($-[1], $1);
4083 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004084 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004085 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004086 if (ERROR("BRACKET_SPACE",
4087 "space prohibited before open square bracket '['\n" . $herecurr) &&
4088 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004089 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004090 s/^(\+.*?)\s+\[/$1\[/;
4091 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004092 }
4093 }
4094
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004095# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004096 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004097 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004098 my $ctx_before = substr($line, 0, $-[1]);
4099 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004100
4101 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004102 if ($name =~ /^(?:
4103 if|for|while|switch|return|case|
4104 volatile|__volatile__|
4105 __attribute__|format|__extension__|
4106 asm|__asm__)$/x)
4107 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004108 # cpp #define statements have non-optional spaces, ie
4109 # if there is a space between the name and the open
4110 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004111 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004112
4113 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004114 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004115
4116 # If this whole things ends with a type its most
4117 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004118 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004119
4120 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004121 if (WARN("SPACING",
4122 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4123 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004124 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004125 s/\b$name\s+\(/$name\(/;
4126 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004127 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004128 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004129
Andy Whitcroft653d4872007-06-23 17:16:34 -07004130# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004131 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004132 my $fixed_line = "";
4133 my $line_fixed = 0;
4134
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004135 my $ops = qr{
4136 <<=|>>=|<=|>=|==|!=|
4137 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4138 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004139 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004140 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004141 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004142 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004143
4144## print("element count: <" . $#elements . ">\n");
4145## foreach my $el (@elements) {
4146## print("el: <$el>\n");
4147## }
4148
4149 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004150 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004151
Joe Perches3705ce52013-07-03 15:05:31 -07004152 foreach my $el (@elements) {
4153 push(@fix_elements, substr($rawline, $off, length($el)));
4154 $off += length($el);
4155 }
4156
4157 $off = 0;
4158
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004159 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004160 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004161
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004162 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004163
4164 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4165
4166## print("n: <$n> good: <$good>\n");
4167
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004168 $off += length($elements[$n]);
4169
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004170 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004171 my $ca = substr($opline, 0, $off);
4172 my $cc = '';
4173 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4174 $cc = substr($opline, $off + length($elements[$n + 1]));
4175 }
4176 my $cb = "$ca$;$cc";
4177
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004178 my $a = '';
4179 $a = 'V' if ($elements[$n] ne '');
4180 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004181 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004182 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4183 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004184 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004185
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004186 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004187
4188 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004189 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004190 $c = 'V' if ($elements[$n + 2] ne '');
4191 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004192 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004193 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4194 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004195 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004196 } else {
4197 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004198 }
4199
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004200 my $ctx = "${a}x${c}";
4201
4202 my $at = "(ctx:$ctx)";
4203
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004204 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004205 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004206
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004207 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004208 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004209
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004210 # Get the full operator variant.
4211 my $opv = $op . substr($curr_vars, $off, 1);
4212
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004213 # Ignore operators passed as parameters.
4214 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004215 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004216
Andy Whitcroftcf655042008-03-04 14:28:20 -08004217# # Ignore comments
4218# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004219
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004220 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004221 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004222 if ($ctx !~ /.x[WEBC]/ &&
4223 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004224 if (ERROR("SPACING",
4225 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004226 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004227 $line_fixed = 1;
4228 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004229 }
4230
4231 # // is a comment
4232 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004233
Joe Perchesb00e4812014-04-03 14:49:33 -07004234 # : when part of a bitfield
4235 } elsif ($opv eq ':B') {
4236 # skip the bitfield test for now
4237
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004238 # No spaces for:
4239 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004240 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004241 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004242 if (ERROR("SPACING",
4243 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004244 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004245 if (defined $fix_elements[$n + 2]) {
4246 $fix_elements[$n + 2] =~ s/^\s+//;
4247 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004248 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004249 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004250 }
4251
Joe Perches23810972014-12-10 15:51:32 -08004252 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004253 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004254 my $rtrim_before = 0;
4255 my $space_after = 0;
4256 if ($ctx =~ /Wx./) {
4257 if (ERROR("SPACING",
4258 "space prohibited before that '$op' $at\n" . $hereptr)) {
4259 $line_fixed = 1;
4260 $rtrim_before = 1;
4261 }
4262 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004263 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004264 if (ERROR("SPACING",
4265 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004266 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004267 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004268 $space_after = 1;
4269 }
4270 }
4271 if ($rtrim_before || $space_after) {
4272 if ($rtrim_before) {
4273 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4274 } else {
4275 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4276 }
4277 if ($space_after) {
4278 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004279 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004280 }
4281
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004282 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004283 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004284 #warn "'*' is part of type\n";
4285
4286 # unary operators should have a space before and
4287 # none after. May be left adjacent to another
4288 # unary operator, or a cast
4289 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004290 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004291 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004292 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004293 if (ERROR("SPACING",
4294 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004295 if ($n != $last_after + 2) {
4296 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4297 $line_fixed = 1;
4298 }
Joe Perches3705ce52013-07-03 15:05:31 -07004299 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004300 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004301 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004302 # A unary '*' may be const
4303
4304 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004305 if (ERROR("SPACING",
4306 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004307 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004308 if (defined $fix_elements[$n + 2]) {
4309 $fix_elements[$n + 2] =~ s/^\s+//;
4310 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004311 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004312 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004313 }
4314
4315 # unary ++ and unary -- are allowed no space on one side.
4316 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004317 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004318 if (ERROR("SPACING",
4319 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004320 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004321 $line_fixed = 1;
4322 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004323 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004324 if ($ctx =~ /Wx[BE]/ ||
4325 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004326 if (ERROR("SPACING",
4327 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004328 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004329 $line_fixed = 1;
4330 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004331 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004332 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004333 if (ERROR("SPACING",
4334 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004335 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004336 if (defined $fix_elements[$n + 2]) {
4337 $fix_elements[$n + 2] =~ s/^\s+//;
4338 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004339 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004340 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004341 }
4342
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004343 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004344 } elsif ($op eq '<<' or $op eq '>>' or
4345 $op eq '&' or $op eq '^' or $op eq '|' or
4346 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004347 $op eq '*' or $op eq '/' or
4348 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004349 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004350 if ($check) {
4351 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4352 if (CHK("SPACING",
4353 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4354 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4355 $fix_elements[$n + 2] =~ s/^\s+//;
4356 $line_fixed = 1;
4357 }
4358 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4359 if (CHK("SPACING",
4360 "space preferred before that '$op' $at\n" . $hereptr)) {
4361 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4362 $line_fixed = 1;
4363 }
4364 }
4365 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004366 if (ERROR("SPACING",
4367 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004368 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4369 if (defined $fix_elements[$n + 2]) {
4370 $fix_elements[$n + 2] =~ s/^\s+//;
4371 }
Joe Perches3705ce52013-07-03 15:05:31 -07004372 $line_fixed = 1;
4373 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004374 }
4375
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004376 # A colon needs no spaces before when it is
4377 # terminating a case value or a label.
4378 } elsif ($opv eq ':C' || $opv eq ':L') {
4379 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004380 if (ERROR("SPACING",
4381 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004382 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004383 $line_fixed = 1;
4384 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004385 }
4386
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004387 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004388 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004389 my $ok = 0;
4390
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004391 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004392 if (($op eq '<' &&
4393 $cc =~ /^\S+\@\S+>/) ||
4394 ($op eq '>' &&
4395 $ca =~ /<\S+\@\S+$/))
4396 {
4397 $ok = 1;
4398 }
4399
Joe Perchese0df7e12015-04-16 12:44:53 -07004400 # for asm volatile statements
4401 # ignore a colon with another
4402 # colon immediately before or after
4403 if (($op eq ':') &&
4404 ($ca =~ /:$/ || $cc =~ /^:/)) {
4405 $ok = 1;
4406 }
4407
Joe Perches84731622013-11-12 15:10:05 -08004408 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004409 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004410 my $msg_level = \&ERROR;
4411 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004412
Jean Delvare0675a8f2017-09-08 16:16:07 -07004413 if (&{$msg_level}("SPACING",
4414 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004415 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4416 if (defined $fix_elements[$n + 2]) {
4417 $fix_elements[$n + 2] =~ s/^\s+//;
4418 }
Joe Perches3705ce52013-07-03 15:05:31 -07004419 $line_fixed = 1;
4420 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004421 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004422 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004423 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004424
4425## print("n: <$n> GOOD: <$good>\n");
4426
4427 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004428 }
Joe Perches3705ce52013-07-03 15:05:31 -07004429
4430 if (($#elements % 2) == 0) {
4431 $fixed_line = $fixed_line . $fix_elements[$#elements];
4432 }
4433
Joe Perches194f66f2014-08-06 16:11:03 -07004434 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4435 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004436 }
4437
4438
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004439 }
4440
Joe Perches786b6322013-07-03 15:05:32 -07004441# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004442 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004443 if (WARN("SPACING",
4444 "space prohibited before semicolon\n" . $herecurr) &&
4445 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004446 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004447 s/^(\+.*\S)\s+;/$1;/;
4448 }
4449 }
4450
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004451# check for multiple assignments
4452 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004453 CHK("MULTIPLE_ASSIGNMENTS",
4454 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004455 }
4456
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004457## # check for multiple declarations, allowing for a function declaration
4458## # continuation.
4459## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4460## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4461##
4462## # Remove any bracketed sections to ensure we do not
4463## # falsly report the parameters of functions.
4464## my $ln = $line;
4465## while ($ln =~ s/\([^\(\)]*\)//g) {
4466## }
4467## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004468## WARN("MULTIPLE_DECLARATION",
4469## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004470## }
4471## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004472
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004473#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004474 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004475 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004476 if (ERROR("SPACING",
4477 "space required before the open brace '{'\n" . $herecurr) &&
4478 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004479 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004480 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004481 }
4482
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004483## # check for blank lines before declarations
4484## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4485## $prevrawline =~ /^.\s*$/) {
4486## WARN("SPACING",
4487## "No blank lines before declarations\n" . $hereprev);
4488## }
4489##
4490
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004491# closing brace should have a space following it when it has anything
4492# on the line
4493 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004494 if (ERROR("SPACING",
4495 "space required after that close brace '}'\n" . $herecurr) &&
4496 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004497 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004498 s/}((?!(?:,|;|\)))\S)/} $1/;
4499 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004500 }
4501
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004502# check spacing on square brackets
4503 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004504 if (ERROR("SPACING",
4505 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4506 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004507 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004508 s/\[\s+/\[/;
4509 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004510 }
4511 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004512 if (ERROR("SPACING",
4513 "space prohibited before that close square bracket ']'\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 }
4519
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004520# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004521 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4522 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004523 if (ERROR("SPACING",
4524 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4525 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004526 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004527 s/\(\s+/\(/;
4528 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004529 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004530 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004531 $line !~ /for\s*\(.*;\s+\)/ &&
4532 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004533 if (ERROR("SPACING",
4534 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4535 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004536 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004537 s/\s+\)/\)/;
4538 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004539 }
4540
Joe Perchese2826fd2014-08-06 16:10:48 -07004541# check unnecessary parentheses around addressof/dereference single $Lvals
4542# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4543
4544 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004545 my $var = $1;
4546 if (CHK("UNNECESSARY_PARENTHESES",
4547 "Unnecessary parentheses around $var\n" . $herecurr) &&
4548 $fix) {
4549 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4550 }
4551 }
4552
4553# check for unnecessary parentheses around function pointer uses
4554# ie: (foo->bar)(); should be foo->bar();
4555# but not "if (foo->bar) (" to avoid some false positives
4556 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4557 my $var = $2;
4558 if (CHK("UNNECESSARY_PARENTHESES",
4559 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4560 $fix) {
4561 my $var2 = deparenthesize($var);
4562 $var2 =~ s/\s//g;
4563 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4564 }
4565 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004566
Joe Perches63b7c732017-09-08 16:16:01 -07004567# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004568# when !drivers/staging or command-line uses --strict
4569 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4570 $^V && $^V ge 5.10.0 && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004571 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4572 my $if_stat = $1;
4573 my $test = substr($2, 1, -1);
4574 my $herectx;
4575 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4576 my $match = $1;
4577 # avoid parentheses around potential macro args
4578 next if ($match =~ /^\s*\w+\s*$/);
4579 if (!defined($herectx)) {
4580 $herectx = $here . "\n";
4581 my $cnt = statement_rawlines($if_stat);
4582 for (my $n = 0; $n < $cnt; $n++) {
4583 my $rl = raw_line($linenr, $n);
4584 $herectx .= $rl . "\n";
4585 last if $rl =~ /^[ \+].*\{/;
4586 }
4587 }
4588 CHK("UNNECESSARY_PARENTHESES",
4589 "Unnecessary parentheses around '$match'\n" . $herectx);
4590 }
4591 }
4592
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004593#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004594 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004595 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004596 if (WARN("INDENTED_LABEL",
4597 "labels should not be indented\n" . $herecurr) &&
4598 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004599 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004600 s/^(.)\s+/$1/;
4601 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004602 }
4603
Joe Perches5b9553a2014-04-03 14:49:21 -07004604# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004605 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004606 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004607 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004608 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4609 my $value = $1;
4610 $value = deparenthesize($value);
4611 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4612 ERROR("RETURN_PARENTHESES",
4613 "return is not a function, parentheses are not required\n" . $herecurr);
4614 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004615 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004616 ERROR("SPACING",
4617 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004618 }
4619 }
Joe Perches507e5142013-11-12 15:10:13 -08004620
Joe Perchesb43ae212014-06-23 13:22:07 -07004621# unnecessary return in a void function
4622# at end-of-function, with the previous line a single leading tab, then return;
4623# and the line before that not a goto label target like "out:"
4624 if ($sline =~ /^[ \+]}\s*$/ &&
4625 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4626 $linenr >= 3 &&
4627 $lines[$linenr - 3] =~ /^[ +]/ &&
4628 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004629 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004630 "void function return statements are not generally useful\n" . $hereprev);
4631 }
Joe Perches9819cf22014-06-04 16:12:09 -07004632
Joe Perches189248d2014-01-23 15:54:47 -08004633# if statements using unnecessary parentheses - ie: if ((foo == bar))
4634 if ($^V && $^V ge 5.10.0 &&
4635 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4636 my $openparens = $1;
4637 my $count = $openparens =~ tr@\(@\(@;
4638 my $msg = "";
4639 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4640 my $comp = $4; #Not $1 because of $LvalOrFunc
4641 $msg = " - maybe == should be = ?" if ($comp eq "==");
4642 WARN("UNNECESSARY_PARENTHESES",
4643 "Unnecessary parentheses$msg\n" . $herecurr);
4644 }
4645 }
4646
Joe Perchesc5595fa2015-09-09 15:37:58 -07004647# comparisons with a constant or upper case identifier on the left
4648# avoid cases like "foo + BAR < baz"
4649# only fix matches surrounded by parentheses to avoid incorrect
4650# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4651 if ($^V && $^V ge 5.10.0 &&
4652 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4653 my $lead = $1;
4654 my $const = $2;
4655 my $comp = $3;
4656 my $to = $4;
4657 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004658 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004659 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4660 WARN("CONSTANT_COMPARISON",
4661 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4662 $fix) {
4663 if ($comp eq "<") {
4664 $newcomp = ">";
4665 } elsif ($comp eq "<=") {
4666 $newcomp = ">=";
4667 } elsif ($comp eq ">") {
4668 $newcomp = "<";
4669 } elsif ($comp eq ">=") {
4670 $newcomp = "<=";
4671 }
4672 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4673 }
4674 }
4675
Joe Perchesf34e4a42015-04-16 12:44:19 -07004676# Return of what appears to be an errno should normally be negative
4677 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004678 my $name = $1;
4679 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004680 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004681 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004682 }
4683 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004684
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004685# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004686 if ($line =~ /\b(if|while|for|switch)\(/) {
4687 if (ERROR("SPACING",
4688 "space required before the open parenthesis '('\n" . $herecurr) &&
4689 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004690 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004691 s/\b(if|while|for|switch)\(/$1 \(/;
4692 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004693 }
4694
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004695# Check for illegal assignment in if conditional -- and check for trailing
4696# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004697 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004698 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4699 ctx_statement_block($linenr, $realcnt, 0)
4700 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004701 my ($stat_next) = ctx_statement_block($line_nr_next,
4702 $remain_next, $off_next);
4703 $stat_next =~ s/\n./\n /g;
4704 ##print "stat<$stat> stat_next<$stat_next>\n";
4705
4706 if ($stat_next =~ /^\s*while\b/) {
4707 # If the statement carries leading newlines,
4708 # then count those as offsets.
4709 my ($whitespace) =
4710 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4711 my $offset =
4712 statement_rawlines($whitespace) - 1;
4713
4714 $suppress_whiletrailers{$line_nr_next +
4715 $offset} = 1;
4716 }
4717 }
4718 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004719 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004720 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004721 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004722
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004723 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004724 ERROR("ASSIGN_IN_IF",
4725 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004726 }
4727
4728 # Find out what is on the end of the line after the
4729 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004730 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004731 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004732 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004733 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4734 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004735 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004736 # Find out how long the conditional actually is.
4737 my @newlines = ($c =~ /\n/gs);
4738 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004739 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004740
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004741 $stat_real = raw_line($linenr, $cond_lines)
4742 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004743 if (defined($stat_real) && $cond_lines > 1) {
4744 $stat_real = "[...]\n$stat_real";
4745 }
4746
Joe Perches000d1cc12011-07-25 17:13:25 -07004747 ERROR("TRAILING_STATEMENTS",
4748 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004749 }
4750 }
4751
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004752# Check for bitwise tests written as boolean
4753 if ($line =~ /
4754 (?:
4755 (?:\[|\(|\&\&|\|\|)
4756 \s*0[xX][0-9]+\s*
4757 (?:\&\&|\|\|)
4758 |
4759 (?:\&\&|\|\|)
4760 \s*0[xX][0-9]+\s*
4761 (?:\&\&|\|\||\)|\])
4762 )/x)
4763 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004764 WARN("HEXADECIMAL_BOOLEAN_TEST",
4765 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004766 }
4767
Andy Whitcroft8905a672007-11-28 16:21:06 -08004768# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004769 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4770 my $s = $1;
4771 $s =~ s/$;//g; # Remove any comments
4772 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004773 ERROR("TRAILING_STATEMENTS",
4774 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004775 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004776 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004777# if should not continue a brace
4778 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004779 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004780 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004781 $herecurr);
4782 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004783# case and default should not have general statements after them
4784 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4785 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004786 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004787 \s*return\s+
4788 )/xg)
4789 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004790 ERROR("TRAILING_STATEMENTS",
4791 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004792 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004793
4794 # Check for }<nl>else {, these must be at the same
4795 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004796 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4797 $previndent == $indent) {
4798 if (ERROR("ELSE_AFTER_BRACE",
4799 "else should follow close brace '}'\n" . $hereprev) &&
4800 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4801 fix_delete_line($fixlinenr - 1, $prevrawline);
4802 fix_delete_line($fixlinenr, $rawline);
4803 my $fixedline = $prevrawline;
4804 $fixedline =~ s/}\s*$//;
4805 if ($fixedline !~ /^\+\s*$/) {
4806 fix_insert_line($fixlinenr, $fixedline);
4807 }
4808 $fixedline = $rawline;
4809 $fixedline =~ s/^(.\s*)else/$1} else/;
4810 fix_insert_line($fixlinenr, $fixedline);
4811 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004812 }
4813
Joe Perches8b8856f2014-08-06 16:11:14 -07004814 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4815 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004816 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4817
4818 # Find out what is on the end of the line after the
4819 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004820 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004821 $s =~ s/\n.*//g;
4822
4823 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004824 if (ERROR("WHILE_AFTER_BRACE",
4825 "while should follow close brace '}'\n" . $hereprev) &&
4826 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4827 fix_delete_line($fixlinenr - 1, $prevrawline);
4828 fix_delete_line($fixlinenr, $rawline);
4829 my $fixedline = $prevrawline;
4830 my $trailing = $rawline;
4831 $trailing =~ s/^\+//;
4832 $trailing = trim($trailing);
4833 $fixedline =~ s/}\s*$/} $trailing/;
4834 fix_insert_line($fixlinenr, $fixedline);
4835 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004836 }
4837 }
4838
Joe Perches95e2c602013-07-03 15:05:20 -07004839#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004840 while ($line =~ m{($Constant|$Lval)}g) {
4841 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004842
4843#gcc binary extension
4844 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004845 if (WARN("GCC_BINARY_CONSTANT",
4846 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4847 $fix) {
4848 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004849 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004850 s/\b$var\b/$hexval/;
4851 }
Joe Perches95e2c602013-07-03 15:05:20 -07004852 }
4853
4854#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004855 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004856 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004857#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004858 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004859#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004860 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4861#Ignore some three character SI units explicitly, like MiB and KHz
4862 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004863 while ($var =~ m{($Ident)}g) {
4864 my $word = $1;
4865 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004866 if ($check) {
4867 seed_camelcase_includes();
4868 if (!$file && !$camelcase_file_seeded) {
4869 seed_camelcase_file($realfile);
4870 $camelcase_file_seeded = 1;
4871 }
4872 }
Joe Perches7e781f62013-09-11 14:23:55 -07004873 if (!defined $camelcase{$word}) {
4874 $camelcase{$word} = 1;
4875 CHK("CAMELCASE",
4876 "Avoid CamelCase: <$word>\n" . $herecurr);
4877 }
Joe Perches34456862013-07-03 15:05:34 -07004878 }
Joe Perches323c1262012-12-17 16:02:07 -08004879 }
4880 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004881
4882#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004883 if ($line =~ /\#\s*define.*\\\s+$/) {
4884 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4885 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4886 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004887 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004888 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004889 }
4890
Fabian Frederick0e212e02015-04-16 12:44:25 -07004891# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4892# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004893 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004894 my $file = "$1.h";
4895 my $checkfile = "include/linux/$file";
4896 if (-f "$root/$checkfile" &&
4897 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004898 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004899 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004900 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4901 if ($asminclude > 0) {
4902 if ($realfile =~ m{^arch/}) {
4903 CHK("ARCH_INCLUDE_LINUX",
4904 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4905 } else {
4906 WARN("INCLUDE_LINUX",
4907 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4908 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004909 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004910 }
4911 }
4912
Andy Whitcroft653d4872007-06-23 17:16:34 -07004913# multi-statement macros should be enclosed in a do while loop, grab the
4914# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004915# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004916 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4917 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004918 my $ln = $linenr;
4919 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004920 my ($off, $dstat, $dcond, $rest);
4921 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004922 my $has_flow_statement = 0;
4923 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004924 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004925 ctx_statement_block($linenr, $realcnt, 0);
4926 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004927 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004928 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004929
Joe Perches08a28432014-10-13 15:51:55 -07004930 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004931 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004932
Joe Perchesf59b64b2016-10-11 13:52:08 -07004933 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4934 my $define_args = $1;
4935 my $define_stmt = $dstat;
4936 my @def_args = ();
4937
4938 if (defined $define_args && $define_args ne "") {
4939 $define_args = substr($define_args, 1, length($define_args) - 2);
4940 $define_args =~ s/\s*//g;
4941 @def_args = split(",", $define_args);
4942 }
4943
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004944 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004945 $dstat =~ s/\\\n.//g;
4946 $dstat =~ s/^\s*//s;
4947 $dstat =~ s/\s*$//s;
4948
4949 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004950 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4951 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004952 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004953 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004954 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004955
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004956 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004957 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4958 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004959 {
4960 }
4961
Joe Perches42e15292016-03-15 14:58:01 -07004962 # Make asm volatile uses seem like a generic function
4963 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4964
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004965 my $exceptions = qr{
4966 $Declare|
4967 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004968 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004969 DECLARE_PER_CPU|
4970 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004971 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004972 union|
4973 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004974 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004975 ^\"|\"$|
4976 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004977 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004978 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004979
4980 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004981 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07004982 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07004983
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004984 if ($dstat ne '' &&
4985 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4986 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004987 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004988 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004989 $dstat !~ /$exceptions/ &&
4990 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004991 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004992 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004993 $dstat !~ /^for\s*$Constant$/ && # for (...)
4994 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4995 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004996 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004997 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004998 {
Joe Perchese7955562017-05-08 15:55:48 -07004999 if ($dstat =~ /^\s*if\b/) {
5000 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5001 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5002 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005003 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5004 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5005 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005006 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005007 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005008 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005009
5010 }
Joe Perches52076492016-10-11 13:52:14 -07005011
5012 # Make $define_stmt single line, comment-free, etc
5013 my @stmt_array = split('\n', $define_stmt);
5014 my $first = 1;
5015 $define_stmt = "";
5016 foreach my $l (@stmt_array) {
5017 $l =~ s/\\$//;
5018 if ($first) {
5019 $define_stmt = $l;
5020 $first = 0;
5021 } elsif ($l =~ /^[\+ ]/) {
5022 $define_stmt .= substr($l, 1);
5023 }
5024 }
5025 $define_stmt =~ s/$;//g;
5026 $define_stmt =~ s/\s+/ /g;
5027 $define_stmt = trim($define_stmt);
5028
Joe Perchesf59b64b2016-10-11 13:52:08 -07005029# check if any macro arguments are reused (ignore '...' and 'type')
5030 foreach my $arg (@def_args) {
5031 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005032 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005033 my $tmp_stmt = $define_stmt;
5034 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5035 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5036 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5037 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005038 if ($use_cnt > 1) {
5039 CHK("MACRO_ARG_REUSE",
5040 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005041 }
5042# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005043 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005044 ((defined($1) && $1 ne ',') ||
5045 (defined($2) && $2 ne ','))) {
5046 CHK("MACRO_ARG_PRECEDENCE",
5047 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005048 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005049 }
Joe Perches5023d342012-12-17 16:01:47 -08005050
Joe Perches08a28432014-10-13 15:51:55 -07005051# check for macros with flow control, but without ## concatenation
5052# ## concatenation is commonly a macro that defines a function so ignore those
5053 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005054 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005055 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005056
Joe Perches08a28432014-10-13 15:51:55 -07005057 WARN("MACRO_WITH_FLOW_CONTROL",
5058 "Macros with flow control statements should be avoided\n" . "$herectx");
5059 }
5060
Joe Perches481eb482012-12-17 16:01:56 -08005061# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005062
5063 } else {
5064 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005065 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5066 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005067 $line =~ /^\+.*\\$/) {
5068 WARN("LINE_CONTINUATIONS",
5069 "Avoid unnecessary line continuations\n" . $herecurr);
5070 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005071 }
5072
Joe Perchesb13edf72012-07-30 14:41:24 -07005073# do {} while (0) macro tests:
5074# single-statement macros do not need to be enclosed in do while (0) loop,
5075# macro should not end with a semicolon
5076 if ($^V && $^V ge 5.10.0 &&
5077 $realfile !~ m@/vmlinux.lds.h$@ &&
5078 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5079 my $ln = $linenr;
5080 my $cnt = $realcnt;
5081 my ($off, $dstat, $dcond, $rest);
5082 my $ctx = '';
5083 ($dstat, $dcond, $ln, $cnt, $off) =
5084 ctx_statement_block($linenr, $realcnt, 0);
5085 $ctx = $dstat;
5086
5087 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005088 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005089
5090 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5091 my $stmts = $2;
5092 my $semis = $3;
5093
5094 $ctx =~ s/\n*$//;
5095 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005096 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005097
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);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005110 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005111
5112 WARN("TRAILING_SEMICOLON",
5113 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005114 }
5115 }
5116
Mike Frysinger080ba922009-01-06 14:41:25 -08005117# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5118# all assignments may have only one of the following with an assignment:
5119# .
5120# ALIGN(...)
5121# VMLINUX_SYMBOL(...)
5122 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005123 WARN("MISSING_VMLINUX_SYMBOL",
5124 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005125 }
5126
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005127# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005128 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5129 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005130 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005131 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005132 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5133 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005134 my @allowed = ();
5135 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005136 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005137 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005138 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005139 for my $chunk (@chunks) {
5140 my ($cond, $block) = @{$chunk};
5141
Andy Whitcroft773647a2008-03-28 14:15:58 -07005142 # If the condition carries leading newlines, then count those as offsets.
5143 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5144 my $offset = statement_rawlines($whitespace) - 1;
5145
Joe Perchesaad4f612012-03-23 15:02:19 -07005146 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005147 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5148
5149 # We have looked at and allowed this specific line.
5150 $suppress_ifbraces{$ln + $offset} = 1;
5151
5152 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005153 $ln += statement_rawlines($block) - 1;
5154
Andy Whitcroft773647a2008-03-28 14:15:58 -07005155 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005156
5157 $seen++ if ($block =~ /^\s*{/);
5158
Joe Perchesaad4f612012-03-23 15:02:19 -07005159 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005160 if (statement_lines($cond) > 1) {
5161 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005162 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005163 }
5164 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005165 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005166 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005167 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005168 if (statement_block_size($block) > 1) {
5169 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005170 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005171 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005172 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005173 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005174 if ($seen) {
5175 my $sum_allowed = 0;
5176 foreach (@allowed) {
5177 $sum_allowed += $_;
5178 }
5179 if ($sum_allowed == 0) {
5180 WARN("BRACES",
5181 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5182 } elsif ($sum_allowed != $allow &&
5183 $seen != $allow) {
5184 CHK("BRACES",
5185 "braces {} should be used on all arms of this statement\n" . $herectx);
5186 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005187 }
5188 }
5189 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005190 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005191 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005192 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005193
Andy Whitcroftcf655042008-03-04 14:28:20 -08005194 # Check the pre-context.
5195 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5196 #print "APW: ALLOWED: pre<$1>\n";
5197 $allowed = 1;
5198 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005199
5200 my ($level, $endln, @chunks) =
5201 ctx_statement_full($linenr, $realcnt, $-[0]);
5202
Andy Whitcroftcf655042008-03-04 14:28:20 -08005203 # Check the condition.
5204 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005205 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005206 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005207 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005208 }
5209 if (statement_lines($cond) > 1) {
5210 #print "APW: ALLOWED: cond<$cond>\n";
5211 $allowed = 1;
5212 }
5213 if ($block =~/\b(?:if|for|while)\b/) {
5214 #print "APW: ALLOWED: block<$block>\n";
5215 $allowed = 1;
5216 }
5217 if (statement_block_size($block) > 1) {
5218 #print "APW: ALLOWED: lines block<$block>\n";
5219 $allowed = 1;
5220 }
5221 # Check the post-context.
5222 if (defined $chunks[1]) {
5223 my ($cond, $block) = @{$chunks[1]};
5224 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005225 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005226 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005227 if ($block =~ /^\s*\{/) {
5228 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5229 $allowed = 1;
5230 }
5231 }
5232 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005233 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005234 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005235
Joe Perches000d1cc12011-07-25 17:13:25 -07005236 WARN("BRACES",
5237 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005238 }
5239 }
5240
Joe Perchese4c5bab2017-02-24 15:01:41 -08005241# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005242 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5243 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005244 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5245 }
5246
Joe Perches0979ae62012-12-17 16:01:59 -08005247# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005248 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005249 if (CHK("BRACES",
5250 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5251 $fix && $prevrawline =~ /^\+/) {
5252 fix_delete_line($fixlinenr - 1, $prevrawline);
5253 }
Joe Perches0979ae62012-12-17 16:01:59 -08005254 }
Joe Perches77b9a532013-07-03 15:05:29 -07005255 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005256 if (CHK("BRACES",
5257 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5258 $fix) {
5259 fix_delete_line($fixlinenr, $rawline);
5260 }
Joe Perches0979ae62012-12-17 16:01:59 -08005261 }
5262
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005263# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005264 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5265 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005266 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005267 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005268 }
5269
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005270# Check for user-visible strings broken across lines, which breaks the ability
5271# to grep for the string. Make exceptions when the previous string ends in a
5272# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5273# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005274 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005275 $prevline =~ /"\s*$/ &&
5276 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5277 if (WARN("SPLIT_STRING",
5278 "quoted string split across lines\n" . $hereprev) &&
5279 $fix &&
5280 $prevrawline =~ /^\+.*"\s*$/ &&
5281 $last_coalesced_string_linenr != $linenr - 1) {
5282 my $extracted_string = get_quoted_string($line, $rawline);
5283 my $comma_close = "";
5284 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5285 $comma_close = $1;
5286 }
5287
5288 fix_delete_line($fixlinenr - 1, $prevrawline);
5289 fix_delete_line($fixlinenr, $rawline);
5290 my $fixedline = $prevrawline;
5291 $fixedline =~ s/"\s*$//;
5292 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5293 fix_insert_line($fixlinenr - 1, $fixedline);
5294 $fixedline = $rawline;
5295 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5296 if ($fixedline !~ /\+\s*$/) {
5297 fix_insert_line($fixlinenr, $fixedline);
5298 }
5299 $last_coalesced_string_linenr = $linenr;
5300 }
5301 }
5302
5303# check for missing a space in a string concatenation
5304 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5305 WARN('MISSING_SPACE',
5306 "break quoted strings at a space character\n" . $hereprev);
5307 }
5308
Joe Perchese4b7d302017-05-08 15:55:51 -07005309# check for an embedded function name in a string when the function is known
5310# This does not work very well for -f --file checking as it depends on patch
5311# context providing the function name or a single line form for in-file
5312# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005313 if ($line =~ /^\+.*$String/ &&
5314 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005315 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5316 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005317 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005318 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005319 }
5320
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005321# check for spaces before a quoted newline
5322 if ($rawline =~ /^.*\".*\s\\n/) {
5323 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5324 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5325 $fix) {
5326 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5327 }
5328
5329 }
5330
Joe Perchesf17dba42014-10-13 15:51:51 -07005331# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005332 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005333 CHK("CONCATENATED_STRING",
5334 "Concatenated strings should use spaces between elements\n" . $herecurr);
5335 }
5336
Joe Perches90ad30e2014-12-10 15:51:59 -08005337# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005338 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005339 WARN("STRING_FRAGMENTS",
5340 "Consecutive strings are generally better as a single string\n" . $herecurr);
5341 }
5342
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005343# check for non-standard and hex prefixed decimal printf formats
5344 my $show_L = 1; #don't show the same defect twice
5345 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005346 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005347 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005348 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005349 # check for %L
5350 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005351 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005352 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5353 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005354 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005355 # check for %Z
5356 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5357 WARN("PRINTF_Z",
5358 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5359 $show_Z = 0;
5360 }
5361 # check for 0x<decimal>
5362 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5363 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005364 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5365 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005366 }
5367
5368# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005369 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005370 WARN("LINE_CONTINUATIONS",
5371 "Avoid line continuations in quoted strings\n" . $herecurr);
5372 }
5373
Andy Whitcroft00df3442007-06-08 13:47:06 -07005374# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005375 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005376 CHK("REDUNDANT_CODE",
5377 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005378 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005379 }
5380
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005381# check for needless "if (<foo>) fn(<foo>)" uses
5382 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005383 my $tested = quotemeta($1);
5384 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5385 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5386 my $func = $1;
5387 if (WARN('NEEDLESS_IF',
5388 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5389 $fix) {
5390 my $do_fix = 1;
5391 my $leading_tabs = "";
5392 my $new_leading_tabs = "";
5393 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5394 $leading_tabs = $1;
5395 } else {
5396 $do_fix = 0;
5397 }
5398 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5399 $new_leading_tabs = $1;
5400 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5401 $do_fix = 0;
5402 }
5403 } else {
5404 $do_fix = 0;
5405 }
5406 if ($do_fix) {
5407 fix_delete_line($fixlinenr - 1, $prevrawline);
5408 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5409 }
5410 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005411 }
5412 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005413
Joe Perchesebfdc402014-08-06 16:10:27 -07005414# check for unnecessary "Out of Memory" messages
5415 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5416 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5417 (defined $1 || defined $3) &&
5418 $linenr > 3) {
5419 my $testval = $2;
5420 my $testline = $lines[$linenr - 3];
5421
5422 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5423# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5424
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005425 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 -07005426 WARN("OOM_MESSAGE",
5427 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5428 }
5429 }
5430
Joe Perchesf78d98f2014-10-13 15:52:01 -07005431# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005432 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005433 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5434 my $level = $1;
5435 if (WARN("UNNECESSARY_KERN_LEVEL",
5436 "Possible unnecessary $level\n" . $herecurr) &&
5437 $fix) {
5438 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5439 }
5440 }
5441
Joe Perches45c55e92017-02-24 15:01:31 -08005442# check for logging continuations
5443 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5444 WARN("LOGGING_CONTINUATION",
5445 "Avoid logging continuation uses where feasible\n" . $herecurr);
5446 }
5447
Joe Perchesabb08a52014-12-10 15:51:46 -08005448# check for mask then right shift without a parentheses
5449 if ($^V && $^V ge 5.10.0 &&
5450 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5451 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5452 WARN("MASK_THEN_SHIFT",
5453 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5454 }
5455
Joe Perchesb75ac612014-12-10 15:52:02 -08005456# check for pointer comparisons to NULL
5457 if ($^V && $^V ge 5.10.0) {
5458 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5459 my $val = $1;
5460 my $equal = "!";
5461 $equal = "" if ($4 eq "!=");
5462 if (CHK("COMPARISON_TO_NULL",
5463 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5464 $fix) {
5465 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5466 }
5467 }
5468 }
5469
Joe Perches8716de32013-09-11 14:24:05 -07005470# check for bad placement of section $InitAttribute (e.g.: __initdata)
5471 if ($line =~ /(\b$InitAttribute\b)/) {
5472 my $attr = $1;
5473 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5474 my $ptr = $1;
5475 my $var = $2;
5476 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5477 ERROR("MISPLACED_INIT",
5478 "$attr should be placed after $var\n" . $herecurr)) ||
5479 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5480 WARN("MISPLACED_INIT",
5481 "$attr should be placed after $var\n" . $herecurr))) &&
5482 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005483 $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 -07005484 }
5485 }
5486 }
5487
Joe Perchese970b8842013-11-12 15:10:10 -08005488# check for $InitAttributeData (ie: __initdata) with const
5489 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5490 my $attr = $1;
5491 $attr =~ /($InitAttributePrefix)(.*)/;
5492 my $attr_prefix = $1;
5493 my $attr_type = $2;
5494 if (ERROR("INIT_ATTRIBUTE",
5495 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5496 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005497 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005498 s/$InitAttributeData/${attr_prefix}initconst/;
5499 }
5500 }
5501
5502# check for $InitAttributeConst (ie: __initconst) without const
5503 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5504 my $attr = $1;
5505 if (ERROR("INIT_ATTRIBUTE",
5506 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5507 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005508 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005509 /(^\+\s*(?:static\s+))/;
5510 $lead = rtrim($1);
5511 $lead = "$lead " if ($lead !~ /^\+$/);
5512 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005513 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005514 }
5515 }
5516
Joe Perchesc17893c2015-04-16 12:44:42 -07005517# check for __read_mostly with const non-pointer (should just be const)
5518 if ($line =~ /\b__read_mostly\b/ &&
5519 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5520 if (ERROR("CONST_READ_MOSTLY",
5521 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5522 $fix) {
5523 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5524 }
5525 }
5526
Joe Perchesfbdb8132014-04-03 14:49:14 -07005527# don't use __constant_<foo> functions outside of include/uapi/
5528 if ($realfile !~ m@^include/uapi/@ &&
5529 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5530 my $constant_func = $1;
5531 my $func = $constant_func;
5532 $func =~ s/^__constant_//;
5533 if (WARN("CONSTANT_CONVERSION",
5534 "$constant_func should be $func\n" . $herecurr) &&
5535 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005536 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005537 }
5538 }
5539
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005540# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005541 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005542 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005543 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005544 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005545 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005546 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5547 }
5548 if ($delay > 2000) {
5549 WARN("LONG_UDELAY",
5550 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005551 }
5552 }
5553
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005554# warn about unexpectedly long msleep's
5555 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5556 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005557 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005558 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005559 }
5560 }
5561
Joe Perches36ec1932013-07-03 15:05:25 -07005562# check for comparisons of jiffies
5563 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5564 WARN("JIFFIES_COMPARISON",
5565 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5566 }
5567
Joe Perches9d7a34a2013-07-03 15:05:26 -07005568# check for comparisons of get_jiffies_64()
5569 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5570 WARN("JIFFIES_COMPARISON",
5571 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5572 }
5573
Andy Whitcroft00df3442007-06-08 13:47:06 -07005574# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005575# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005576# print "#ifdef in C files should be avoided\n";
5577# print "$herecurr";
5578# $clean = 0;
5579# }
5580
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005581# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005582 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005583 if (ERROR("SPACING",
5584 "exactly one space required after that #$1\n" . $herecurr) &&
5585 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005586 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005587 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5588 }
5589
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005590 }
5591
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005592# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005593 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5594 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005595 my $which = $1;
5596 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005597 CHK("UNCOMMENTED_DEFINITION",
5598 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005599 }
5600 }
5601# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005602
5603 my $barriers = qr{
5604 mb|
5605 rmb|
5606 wmb|
5607 read_barrier_depends
5608 }x;
5609 my $barrier_stems = qr{
5610 mb__before_atomic|
5611 mb__after_atomic|
5612 store_release|
5613 load_acquire|
5614 store_mb|
5615 (?:$barriers)
5616 }x;
5617 my $all_barriers = qr{
5618 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005619 smp_(?:$barrier_stems)|
5620 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005621 }x;
5622
5623 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005624 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005625 WARN("MEMORY_BARRIER",
5626 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005627 }
5628 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005629
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005630 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5631
5632 if ($realfile !~ m@^include/asm-generic/@ &&
5633 $realfile !~ m@/barrier\.h$@ &&
5634 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5635 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5636 WARN("MEMORY_BARRIER",
5637 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5638 }
5639
Joe Perchescb426e92015-06-25 15:02:46 -07005640# check for waitqueue_active without a comment.
5641 if ($line =~ /\bwaitqueue_active\s*\(/) {
5642 if (!ctx_has_comment($first_line, $linenr)) {
5643 WARN("WAITQUEUE_ACTIVE",
5644 "waitqueue_active without comment\n" . $herecurr);
5645 }
5646 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005647
Paul E. McKenney91db2592017-11-27 09:37:35 -08005648# check for smp_read_barrier_depends and read_barrier_depends
5649 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5650 WARN("READ_BARRIER_DEPENDS",
5651 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5652 }
5653
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005654# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005655 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005656 CHK("ARCH_DEFINES",
5657 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005658 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005659
Joe Perches596ed452017-07-12 14:37:02 -07005660# check that the storage class is not after a type
5661 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005662 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005663 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5664 }
5665# Check that the storage class is at the beginning of a declaration
5666 if ($line =~ /\b$Storage\b/ &&
5667 $line !~ /^.\s*$Storage/ &&
5668 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5669 $1 !~ /[\,\)]\s*$/) {
5670 WARN("STORAGE_CLASS",
5671 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005672 }
5673
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005674# check the location of the inline attribute, that it is between
5675# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005676 if ($line =~ /\b$Type\s+$Inline\b/ ||
5677 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005678 ERROR("INLINE_LOCATION",
5679 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005680 }
5681
Andy Whitcroft8905a672007-11-28 16:21:06 -08005682# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005683 if ($realfile !~ m@\binclude/uapi/@ &&
5684 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005685 if (WARN("INLINE",
5686 "plain inline is preferred over $1\n" . $herecurr) &&
5687 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005688 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005689
5690 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005691 }
5692
Joe Perches3d130fd2011-01-12 17:00:00 -08005693# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005694 if ($realfile !~ m@\binclude/uapi/@ &&
5695 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005696 WARN("PREFER_PACKED",
5697 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005698 }
5699
Joe Perches39b7e282011-07-25 17:13:24 -07005700# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005701 if ($realfile !~ m@\binclude/uapi/@ &&
5702 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005703 WARN("PREFER_ALIGNED",
5704 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005705 }
5706
Joe Perches5f14d3b2012-01-10 15:09:52 -08005707# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005708 if ($realfile !~ m@\binclude/uapi/@ &&
5709 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005710 if (WARN("PREFER_PRINTF",
5711 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5712 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005713 $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 -07005714
5715 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005716 }
5717
Joe Perches6061d942012-03-23 15:02:16 -07005718# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005719 if ($realfile !~ m@\binclude/uapi/@ &&
5720 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005721 if (WARN("PREFER_SCANF",
5722 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5723 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005724 $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 -07005725 }
Joe Perches6061d942012-03-23 15:02:16 -07005726 }
5727
Joe Perches619a9082014-12-10 15:51:35 -08005728# Check for __attribute__ weak, or __weak declarations (may have link issues)
5729 if ($^V && $^V ge 5.10.0 &&
5730 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5731 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5732 $line =~ /\b__weak\b/)) {
5733 ERROR("WEAK_DECLARATION",
5734 "Using weak declarations can have unintended link defects\n" . $herecurr);
5735 }
5736
Tomas Winklerfd39f902016-12-12 16:46:34 -08005737# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005738 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005739 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005740 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5741 my $type = $1;
5742 if ($type =~ /\b($typeC99Typedefs)\b/) {
5743 $type = $1;
5744 my $kernel_type = 'u';
5745 $kernel_type = 's' if ($type =~ /^_*[si]/);
5746 $type =~ /(\d+)/;
5747 $kernel_type .= $1;
5748 if (CHK("PREFER_KERNEL_TYPES",
5749 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5750 $fix) {
5751 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5752 }
5753 }
5754 }
5755
Joe Perches938224b2016-01-20 14:59:15 -08005756# check for cast of C90 native int or longer types constants
5757 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5758 my $cast = $1;
5759 my $const = $2;
5760 if (WARN("TYPECAST_INT_CONSTANT",
5761 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5762 $fix) {
5763 my $suffix = "";
5764 my $newconst = $const;
5765 $newconst =~ s/${Int_type}$//;
5766 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5767 if ($cast =~ /\blong\s+long\b/) {
5768 $suffix .= 'LL';
5769 } elsif ($cast =~ /\blong\b/) {
5770 $suffix .= 'L';
5771 }
5772 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5773 }
5774 }
5775
Joe Perches8f53a9b2010-03-05 13:43:48 -08005776# check for sizeof(&)
5777 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005778 WARN("SIZEOF_ADDRESS",
5779 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005780 }
5781
Joe Perches66c80b62012-07-30 14:41:22 -07005782# check for sizeof without parenthesis
5783 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005784 if (WARN("SIZEOF_PARENTHESIS",
5785 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5786 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005787 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005788 }
Joe Perches66c80b62012-07-30 14:41:22 -07005789 }
5790
Joe Perches88982fe2012-12-17 16:02:00 -08005791# check for struct spinlock declarations
5792 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5793 WARN("USE_SPINLOCK_T",
5794 "struct spinlock should be spinlock_t\n" . $herecurr);
5795 }
5796
Joe Perchesa6962d72013-04-29 16:18:13 -07005797# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005798 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005799 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005800 $fmt =~ s/%%//g;
5801 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005802 if (WARN("PREFER_SEQ_PUTS",
5803 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5804 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005805 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005806 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005807 }
5808 }
5809
Joe Perches0b523762017-05-08 15:55:36 -07005810 # check for vsprintf extension %p<foo> misuses
5811 if ($^V && $^V ge 5.10.0 &&
5812 defined $stat &&
5813 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5814 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07005815 my $specifier;
5816 my $extension;
5817 my $bad_specifier = "";
5818 my $stat_real;
5819
Joe Perches0b523762017-05-08 15:55:36 -07005820 my $lc = $stat =~ tr@\n@@;
5821 $lc = $lc + $linenr;
5822 for (my $count = $linenr; $count <= $lc; $count++) {
5823 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5824 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005825
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07005826 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
5827 $specifier = $1;
5828 $extension = $2;
5829 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) {
5830 $bad_specifier = $specifier;
5831 last;
5832 }
5833 if ($extension eq "x" && !defined($stat_real)) {
5834 if (!defined($stat_real)) {
5835 $stat_real = get_stat_real($linenr, $lc);
5836 }
5837 WARN("VSPRINTF_SPECIFIER_PX",
5838 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
5839 }
5840 }
5841 if ($bad_specifier ne "") {
5842 my $stat_real = get_stat_real($linenr, $lc);
5843 my $ext_type = "Invalid";
5844 my $use = "";
5845 if ($bad_specifier =~ /p[Ff]/) {
5846 $ext_type = "Deprecated";
5847 $use = " - use %pS instead";
5848 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
5849 }
5850
5851 WARN("VSPRINTF_POINTER_EXTENSION",
5852 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
5853 }
Joe Perches0b523762017-05-08 15:55:36 -07005854 }
5855 }
5856
Andy Whitcroft554e1652012-01-10 15:09:57 -08005857# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005858 if ($^V && $^V ge 5.10.0 &&
5859 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005860 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005861
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005862 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005863 my $ms_val = $7;
5864 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005865
Andy Whitcroft554e1652012-01-10 15:09:57 -08005866 if ($ms_size =~ /^(0x|)0$/i) {
5867 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005868 "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 -08005869 } elsif ($ms_size =~ /^(0x|)1$/i) {
5870 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005871 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5872 }
5873 }
5874
Joe Perches98a9bba2014-01-23 15:54:52 -08005875# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005876# if ($^V && $^V ge 5.10.0 &&
5877# defined $stat &&
5878# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5879# if (WARN("PREFER_ETHER_ADDR_COPY",
5880# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5881# $fix) {
5882# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5883# }
5884# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005885
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005886# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005887# if ($^V && $^V ge 5.10.0 &&
5888# defined $stat &&
5889# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5890# WARN("PREFER_ETHER_ADDR_EQUAL",
5891# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5892# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005893
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005894# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5895# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf3331952016-10-11 13:51:53 -07005896# if ($^V && $^V ge 5.10.0 &&
5897# defined $stat &&
5898# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5899#
5900# my $ms_val = $7;
5901#
5902# if ($ms_val =~ /^(?:0x|)0+$/i) {
5903# if (WARN("PREFER_ETH_ZERO_ADDR",
5904# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5905# $fix) {
5906# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5907# }
5908# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5909# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5910# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5911# $fix) {
5912# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5913# }
5914# }
5915# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005916
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005917# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005918 if ($^V && $^V ge 5.10.0 &&
5919 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005920 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005921 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005922 my $call = $1;
5923 my $cast1 = deparenthesize($2);
5924 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005925 my $cast2 = deparenthesize($7);
5926 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005927 my $cast;
5928
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005929 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005930 $cast = "$cast1 or $cast2";
5931 } elsif ($cast1 ne "") {
5932 $cast = $cast1;
5933 } else {
5934 $cast = $cast2;
5935 }
5936 WARN("MINMAX",
5937 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005938 }
5939 }
5940
Joe Perches4a273192012-07-30 14:41:20 -07005941# check usleep_range arguments
5942 if ($^V && $^V ge 5.10.0 &&
5943 defined $stat &&
5944 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5945 my $min = $1;
5946 my $max = $7;
5947 if ($min eq $max) {
5948 WARN("USLEEP_RANGE",
5949 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5950 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5951 $min > $max) {
5952 WARN("USLEEP_RANGE",
5953 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5954 }
5955 }
5956
Joe Perches823b7942013-11-12 15:10:15 -08005957# check for naked sscanf
5958 if ($^V && $^V ge 5.10.0 &&
5959 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005960 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005961 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5962 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5963 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5964 my $lc = $stat =~ tr@\n@@;
5965 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005966 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08005967 WARN("NAKED_SSCANF",
5968 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5969 }
5970
Joe Perchesafc819a2014-06-04 16:12:08 -07005971# check for simple sscanf that should be kstrto<foo>
5972 if ($^V && $^V ge 5.10.0 &&
5973 defined $stat &&
5974 $line =~ /\bsscanf\b/) {
5975 my $lc = $stat =~ tr@\n@@;
5976 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005977 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07005978 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5979 my $format = $6;
5980 my $count = $format =~ tr@%@%@;
5981 if ($count == 1 &&
5982 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5983 WARN("SSCANF_TO_KSTRTO",
5984 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5985 }
5986 }
5987 }
5988
Joe Perches70dc8a42013-09-11 14:23:58 -07005989# check for new externs in .h files.
5990 if ($realfile =~ /\.h$/ &&
5991 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005992 if (CHK("AVOID_EXTERNS",
5993 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005994 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005995 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005996 }
5997 }
5998
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005999# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006000 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006001 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006002 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006003 my $function_name = $1;
6004 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006005
6006 my $s = $stat;
6007 if (defined $cond) {
6008 substr($s, 0, length($cond), '');
6009 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006010 if ($s =~ /^\s*;/ &&
6011 $function_name ne 'uninitialized_var')
6012 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006013 WARN("AVOID_EXTERNS",
6014 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006015 }
6016
6017 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006018 WARN("FUNCTION_ARGUMENTS",
6019 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006020 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006021
6022 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6023 $stat =~ /^.\s*extern\s+/)
6024 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006025 WARN("AVOID_EXTERNS",
6026 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006027 }
6028
Joe Perchesa0ad7592017-07-10 15:52:19 -07006029# check for function declarations that have arguments without identifier names
6030 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006031 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006032 $1 ne "void") {
6033 my $args = trim($1);
6034 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6035 my $arg = trim($1);
6036 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6037 WARN("FUNCTION_ARGUMENTS",
6038 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6039 }
6040 }
6041 }
6042
Joe Perchesa0ad7592017-07-10 15:52:19 -07006043# check for function definitions
6044 if ($^V && $^V ge 5.10.0 &&
6045 defined $stat &&
6046 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6047 $context_function = $1;
6048
6049# check for multiline function definition with misplaced open brace
6050 my $ok = 0;
6051 my $cnt = statement_rawlines($stat);
6052 my $herectx = $here . "\n";
6053 for (my $n = 0; $n < $cnt; $n++) {
6054 my $rl = raw_line($linenr, $n);
6055 $herectx .= $rl . "\n";
6056 $ok = 1 if ($rl =~ /^[ \+]\{/);
6057 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6058 last if $rl =~ /^[ \+].*\{/;
6059 }
6060 if (!$ok) {
6061 ERROR("OPEN_BRACE",
6062 "open brace '{' following function definitions go on the next line\n" . $herectx);
6063 }
6064 }
6065
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006066# checks for new __setup's
6067 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6068 my $name = $1;
6069
6070 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006071 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006072 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006073 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006074 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006075
6076# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08006077 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006078 WARN("UNNECESSARY_CASTS",
6079 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006080 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006081
Joe Perchesa640d252013-07-03 15:05:21 -07006082# alloc style
6083# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6084 if ($^V && $^V ge 5.10.0 &&
6085 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6086 CHK("ALLOC_SIZEOF_STRUCT",
6087 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6088 }
6089
Joe Perches60a55362014-06-04 16:12:07 -07006090# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6091 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006092 defined $stat &&
6093 $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 -07006094 my $oldfunc = $3;
6095 my $a1 = $4;
6096 my $a2 = $10;
6097 my $newfunc = "kmalloc_array";
6098 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006099 my $r1 = $a1;
6100 my $r2 = $a2;
6101 if ($a1 =~ /^sizeof\s*\S/) {
6102 $r1 = $a2;
6103 $r2 = $a1;
6104 }
6105 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6106 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006107 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006108 my $herectx = get_stat_here($linenr, $cnt, $here);
6109
Joe Perches60a55362014-06-04 16:12:07 -07006110 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006111 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6112 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006113 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006114 $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 -07006115 }
6116 }
6117 }
6118
Joe Perches972fdea2013-04-29 16:18:12 -07006119# check for krealloc arg reuse
6120 if ($^V && $^V ge 5.10.0 &&
6121 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6122 WARN("KREALLOC_ARG_REUSE",
6123 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6124 }
6125
Joe Perches5ce59ae2013-02-21 16:44:18 -08006126# check for alloc argument mismatch
6127 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6128 WARN("ALLOC_ARRAY_ARGS",
6129 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6130 }
6131
Joe Perchescaf2a542011-01-12 16:59:56 -08006132# check for multiple semicolons
6133 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006134 if (WARN("ONE_SEMICOLON",
6135 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6136 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006137 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006138 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006139 }
6140
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006141# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6142 if ($realfile !~ m@^include/uapi/@ &&
6143 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006144 my $ull = "";
6145 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6146 if (CHK("BIT_MACRO",
6147 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6148 $fix) {
6149 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6150 }
6151 }
6152
Joe Perches2d632742016-05-20 17:04:00 -07006153# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6154 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6155 my $config = $1;
6156 if (WARN("PREFER_IS_ENABLED",
6157 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6158 $fix) {
6159 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6160 }
6161 }
6162
Joe Perchese81f2392014-08-06 16:11:25 -07006163# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006164 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6165 my $has_break = 0;
6166 my $has_statement = 0;
6167 my $count = 0;
6168 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006169 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006170 $prevline--;
6171 my $rline = $rawlines[$prevline - 1];
6172 my $fline = $lines[$prevline - 1];
6173 last if ($fline =~ /^\@\@/);
6174 next if ($fline =~ /^\-/);
6175 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6176 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6177 next if ($fline =~ /^.[\s$;]*$/);
6178 $has_statement = 1;
6179 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006180 $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 -08006181 }
6182 if (!$has_break && $has_statement) {
6183 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006184 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006185 }
6186 }
6187
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006188# check for switch/default statements without a break;
6189 if ($^V && $^V ge 5.10.0 &&
6190 defined $stat &&
6191 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006192 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006193 my $herectx = get_stat_here($linenr, $cnt, $here);
6194
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006195 WARN("DEFAULT_NO_BREAK",
6196 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006197 }
6198
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006199# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006200 if ($line =~ /\b__FUNCTION__\b/) {
6201 if (WARN("USE_FUNC",
6202 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6203 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006204 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006205 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006206 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006207
Joe Perches62ec8182015-02-13 14:38:18 -08006208# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6209 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6210 ERROR("DATE_TIME",
6211 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6212 }
6213
Joe Perches2c924882012-03-23 15:02:20 -07006214# check for use of yield()
6215 if ($line =~ /\byield\s*\(\s*\)/) {
6216 WARN("YIELD",
6217 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6218 }
6219
Joe Perches179f8f42013-07-03 15:05:30 -07006220# check for comparisons against true and false
6221 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6222 my $lead = $1;
6223 my $arg = $2;
6224 my $test = $3;
6225 my $otype = $4;
6226 my $trail = $5;
6227 my $op = "!";
6228
6229 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6230
6231 my $type = lc($otype);
6232 if ($type =~ /^(?:true|false)$/) {
6233 if (("$test" eq "==" && "$type" eq "true") ||
6234 ("$test" eq "!=" && "$type" eq "false")) {
6235 $op = "";
6236 }
6237
6238 CHK("BOOL_COMPARISON",
6239 "Using comparison to $otype is error prone\n" . $herecurr);
6240
6241## maybe suggesting a correct construct would better
6242## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6243
6244 }
6245 }
6246
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006247# check for semaphores initialized locked
6248 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006249 WARN("CONSIDER_COMPLETION",
6250 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006251 }
Joe Perches6712d852012-03-23 15:02:20 -07006252
Joe Perches67d0a072011-10-31 17:13:10 -07006253# recommend kstrto* over simple_strto* and strict_strto*
6254 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006255 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006256 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006257 }
Joe Perches6712d852012-03-23 15:02:20 -07006258
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006259# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006260 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006261 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006262 "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 -07006263 }
Joe Perches6712d852012-03-23 15:02:20 -07006264
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006265# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006266# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006267 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006268 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006269 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006270 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006271 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006272
6273# use of NR_CPUS is usually wrong
6274# ignore definitions of NR_CPUS and usage to define arrays as likely right
6275 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006276 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6277 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006278 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6279 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6280 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006281 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006282 WARN("NR_CPUS",
6283 "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 -07006284 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006285
Joe Perches52ea8502013-11-12 15:10:09 -08006286# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6287 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6288 ERROR("DEFINE_ARCH_HAS",
6289 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6290 }
6291
Joe Perchesacd93622015-02-13 14:38:38 -08006292# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6293 if ($^V && $^V ge 5.10.0 &&
6294 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6295 WARN("LIKELY_MISUSE",
6296 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6297 }
6298
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006299# whine mightly about in_atomic
6300 if ($line =~ /\bin_atomic\s*\(/) {
6301 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006302 ERROR("IN_ATOMIC",
6303 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006304 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006305 WARN("IN_ATOMIC",
6306 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006307 }
6308 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006309
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006310# check for mutex_trylock_recursive usage
6311 if ($line =~ /mutex_trylock_recursive/) {
6312 ERROR("LOCKING",
6313 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6314 }
6315
Peter Zijlstra1704f472010-03-19 01:37:42 +01006316# check for lockdep_set_novalidate_class
6317 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6318 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6319 if ($realfile !~ m@^kernel/lockdep@ &&
6320 $realfile !~ m@^include/linux/lockdep@ &&
6321 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006322 ERROR("LOCKDEP",
6323 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006324 }
6325 }
Dave Jones88f88312011-01-12 16:59:59 -08006326
Joe Perchesb392c642015-04-16 12:44:16 -07006327 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6328 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006329 WARN("EXPORTED_WORLD_WRITABLE",
6330 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006331 }
Joe Perches24358802014-04-03 14:49:13 -07006332
Joe Perches00180462018-02-06 15:38:55 -08006333# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6334# and whether or not function naming is typical and if
6335# DEVICE_ATTR permissions uses are unusual too
6336 if ($^V && $^V ge 5.10.0 &&
6337 defined $stat &&
6338 $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*\)/) {
6339 my $var = $1;
6340 my $perms = $2;
6341 my $show = $3;
6342 my $store = $4;
6343 my $octal_perms = perms_to_octal($perms);
6344 if ($show =~ /^${var}_show$/ &&
6345 $store =~ /^${var}_store$/ &&
6346 $octal_perms eq "0644") {
6347 if (WARN("DEVICE_ATTR_RW",
6348 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6349 $fix) {
6350 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6351 }
6352 } elsif ($show =~ /^${var}_show$/ &&
6353 $store =~ /^NULL$/ &&
6354 $octal_perms eq "0444") {
6355 if (WARN("DEVICE_ATTR_RO",
6356 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6357 $fix) {
6358 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6359 }
6360 } elsif ($show =~ /^NULL$/ &&
6361 $store =~ /^${var}_store$/ &&
6362 $octal_perms eq "0200") {
6363 if (WARN("DEVICE_ATTR_WO",
6364 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6365 $fix) {
6366 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6367 }
6368 } elsif ($octal_perms eq "0644" ||
6369 $octal_perms eq "0444" ||
6370 $octal_perms eq "0200") {
6371 my $newshow = "$show";
6372 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6373 my $newstore = $store;
6374 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6375 my $rename = "";
6376 if ($show ne $newshow) {
6377 $rename .= " '$show' to '$newshow'";
6378 }
6379 if ($store ne $newstore) {
6380 $rename .= " '$store' to '$newstore'";
6381 }
6382 WARN("DEVICE_ATTR_FUNCTIONS",
6383 "Consider renaming function(s)$rename\n" . $herecurr);
6384 } else {
6385 WARN("DEVICE_ATTR_PERMS",
6386 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6387 }
6388 }
6389
Joe Perches515a2352014-04-03 14:49:24 -07006390# Mode permission misuses where it seems decimal should be octal
6391# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006392# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6393# specific definition of not visible in sysfs.
6394# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6395# use the default permissions
Joe Perches515a2352014-04-03 14:49:24 -07006396 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006397 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006398 $line =~ /$mode_perms_search/) {
6399 foreach my $entry (@mode_permission_funcs) {
6400 my $func = $entry->[0];
6401 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006402
Joe Perches459cf0a2016-10-11 13:52:19 -07006403 my $lc = $stat =~ tr@\n@@;
6404 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006405 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006406
Joe Perches515a2352014-04-03 14:49:24 -07006407 my $skip_args = "";
6408 if ($arg_pos > 1) {
6409 $arg_pos--;
6410 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6411 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006412 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006413 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006414 my $val = $1;
6415 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006416 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6417 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6418 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006419 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006420 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006421 }
6422 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006423 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006424 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006425 }
Joe Perches24358802014-04-03 14:49:13 -07006426 }
6427 }
6428 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006429
Joe Perches459cf0a2016-10-11 13:52:19 -07006430# check for uses of S_<PERMS> that could be octal for readability
Joe Perches00180462018-02-06 15:38:55 -08006431 if ($line =~ /\b($multi_mode_perms_string_search)\b/) {
6432 my $oval = $1;
6433 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006434 if (WARN("SYMBOLIC_PERMS",
6435 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6436 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006437 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006438 }
6439 }
6440
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006441# validate content of MODULE_LICENSE against list from include/linux/module.h
6442 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6443 my $extracted_string = get_quoted_string($line, $rawline);
6444 my $valid_licenses = qr{
6445 GPL|
6446 GPL\ v2|
6447 GPL\ and\ additional\ rights|
6448 Dual\ BSD/GPL|
6449 Dual\ MIT/GPL|
6450 Dual\ MPL/GPL|
6451 Proprietary
6452 }x;
6453 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6454 WARN("MODULE_LICENSE",
6455 "unknown module license " . $extracted_string . "\n" . $herecurr);
6456 }
6457 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006458 }
6459
6460 # If we have no input at all, then there is nothing to report on
6461 # so just keep quiet.
6462 if ($#rawlines == -1) {
6463 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006464 }
6465
Andy Whitcroft8905a672007-11-28 16:21:06 -08006466 # In mailback mode only produce a report in the negative, for
6467 # things that appear to be patches.
6468 if ($mailback && ($clean == 1 || !$is_patch)) {
6469 exit(0);
6470 }
6471
6472 # This is not a patch, and we are are in 'no-patch' mode so
6473 # just keep quiet.
6474 if (!$chk_patch && !$is_patch) {
6475 exit(0);
6476 }
6477
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006478 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006479 ERROR("NOT_UNIFIED_DIFF",
6480 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006481 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006482 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006483 ERROR("MISSING_SIGN_OFF",
6484 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006485 }
6486
Andy Whitcroft8905a672007-11-28 16:21:06 -08006487 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006488 if ($summary && !($clean == 1 && $quiet == 1)) {
6489 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006490 print "total: $cnt_error errors, $cnt_warn warnings, " .
6491 (($check)? "$cnt_chk checks, " : "") .
6492 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006493 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006494
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006495 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006496 # If there were any defects found and not already fixing them
6497 if (!$clean and !$fix) {
6498 print << "EOM"
6499
6500NOTE: For some of the reported defects, checkpatch may be able to
6501 mechanically convert to the typical style using --fix or --fix-inplace.
6502EOM
6503 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006504 # If there were whitespace errors which cleanpatch can fix
6505 # then suggest that.
6506 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006507 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006508 print << "EOM"
6509
6510NOTE: Whitespace errors detected.
6511 You may wish to use scripts/cleanpatch or scripts/cleanfile
6512EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006513 }
6514 }
6515
Joe Perchesd752fcc2014-08-06 16:11:05 -07006516 if ($clean == 0 && $fix &&
6517 ("@rawlines" ne "@fixed" ||
6518 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006519 my $newfile = $filename;
6520 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006521 my $linecount = 0;
6522 my $f;
6523
Joe Perchesd752fcc2014-08-06 16:11:05 -07006524 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6525
Joe Perches3705ce52013-07-03 15:05:31 -07006526 open($f, '>', $newfile)
6527 or die "$P: Can't open $newfile for write\n";
6528 foreach my $fixed_line (@fixed) {
6529 $linecount++;
6530 if ($file) {
6531 if ($linecount > 3) {
6532 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006533 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006534 }
6535 } else {
6536 print $f $fixed_line . "\n";
6537 }
6538 }
6539 close($f);
6540
6541 if (!$quiet) {
6542 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006543
Joe Perches3705ce52013-07-03 15:05:31 -07006544Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6545
6546Do _NOT_ trust the results written to this file.
6547Do _NOT_ submit these changes without inspecting them for correctness.
6548
6549This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6550No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006551EOM
6552 }
6553 }
6554
Joe Perchesd8469f12015-06-25 15:03:00 -07006555 if ($quiet == 0) {
6556 print "\n";
6557 if ($clean == 1) {
6558 print "$vname has no obvious style problems and is ready for submission.\n";
6559 } else {
6560 print "$vname has style problems, please review.\n";
6561 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006562 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006563 return $clean;
6564}