blob: 43322bd8f66ab496ba5a8d4f0396814924e9a91b [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
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001648sub cat_vet {
1649 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001650 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001651
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001652 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001653 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1654 $res .= $1;
1655 if ($2 ne '') {
1656 $coded = sprintf("^%c", unpack('C', $2) + 64);
1657 $res .= $coded;
1658 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001659 }
1660 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001661
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001662 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001663}
1664
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001665my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001666my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001667my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001668my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001669
1670sub annotate_reset {
1671 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001672 $av_pending = '_';
1673 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001674 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001675}
1676
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001677sub annotate_values {
1678 my ($stream, $type) = @_;
1679
1680 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001681 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001682 my $cur = $stream;
1683
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001684 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001685
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001686 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001687 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001688 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001689 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001690 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001691 print "WS($1)\n" if ($dbg_values > 1);
1692 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001693 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001694 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001695 }
1696
Florian Micklerc023e4732011-01-12 16:59:58 -08001697 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001698 print "CAST($1)\n" if ($dbg_values > 1);
1699 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001700 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001701
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001702 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001703 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001704 $type = 'T';
1705
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001706 } elsif ($cur =~ /^($Modifier)\s*/) {
1707 print "MODIFIER($1)\n" if ($dbg_values > 1);
1708 $type = 'T';
1709
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001710 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001711 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001712 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001713 push(@av_paren_type, $type);
1714 if ($2 ne '') {
1715 $av_pending = 'N';
1716 }
1717 $type = 'E';
1718
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001719 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001720 print "UNDEF($1)\n" if ($dbg_values > 1);
1721 $av_preprocessor = 1;
1722 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001723
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001724 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001725 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001726 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001727
1728 push(@av_paren_type, $type);
1729 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001730 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001731
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001732 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001733 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1734 $av_preprocessor = 1;
1735
1736 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1737
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001738 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001739
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001740 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001741 print "PRE_END($1)\n" if ($dbg_values > 1);
1742
1743 $av_preprocessor = 1;
1744
1745 # Assume all arms of the conditional end as this
1746 # one does, and continue as if the #endif was not here.
1747 pop(@av_paren_type);
1748 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001749 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001750
1751 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001752 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001753
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001754 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1755 print "ATTR($1)\n" if ($dbg_values > 1);
1756 $av_pending = $type;
1757 $type = 'N';
1758
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001759 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001760 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001762 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001763 }
1764 $type = 'N';
1765
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001766 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001767 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001768 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001769 $type = 'N';
1770
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001771 } elsif ($cur =~/^(case)/o) {
1772 print "CASE($1)\n" if ($dbg_values > 1);
1773 $av_pend_colon = 'C';
1774 $type = 'N';
1775
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001776 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001777 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001778 $type = 'N';
1779
1780 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001781 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001782 push(@av_paren_type, $av_pending);
1783 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001784 $type = 'N';
1785
1786 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001787 my $new_type = pop(@av_paren_type);
1788 if ($new_type ne '_') {
1789 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001790 print "PAREN('$1') -> $type\n"
1791 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001792 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001793 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001794 }
1795
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001796 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001797 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001798 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001799 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001800
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001801 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1802 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001803 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001804 } elsif ($type eq 'E') {
1805 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001806 }
1807 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1808 $type = 'V';
1809
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001810 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001811 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001812 $type = 'V';
1813
1814 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001815 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001816 $type = 'N';
1817
Andy Whitcroftcf655042008-03-04 14:28:20 -08001818 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001819 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001820 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001821 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001822
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001823 } elsif ($cur =~/^(,)/) {
1824 print "COMMA($1)\n" if ($dbg_values > 1);
1825 $type = 'C';
1826
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001827 } elsif ($cur =~ /^(\?)/o) {
1828 print "QUESTION($1)\n" if ($dbg_values > 1);
1829 $type = 'N';
1830
1831 } elsif ($cur =~ /^(:)/o) {
1832 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1833
1834 substr($var, length($res), 1, $av_pend_colon);
1835 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1836 $type = 'E';
1837 } else {
1838 $type = 'N';
1839 }
1840 $av_pend_colon = 'O';
1841
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001842 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001843 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001844 $type = 'N';
1845
Andy Whitcroft0d413862008-10-15 22:02:16 -07001846 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001847 my $variant;
1848
1849 print "OPV($1)\n" if ($dbg_values > 1);
1850 if ($type eq 'V') {
1851 $variant = 'B';
1852 } else {
1853 $variant = 'U';
1854 }
1855
1856 substr($var, length($res), 1, $variant);
1857 $type = 'N';
1858
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001859 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001860 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001861 if ($1 ne '++' && $1 ne '--') {
1862 $type = 'N';
1863 }
1864
1865 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001866 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001867 }
1868 if (defined $1) {
1869 $cur = substr($cur, length($1));
1870 $res .= $type x length($1);
1871 }
1872 }
1873
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001874 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001875}
1876
Andy Whitcroft8905a672007-11-28 16:21:06 -08001877sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001878 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001879 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001880 ^(?:
1881 $Modifier|
1882 $Storage|
1883 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001884 DEFINE_\S+
1885 )$|
1886 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001887 goto|
1888 return|
1889 case|
1890 else|
1891 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001892 do|
1893 \#|
1894 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001895 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001896 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001897 )}x;
1898 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1899 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001900 # Check for modifiers.
1901 $possible =~ s/\s*$Storage\s*//g;
1902 $possible =~ s/\s*$Sparse\s*//g;
1903 if ($possible =~ /^\s*$/) {
1904
1905 } elsif ($possible =~ /\s/) {
1906 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001907 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001908 if ($modifier !~ $notPermitted) {
1909 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001910 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001911 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001912 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001913
1914 } else {
1915 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001916 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001917 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001918 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001919 } else {
1920 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001921 }
1922}
1923
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001924my $prefix = '';
1925
Joe Perches000d1cc12011-07-25 17:13:25 -07001926sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001927 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001928
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001929 $type =~ tr/[a-z]/[A-Z]/;
1930
Joe Perchescbec18a2014-04-03 14:49:19 -07001931 return defined $use_type{$type} if (scalar keys %use_type > 0);
1932
1933 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001934}
1935
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001936sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001937 my ($level, $type, $msg) = @_;
1938
1939 if (!show_type($type) ||
1940 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001941 return 0;
1942 }
Joe Perches57230292015-06-25 15:03:03 -07001943 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001944 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001945 if ($level eq 'ERROR') {
1946 $output .= RED;
1947 } elsif ($level eq 'WARNING') {
1948 $output .= YELLOW;
1949 } else {
1950 $output .= GREEN;
1951 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001952 }
Joe Perches57230292015-06-25 15:03:03 -07001953 $output .= $prefix . $level . ':';
1954 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001955 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001956 $output .= "$type:";
1957 }
John Brooks737c0762017-07-10 15:52:24 -07001958 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001959 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001960
1961 if ($showfile) {
1962 my @lines = split("\n", $output, -1);
1963 splice(@lines, 1, 1);
1964 $output = join("\n", @lines);
1965 }
Joe Perches57230292015-06-25 15:03:03 -07001966 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001967
Joe Perches57230292015-06-25 15:03:03 -07001968 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001969
1970 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001971}
Joe Perchescbec18a2014-04-03 14:49:19 -07001972
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001973sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001974 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001975}
Joe Perches000d1cc12011-07-25 17:13:25 -07001976
Joe Perchesd752fcc2014-08-06 16:11:05 -07001977sub fixup_current_range {
1978 my ($lineRef, $offset, $length) = @_;
1979
1980 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1981 my $o = $1;
1982 my $l = $2;
1983 my $no = $o + $offset;
1984 my $nl = $l + $length;
1985 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1986 }
1987}
1988
1989sub fix_inserted_deleted_lines {
1990 my ($linesRef, $insertedRef, $deletedRef) = @_;
1991
1992 my $range_last_linenr = 0;
1993 my $delta_offset = 0;
1994
1995 my $old_linenr = 0;
1996 my $new_linenr = 0;
1997
1998 my $next_insert = 0;
1999 my $next_delete = 0;
2000
2001 my @lines = ();
2002
2003 my $inserted = @{$insertedRef}[$next_insert++];
2004 my $deleted = @{$deletedRef}[$next_delete++];
2005
2006 foreach my $old_line (@{$linesRef}) {
2007 my $save_line = 1;
2008 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002009 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002010 $delta_offset = 0;
2011 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2012 $range_last_linenr = $new_linenr;
2013 fixup_current_range(\$line, $delta_offset, 0);
2014 }
2015
2016 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2017 $deleted = @{$deletedRef}[$next_delete++];
2018 $save_line = 0;
2019 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2020 }
2021
2022 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2023 push(@lines, ${$inserted}{'LINE'});
2024 $inserted = @{$insertedRef}[$next_insert++];
2025 $new_linenr++;
2026 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2027 }
2028
2029 if ($save_line) {
2030 push(@lines, $line);
2031 $new_linenr++;
2032 }
2033
2034 $old_linenr++;
2035 }
2036
2037 return @lines;
2038}
2039
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002040sub fix_insert_line {
2041 my ($linenr, $line) = @_;
2042
2043 my $inserted = {
2044 LINENR => $linenr,
2045 LINE => $line,
2046 };
2047 push(@fixed_inserted, $inserted);
2048}
2049
2050sub fix_delete_line {
2051 my ($linenr, $line) = @_;
2052
2053 my $deleted = {
2054 LINENR => $linenr,
2055 LINE => $line,
2056 };
2057
2058 push(@fixed_deleted, $deleted);
2059}
2060
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002061sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002062 my ($type, $msg) = @_;
2063
2064 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002065 our $clean = 0;
2066 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002067 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002068 }
Joe Perches3705ce52013-07-03 15:05:31 -07002069 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002070}
2071sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002072 my ($type, $msg) = @_;
2073
2074 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002075 our $clean = 0;
2076 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002077 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002078 }
Joe Perches3705ce52013-07-03 15:05:31 -07002079 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002080}
2081sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002082 my ($type, $msg) = @_;
2083
2084 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002085 our $clean = 0;
2086 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002087 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002088 }
Joe Perches3705ce52013-07-03 15:05:31 -07002089 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002090}
2091
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002092sub check_absolute_file {
2093 my ($absolute, $herecurr) = @_;
2094 my $file = $absolute;
2095
2096 ##print "absolute<$absolute>\n";
2097
2098 # See if any suffix of this path is a path within the tree.
2099 while ($file =~ s@^[^/]*/@@) {
2100 if (-f "$root/$file") {
2101 ##print "file<$file>\n";
2102 last;
2103 }
2104 }
2105 if (! -f _) {
2106 return 0;
2107 }
2108
2109 # It is, so see if the prefix is acceptable.
2110 my $prefix = $absolute;
2111 substr($prefix, -length($file)) = '';
2112
2113 ##print "prefix<$prefix>\n";
2114 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002115 WARN("USE_RELATIVE_PATH",
2116 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002117 }
2118}
2119
Joe Perches3705ce52013-07-03 15:05:31 -07002120sub trim {
2121 my ($string) = @_;
2122
Joe Perchesb34c6482013-09-11 14:24:01 -07002123 $string =~ s/^\s+|\s+$//g;
2124
2125 return $string;
2126}
2127
2128sub ltrim {
2129 my ($string) = @_;
2130
2131 $string =~ s/^\s+//;
2132
2133 return $string;
2134}
2135
2136sub rtrim {
2137 my ($string) = @_;
2138
2139 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002140
2141 return $string;
2142}
2143
Joe Perches52ea8502013-11-12 15:10:09 -08002144sub string_find_replace {
2145 my ($string, $find, $replace) = @_;
2146
2147 $string =~ s/$find/$replace/g;
2148
2149 return $string;
2150}
2151
Joe Perches3705ce52013-07-03 15:05:31 -07002152sub tabify {
2153 my ($leading) = @_;
2154
2155 my $source_indent = 8;
2156 my $max_spaces_before_tab = $source_indent - 1;
2157 my $spaces_to_tab = " " x $source_indent;
2158
2159 #convert leading spaces to tabs
2160 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2161 #Remove spaces before a tab
2162 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2163
2164 return "$leading";
2165}
2166
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002167sub pos_last_openparen {
2168 my ($line) = @_;
2169
2170 my $pos = 0;
2171
2172 my $opens = $line =~ tr/\(/\(/;
2173 my $closes = $line =~ tr/\)/\)/;
2174
2175 my $last_openparen = 0;
2176
2177 if (($opens == 0) || ($closes >= $opens)) {
2178 return -1;
2179 }
2180
2181 my $len = length($line);
2182
2183 for ($pos = 0; $pos < $len; $pos++) {
2184 my $string = substr($line, $pos);
2185 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2186 $pos += length($1) - 1;
2187 } elsif (substr($line, $pos, 1) eq '(') {
2188 $last_openparen = $pos;
2189 } elsif (index($string, '(') == -1) {
2190 last;
2191 }
2192 }
2193
Joe Perches91cb5192014-04-03 14:49:32 -07002194 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002195}
2196
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002197sub process {
2198 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002199
2200 my $linenr=0;
2201 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002202 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002203 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002204 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002205
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002206 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002207 my $indent;
2208 my $previndent=0;
2209 my $stashindent=0;
2210
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002211 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002212 my $signoff = 0;
2213 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002214 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002215 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002216 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002217 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002218 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002219 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002220 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002221 my $non_utf8_charset = 0;
2222
Joe Perches365dd4e2014-08-06 16:10:42 -07002223 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002224 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002225
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002226 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002227 our $cnt_lines = 0;
2228 our $cnt_error = 0;
2229 our $cnt_warn = 0;
2230 our $cnt_chk = 0;
2231
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002232 # Trace the real file/line as we go.
2233 my $realfile = '';
2234 my $realline = 0;
2235 my $realcnt = 0;
2236 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002237 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002238 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002239 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002240 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002241 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002242
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002243 my $prev_values = 'E';
2244
2245 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002246 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002247 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002248 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002249 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002250
Joe Perches7e51f192013-09-11 14:23:57 -07002251 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002252
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002253 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002254 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002255 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002256 my @setup_docs = ();
2257 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002258
Joe Perchesd8b07712013-11-12 15:10:06 -08002259 my $camelcase_file_seeded = 0;
2260
Rob Herring9f3a8992018-04-10 16:33:13 -07002261 my $checklicenseline = 1;
2262
Andy Whitcroft773647a2008-03-28 14:15:58 -07002263 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002264 my $line;
2265 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002266 $linenr++;
2267 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002268
Joe Perches3705ce52013-07-03 15:05:31 -07002269 push(@fixed, $rawline) if ($fix);
2270
Andy Whitcroft773647a2008-03-28 14:15:58 -07002271 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002272 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002273 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002274 $setup_docs = 1;
2275 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002276 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002277 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002278 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002279 $realline=$1-1;
2280 if (defined $2) {
2281 $realcnt=$3+1;
2282 } else {
2283 $realcnt=1+1;
2284 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002285 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002286
2287 # Guestimate if this is a continuing comment. Run
2288 # the context looking for a comment "edge". If this
2289 # edge is a close comment then we must be in a comment
2290 # at context start.
2291 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002292 my $cnt = $realcnt;
2293 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2294 next if (defined $rawlines[$ln - 1] &&
2295 $rawlines[$ln - 1] =~ /^-/);
2296 $cnt--;
2297 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002298 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002299 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2300 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2301 ($edge) = $1;
2302 last;
2303 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002304 }
2305 if (defined $edge && $edge eq '*/') {
2306 $in_comment = 1;
2307 }
2308
2309 # Guestimate if this is a continuing comment. If this
2310 # is the start of a diff block and this line starts
2311 # ' *' then it is very likely a comment.
2312 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002313 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002314 {
2315 $in_comment = 1;
2316 }
2317
2318 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2319 sanitise_line_reset($in_comment);
2320
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002321 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002322 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002323 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002324 $line = sanitise_line($rawline);
2325 }
2326 push(@lines, $line);
2327
2328 if ($realcnt > 1) {
2329 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2330 } else {
2331 $realcnt = 0;
2332 }
2333
2334 #print "==>$rawline\n";
2335 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002336
2337 if ($setup_docs && $line =~ /^\+/) {
2338 push(@setup_docs, $line);
2339 }
2340 }
2341
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002342 $prefix = '';
2343
Andy Whitcroft773647a2008-03-28 14:15:58 -07002344 $realcnt = 0;
2345 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002346 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002347 foreach my $line (@lines) {
2348 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002349 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002350 my $sline = $line; #copy of $line
2351 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002352
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002353 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002354
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002355#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002356 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002357 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2358 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002359 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002360 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002361 $realline=$1-1;
2362 if (defined $2) {
2363 $realcnt=$3+1;
2364 } else {
2365 $realcnt=1+1;
2366 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002367 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002368 $prev_values = 'E';
2369
Andy Whitcroft773647a2008-03-28 14:15:58 -07002370 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002371 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002372 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002373 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002374 if ($context =~ /\b(\w+)\s*\(/) {
2375 $context_function = $1;
2376 } else {
2377 undef $context_function;
2378 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002379 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002380
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002381# track the line number as we move through the hunk, note that
2382# new versions of GNU diff omit the leading space on completely
2383# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002384 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002385 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002386 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002387
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002388 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002389 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002390
2391 # Track the previous line.
2392 ($prevline, $stashline) = ($stashline, $line);
2393 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002394 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2395
Andy Whitcroft773647a2008-03-28 14:15:58 -07002396 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002397
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002398 } elsif ($realcnt == 1) {
2399 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002400 }
2401
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002402 my $hunk_line = ($realcnt != 0);
2403
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002404 $here = "#$linenr: " if (!$file);
2405 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002406
Joe Perches2ac73b42014-06-04 16:12:05 -07002407 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002408 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002409 if ($line =~ /^diff --git.*?(\S+)$/) {
2410 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002411 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002412 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002413 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002414 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002415 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002416 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002417 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002418
2419 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002420 if (!$file && $tree && $p1_prefix ne '' &&
2421 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002422 WARN("PATCH_PREFIX",
2423 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002424 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002425
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002426 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002427 ERROR("MODIFIED_INCLUDE_ASM",
2428 "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 -07002429 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002430 $found_file = 1;
2431 }
2432
Joe Perches34d88152015-06-25 15:03:05 -07002433#make up the handle for any error we report on this line
2434 if ($showfile) {
2435 $prefix = "$realfile:$realline: "
2436 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002437 if ($file) {
2438 $prefix = "$filename:$realline: ";
2439 } else {
2440 $prefix = "$filename:$linenr: ";
2441 }
Joe Perches34d88152015-06-25 15:03:05 -07002442 }
2443
Joe Perches2ac73b42014-06-04 16:12:05 -07002444 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002445 if (is_maintained_obsolete($realfile)) {
2446 WARN("OBSOLETE",
2447 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2448 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002449 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002450 $check = 1;
2451 } else {
2452 $check = $check_orig;
2453 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002454 $checklicenseline = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002455 next;
2456 }
2457
Randy Dunlap389834b2007-06-08 13:47:03 -07002458 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002459
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002460 my $hereline = "$here\n$rawline\n";
2461 my $herecurr = "$here\n$rawline\n";
2462 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002463
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002464 $cnt_lines++ if ($realcnt != 0);
2465
Joe Perchese518e9a2015-06-25 15:03:27 -07002466# Check if the commit log has what seems like a diff which can confuse patch
2467 if ($in_commit_log && !$commit_log_has_diff &&
2468 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2469 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2470 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2471 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2472 ERROR("DIFF_IN_COMMIT_MSG",
2473 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2474 $commit_log_has_diff = 1;
2475 }
2476
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002477# Check for incorrect file permissions
2478 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2479 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002480 if ($realfile !~ m@scripts/@ &&
2481 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002482 ERROR("EXECUTE_PERMISSIONS",
2483 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002484 }
2485 }
2486
Joe Perches20112472011-07-25 17:13:23 -07002487# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002488 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002489 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002490 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002491 }
2492
Joe Perchese0d975b2014-12-10 15:51:49 -08002493# Check if MAINTAINERS is being updated. If so, there's probably no need to
2494# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2495 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2496 $reported_maintainer_file = 1;
2497 }
2498
Joe Perches20112472011-07-25 17:13:23 -07002499# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002500 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002501 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002502 my $space_before = $1;
2503 my $sign_off = $2;
2504 my $space_after = $3;
2505 my $email = $4;
2506 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2507
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002508 if ($sign_off !~ /$signature_tags/) {
2509 WARN("BAD_SIGN_OFF",
2510 "Non-standard signature: $sign_off\n" . $herecurr);
2511 }
Joe Perches20112472011-07-25 17:13:23 -07002512 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002513 if (WARN("BAD_SIGN_OFF",
2514 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2515 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002516 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002517 "$ucfirst_sign_off $email";
2518 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002519 }
Joe Perches20112472011-07-25 17:13:23 -07002520 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002521 if (WARN("BAD_SIGN_OFF",
2522 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2523 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002524 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002525 "$ucfirst_sign_off $email";
2526 }
2527
Joe Perches20112472011-07-25 17:13:23 -07002528 }
2529 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002530 if (WARN("BAD_SIGN_OFF",
2531 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2532 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002533 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002534 "$ucfirst_sign_off $email";
2535 }
Joe Perches20112472011-07-25 17:13:23 -07002536 }
2537
2538 my ($email_name, $email_address, $comment) = parse_email($email);
2539 my $suggested_email = format_email(($email_name, $email_address));
2540 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002541 ERROR("BAD_SIGN_OFF",
2542 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002543 } else {
2544 my $dequoted = $suggested_email;
2545 $dequoted =~ s/^"//;
2546 $dequoted =~ s/" </ </;
2547 # Don't force email to have quotes
2548 # Allow just an angle bracketed address
2549 if ("$dequoted$comment" ne $email &&
2550 "<$email_address>$comment" ne $email &&
2551 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002552 WARN("BAD_SIGN_OFF",
2553 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002554 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002555 }
Joe Perches7e51f192013-09-11 14:23:57 -07002556
2557# Check for duplicate signatures
2558 my $sig_nospace = $line;
2559 $sig_nospace =~ s/\s//g;
2560 $sig_nospace = lc($sig_nospace);
2561 if (defined $signatures{$sig_nospace}) {
2562 WARN("BAD_SIGN_OFF",
2563 "Duplicate signature\n" . $herecurr);
2564 } else {
2565 $signatures{$sig_nospace} = 1;
2566 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002567 }
2568
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002569# Check email subject for common tools that don't need to be mentioned
2570 if ($in_header_lines &&
2571 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2572 WARN("EMAIL_SUBJECT",
2573 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2574 }
2575
Joe Perches9b3189e2014-06-04 16:12:10 -07002576# Check for old stable address
2577 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2578 ERROR("STABLE_ADDRESS",
2579 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2580 }
2581
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002582# Check for unwanted Gerrit info
2583 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2584 ERROR("GERRIT_CHANGE_ID",
2585 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2586 }
2587
Joe Perches369c8dd2015-11-06 16:31:34 -08002588# Check if the commit log is in a possible stack dump
2589 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2590 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2591 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2592 # timestamp
2593 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2594 # stack dump address
2595 $commit_log_possible_stack_dump = 1;
2596 }
2597
Joe Perches2a076f42015-04-16 12:44:28 -07002598# Check for line lengths > 75 in commit log, warn once
2599 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002600 length($line) > 75 &&
2601 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2602 # file delta changes
2603 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2604 # filename then :
2605 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2606 # A Fixes: or Link: line
2607 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002608 WARN("COMMIT_LOG_LONG_LINE",
2609 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2610 $commit_log_long_line = 1;
2611 }
2612
Joe Perchesbf4daf12015-09-09 15:37:50 -07002613# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002614 if ($in_commit_log && $commit_log_possible_stack_dump &&
2615 $line =~ /^\s*$/) {
2616 $commit_log_possible_stack_dump = 0;
2617 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002618
Joe Perches0d7835f2015-02-13 14:38:35 -08002619# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002620 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002621 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002622 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002623 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002624 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002625 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2626 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002627 my $init_char = "c";
2628 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002629 my $short = 1;
2630 my $long = 0;
2631 my $case = 1;
2632 my $space = 1;
2633 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002634 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002635 my $id = '0123456789ab';
2636 my $orig_desc = "commit description";
2637 my $description = "";
2638
Joe Perchesfe043ea2015-09-09 15:37:25 -07002639 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2640 $init_char = $1;
2641 $orig_commit = lc($2);
2642 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2643 $orig_commit = lc($1);
2644 }
2645
Joe Perches0d7835f2015-02-13 14:38:35 -08002646 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2647 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2648 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2649 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2650 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2651 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002652 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002653 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2654 defined $rawlines[$linenr] &&
2655 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2656 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002657 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002658 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2659 defined $rawlines[$linenr] &&
2660 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2661 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2662 $orig_desc = $1;
2663 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2664 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002665 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002666 }
2667
2668 ($id, $description) = git_commit_info($orig_commit,
2669 $id, $orig_desc);
2670
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002671 if (defined($id) &&
2672 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002673 ERROR("GIT_COMMIT_ID",
2674 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2675 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002676 }
2677
Joe Perches13f19372014-08-06 16:10:59 -07002678# Check for added, moved or deleted files
2679 if (!$reported_maintainer_file && !$in_commit_log &&
2680 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2681 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2682 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2683 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002684 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002685 $reported_maintainer_file = 1;
2686 WARN("FILE_PATH_CHANGES",
2687 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2688 }
2689
Andy Whitcroft00df3442007-06-08 13:47:06 -07002690# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002691 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002692 ERROR("CORRUPTED_PATCH",
2693 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002694 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002695 }
2696
2697# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2698 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002699 $rawline !~ m/^$UTF8*$/) {
2700 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2701
2702 my $blank = copy_spacing($rawline);
2703 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2704 my $hereptr = "$hereline$ptr\n";
2705
Joe Perches34d99212011-07-25 17:13:26 -07002706 CHK("INVALID_UTF8",
2707 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002708 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002709
Joe Perches15662b32011-10-31 17:13:12 -07002710# Check if it's the start of a commit log
2711# (not a header line and we haven't seen the patch filename)
2712 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002713 !($rawline =~ /^\s+(?:\S|$)/ ||
2714 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002715 $in_header_lines = 0;
2716 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002717 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002718 }
2719
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002720# Check if there is UTF-8 in a commit log when a mail header has explicitly
2721# declined it, i.e defined some charset where it is missing.
2722 if ($in_header_lines &&
2723 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2724 $1 !~ /utf-8/i) {
2725 $non_utf8_charset = 1;
2726 }
2727
2728 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002729 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002730 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002731 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2732 }
2733
Joe Perchesd6430f72016-12-12 16:46:28 -08002734# Check for absolute kernel paths in commit message
2735 if ($tree && $in_commit_log) {
2736 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2737 my $file = $1;
2738
2739 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2740 check_absolute_file($1, $herecurr)) {
2741 #
2742 } else {
2743 check_absolute_file($file, $herecurr);
2744 }
2745 }
2746 }
2747
Kees Cook66b47b42014-10-13 15:51:57 -07002748# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002749 if (defined($misspellings) &&
2750 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002751 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002752 my $typo = $1;
2753 my $typo_fix = $spelling_fix{lc($typo)};
2754 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2755 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002756 my $msg_level = \&WARN;
2757 $msg_level = \&CHK if ($file);
2758 if (&{$msg_level}("TYPO_SPELLING",
2759 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002760 $fix) {
2761 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2762 }
2763 }
2764 }
2765
Andy Whitcroft306708542008-10-15 22:02:28 -07002766# ignore non-hunk lines and lines being removed
2767 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002768
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002769#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002770 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002771 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002772 if (ERROR("DOS_LINE_ENDINGS",
2773 "DOS line endings\n" . $herevet) &&
2774 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002775 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002776 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002777 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2778 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002779 if (ERROR("TRAILING_WHITESPACE",
2780 "trailing whitespace\n" . $herevet) &&
2781 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002782 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002783 }
2784
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002785 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002786 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002787
Josh Triplett4783f892013-11-12 15:10:12 -08002788# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002789 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002790 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002791 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2792 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002793 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002794 my $msg_level = \&ERROR;
2795 $msg_level = \&CHK if ($file);
2796 &{$msg_level}("FSF_MAILING_ADDRESS",
2797 "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 -08002798 }
2799
Andi Kleen33549572010-05-24 14:33:29 -07002800# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002801# Only applies when adding the entry originally, after that we do not have
2802# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002803 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002804 # 'choice' is usually the last thing on the line (though
2805 # Kconfig supports named choices), so use a word boundary
2806 # (\b) rather than a whitespace character (\s)
2807 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002808 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002809 my $cnt = $realcnt;
2810 my $ln = $linenr + 1;
2811 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002812 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002813 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002814 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002815 $f = $lines[$ln - 1];
2816 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2817 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002818
2819 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002820 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002821
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002822 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002823 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002824 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2825 if ($lines[$ln - 1] =~ "---help---") {
2826 WARN("CONFIG_DESCRIPTION",
2827 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2828 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002829 $length = -1;
2830 }
2831
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002832 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002833 $f =~ s/#.*//;
2834 $f =~ s/^\s+//;
2835 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002836
2837 # This only checks context lines in the patch
2838 # and so hopefully shouldn't trigger false
2839 # positives, even though some of these are
2840 # common words in help texts
2841 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2842 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002843 $is_end = 1;
2844 last;
2845 }
Andi Kleen33549572010-05-24 14:33:29 -07002846 $length++;
2847 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002848 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2849 WARN("CONFIG_DESCRIPTION",
2850 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2851 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002852 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002853 }
2854
Joe Perches628f91a2017-07-10 15:52:07 -07002855# check for MAINTAINERS entries that don't have the right form
2856 if ($realfile =~ /^MAINTAINERS$/ &&
2857 $rawline =~ /^\+[A-Z]:/ &&
2858 $rawline !~ /^\+[A-Z]:\t\S/) {
2859 if (WARN("MAINTAINERS_STYLE",
2860 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2861 $fix) {
2862 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2863 }
2864 }
2865
Christoph Jaeger327953e2015-02-13 14:38:29 -08002866# discourage the use of boolean for type definition attributes of Kconfig options
2867 if ($realfile =~ /Kconfig/ &&
2868 $line =~ /^\+\s*\bboolean\b/) {
2869 WARN("CONFIG_TYPE_BOOLEAN",
2870 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2871 }
2872
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002873 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2874 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2875 my $flag = $1;
2876 my $replacement = {
2877 'EXTRA_AFLAGS' => 'asflags-y',
2878 'EXTRA_CFLAGS' => 'ccflags-y',
2879 'EXTRA_CPPFLAGS' => 'cppflags-y',
2880 'EXTRA_LDFLAGS' => 'ldflags-y',
2881 };
2882
2883 WARN("DEPRECATED_VARIABLE",
2884 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2885 }
2886
Rob Herringbff5da42014-01-23 15:54:51 -08002887# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002888 if (defined $root &&
2889 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2890 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2891
Rob Herringbff5da42014-01-23 15:54:51 -08002892 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2893
Florian Vaussardcc933192014-04-03 14:49:27 -07002894 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2895 my $vp_file = $dt_path . "vendor-prefixes.txt";
2896
Rob Herringbff5da42014-01-23 15:54:51 -08002897 foreach my $compat (@compats) {
2898 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002899 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2900 my $compat3 = $compat;
2901 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2902 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002903 if ( $? >> 8 ) {
2904 WARN("UNDOCUMENTED_DT_STRING",
2905 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2906 }
2907
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002908 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2909 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002910 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002911 if ( $? >> 8 ) {
2912 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002913 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002914 }
2915 }
2916 }
2917
Rob Herring9f3a8992018-04-10 16:33:13 -07002918# check for using SPDX license tag at beginning of files
2919 if ($realline == $checklicenseline) {
2920 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2921 $checklicenseline = 2;
2922 } elsif ($rawline =~ /^\+/) {
2923 my $comment = "";
2924 if ($realfile =~ /\.(h|s|S)$/) {
2925 $comment = '/*';
2926 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2927 $comment = '//';
2928 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2929 $comment = '#';
2930 } elsif ($realfile =~ /\.rst$/) {
2931 $comment = '..';
2932 }
2933
2934 if ($comment !~ /^$/ &&
2935 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
2936 WARN("SPDX_LICENSE_TAG",
2937 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
2938 }
2939 }
2940 }
2941
Andy Whitcroft5368df202008-10-15 22:02:27 -07002942# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002943 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002944
Joe Perches47e0c882015-06-25 15:02:57 -07002945# line length limit (with some exclusions)
2946#
2947# There are a few types of lines that may extend beyond $max_line_length:
2948# logging functions like pr_info that end in a string
2949# lines with a single string
2950# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002951# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07002952#
2953# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002954# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002955# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2956# LONG_LINE all other lines longer than $max_line_length
2957#
2958# if LONG_LINE is ignored, the other 2 types are also ignored
2959#
2960
Joe Perchesb4749e92015-07-17 16:24:01 -07002961 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002962 my $msg_type = "LONG_LINE";
2963
2964 # Check the allowed long line types first
2965
2966 # logging functions that end in a string that starts
2967 # before $max_line_length
2968 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2969 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2970 $msg_type = "";
2971
2972 # lines with only strings (w/ possible termination)
2973 # #defines with only strings
2974 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2975 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2976 $msg_type = "";
2977
Joe Perchescc147502017-11-17 15:28:44 -08002978 # More special cases
2979 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
2980 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07002981 $msg_type = "";
2982
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002983 # URL ($rawline is used in case the URL is in a comment)
2984 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
2985 $msg_type = "";
2986
Joe Perches47e0c882015-06-25 15:02:57 -07002987 # Otherwise set the alternate message types
2988
2989 # a comment starts before $max_line_length
2990 } elsif ($line =~ /($;[\s$;]*)$/ &&
2991 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2992 $msg_type = "LONG_LINE_COMMENT"
2993
2994 # a quoted string starts before $max_line_length
2995 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2996 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2997 $msg_type = "LONG_LINE_STRING"
2998 }
2999
3000 if ($msg_type ne "" &&
3001 (show_type("LONG_LINE") || show_type($msg_type))) {
3002 WARN($msg_type,
3003 "line over $max_line_length characters\n" . $herecurr);
3004 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003005 }
3006
Andy Whitcroft8905a672007-11-28 16:21:06 -08003007# check for adding lines without a newline.
3008 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003009 WARN("MISSING_EOF_NEWLINE",
3010 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003011 }
3012
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003013# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003014 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003015
3016# at the beginning of a line any tabs must come first and anything
3017# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003018 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3019 $rawline =~ /^\+\s* \s*/) {
3020 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003021 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003022 if (ERROR("CODE_INDENT",
3023 "code indent should use tabs where possible\n" . $herevet) &&
3024 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003025 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003026 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003027 }
3028
Alberto Panizzo08e44362010-03-05 13:43:54 -08003029# check for space before tabs.
3030 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3031 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003032 if (WARN("SPACE_BEFORE_TAB",
3033 "please, no space before tabs\n" . $herevet) &&
3034 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003035 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003036 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003037 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003038 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003039 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003040 }
3041
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003042# check for && or || at the start of a line
3043 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3044 CHK("LOGICAL_CONTINUATIONS",
3045 "Logical continuations should be on the previous line\n" . $hereprev);
3046 }
3047
Joe Perchesa91e8992016-05-20 17:04:05 -07003048# check indentation starts on a tab stop
3049 if ($^V && $^V ge 5.10.0 &&
Joe Perchesbd491112018-02-06 15:39:06 -08003050 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003051 my $indent = length($1);
3052 if ($indent % 8) {
3053 if (WARN("TABSTOP",
3054 "Statements should start on a tabstop\n" . $herecurr) &&
3055 $fix) {
3056 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3057 }
3058 }
3059 }
3060
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003061# check multi-line statement indentation matches previous line
3062 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003063 $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 -07003064 $prevline =~ /^\+(\t*)(.*)$/;
3065 my $oldindent = $1;
3066 my $rest = $2;
3067
3068 my $pos = pos_last_openparen($rest);
3069 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003070 $line =~ /^(\+| )([ \t]*)/;
3071 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003072
3073 my $goodtabindent = $oldindent .
3074 "\t" x ($pos / 8) .
3075 " " x ($pos % 8);
3076 my $goodspaceindent = $oldindent . " " x $pos;
3077
3078 if ($newindent ne $goodtabindent &&
3079 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003080
3081 if (CHK("PARENTHESIS_ALIGNMENT",
3082 "Alignment should match open parenthesis\n" . $hereprev) &&
3083 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003084 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003085 s/^\+[ \t]*/\+$goodtabindent/;
3086 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003087 }
3088 }
3089 }
3090
Joe Perches6ab3a972015-04-16 12:44:05 -07003091# check for space after cast like "(int) foo" or "(struct foo) bar"
3092# avoid checking a few false positives:
3093# "sizeof(<type>)" or "__alignof__(<type>)"
3094# function pointer declarations like "(*foo)(int) = bar;"
3095# structure definitions like "(struct foo) { 0 };"
3096# multiline macros that define functions
3097# known attributes or the __attribute__ keyword
3098 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3099 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003100 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003101 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003102 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003103 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003104 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003105 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003106 }
3107
Joe Perches86406b12015-09-09 15:37:41 -07003108# Block comment styles
3109# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003110 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003111 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003112 $rawline =~ /^\+[ \t]*\*/ &&
3113 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003114 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3115 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3116 }
3117
Joe Perches86406b12015-09-09 15:37:41 -07003118# Block comments use * on subsequent lines
3119 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3120 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003121 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003122 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003123 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003124 WARN("BLOCK_COMMENT_STYLE",
3125 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003126 }
3127
Joe Perches86406b12015-09-09 15:37:41 -07003128# Block comments use */ on trailing lines
3129 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003130 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3131 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3132 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003133 WARN("BLOCK_COMMENT_STYLE",
3134 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003135 }
3136
Joe Perches08eb9b82016-10-11 13:51:50 -07003137# Block comment * alignment
3138 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003139 $line =~ /^\+[ \t]*$;/ && #leading comment
3140 $rawline =~ /^\+[ \t]*\*/ && #leading *
3141 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003142 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003143 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3144 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003145 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003146 if (defined($1)) {
3147 $oldindent = expand_tabs($1);
3148 } else {
3149 $prevrawline =~ m@^\+(.*/?)\*@;
3150 $oldindent = expand_tabs($1);
3151 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003152 $rawline =~ m@^\+([ \t]*)\*@;
3153 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003154 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003155 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003156 WARN("BLOCK_COMMENT_STYLE",
3157 "Block comments should align the * on each line\n" . $hereprev);
3158 }
3159 }
3160
Joe Perches7f619192014-08-06 16:10:39 -07003161# check for missing blank lines after struct/union declarations
3162# with exceptions for various attributes and macros
3163 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3164 $line =~ /^\+/ &&
3165 !($line =~ /^\+\s*$/ ||
3166 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3167 $line =~ /^\+\s*MODULE_/i ||
3168 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3169 $line =~ /^\+[a-z_]*init/ ||
3170 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3171 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003172 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003173 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003174 if (CHK("LINE_SPACING",
3175 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3176 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003177 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003178 }
Joe Perches7f619192014-08-06 16:10:39 -07003179 }
3180
Joe Perches365dd4e2014-08-06 16:10:42 -07003181# check for multiple consecutive blank lines
3182 if ($prevline =~ /^[\+ ]\s*$/ &&
3183 $line =~ /^\+\s*$/ &&
3184 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003185 if (CHK("LINE_SPACING",
3186 "Please don't use multiple blank lines\n" . $hereprev) &&
3187 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003188 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003189 }
3190
Joe Perches365dd4e2014-08-06 16:10:42 -07003191 $last_blank_line = $linenr;
3192 }
3193
Joe Perches3b617e32014-04-03 14:49:28 -07003194# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003195 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3196 # actual declarations
3197 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003198 # function pointer declarations
3199 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003200 # foo bar; where foo is some local typedef or #define
3201 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3202 # known declaration macros
3203 $prevline =~ /^\+\s+$declaration_macros/) &&
3204 # for "else if" which can look like "$Ident $Ident"
3205 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3206 # other possible extensions of declaration lines
3207 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3208 # not starting a section or a macro "\" extended line
3209 $prevline =~ /(?:\{\s*|\\)$/) &&
3210 # looks like a declaration
3211 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003212 # function pointer declarations
3213 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003214 # foo bar; where foo is some local typedef or #define
3215 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3216 # known declaration macros
3217 $sline =~ /^\+\s+$declaration_macros/ ||
3218 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003219 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003220 # start or end of block or continuation of declaration
3221 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3222 # bitfield continuation
3223 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3224 # other possible extensions of declaration lines
3225 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3226 # indentation of previous and current line are the same
3227 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003228 if (WARN("LINE_SPACING",
3229 "Missing a blank line after declarations\n" . $hereprev) &&
3230 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003231 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003232 }
Joe Perches3b617e32014-04-03 14:49:28 -07003233 }
3234
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003235# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003236# Exceptions:
3237# 1) within comments
3238# 2) indented preprocessor commands
3239# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003240 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003241 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003242 if (WARN("LEADING_SPACE",
3243 "please, no spaces at the start of a line\n" . $herevet) &&
3244 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003245 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003246 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003247 }
3248
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003249# check we are in a valid C source file if not then ignore this hunk
3250 next if ($realfile !~ /\.(h|c)$/);
3251
Joe Perches5751a242017-11-17 15:28:52 -08003252# check for unusual line ending [ or (
3253 if ($line =~ /^\+.*([\[\(])\s*$/) {
3254 CHK("OPEN_ENDED_LINE",
3255 "Lines should not end with a '$1'\n" . $herecurr);
3256 }
3257
Joe Perches4dbed762017-05-08 15:55:39 -07003258# check if this appears to be the start function declaration, save the name
3259 if ($sline =~ /^\+\{\s*$/ &&
3260 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3261 $context_function = $1;
3262 }
3263
3264# check if this appears to be the end of function declaration
3265 if ($sline =~ /^\+\}\s*$/) {
3266 undef $context_function;
3267 }
3268
Joe Perches032a4c02014-08-06 16:10:29 -07003269# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003270# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003271# if the previous line is a break or return and is indented 1 tab more...
3272 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3273 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003274 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3275 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3276 defined $lines[$linenr] &&
3277 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003278 WARN("UNNECESSARY_ELSE",
3279 "else is not generally useful after a break or return\n" . $hereprev);
3280 }
3281 }
3282
Joe Perchesc00df192014-08-06 16:11:01 -07003283# check indentation of a line with a break;
3284# if the previous line is a goto or return and is indented the same # of tabs
3285 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3286 my $tabs = $1;
3287 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3288 WARN("UNNECESSARY_BREAK",
3289 "break is not useful after a goto or return\n" . $hereprev);
3290 }
3291 }
3292
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003293# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003294 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003295 WARN("CVS_KEYWORD",
3296 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003297 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003298
Joe Perches56e77d72013-02-21 16:44:14 -08003299# check for old HOTPLUG __dev<foo> section markings
3300 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3301 WARN("HOTPLUG_SECTION",
3302 "Using $1 is unnecessary\n" . $herecurr);
3303 }
3304
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003305# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003306 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3307 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003308#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003309 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003310 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003311 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003312 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003313 $stat =~ s/\n./\n /g;
3314 $cond =~ s/\n./\n /g;
3315
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003316#print "linenr<$linenr> <$stat>\n";
3317 # If this statement has no statement boundaries within
3318 # it there is no point in retrying a statement scan
3319 # until we hit end of it.
3320 my $frag = $stat; $frag =~ s/;+\s*$//;
3321 if ($frag !~ /(?:{|;)/) {
3322#print "skip<$line_nr_next>\n";
3323 $suppress_statement = $line_nr_next;
3324 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003325
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003326 # Find the real next line.
3327 $realline_next = $line_nr_next;
3328 if (defined $realline_next &&
3329 (!defined $lines[$realline_next - 1] ||
3330 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3331 $realline_next++;
3332 }
3333
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003334 my $s = $stat;
3335 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003336
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003337 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003338 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003339
3340 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003341 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003342
Andy Whitcroft463f2862009-09-21 17:04:34 -07003343 } elsif ($s =~ /^.\s*else\b/s) {
3344
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003345 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003346 } 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 -07003347 my $type = $1;
3348 $type =~ s/\s+/ /g;
3349 possible($type, "A:" . $s);
3350
Andy Whitcroft8905a672007-11-28 16:21:06 -08003351 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003352 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003353 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003354 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003355
3356 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003357 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003358 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003359 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003360
3361 # Check for any sort of function declaration.
3362 # int foo(something bar, other baz);
3363 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003364 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 -08003365 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003366
Andy Whitcroftcf655042008-03-04 14:28:20 -08003367 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003368 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003369 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003370
Andy Whitcroft8905a672007-11-28 16:21:06 -08003371 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003372 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003373
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003374 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003375 }
3376 }
3377 }
3378
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003379 }
3380
Andy Whitcroft653d4872007-06-23 17:16:34 -07003381#
3382# Checks which may be anchored in the context.
3383#
3384
3385# Check for switch () and associated case and default
3386# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003387 if ($line=~/\bswitch\s*\(.*\)/) {
3388 my $err = '';
3389 my $sep = '';
3390 my @ctx = ctx_block_outer($linenr, $realcnt);
3391 shift(@ctx);
3392 for my $ctx (@ctx) {
3393 my ($clen, $cindent) = line_stats($ctx);
3394 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3395 $indent != $cindent) {
3396 $err .= "$sep$ctx\n";
3397 $sep = '';
3398 } else {
3399 $sep = "[...]\n";
3400 }
3401 }
3402 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003403 ERROR("SWITCH_CASE_INDENT_LEVEL",
3404 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003405 }
3406 }
3407
3408# if/while/etc brace do not go on next line, unless defining a do while loop,
3409# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003410 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 -07003411 my $pre_ctx = "$1$2";
3412
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003413 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003414
3415 if ($line =~ /^\+\t{6,}/) {
3416 WARN("DEEP_INDENTATION",
3417 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3418 }
3419
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003420 my $ctx_cnt = $realcnt - $#ctx - 1;
3421 my $ctx = join("\n", @ctx);
3422
Andy Whitcroft548596d2008-07-23 21:29:01 -07003423 my $ctx_ln = $linenr;
3424 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003425
Andy Whitcroft548596d2008-07-23 21:29:01 -07003426 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3427 defined $lines[$ctx_ln - 1] &&
3428 $lines[$ctx_ln - 1] =~ /^-/)) {
3429 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3430 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003431 $ctx_ln++;
3432 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003433
Andy Whitcroft53210162008-07-23 21:29:03 -07003434 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3435 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003436
Joe Perchesd752fcc2014-08-06 16:11:05 -07003437 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003438 ERROR("OPEN_BRACE",
3439 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003440 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003441 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003442 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3443 $ctx =~ /\)\s*\;\s*$/ &&
3444 defined $lines[$ctx_ln - 1])
3445 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003446 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3447 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003448 WARN("TRAILING_SEMICOLON",
3449 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003450 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003451 }
3452 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003453 }
3454
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003455# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003456 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 -08003457 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3458 ctx_statement_block($linenr, $realcnt, 0)
3459 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003460 my ($s, $c) = ($stat, $cond);
3461
3462 substr($s, 0, length($c), '');
3463
Joe Perches9f5af482015-09-09 15:37:30 -07003464 # remove inline comments
3465 $s =~ s/$;/ /g;
3466 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003467
3468 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003469 my @newlines = ($c =~ /\n/gs);
3470 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003471
Joe Perches9f5af482015-09-09 15:37:30 -07003472 # Make sure we remove the line prefixes as we have
3473 # none on the first line, and are going to readd them
3474 # where necessary.
3475 $s =~ s/\n./\n/gs;
3476 while ($s =~ /\n\s+\\\n/) {
3477 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3478 }
3479
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003480 # We want to check the first line inside the block
3481 # starting at the end of the conditional, so remove:
3482 # 1) any blank line termination
3483 # 2) any opening brace { on end of the line
3484 # 3) any do (...) {
3485 my $continuation = 0;
3486 my $check = 0;
3487 $s =~ s/^.*\bdo\b//;
3488 $s =~ s/^\s*{//;
3489 if ($s =~ s/^\s*\\//) {
3490 $continuation = 1;
3491 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003492 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003493 $check = 1;
3494 $cond_lines++;
3495 }
3496
3497 # Also ignore a loop construct at the end of a
3498 # preprocessor statement.
3499 if (($prevline =~ /^.\s*#\s*define\s/ ||
3500 $prevline =~ /\\\s*$/) && $continuation == 0) {
3501 $check = 0;
3502 }
3503
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003504 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003505 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003506 while ($cond_ptr != $cond_lines) {
3507 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003508
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003509 # If we see an #else/#elif then the code
3510 # is not linear.
3511 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3512 $check = 0;
3513 }
3514
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003515 # Ignore:
3516 # 1) blank lines, they should be at 0,
3517 # 2) preprocessor lines, and
3518 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003519 if ($continuation ||
3520 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003521 $s =~ /^\s*#\s*?/ ||
3522 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003523 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003524 if ($s =~ s/^.*?\n//) {
3525 $cond_lines++;
3526 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003527 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003528 }
3529
3530 my (undef, $sindent) = line_stats("+" . $s);
3531 my $stat_real = raw_line($linenr, $cond_lines);
3532
3533 # Check if either of these lines are modified, else
3534 # this is not this patch's fault.
3535 if (!defined($stat_real) ||
3536 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3537 $check = 0;
3538 }
3539 if (defined($stat_real) && $cond_lines > 1) {
3540 $stat_real = "[...]\n$stat_real";
3541 }
3542
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003543 #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 -07003544
Joe Perches9f5af482015-09-09 15:37:30 -07003545 if ($check && $s ne '' &&
3546 (($sindent % 8) != 0 ||
3547 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003548 ($sindent == $indent &&
3549 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003550 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003551 WARN("SUSPECT_CODE_INDENT",
3552 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003553 }
3554 }
3555
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003556 # Track the 'values' across context and added lines.
3557 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003558 my ($curr_values, $curr_vars) =
3559 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003560 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003561 if ($dbg_values) {
3562 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003563 print "$linenr > .$outline\n";
3564 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003565 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003566 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003567 $prev_values = substr($curr_values, -1);
3568
Andy Whitcroft00df3442007-06-08 13:47:06 -07003569#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003570 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003571
Joe Perches11ca40a2016-12-12 16:46:31 -08003572# check for dereferences that span multiple lines
3573 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3574 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3575 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3576 my $ref = $1;
3577 $line =~ /^.\s*($Lval)/;
3578 $ref .= $1;
3579 $ref =~ s/\s//g;
3580 WARN("MULTILINE_DEREFERENCE",
3581 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3582 }
3583
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003584# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003585 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 -07003586 my $type = $1;
3587 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003588 $var = "" if (!defined $var);
3589 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003590 my $sign = $1;
3591 my $pointer = $2;
3592
3593 $pointer = "" if (!defined $pointer);
3594
3595 if (WARN("UNSPECIFIED_INT",
3596 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3597 $fix) {
3598 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003599 my $comp_pointer = $pointer;
3600 $comp_pointer =~ s/\s//g;
3601 $decl .= $comp_pointer;
3602 $decl = rtrim($decl) if ($var eq "");
3603 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003604 }
3605 }
3606 }
3607
Andy Whitcroft653d4872007-06-23 17:16:34 -07003608# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003609 if ($dbg_type) {
3610 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003611 ERROR("TEST_TYPE",
3612 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003613 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003614 ERROR("TEST_NOT_TYPE",
3615 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003616 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003617 next;
3618 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003619# TEST: allow direct testing of the attribute matcher.
3620 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003621 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003622 ERROR("TEST_ATTR",
3623 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003624 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003625 ERROR("TEST_NOT_ATTR",
3626 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003627 }
3628 next;
3629 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003630
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003631# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003632 if ($line =~ /^.\s*{/ &&
3633 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003634 if (ERROR("OPEN_BRACE",
3635 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003636 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3637 fix_delete_line($fixlinenr - 1, $prevrawline);
3638 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003639 my $fixedline = $prevrawline;
3640 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003641 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003642 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003643 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003644 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003645 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003646 }
3647
Andy Whitcroft653d4872007-06-23 17:16:34 -07003648#
3649# Checks which are anchored on the added line.
3650#
3651
3652# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003653 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003654 my $path = $1;
3655 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003656 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003657 "malformed #include filename\n" . $herecurr);
3658 }
3659 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3660 ERROR("UAPI_INCLUDE",
3661 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003662 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003663 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003664
3665# no C99 // comments
3666 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003667 if (ERROR("C99_COMMENTS",
3668 "do not use C99 // comments\n" . $herecurr) &&
3669 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003670 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003671 if ($line =~ /\/\/(.*)$/) {
3672 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003673 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003674 }
3675 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003676 }
3677 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003678 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003679 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003680
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003681# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3682# the whole statement.
3683#print "APW <$lines[$realline_next - 1]>\n";
3684 if (defined $realline_next &&
3685 exists $lines[$realline_next - 1] &&
3686 !defined $suppress_export{$realline_next} &&
3687 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3688 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003689 # Handle definitions which produce identifiers with
3690 # a prefix:
3691 # XXX(foo);
3692 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003693 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003694 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003695 $name =~ /^${Ident}_$2/) {
3696#print "FOO C name<$name>\n";
3697 $suppress_export{$realline_next} = 1;
3698
3699 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003700 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003701 ^.DEFINE_$Ident\(\Q$name\E\)|
3702 ^.DECLARE_$Ident\(\Q$name\E\)|
3703 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003704 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3705 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003706 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003707#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3708 $suppress_export{$realline_next} = 2;
3709 } else {
3710 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003711 }
3712 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003713 if (!defined $suppress_export{$linenr} &&
3714 $prevline =~ /^.\s*$/ &&
3715 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3716 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3717#print "FOO B <$lines[$linenr - 1]>\n";
3718 $suppress_export{$linenr} = 2;
3719 }
3720 if (defined $suppress_export{$linenr} &&
3721 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003722 WARN("EXPORT_SYMBOL",
3723 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003724 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003725
Joe Eloff5150bda2010-08-09 17:21:00 -07003726# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003727 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003728 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003729 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003730 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003731 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003732 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003733 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003734# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003735 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003736 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003737 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003738 $herecurr) &&
3739 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003740 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003741 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003742 }
3743
Joe Perches18130872014-08-06 16:11:22 -07003744# check for misordered declarations of char/short/int/long with signed/unsigned
3745 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3746 my $tmp = trim($1);
3747 WARN("MISORDERED_TYPE",
3748 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3749 }
3750
Joe Perchescb710ec2010-10-26 14:23:20 -07003751# check for static const char * arrays.
3752 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003753 WARN("STATIC_CONST_CHAR_ARRAY",
3754 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003755 $herecurr);
3756 }
3757
3758# check for static char foo[] = "bar" declarations.
3759 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003760 WARN("STATIC_CONST_CHAR_ARRAY",
3761 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003762 $herecurr);
3763 }
3764
Joe Perchesab7e23f2015-04-16 12:44:22 -07003765# check for const <foo> const where <foo> is not a pointer or array type
3766 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3767 my $found = $1;
3768 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3769 WARN("CONST_CONST",
3770 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3771 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3772 WARN("CONST_CONST",
3773 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3774 }
3775 }
3776
Joe Perches9b0fa602014-04-03 14:49:18 -07003777# check for non-global char *foo[] = {"bar", ...} declarations.
3778 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3779 WARN("STATIC_CONST_CHAR_ARRAY",
3780 "char * array declaration might be better as static const\n" .
3781 $herecurr);
3782 }
3783
Joe Perchesb598b672015-04-16 12:44:36 -07003784# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3785 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3786 my $array = $1;
3787 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3788 my $array_div = $1;
3789 if (WARN("ARRAY_SIZE",
3790 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3791 $fix) {
3792 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3793 }
3794 }
3795 }
3796
Joe Perchesb36190c2014-01-27 17:07:18 -08003797# check for function declarations without arguments like "int foo()"
3798 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3799 if (ERROR("FUNCTION_WITHOUT_ARGS",
3800 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3801 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003802 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003803 }
3804 }
3805
Andy Whitcroft653d4872007-06-23 17:16:34 -07003806# check for new typedefs, only function parameters and sparse annotations
3807# make sense.
3808 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003809 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003810 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003811 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003812 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003813 WARN("NEW_TYPEDEFS",
3814 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003815 }
3816
3817# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003818 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003819 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3820 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003821 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003822
Andy Whitcroft65863862009-01-06 14:41:21 -08003823 # Should start with a space.
3824 $to =~ s/^(\S)/ $1/;
3825 # Should not end with a space.
3826 $to =~ s/\s+$//;
3827 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003828 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003829 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003830
Joe Perches3705ce52013-07-03 15:05:31 -07003831## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003832 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003833 if (ERROR("POINTER_LOCATION",
3834 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3835 $fix) {
3836 my $sub_from = $ident;
3837 my $sub_to = $ident;
3838 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003839 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003840 s@\Q$sub_from\E@$sub_to@;
3841 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003842 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003843 }
3844 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3845 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003846 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003847
Andy Whitcroft65863862009-01-06 14:41:21 -08003848 # Should start with a space.
3849 $to =~ s/^(\S)/ $1/;
3850 # Should not end with a space.
3851 $to =~ s/\s+$//;
3852 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003853 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003854 }
3855 # Modifiers should have spaces.
3856 $to =~ s/(\b$Modifier$)/$1 /;
3857
Joe Perches3705ce52013-07-03 15:05:31 -07003858## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003859 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003860 if (ERROR("POINTER_LOCATION",
3861 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3862 $fix) {
3863
3864 my $sub_from = $match;
3865 my $sub_to = $match;
3866 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003867 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003868 s@\Q$sub_from\E@$sub_to@;
3869 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003870 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003871 }
3872
Joe Perches9d3e3c72015-09-09 15:37:27 -07003873# avoid BUG() or BUG_ON()
3874 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003875 my $msg_level = \&WARN;
3876 $msg_level = \&CHK if ($file);
3877 &{$msg_level}("AVOID_BUG",
3878 "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 -07003879 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003880
Joe Perches9d3e3c72015-09-09 15:37:27 -07003881# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003882 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003883 WARN("LINUX_VERSION_CODE",
3884 "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 -08003885 }
3886
Joe Perches17441222011-06-15 15:08:17 -07003887# check for uses of printk_ratelimit
3888 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003889 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003890 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003891 }
3892
Joe Percheseeef5732017-11-17 15:28:41 -08003893# printk should use KERN_* levels
3894 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3895 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3896 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003897 }
3898
Joe Perches243f3802012-05-31 16:26:09 -07003899 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3900 my $orig = $1;
3901 my $level = lc($orig);
3902 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003903 my $level2 = $level;
3904 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003905 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003906 "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 -07003907 }
3908
3909 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003910 if (WARN("PREFER_PR_LEVEL",
3911 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3912 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003913 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003914 s/\bpr_warning\b/pr_warn/;
3915 }
Joe Perches243f3802012-05-31 16:26:09 -07003916 }
3917
Joe Perchesdc139312013-02-21 16:44:13 -08003918 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3919 my $orig = $1;
3920 my $level = lc($orig);
3921 $level = "warn" if ($level eq "warning");
3922 $level = "dbg" if ($level eq "debug");
3923 WARN("PREFER_DEV_LEVEL",
3924 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3925 }
3926
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003927# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3928# number of false positives, but assembly files are not checked, so at
3929# least the arch entry code will not trigger this warning.
3930 if ($line =~ /\bENOSYS\b/) {
3931 WARN("ENOSYS",
3932 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3933 }
3934
Andy Whitcroft653d4872007-06-23 17:16:34 -07003935# function brace can't be on same line, except for #defines of do while,
3936# or if closed on same line
Joe Perches2d453e32018-02-06 15:39:09 -08003937 if ($^V && $^V ge 5.10.0 &&
3938 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3939 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3940 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07003941 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08003942 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07003943 $fix) {
3944 fix_delete_line($fixlinenr, $rawline);
3945 my $fixed_line = $rawline;
3946 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3947 my $line1 = $1;
3948 my $line2 = $2;
3949 fix_insert_line($fixlinenr, ltrim($line1));
3950 fix_insert_line($fixlinenr, "\+{");
3951 if ($line2 !~ /^\s*$/) {
3952 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3953 }
3954 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003955 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003956
Andy Whitcroft8905a672007-11-28 16:21:06 -08003957# open braces for enum, union and struct go on the same line.
3958 if ($line =~ /^.\s*{/ &&
3959 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003960 if (ERROR("OPEN_BRACE",
3961 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3962 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3963 fix_delete_line($fixlinenr - 1, $prevrawline);
3964 fix_delete_line($fixlinenr, $rawline);
3965 my $fixedline = rtrim($prevrawline) . " {";
3966 fix_insert_line($fixlinenr, $fixedline);
3967 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003968 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003969 if ($fixedline !~ /^\+\s*$/) {
3970 fix_insert_line($fixlinenr, $fixedline);
3971 }
3972 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003973 }
3974
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003975# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003976 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3977 if (WARN("SPACING",
3978 "missing space after $1 definition\n" . $herecurr) &&
3979 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003980 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003981 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3982 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003983 }
3984
Joe Perches31070b52014-01-23 15:54:49 -08003985# Function pointer declarations
3986# check spacing between type, funcptr, and args
3987# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003988 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003989 my $declare = $1;
3990 my $pre_pointer_space = $2;
3991 my $post_pointer_space = $3;
3992 my $funcname = $4;
3993 my $post_funcname_space = $5;
3994 my $pre_args_space = $6;
3995
Joe Perches91f72e92014-04-03 14:49:12 -07003996# the $Declare variable will capture all spaces after the type
3997# so check it for a missing trailing missing space but pointer return types
3998# don't need a space so don't warn for those.
3999 my $post_declare_space = "";
4000 if ($declare =~ /(\s+)$/) {
4001 $post_declare_space = $1;
4002 $declare = rtrim($declare);
4003 }
4004 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004005 WARN("SPACING",
4006 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004007 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004008 }
4009
4010# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004011# This test is not currently implemented because these declarations are
4012# equivalent to
4013# int foo(int bar, ...)
4014# and this is form shouldn't/doesn't generate a checkpatch warning.
4015#
4016# elsif ($declare =~ /\s{2,}$/) {
4017# WARN("SPACING",
4018# "Multiple spaces after return type\n" . $herecurr);
4019# }
Joe Perches31070b52014-01-23 15:54:49 -08004020
4021# unnecessary space "type ( *funcptr)(args...)"
4022 if (defined $pre_pointer_space &&
4023 $pre_pointer_space =~ /^\s/) {
4024 WARN("SPACING",
4025 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4026 }
4027
4028# unnecessary space "type (* funcptr)(args...)"
4029 if (defined $post_pointer_space &&
4030 $post_pointer_space =~ /^\s/) {
4031 WARN("SPACING",
4032 "Unnecessary space before function pointer name\n" . $herecurr);
4033 }
4034
4035# unnecessary space "type (*funcptr )(args...)"
4036 if (defined $post_funcname_space &&
4037 $post_funcname_space =~ /^\s/) {
4038 WARN("SPACING",
4039 "Unnecessary space after function pointer name\n" . $herecurr);
4040 }
4041
4042# unnecessary space "type (*funcptr) (args...)"
4043 if (defined $pre_args_space &&
4044 $pre_args_space =~ /^\s/) {
4045 WARN("SPACING",
4046 "Unnecessary space before function pointer arguments\n" . $herecurr);
4047 }
4048
4049 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004050 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004051 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004052 }
4053 }
4054
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004055# check for spacing round square brackets; allowed:
4056# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004057# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4058# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004059 while ($line =~ /(.*?\s)\[/g) {
4060 my ($where, $prefix) = ($-[1], $1);
4061 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004062 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004063 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004064 if (ERROR("BRACKET_SPACE",
4065 "space prohibited before open square bracket '['\n" . $herecurr) &&
4066 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004067 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004068 s/^(\+.*?)\s+\[/$1\[/;
4069 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004070 }
4071 }
4072
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004073# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004074 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004075 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004076 my $ctx_before = substr($line, 0, $-[1]);
4077 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004078
4079 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004080 if ($name =~ /^(?:
4081 if|for|while|switch|return|case|
4082 volatile|__volatile__|
4083 __attribute__|format|__extension__|
4084 asm|__asm__)$/x)
4085 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004086 # cpp #define statements have non-optional spaces, ie
4087 # if there is a space between the name and the open
4088 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004089 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004090
4091 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004092 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004093
4094 # If this whole things ends with a type its most
4095 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004096 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004097
4098 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004099 if (WARN("SPACING",
4100 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4101 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004102 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004103 s/\b$name\s+\(/$name\(/;
4104 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004105 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004106 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004107
Andy Whitcroft653d4872007-06-23 17:16:34 -07004108# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004109 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004110 my $fixed_line = "";
4111 my $line_fixed = 0;
4112
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004113 my $ops = qr{
4114 <<=|>>=|<=|>=|==|!=|
4115 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4116 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004117 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004118 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004119 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004120 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004121
4122## print("element count: <" . $#elements . ">\n");
4123## foreach my $el (@elements) {
4124## print("el: <$el>\n");
4125## }
4126
4127 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004128 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004129
Joe Perches3705ce52013-07-03 15:05:31 -07004130 foreach my $el (@elements) {
4131 push(@fix_elements, substr($rawline, $off, length($el)));
4132 $off += length($el);
4133 }
4134
4135 $off = 0;
4136
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004137 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004138 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004139
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004140 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004141
4142 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4143
4144## print("n: <$n> good: <$good>\n");
4145
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004146 $off += length($elements[$n]);
4147
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004148 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004149 my $ca = substr($opline, 0, $off);
4150 my $cc = '';
4151 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4152 $cc = substr($opline, $off + length($elements[$n + 1]));
4153 }
4154 my $cb = "$ca$;$cc";
4155
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004156 my $a = '';
4157 $a = 'V' if ($elements[$n] ne '');
4158 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004159 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004160 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4161 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004162 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004163
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004164 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004165
4166 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004167 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004168 $c = 'V' if ($elements[$n + 2] ne '');
4169 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004170 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004171 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4172 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004173 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004174 } else {
4175 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004176 }
4177
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004178 my $ctx = "${a}x${c}";
4179
4180 my $at = "(ctx:$ctx)";
4181
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004182 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004183 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004184
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004185 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004186 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004187
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004188 # Get the full operator variant.
4189 my $opv = $op . substr($curr_vars, $off, 1);
4190
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004191 # Ignore operators passed as parameters.
4192 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004193 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004194
Andy Whitcroftcf655042008-03-04 14:28:20 -08004195# # Ignore comments
4196# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004197
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004198 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004199 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004200 if ($ctx !~ /.x[WEBC]/ &&
4201 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004202 if (ERROR("SPACING",
4203 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004204 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004205 $line_fixed = 1;
4206 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004207 }
4208
4209 # // is a comment
4210 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004211
Joe Perchesb00e4812014-04-03 14:49:33 -07004212 # : when part of a bitfield
4213 } elsif ($opv eq ':B') {
4214 # skip the bitfield test for now
4215
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004216 # No spaces for:
4217 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004218 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004219 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004220 if (ERROR("SPACING",
4221 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004222 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004223 if (defined $fix_elements[$n + 2]) {
4224 $fix_elements[$n + 2] =~ s/^\s+//;
4225 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004226 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004227 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004228 }
4229
Joe Perches23810972014-12-10 15:51:32 -08004230 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004231 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004232 my $rtrim_before = 0;
4233 my $space_after = 0;
4234 if ($ctx =~ /Wx./) {
4235 if (ERROR("SPACING",
4236 "space prohibited before that '$op' $at\n" . $hereptr)) {
4237 $line_fixed = 1;
4238 $rtrim_before = 1;
4239 }
4240 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004241 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004242 if (ERROR("SPACING",
4243 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004244 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004245 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004246 $space_after = 1;
4247 }
4248 }
4249 if ($rtrim_before || $space_after) {
4250 if ($rtrim_before) {
4251 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4252 } else {
4253 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4254 }
4255 if ($space_after) {
4256 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004257 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004258 }
4259
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004260 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004261 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004262 #warn "'*' is part of type\n";
4263
4264 # unary operators should have a space before and
4265 # none after. May be left adjacent to another
4266 # unary operator, or a cast
4267 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004268 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004269 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004270 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004271 if (ERROR("SPACING",
4272 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004273 if ($n != $last_after + 2) {
4274 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4275 $line_fixed = 1;
4276 }
Joe Perches3705ce52013-07-03 15:05:31 -07004277 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004278 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004279 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004280 # A unary '*' may be const
4281
4282 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004283 if (ERROR("SPACING",
4284 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004285 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004286 if (defined $fix_elements[$n + 2]) {
4287 $fix_elements[$n + 2] =~ s/^\s+//;
4288 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004289 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004290 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004291 }
4292
4293 # unary ++ and unary -- are allowed no space on one side.
4294 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004295 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004296 if (ERROR("SPACING",
4297 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004298 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004299 $line_fixed = 1;
4300 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004301 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004302 if ($ctx =~ /Wx[BE]/ ||
4303 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004304 if (ERROR("SPACING",
4305 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004306 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004307 $line_fixed = 1;
4308 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004309 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004310 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004311 if (ERROR("SPACING",
4312 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004313 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004314 if (defined $fix_elements[$n + 2]) {
4315 $fix_elements[$n + 2] =~ s/^\s+//;
4316 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004317 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004318 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004319 }
4320
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004321 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004322 } elsif ($op eq '<<' or $op eq '>>' or
4323 $op eq '&' or $op eq '^' or $op eq '|' or
4324 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004325 $op eq '*' or $op eq '/' or
4326 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004327 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004328 if ($check) {
4329 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4330 if (CHK("SPACING",
4331 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4332 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4333 $fix_elements[$n + 2] =~ s/^\s+//;
4334 $line_fixed = 1;
4335 }
4336 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4337 if (CHK("SPACING",
4338 "space preferred before that '$op' $at\n" . $hereptr)) {
4339 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4340 $line_fixed = 1;
4341 }
4342 }
4343 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004344 if (ERROR("SPACING",
4345 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004346 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4347 if (defined $fix_elements[$n + 2]) {
4348 $fix_elements[$n + 2] =~ s/^\s+//;
4349 }
Joe Perches3705ce52013-07-03 15:05:31 -07004350 $line_fixed = 1;
4351 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004352 }
4353
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004354 # A colon needs no spaces before when it is
4355 # terminating a case value or a label.
4356 } elsif ($opv eq ':C' || $opv eq ':L') {
4357 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004358 if (ERROR("SPACING",
4359 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004360 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004361 $line_fixed = 1;
4362 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004363 }
4364
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004365 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004366 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004367 my $ok = 0;
4368
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004369 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004370 if (($op eq '<' &&
4371 $cc =~ /^\S+\@\S+>/) ||
4372 ($op eq '>' &&
4373 $ca =~ /<\S+\@\S+$/))
4374 {
4375 $ok = 1;
4376 }
4377
Joe Perchese0df7e12015-04-16 12:44:53 -07004378 # for asm volatile statements
4379 # ignore a colon with another
4380 # colon immediately before or after
4381 if (($op eq ':') &&
4382 ($ca =~ /:$/ || $cc =~ /^:/)) {
4383 $ok = 1;
4384 }
4385
Joe Perches84731622013-11-12 15:10:05 -08004386 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004387 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004388 my $msg_level = \&ERROR;
4389 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004390
Jean Delvare0675a8f2017-09-08 16:16:07 -07004391 if (&{$msg_level}("SPACING",
4392 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004393 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4394 if (defined $fix_elements[$n + 2]) {
4395 $fix_elements[$n + 2] =~ s/^\s+//;
4396 }
Joe Perches3705ce52013-07-03 15:05:31 -07004397 $line_fixed = 1;
4398 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004399 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004400 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004401 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004402
4403## print("n: <$n> GOOD: <$good>\n");
4404
4405 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004406 }
Joe Perches3705ce52013-07-03 15:05:31 -07004407
4408 if (($#elements % 2) == 0) {
4409 $fixed_line = $fixed_line . $fix_elements[$#elements];
4410 }
4411
Joe Perches194f66f2014-08-06 16:11:03 -07004412 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4413 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004414 }
4415
4416
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004417 }
4418
Joe Perches786b6322013-07-03 15:05:32 -07004419# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004420 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004421 if (WARN("SPACING",
4422 "space prohibited before semicolon\n" . $herecurr) &&
4423 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004424 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004425 s/^(\+.*\S)\s+;/$1;/;
4426 }
4427 }
4428
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004429# check for multiple assignments
4430 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004431 CHK("MULTIPLE_ASSIGNMENTS",
4432 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004433 }
4434
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004435## # check for multiple declarations, allowing for a function declaration
4436## # continuation.
4437## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4438## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4439##
4440## # Remove any bracketed sections to ensure we do not
4441## # falsly report the parameters of functions.
4442## my $ln = $line;
4443## while ($ln =~ s/\([^\(\)]*\)//g) {
4444## }
4445## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004446## WARN("MULTIPLE_DECLARATION",
4447## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004448## }
4449## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004450
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004451#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004452 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004453 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004454 if (ERROR("SPACING",
4455 "space required before the open brace '{'\n" . $herecurr) &&
4456 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004457 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004458 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004459 }
4460
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004461## # check for blank lines before declarations
4462## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4463## $prevrawline =~ /^.\s*$/) {
4464## WARN("SPACING",
4465## "No blank lines before declarations\n" . $hereprev);
4466## }
4467##
4468
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004469# closing brace should have a space following it when it has anything
4470# on the line
4471 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004472 if (ERROR("SPACING",
4473 "space required after that close brace '}'\n" . $herecurr) &&
4474 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004475 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004476 s/}((?!(?:,|;|\)))\S)/} $1/;
4477 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004478 }
4479
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004480# check spacing on square brackets
4481 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004482 if (ERROR("SPACING",
4483 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4484 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004485 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004486 s/\[\s+/\[/;
4487 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004488 }
4489 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004490 if (ERROR("SPACING",
4491 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4492 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004493 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004494 s/\s+\]/\]/;
4495 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004496 }
4497
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004498# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004499 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4500 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004501 if (ERROR("SPACING",
4502 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4503 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004504 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004505 s/\(\s+/\(/;
4506 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004507 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004508 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004509 $line !~ /for\s*\(.*;\s+\)/ &&
4510 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004511 if (ERROR("SPACING",
4512 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4513 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004514 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004515 s/\s+\)/\)/;
4516 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004517 }
4518
Joe Perchese2826fd2014-08-06 16:10:48 -07004519# check unnecessary parentheses around addressof/dereference single $Lvals
4520# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4521
4522 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004523 my $var = $1;
4524 if (CHK("UNNECESSARY_PARENTHESES",
4525 "Unnecessary parentheses around $var\n" . $herecurr) &&
4526 $fix) {
4527 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4528 }
4529 }
4530
4531# check for unnecessary parentheses around function pointer uses
4532# ie: (foo->bar)(); should be foo->bar();
4533# but not "if (foo->bar) (" to avoid some false positives
4534 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4535 my $var = $2;
4536 if (CHK("UNNECESSARY_PARENTHESES",
4537 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4538 $fix) {
4539 my $var2 = deparenthesize($var);
4540 $var2 =~ s/\s//g;
4541 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4542 }
4543 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004544
Joe Perches63b7c732017-09-08 16:16:01 -07004545# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004546# when !drivers/staging or command-line uses --strict
4547 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4548 $^V && $^V ge 5.10.0 && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004549 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4550 my $if_stat = $1;
4551 my $test = substr($2, 1, -1);
4552 my $herectx;
4553 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4554 my $match = $1;
4555 # avoid parentheses around potential macro args
4556 next if ($match =~ /^\s*\w+\s*$/);
4557 if (!defined($herectx)) {
4558 $herectx = $here . "\n";
4559 my $cnt = statement_rawlines($if_stat);
4560 for (my $n = 0; $n < $cnt; $n++) {
4561 my $rl = raw_line($linenr, $n);
4562 $herectx .= $rl . "\n";
4563 last if $rl =~ /^[ \+].*\{/;
4564 }
4565 }
4566 CHK("UNNECESSARY_PARENTHESES",
4567 "Unnecessary parentheses around '$match'\n" . $herectx);
4568 }
4569 }
4570
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004571#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004572 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004573 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004574 if (WARN("INDENTED_LABEL",
4575 "labels should not be indented\n" . $herecurr) &&
4576 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004577 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004578 s/^(.)\s+/$1/;
4579 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004580 }
4581
Joe Perches5b9553a2014-04-03 14:49:21 -07004582# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004583 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004584 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004585 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004586 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4587 my $value = $1;
4588 $value = deparenthesize($value);
4589 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4590 ERROR("RETURN_PARENTHESES",
4591 "return is not a function, parentheses are not required\n" . $herecurr);
4592 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004593 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004594 ERROR("SPACING",
4595 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004596 }
4597 }
Joe Perches507e5142013-11-12 15:10:13 -08004598
Joe Perchesb43ae212014-06-23 13:22:07 -07004599# unnecessary return in a void function
4600# at end-of-function, with the previous line a single leading tab, then return;
4601# and the line before that not a goto label target like "out:"
4602 if ($sline =~ /^[ \+]}\s*$/ &&
4603 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4604 $linenr >= 3 &&
4605 $lines[$linenr - 3] =~ /^[ +]/ &&
4606 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004607 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004608 "void function return statements are not generally useful\n" . $hereprev);
4609 }
Joe Perches9819cf22014-06-04 16:12:09 -07004610
Joe Perches189248d2014-01-23 15:54:47 -08004611# if statements using unnecessary parentheses - ie: if ((foo == bar))
4612 if ($^V && $^V ge 5.10.0 &&
4613 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4614 my $openparens = $1;
4615 my $count = $openparens =~ tr@\(@\(@;
4616 my $msg = "";
4617 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4618 my $comp = $4; #Not $1 because of $LvalOrFunc
4619 $msg = " - maybe == should be = ?" if ($comp eq "==");
4620 WARN("UNNECESSARY_PARENTHESES",
4621 "Unnecessary parentheses$msg\n" . $herecurr);
4622 }
4623 }
4624
Joe Perchesc5595fa2015-09-09 15:37:58 -07004625# comparisons with a constant or upper case identifier on the left
4626# avoid cases like "foo + BAR < baz"
4627# only fix matches surrounded by parentheses to avoid incorrect
4628# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4629 if ($^V && $^V ge 5.10.0 &&
4630 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4631 my $lead = $1;
4632 my $const = $2;
4633 my $comp = $3;
4634 my $to = $4;
4635 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004636 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004637 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4638 WARN("CONSTANT_COMPARISON",
4639 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4640 $fix) {
4641 if ($comp eq "<") {
4642 $newcomp = ">";
4643 } elsif ($comp eq "<=") {
4644 $newcomp = ">=";
4645 } elsif ($comp eq ">") {
4646 $newcomp = "<";
4647 } elsif ($comp eq ">=") {
4648 $newcomp = "<=";
4649 }
4650 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4651 }
4652 }
4653
Joe Perchesf34e4a42015-04-16 12:44:19 -07004654# Return of what appears to be an errno should normally be negative
4655 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004656 my $name = $1;
4657 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004658 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004659 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004660 }
4661 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004662
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004663# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004664 if ($line =~ /\b(if|while|for|switch)\(/) {
4665 if (ERROR("SPACING",
4666 "space required before the open parenthesis '('\n" . $herecurr) &&
4667 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004668 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004669 s/\b(if|while|for|switch)\(/$1 \(/;
4670 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004671 }
4672
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004673# Check for illegal assignment in if conditional -- and check for trailing
4674# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004675 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004676 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4677 ctx_statement_block($linenr, $realcnt, 0)
4678 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004679 my ($stat_next) = ctx_statement_block($line_nr_next,
4680 $remain_next, $off_next);
4681 $stat_next =~ s/\n./\n /g;
4682 ##print "stat<$stat> stat_next<$stat_next>\n";
4683
4684 if ($stat_next =~ /^\s*while\b/) {
4685 # If the statement carries leading newlines,
4686 # then count those as offsets.
4687 my ($whitespace) =
4688 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4689 my $offset =
4690 statement_rawlines($whitespace) - 1;
4691
4692 $suppress_whiletrailers{$line_nr_next +
4693 $offset} = 1;
4694 }
4695 }
4696 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004697 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004698 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004699 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004700
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004701 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004702 ERROR("ASSIGN_IN_IF",
4703 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004704 }
4705
4706 # Find out what is on the end of the line after the
4707 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004708 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004709 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004710 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004711 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4712 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004713 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004714 # Find out how long the conditional actually is.
4715 my @newlines = ($c =~ /\n/gs);
4716 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004717 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004718
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004719 $stat_real = raw_line($linenr, $cond_lines)
4720 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004721 if (defined($stat_real) && $cond_lines > 1) {
4722 $stat_real = "[...]\n$stat_real";
4723 }
4724
Joe Perches000d1cc12011-07-25 17:13:25 -07004725 ERROR("TRAILING_STATEMENTS",
4726 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004727 }
4728 }
4729
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004730# Check for bitwise tests written as boolean
4731 if ($line =~ /
4732 (?:
4733 (?:\[|\(|\&\&|\|\|)
4734 \s*0[xX][0-9]+\s*
4735 (?:\&\&|\|\|)
4736 |
4737 (?:\&\&|\|\|)
4738 \s*0[xX][0-9]+\s*
4739 (?:\&\&|\|\||\)|\])
4740 )/x)
4741 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004742 WARN("HEXADECIMAL_BOOLEAN_TEST",
4743 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004744 }
4745
Andy Whitcroft8905a672007-11-28 16:21:06 -08004746# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004747 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4748 my $s = $1;
4749 $s =~ s/$;//g; # Remove any comments
4750 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004751 ERROR("TRAILING_STATEMENTS",
4752 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004753 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004754 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004755# if should not continue a brace
4756 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004757 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004758 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004759 $herecurr);
4760 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004761# case and default should not have general statements after them
4762 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4763 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004764 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004765 \s*return\s+
4766 )/xg)
4767 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004768 ERROR("TRAILING_STATEMENTS",
4769 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004770 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004771
4772 # Check for }<nl>else {, these must be at the same
4773 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004774 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4775 $previndent == $indent) {
4776 if (ERROR("ELSE_AFTER_BRACE",
4777 "else should follow close brace '}'\n" . $hereprev) &&
4778 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4779 fix_delete_line($fixlinenr - 1, $prevrawline);
4780 fix_delete_line($fixlinenr, $rawline);
4781 my $fixedline = $prevrawline;
4782 $fixedline =~ s/}\s*$//;
4783 if ($fixedline !~ /^\+\s*$/) {
4784 fix_insert_line($fixlinenr, $fixedline);
4785 }
4786 $fixedline = $rawline;
4787 $fixedline =~ s/^(.\s*)else/$1} else/;
4788 fix_insert_line($fixlinenr, $fixedline);
4789 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004790 }
4791
Joe Perches8b8856f2014-08-06 16:11:14 -07004792 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4793 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004794 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4795
4796 # Find out what is on the end of the line after the
4797 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004798 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004799 $s =~ s/\n.*//g;
4800
4801 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004802 if (ERROR("WHILE_AFTER_BRACE",
4803 "while should follow close brace '}'\n" . $hereprev) &&
4804 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4805 fix_delete_line($fixlinenr - 1, $prevrawline);
4806 fix_delete_line($fixlinenr, $rawline);
4807 my $fixedline = $prevrawline;
4808 my $trailing = $rawline;
4809 $trailing =~ s/^\+//;
4810 $trailing = trim($trailing);
4811 $fixedline =~ s/}\s*$/} $trailing/;
4812 fix_insert_line($fixlinenr, $fixedline);
4813 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004814 }
4815 }
4816
Joe Perches95e2c602013-07-03 15:05:20 -07004817#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004818 while ($line =~ m{($Constant|$Lval)}g) {
4819 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004820
4821#gcc binary extension
4822 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004823 if (WARN("GCC_BINARY_CONSTANT",
4824 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4825 $fix) {
4826 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004827 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004828 s/\b$var\b/$hexval/;
4829 }
Joe Perches95e2c602013-07-03 15:05:20 -07004830 }
4831
4832#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004833 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004834 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004835#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004836 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004837#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004838 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4839#Ignore some three character SI units explicitly, like MiB and KHz
4840 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004841 while ($var =~ m{($Ident)}g) {
4842 my $word = $1;
4843 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004844 if ($check) {
4845 seed_camelcase_includes();
4846 if (!$file && !$camelcase_file_seeded) {
4847 seed_camelcase_file($realfile);
4848 $camelcase_file_seeded = 1;
4849 }
4850 }
Joe Perches7e781f62013-09-11 14:23:55 -07004851 if (!defined $camelcase{$word}) {
4852 $camelcase{$word} = 1;
4853 CHK("CAMELCASE",
4854 "Avoid CamelCase: <$word>\n" . $herecurr);
4855 }
Joe Perches34456862013-07-03 15:05:34 -07004856 }
Joe Perches323c1262012-12-17 16:02:07 -08004857 }
4858 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004859
4860#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004861 if ($line =~ /\#\s*define.*\\\s+$/) {
4862 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4863 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4864 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004865 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004866 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004867 }
4868
Fabian Frederick0e212e02015-04-16 12:44:25 -07004869# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4870# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004871 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004872 my $file = "$1.h";
4873 my $checkfile = "include/linux/$file";
4874 if (-f "$root/$checkfile" &&
4875 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004876 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004877 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004878 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4879 if ($asminclude > 0) {
4880 if ($realfile =~ m{^arch/}) {
4881 CHK("ARCH_INCLUDE_LINUX",
4882 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4883 } else {
4884 WARN("INCLUDE_LINUX",
4885 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4886 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004887 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004888 }
4889 }
4890
Andy Whitcroft653d4872007-06-23 17:16:34 -07004891# multi-statement macros should be enclosed in a do while loop, grab the
4892# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004893# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004894 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4895 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004896 my $ln = $linenr;
4897 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004898 my ($off, $dstat, $dcond, $rest);
4899 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004900 my $has_flow_statement = 0;
4901 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004902 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004903 ctx_statement_block($linenr, $realcnt, 0);
4904 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004905 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004906 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004907
Joe Perches08a28432014-10-13 15:51:55 -07004908 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004909 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004910
Joe Perchesf59b64b2016-10-11 13:52:08 -07004911 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4912 my $define_args = $1;
4913 my $define_stmt = $dstat;
4914 my @def_args = ();
4915
4916 if (defined $define_args && $define_args ne "") {
4917 $define_args = substr($define_args, 1, length($define_args) - 2);
4918 $define_args =~ s/\s*//g;
4919 @def_args = split(",", $define_args);
4920 }
4921
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004922 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004923 $dstat =~ s/\\\n.//g;
4924 $dstat =~ s/^\s*//s;
4925 $dstat =~ s/\s*$//s;
4926
4927 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004928 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4929 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004930 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004931 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004932 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004933
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004934 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004935 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4936 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004937 {
4938 }
4939
Joe Perches42e15292016-03-15 14:58:01 -07004940 # Make asm volatile uses seem like a generic function
4941 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4942
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004943 my $exceptions = qr{
4944 $Declare|
4945 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004946 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004947 DECLARE_PER_CPU|
4948 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004949 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004950 union|
4951 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004952 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004953 ^\"|\"$|
4954 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004955 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004956 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004957
4958 $ctx =~ s/\n*$//;
4959 my $herectx = $here . "\n";
4960 my $stmt_cnt = statement_rawlines($ctx);
4961
4962 for (my $n = 0; $n < $stmt_cnt; $n++) {
4963 $herectx .= raw_line($linenr, $n) . "\n";
4964 }
4965
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004966 if ($dstat ne '' &&
4967 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4968 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004969 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004970 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004971 $dstat !~ /$exceptions/ &&
4972 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004973 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004974 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004975 $dstat !~ /^for\s*$Constant$/ && # for (...)
4976 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4977 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004978 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004979 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004980 {
Joe Perchese7955562017-05-08 15:55:48 -07004981 if ($dstat =~ /^\s*if\b/) {
4982 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4983 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4984 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004985 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4986 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4987 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004988 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004989 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004990 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004991
4992 }
Joe Perches52076492016-10-11 13:52:14 -07004993
4994 # Make $define_stmt single line, comment-free, etc
4995 my @stmt_array = split('\n', $define_stmt);
4996 my $first = 1;
4997 $define_stmt = "";
4998 foreach my $l (@stmt_array) {
4999 $l =~ s/\\$//;
5000 if ($first) {
5001 $define_stmt = $l;
5002 $first = 0;
5003 } elsif ($l =~ /^[\+ ]/) {
5004 $define_stmt .= substr($l, 1);
5005 }
5006 }
5007 $define_stmt =~ s/$;//g;
5008 $define_stmt =~ s/\s+/ /g;
5009 $define_stmt = trim($define_stmt);
5010
Joe Perchesf59b64b2016-10-11 13:52:08 -07005011# check if any macro arguments are reused (ignore '...' and 'type')
5012 foreach my $arg (@def_args) {
5013 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005014 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005015 my $tmp_stmt = $define_stmt;
5016 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5017 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5018 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5019 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005020 if ($use_cnt > 1) {
5021 CHK("MACRO_ARG_REUSE",
5022 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005023 }
5024# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005025 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005026 ((defined($1) && $1 ne ',') ||
5027 (defined($2) && $2 ne ','))) {
5028 CHK("MACRO_ARG_PRECEDENCE",
5029 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005030 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005031 }
Joe Perches5023d342012-12-17 16:01:47 -08005032
Joe Perches08a28432014-10-13 15:51:55 -07005033# check for macros with flow control, but without ## concatenation
5034# ## concatenation is commonly a macro that defines a function so ignore those
5035 if ($has_flow_statement && !$has_arg_concat) {
5036 my $herectx = $here . "\n";
5037 my $cnt = statement_rawlines($ctx);
5038
5039 for (my $n = 0; $n < $cnt; $n++) {
5040 $herectx .= raw_line($linenr, $n) . "\n";
5041 }
5042 WARN("MACRO_WITH_FLOW_CONTROL",
5043 "Macros with flow control statements should be avoided\n" . "$herectx");
5044 }
5045
Joe Perches481eb482012-12-17 16:01:56 -08005046# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005047
5048 } else {
5049 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005050 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5051 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005052 $line =~ /^\+.*\\$/) {
5053 WARN("LINE_CONTINUATIONS",
5054 "Avoid unnecessary line continuations\n" . $herecurr);
5055 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005056 }
5057
Joe Perchesb13edf72012-07-30 14:41:24 -07005058# do {} while (0) macro tests:
5059# single-statement macros do not need to be enclosed in do while (0) loop,
5060# macro should not end with a semicolon
5061 if ($^V && $^V ge 5.10.0 &&
5062 $realfile !~ m@/vmlinux.lds.h$@ &&
5063 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5064 my $ln = $linenr;
5065 my $cnt = $realcnt;
5066 my ($off, $dstat, $dcond, $rest);
5067 my $ctx = '';
5068 ($dstat, $dcond, $ln, $cnt, $off) =
5069 ctx_statement_block($linenr, $realcnt, 0);
5070 $ctx = $dstat;
5071
5072 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005073 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005074
5075 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5076 my $stmts = $2;
5077 my $semis = $3;
5078
5079 $ctx =~ s/\n*$//;
5080 my $cnt = statement_rawlines($ctx);
5081 my $herectx = $here . "\n";
5082
5083 for (my $n = 0; $n < $cnt; $n++) {
5084 $herectx .= raw_line($linenr, $n) . "\n";
5085 }
5086
Joe Perchesac8e97f2012-08-21 16:15:53 -07005087 if (($stmts =~ tr/;/;/) == 1 &&
5088 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005089 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5090 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5091 }
5092 if (defined $semis && $semis ne "") {
5093 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5094 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5095 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005096 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5097 $ctx =~ s/\n*$//;
5098 my $cnt = statement_rawlines($ctx);
5099 my $herectx = $here . "\n";
5100
5101 for (my $n = 0; $n < $cnt; $n++) {
5102 $herectx .= raw_line($linenr, $n) . "\n";
5103 }
5104
5105 WARN("TRAILING_SEMICOLON",
5106 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005107 }
5108 }
5109
Mike Frysinger080ba922009-01-06 14:41:25 -08005110# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5111# all assignments may have only one of the following with an assignment:
5112# .
5113# ALIGN(...)
5114# VMLINUX_SYMBOL(...)
5115 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005116 WARN("MISSING_VMLINUX_SYMBOL",
5117 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005118 }
5119
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005120# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005121 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5122 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005123 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005124 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005125 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5126 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005127 my @allowed = ();
5128 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005129 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005130 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005131 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005132 for my $chunk (@chunks) {
5133 my ($cond, $block) = @{$chunk};
5134
Andy Whitcroft773647a2008-03-28 14:15:58 -07005135 # If the condition carries leading newlines, then count those as offsets.
5136 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5137 my $offset = statement_rawlines($whitespace) - 1;
5138
Joe Perchesaad4f612012-03-23 15:02:19 -07005139 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005140 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5141
5142 # We have looked at and allowed this specific line.
5143 $suppress_ifbraces{$ln + $offset} = 1;
5144
5145 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005146 $ln += statement_rawlines($block) - 1;
5147
Andy Whitcroft773647a2008-03-28 14:15:58 -07005148 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005149
5150 $seen++ if ($block =~ /^\s*{/);
5151
Joe Perchesaad4f612012-03-23 15:02:19 -07005152 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005153 if (statement_lines($cond) > 1) {
5154 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005155 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005156 }
5157 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005158 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005159 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005160 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005161 if (statement_block_size($block) > 1) {
5162 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005163 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005164 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005165 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005166 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005167 if ($seen) {
5168 my $sum_allowed = 0;
5169 foreach (@allowed) {
5170 $sum_allowed += $_;
5171 }
5172 if ($sum_allowed == 0) {
5173 WARN("BRACES",
5174 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5175 } elsif ($sum_allowed != $allow &&
5176 $seen != $allow) {
5177 CHK("BRACES",
5178 "braces {} should be used on all arms of this statement\n" . $herectx);
5179 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005180 }
5181 }
5182 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005183 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005184 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005185 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005186
Andy Whitcroftcf655042008-03-04 14:28:20 -08005187 # Check the pre-context.
5188 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5189 #print "APW: ALLOWED: pre<$1>\n";
5190 $allowed = 1;
5191 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005192
5193 my ($level, $endln, @chunks) =
5194 ctx_statement_full($linenr, $realcnt, $-[0]);
5195
Andy Whitcroftcf655042008-03-04 14:28:20 -08005196 # Check the condition.
5197 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005198 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005199 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005200 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005201 }
5202 if (statement_lines($cond) > 1) {
5203 #print "APW: ALLOWED: cond<$cond>\n";
5204 $allowed = 1;
5205 }
5206 if ($block =~/\b(?:if|for|while)\b/) {
5207 #print "APW: ALLOWED: block<$block>\n";
5208 $allowed = 1;
5209 }
5210 if (statement_block_size($block) > 1) {
5211 #print "APW: ALLOWED: lines block<$block>\n";
5212 $allowed = 1;
5213 }
5214 # Check the post-context.
5215 if (defined $chunks[1]) {
5216 my ($cond, $block) = @{$chunks[1]};
5217 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005218 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005219 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005220 if ($block =~ /^\s*\{/) {
5221 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5222 $allowed = 1;
5223 }
5224 }
5225 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005226 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005227 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005228
Andy Whitcroftf0556632008-10-15 22:02:23 -07005229 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005230 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005231 }
5232
Joe Perches000d1cc12011-07-25 17:13:25 -07005233 WARN("BRACES",
5234 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005235 }
5236 }
5237
Joe Perchese4c5bab2017-02-24 15:01:41 -08005238# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005239 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5240 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005241 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5242 }
5243
Joe Perches0979ae62012-12-17 16:01:59 -08005244# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005245 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005246 if (CHK("BRACES",
5247 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5248 $fix && $prevrawline =~ /^\+/) {
5249 fix_delete_line($fixlinenr - 1, $prevrawline);
5250 }
Joe Perches0979ae62012-12-17 16:01:59 -08005251 }
Joe Perches77b9a532013-07-03 15:05:29 -07005252 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005253 if (CHK("BRACES",
5254 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5255 $fix) {
5256 fix_delete_line($fixlinenr, $rawline);
5257 }
Joe Perches0979ae62012-12-17 16:01:59 -08005258 }
5259
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005260# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005261 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5262 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005263 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005264 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005265 }
5266
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005267# Check for user-visible strings broken across lines, which breaks the ability
5268# to grep for the string. Make exceptions when the previous string ends in a
5269# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5270# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005271 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005272 $prevline =~ /"\s*$/ &&
5273 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5274 if (WARN("SPLIT_STRING",
5275 "quoted string split across lines\n" . $hereprev) &&
5276 $fix &&
5277 $prevrawline =~ /^\+.*"\s*$/ &&
5278 $last_coalesced_string_linenr != $linenr - 1) {
5279 my $extracted_string = get_quoted_string($line, $rawline);
5280 my $comma_close = "";
5281 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5282 $comma_close = $1;
5283 }
5284
5285 fix_delete_line($fixlinenr - 1, $prevrawline);
5286 fix_delete_line($fixlinenr, $rawline);
5287 my $fixedline = $prevrawline;
5288 $fixedline =~ s/"\s*$//;
5289 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5290 fix_insert_line($fixlinenr - 1, $fixedline);
5291 $fixedline = $rawline;
5292 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5293 if ($fixedline !~ /\+\s*$/) {
5294 fix_insert_line($fixlinenr, $fixedline);
5295 }
5296 $last_coalesced_string_linenr = $linenr;
5297 }
5298 }
5299
5300# check for missing a space in a string concatenation
5301 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5302 WARN('MISSING_SPACE',
5303 "break quoted strings at a space character\n" . $hereprev);
5304 }
5305
Joe Perchese4b7d302017-05-08 15:55:51 -07005306# check for an embedded function name in a string when the function is known
5307# This does not work very well for -f --file checking as it depends on patch
5308# context providing the function name or a single line form for in-file
5309# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005310 if ($line =~ /^\+.*$String/ &&
5311 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005312 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5313 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005314 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005315 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005316 }
5317
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005318# check for spaces before a quoted newline
5319 if ($rawline =~ /^.*\".*\s\\n/) {
5320 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5321 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5322 $fix) {
5323 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5324 }
5325
5326 }
5327
Joe Perchesf17dba42014-10-13 15:51:51 -07005328# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005329 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005330 CHK("CONCATENATED_STRING",
5331 "Concatenated strings should use spaces between elements\n" . $herecurr);
5332 }
5333
Joe Perches90ad30e2014-12-10 15:51:59 -08005334# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005335 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005336 WARN("STRING_FRAGMENTS",
5337 "Consecutive strings are generally better as a single string\n" . $herecurr);
5338 }
5339
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005340# check for non-standard and hex prefixed decimal printf formats
5341 my $show_L = 1; #don't show the same defect twice
5342 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005343 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005344 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005345 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005346 # check for %L
5347 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005348 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005349 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5350 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005351 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005352 # check for %Z
5353 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5354 WARN("PRINTF_Z",
5355 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5356 $show_Z = 0;
5357 }
5358 # check for 0x<decimal>
5359 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5360 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005361 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5362 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005363 }
5364
5365# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005366 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005367 WARN("LINE_CONTINUATIONS",
5368 "Avoid line continuations in quoted strings\n" . $herecurr);
5369 }
5370
Andy Whitcroft00df3442007-06-08 13:47:06 -07005371# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005372 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005373 CHK("REDUNDANT_CODE",
5374 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005375 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005376 }
5377
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005378# check for needless "if (<foo>) fn(<foo>)" uses
5379 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005380 my $tested = quotemeta($1);
5381 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5382 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5383 my $func = $1;
5384 if (WARN('NEEDLESS_IF',
5385 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5386 $fix) {
5387 my $do_fix = 1;
5388 my $leading_tabs = "";
5389 my $new_leading_tabs = "";
5390 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5391 $leading_tabs = $1;
5392 } else {
5393 $do_fix = 0;
5394 }
5395 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5396 $new_leading_tabs = $1;
5397 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5398 $do_fix = 0;
5399 }
5400 } else {
5401 $do_fix = 0;
5402 }
5403 if ($do_fix) {
5404 fix_delete_line($fixlinenr - 1, $prevrawline);
5405 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5406 }
5407 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005408 }
5409 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005410
Joe Perchesebfdc402014-08-06 16:10:27 -07005411# check for unnecessary "Out of Memory" messages
5412 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5413 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5414 (defined $1 || defined $3) &&
5415 $linenr > 3) {
5416 my $testval = $2;
5417 my $testline = $lines[$linenr - 3];
5418
5419 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5420# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5421
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005422 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 -07005423 WARN("OOM_MESSAGE",
5424 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5425 }
5426 }
5427
Joe Perchesf78d98f2014-10-13 15:52:01 -07005428# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005429 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005430 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5431 my $level = $1;
5432 if (WARN("UNNECESSARY_KERN_LEVEL",
5433 "Possible unnecessary $level\n" . $herecurr) &&
5434 $fix) {
5435 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5436 }
5437 }
5438
Joe Perches45c55e92017-02-24 15:01:31 -08005439# check for logging continuations
5440 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5441 WARN("LOGGING_CONTINUATION",
5442 "Avoid logging continuation uses where feasible\n" . $herecurr);
5443 }
5444
Joe Perchesabb08a52014-12-10 15:51:46 -08005445# check for mask then right shift without a parentheses
5446 if ($^V && $^V ge 5.10.0 &&
5447 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5448 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5449 WARN("MASK_THEN_SHIFT",
5450 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5451 }
5452
Joe Perchesb75ac612014-12-10 15:52:02 -08005453# check for pointer comparisons to NULL
5454 if ($^V && $^V ge 5.10.0) {
5455 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5456 my $val = $1;
5457 my $equal = "!";
5458 $equal = "" if ($4 eq "!=");
5459 if (CHK("COMPARISON_TO_NULL",
5460 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5461 $fix) {
5462 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5463 }
5464 }
5465 }
5466
Joe Perches8716de32013-09-11 14:24:05 -07005467# check for bad placement of section $InitAttribute (e.g.: __initdata)
5468 if ($line =~ /(\b$InitAttribute\b)/) {
5469 my $attr = $1;
5470 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5471 my $ptr = $1;
5472 my $var = $2;
5473 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5474 ERROR("MISPLACED_INIT",
5475 "$attr should be placed after $var\n" . $herecurr)) ||
5476 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5477 WARN("MISPLACED_INIT",
5478 "$attr should be placed after $var\n" . $herecurr))) &&
5479 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005480 $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 -07005481 }
5482 }
5483 }
5484
Joe Perchese970b8842013-11-12 15:10:10 -08005485# check for $InitAttributeData (ie: __initdata) with const
5486 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5487 my $attr = $1;
5488 $attr =~ /($InitAttributePrefix)(.*)/;
5489 my $attr_prefix = $1;
5490 my $attr_type = $2;
5491 if (ERROR("INIT_ATTRIBUTE",
5492 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5493 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005494 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005495 s/$InitAttributeData/${attr_prefix}initconst/;
5496 }
5497 }
5498
5499# check for $InitAttributeConst (ie: __initconst) without const
5500 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5501 my $attr = $1;
5502 if (ERROR("INIT_ATTRIBUTE",
5503 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5504 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005505 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005506 /(^\+\s*(?:static\s+))/;
5507 $lead = rtrim($1);
5508 $lead = "$lead " if ($lead !~ /^\+$/);
5509 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005510 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005511 }
5512 }
5513
Joe Perchesc17893c2015-04-16 12:44:42 -07005514# check for __read_mostly with const non-pointer (should just be const)
5515 if ($line =~ /\b__read_mostly\b/ &&
5516 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5517 if (ERROR("CONST_READ_MOSTLY",
5518 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5519 $fix) {
5520 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5521 }
5522 }
5523
Joe Perchesfbdb8132014-04-03 14:49:14 -07005524# don't use __constant_<foo> functions outside of include/uapi/
5525 if ($realfile !~ m@^include/uapi/@ &&
5526 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5527 my $constant_func = $1;
5528 my $func = $constant_func;
5529 $func =~ s/^__constant_//;
5530 if (WARN("CONSTANT_CONVERSION",
5531 "$constant_func should be $func\n" . $herecurr) &&
5532 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005533 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005534 }
5535 }
5536
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005537# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005538 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005539 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005540 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005541 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005542 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005543 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5544 }
5545 if ($delay > 2000) {
5546 WARN("LONG_UDELAY",
5547 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005548 }
5549 }
5550
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005551# warn about unexpectedly long msleep's
5552 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5553 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005554 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005555 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005556 }
5557 }
5558
Joe Perches36ec1932013-07-03 15:05:25 -07005559# check for comparisons of jiffies
5560 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5561 WARN("JIFFIES_COMPARISON",
5562 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5563 }
5564
Joe Perches9d7a34a2013-07-03 15:05:26 -07005565# check for comparisons of get_jiffies_64()
5566 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5567 WARN("JIFFIES_COMPARISON",
5568 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5569 }
5570
Andy Whitcroft00df3442007-06-08 13:47:06 -07005571# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005572# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005573# print "#ifdef in C files should be avoided\n";
5574# print "$herecurr";
5575# $clean = 0;
5576# }
5577
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005578# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005579 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005580 if (ERROR("SPACING",
5581 "exactly one space required after that #$1\n" . $herecurr) &&
5582 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005583 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005584 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5585 }
5586
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005587 }
5588
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005589# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005590 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5591 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005592 my $which = $1;
5593 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005594 CHK("UNCOMMENTED_DEFINITION",
5595 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005596 }
5597 }
5598# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005599
5600 my $barriers = qr{
5601 mb|
5602 rmb|
5603 wmb|
5604 read_barrier_depends
5605 }x;
5606 my $barrier_stems = qr{
5607 mb__before_atomic|
5608 mb__after_atomic|
5609 store_release|
5610 load_acquire|
5611 store_mb|
5612 (?:$barriers)
5613 }x;
5614 my $all_barriers = qr{
5615 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005616 smp_(?:$barrier_stems)|
5617 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005618 }x;
5619
5620 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005621 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005622 WARN("MEMORY_BARRIER",
5623 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005624 }
5625 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005626
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005627 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5628
5629 if ($realfile !~ m@^include/asm-generic/@ &&
5630 $realfile !~ m@/barrier\.h$@ &&
5631 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5632 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5633 WARN("MEMORY_BARRIER",
5634 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5635 }
5636
Joe Perchescb426e92015-06-25 15:02:46 -07005637# check for waitqueue_active without a comment.
5638 if ($line =~ /\bwaitqueue_active\s*\(/) {
5639 if (!ctx_has_comment($first_line, $linenr)) {
5640 WARN("WAITQUEUE_ACTIVE",
5641 "waitqueue_active without comment\n" . $herecurr);
5642 }
5643 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005644
Paul E. McKenney91db2592017-11-27 09:37:35 -08005645# check for smp_read_barrier_depends and read_barrier_depends
5646 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5647 WARN("READ_BARRIER_DEPENDS",
5648 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5649 }
5650
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005651# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005652 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005653 CHK("ARCH_DEFINES",
5654 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005655 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005656
Joe Perches596ed452017-07-12 14:37:02 -07005657# check that the storage class is not after a type
5658 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005659 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005660 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5661 }
5662# Check that the storage class is at the beginning of a declaration
5663 if ($line =~ /\b$Storage\b/ &&
5664 $line !~ /^.\s*$Storage/ &&
5665 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5666 $1 !~ /[\,\)]\s*$/) {
5667 WARN("STORAGE_CLASS",
5668 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005669 }
5670
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005671# check the location of the inline attribute, that it is between
5672# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005673 if ($line =~ /\b$Type\s+$Inline\b/ ||
5674 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005675 ERROR("INLINE_LOCATION",
5676 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005677 }
5678
Andy Whitcroft8905a672007-11-28 16:21:06 -08005679# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005680 if ($realfile !~ m@\binclude/uapi/@ &&
5681 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005682 if (WARN("INLINE",
5683 "plain inline is preferred over $1\n" . $herecurr) &&
5684 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005685 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005686
5687 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005688 }
5689
Joe Perches3d130fd2011-01-12 17:00:00 -08005690# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005691 if ($realfile !~ m@\binclude/uapi/@ &&
5692 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005693 WARN("PREFER_PACKED",
5694 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005695 }
5696
Joe Perches39b7e282011-07-25 17:13:24 -07005697# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005698 if ($realfile !~ m@\binclude/uapi/@ &&
5699 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005700 WARN("PREFER_ALIGNED",
5701 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005702 }
5703
Joe Perches5f14d3b2012-01-10 15:09:52 -08005704# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005705 if ($realfile !~ m@\binclude/uapi/@ &&
5706 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005707 if (WARN("PREFER_PRINTF",
5708 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5709 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005710 $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 -07005711
5712 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005713 }
5714
Joe Perches6061d942012-03-23 15:02:16 -07005715# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005716 if ($realfile !~ m@\binclude/uapi/@ &&
5717 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005718 if (WARN("PREFER_SCANF",
5719 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5720 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005721 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005722 }
Joe Perches6061d942012-03-23 15:02:16 -07005723 }
5724
Joe Perches619a9082014-12-10 15:51:35 -08005725# Check for __attribute__ weak, or __weak declarations (may have link issues)
5726 if ($^V && $^V ge 5.10.0 &&
5727 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5728 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5729 $line =~ /\b__weak\b/)) {
5730 ERROR("WEAK_DECLARATION",
5731 "Using weak declarations can have unintended link defects\n" . $herecurr);
5732 }
5733
Tomas Winklerfd39f902016-12-12 16:46:34 -08005734# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005735 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005736 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005737 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5738 my $type = $1;
5739 if ($type =~ /\b($typeC99Typedefs)\b/) {
5740 $type = $1;
5741 my $kernel_type = 'u';
5742 $kernel_type = 's' if ($type =~ /^_*[si]/);
5743 $type =~ /(\d+)/;
5744 $kernel_type .= $1;
5745 if (CHK("PREFER_KERNEL_TYPES",
5746 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5747 $fix) {
5748 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5749 }
5750 }
5751 }
5752
Joe Perches938224b2016-01-20 14:59:15 -08005753# check for cast of C90 native int or longer types constants
5754 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5755 my $cast = $1;
5756 my $const = $2;
5757 if (WARN("TYPECAST_INT_CONSTANT",
5758 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5759 $fix) {
5760 my $suffix = "";
5761 my $newconst = $const;
5762 $newconst =~ s/${Int_type}$//;
5763 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5764 if ($cast =~ /\blong\s+long\b/) {
5765 $suffix .= 'LL';
5766 } elsif ($cast =~ /\blong\b/) {
5767 $suffix .= 'L';
5768 }
5769 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5770 }
5771 }
5772
Joe Perches8f53a9b2010-03-05 13:43:48 -08005773# check for sizeof(&)
5774 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005775 WARN("SIZEOF_ADDRESS",
5776 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005777 }
5778
Joe Perches66c80b62012-07-30 14:41:22 -07005779# check for sizeof without parenthesis
5780 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005781 if (WARN("SIZEOF_PARENTHESIS",
5782 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5783 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005784 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005785 }
Joe Perches66c80b62012-07-30 14:41:22 -07005786 }
5787
Joe Perches88982fe2012-12-17 16:02:00 -08005788# check for struct spinlock declarations
5789 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5790 WARN("USE_SPINLOCK_T",
5791 "struct spinlock should be spinlock_t\n" . $herecurr);
5792 }
5793
Joe Perchesa6962d72013-04-29 16:18:13 -07005794# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005795 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005796 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005797 $fmt =~ s/%%//g;
5798 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005799 if (WARN("PREFER_SEQ_PUTS",
5800 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5801 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005802 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005803 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005804 }
5805 }
5806
Joe Perches0b523762017-05-08 15:55:36 -07005807 # check for vsprintf extension %p<foo> misuses
5808 if ($^V && $^V ge 5.10.0 &&
5809 defined $stat &&
5810 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5811 $1 !~ /^_*volatile_*$/) {
5812 my $bad_extension = "";
5813 my $lc = $stat =~ tr@\n@@;
5814 $lc = $lc + $linenr;
5815 for (my $count = $linenr; $count <= $lc; $count++) {
5816 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5817 $fmt =~ s/%%//g;
Linus Torvaldsab486bc2018-02-01 13:36:15 -08005818 if ($fmt =~ /(\%[\*\d\.]*p(?![\WSsBKRraEhMmIiUDdgVCbGNOx]).)/) {
Joe Perches0b523762017-05-08 15:55:36 -07005819 $bad_extension = $1;
5820 last;
5821 }
5822 }
5823 if ($bad_extension ne "") {
5824 my $stat_real = raw_line($linenr, 0);
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005825 my $ext_type = "Invalid";
5826 my $use = "";
Joe Perches0b523762017-05-08 15:55:36 -07005827 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5828 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5829 }
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005830 if ($bad_extension =~ /p[Ff]/) {
5831 $ext_type = "Deprecated";
5832 $use = " - use %pS instead";
5833 $use =~ s/pS/ps/ if ($bad_extension =~ /pf/);
5834 }
Joe Perches0b523762017-05-08 15:55:36 -07005835 WARN("VSPRINTF_POINTER_EXTENSION",
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005836 "$ext_type vsprintf pointer extension '$bad_extension'$use\n" . "$here\n$stat_real\n");
Joe Perches0b523762017-05-08 15:55:36 -07005837 }
5838 }
5839
Andy Whitcroft554e1652012-01-10 15:09:57 -08005840# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005841 if ($^V && $^V ge 5.10.0 &&
5842 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005843 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005844
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005845 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005846 my $ms_val = $7;
5847 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005848
Andy Whitcroft554e1652012-01-10 15:09:57 -08005849 if ($ms_size =~ /^(0x|)0$/i) {
5850 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005851 "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 -08005852 } elsif ($ms_size =~ /^(0x|)1$/i) {
5853 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005854 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5855 }
5856 }
5857
Joe Perches98a9bba2014-01-23 15:54:52 -08005858# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005859# if ($^V && $^V ge 5.10.0 &&
5860# defined $stat &&
5861# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5862# if (WARN("PREFER_ETHER_ADDR_COPY",
5863# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5864# $fix) {
5865# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5866# }
5867# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005868
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005869# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005870# if ($^V && $^V ge 5.10.0 &&
5871# defined $stat &&
5872# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5873# WARN("PREFER_ETHER_ADDR_EQUAL",
5874# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5875# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005876
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005877# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5878# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf333195d2016-10-11 13:51:53 -07005879# if ($^V && $^V ge 5.10.0 &&
5880# defined $stat &&
5881# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5882#
5883# my $ms_val = $7;
5884#
5885# if ($ms_val =~ /^(?:0x|)0+$/i) {
5886# if (WARN("PREFER_ETH_ZERO_ADDR",
5887# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5888# $fix) {
5889# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5890# }
5891# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5892# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5893# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5894# $fix) {
5895# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5896# }
5897# }
5898# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005899
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005900# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005901 if ($^V && $^V ge 5.10.0 &&
5902 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005903 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005904 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005905 my $call = $1;
5906 my $cast1 = deparenthesize($2);
5907 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005908 my $cast2 = deparenthesize($7);
5909 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005910 my $cast;
5911
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005912 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005913 $cast = "$cast1 or $cast2";
5914 } elsif ($cast1 ne "") {
5915 $cast = $cast1;
5916 } else {
5917 $cast = $cast2;
5918 }
5919 WARN("MINMAX",
5920 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005921 }
5922 }
5923
Joe Perches4a273192012-07-30 14:41:20 -07005924# check usleep_range arguments
5925 if ($^V && $^V ge 5.10.0 &&
5926 defined $stat &&
5927 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5928 my $min = $1;
5929 my $max = $7;
5930 if ($min eq $max) {
5931 WARN("USLEEP_RANGE",
5932 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5933 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5934 $min > $max) {
5935 WARN("USLEEP_RANGE",
5936 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5937 }
5938 }
5939
Joe Perches823b7942013-11-12 15:10:15 -08005940# check for naked sscanf
5941 if ($^V && $^V ge 5.10.0 &&
5942 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005943 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005944 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5945 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5946 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5947 my $lc = $stat =~ tr@\n@@;
5948 $lc = $lc + $linenr;
5949 my $stat_real = raw_line($linenr, 0);
5950 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5951 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5952 }
5953 WARN("NAKED_SSCANF",
5954 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5955 }
5956
Joe Perchesafc819a2014-06-04 16:12:08 -07005957# check for simple sscanf that should be kstrto<foo>
5958 if ($^V && $^V ge 5.10.0 &&
5959 defined $stat &&
5960 $line =~ /\bsscanf\b/) {
5961 my $lc = $stat =~ tr@\n@@;
5962 $lc = $lc + $linenr;
5963 my $stat_real = raw_line($linenr, 0);
5964 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5965 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5966 }
5967 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5968 my $format = $6;
5969 my $count = $format =~ tr@%@%@;
5970 if ($count == 1 &&
5971 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5972 WARN("SSCANF_TO_KSTRTO",
5973 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5974 }
5975 }
5976 }
5977
Joe Perches70dc8a42013-09-11 14:23:58 -07005978# check for new externs in .h files.
5979 if ($realfile =~ /\.h$/ &&
5980 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005981 if (CHK("AVOID_EXTERNS",
5982 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005983 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005984 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005985 }
5986 }
5987
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005988# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005989 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005990 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005991 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005992 my $function_name = $1;
5993 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005994
5995 my $s = $stat;
5996 if (defined $cond) {
5997 substr($s, 0, length($cond), '');
5998 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005999 if ($s =~ /^\s*;/ &&
6000 $function_name ne 'uninitialized_var')
6001 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006002 WARN("AVOID_EXTERNS",
6003 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006004 }
6005
6006 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006007 WARN("FUNCTION_ARGUMENTS",
6008 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006009 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006010
6011 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6012 $stat =~ /^.\s*extern\s+/)
6013 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006014 WARN("AVOID_EXTERNS",
6015 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006016 }
6017
Joe Perchesa0ad7592017-07-10 15:52:19 -07006018# check for function declarations that have arguments without identifier names
6019 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006020 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006021 $1 ne "void") {
6022 my $args = trim($1);
6023 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6024 my $arg = trim($1);
6025 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6026 WARN("FUNCTION_ARGUMENTS",
6027 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6028 }
6029 }
6030 }
6031
Joe Perchesa0ad7592017-07-10 15:52:19 -07006032# check for function definitions
6033 if ($^V && $^V ge 5.10.0 &&
6034 defined $stat &&
6035 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6036 $context_function = $1;
6037
6038# check for multiline function definition with misplaced open brace
6039 my $ok = 0;
6040 my $cnt = statement_rawlines($stat);
6041 my $herectx = $here . "\n";
6042 for (my $n = 0; $n < $cnt; $n++) {
6043 my $rl = raw_line($linenr, $n);
6044 $herectx .= $rl . "\n";
6045 $ok = 1 if ($rl =~ /^[ \+]\{/);
6046 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6047 last if $rl =~ /^[ \+].*\{/;
6048 }
6049 if (!$ok) {
6050 ERROR("OPEN_BRACE",
6051 "open brace '{' following function definitions go on the next line\n" . $herectx);
6052 }
6053 }
6054
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006055# checks for new __setup's
6056 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6057 my $name = $1;
6058
6059 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006060 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006061 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006062 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006063 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006064
6065# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08006066 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006067 WARN("UNNECESSARY_CASTS",
6068 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006069 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006070
Joe Perchesa640d252013-07-03 15:05:21 -07006071# alloc style
6072# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6073 if ($^V && $^V ge 5.10.0 &&
6074 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6075 CHK("ALLOC_SIZEOF_STRUCT",
6076 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6077 }
6078
Joe Perches60a55362014-06-04 16:12:07 -07006079# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6080 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006081 defined $stat &&
6082 $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 -07006083 my $oldfunc = $3;
6084 my $a1 = $4;
6085 my $a2 = $10;
6086 my $newfunc = "kmalloc_array";
6087 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006088 my $r1 = $a1;
6089 my $r2 = $a2;
6090 if ($a1 =~ /^sizeof\s*\S/) {
6091 $r1 = $a2;
6092 $r2 = $a1;
6093 }
6094 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6095 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006096 my $ctx = '';
6097 my $herectx = $here . "\n";
6098 my $cnt = statement_rawlines($stat);
6099 for (my $n = 0; $n < $cnt; $n++) {
6100 $herectx .= raw_line($linenr, $n) . "\n";
6101 }
Joe Perches60a55362014-06-04 16:12:07 -07006102 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006103 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6104 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006105 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006106 $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 -07006107 }
6108 }
6109 }
6110
Joe Perches972fdea2013-04-29 16:18:12 -07006111# check for krealloc arg reuse
6112 if ($^V && $^V ge 5.10.0 &&
6113 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6114 WARN("KREALLOC_ARG_REUSE",
6115 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6116 }
6117
Joe Perches5ce59ae2013-02-21 16:44:18 -08006118# check for alloc argument mismatch
6119 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6120 WARN("ALLOC_ARRAY_ARGS",
6121 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6122 }
6123
Joe Perchescaf2a542011-01-12 16:59:56 -08006124# check for multiple semicolons
6125 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006126 if (WARN("ONE_SEMICOLON",
6127 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6128 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006129 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006130 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006131 }
6132
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006133# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6134 if ($realfile !~ m@^include/uapi/@ &&
6135 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006136 my $ull = "";
6137 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6138 if (CHK("BIT_MACRO",
6139 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6140 $fix) {
6141 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6142 }
6143 }
6144
Joe Perches2d632742016-05-20 17:04:00 -07006145# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6146 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6147 my $config = $1;
6148 if (WARN("PREFER_IS_ENABLED",
6149 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6150 $fix) {
6151 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6152 }
6153 }
6154
Joe Perchese81f2392014-08-06 16:11:25 -07006155# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006156 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6157 my $has_break = 0;
6158 my $has_statement = 0;
6159 my $count = 0;
6160 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006161 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006162 $prevline--;
6163 my $rline = $rawlines[$prevline - 1];
6164 my $fline = $lines[$prevline - 1];
6165 last if ($fline =~ /^\@\@/);
6166 next if ($fline =~ /^\-/);
6167 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6168 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6169 next if ($fline =~ /^.[\s$;]*$/);
6170 $has_statement = 1;
6171 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006172 $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 -08006173 }
6174 if (!$has_break && $has_statement) {
6175 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006176 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006177 }
6178 }
6179
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006180# check for switch/default statements without a break;
6181 if ($^V && $^V ge 5.10.0 &&
6182 defined $stat &&
6183 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6184 my $ctx = '';
6185 my $herectx = $here . "\n";
6186 my $cnt = statement_rawlines($stat);
6187 for (my $n = 0; $n < $cnt; $n++) {
6188 $herectx .= raw_line($linenr, $n) . "\n";
6189 }
6190 WARN("DEFAULT_NO_BREAK",
6191 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006192 }
6193
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006194# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006195 if ($line =~ /\b__FUNCTION__\b/) {
6196 if (WARN("USE_FUNC",
6197 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6198 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006199 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006200 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006201 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006202
Joe Perches62ec8182015-02-13 14:38:18 -08006203# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6204 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6205 ERROR("DATE_TIME",
6206 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6207 }
6208
Joe Perches2c924882012-03-23 15:02:20 -07006209# check for use of yield()
6210 if ($line =~ /\byield\s*\(\s*\)/) {
6211 WARN("YIELD",
6212 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6213 }
6214
Joe Perches179f8f42013-07-03 15:05:30 -07006215# check for comparisons against true and false
6216 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6217 my $lead = $1;
6218 my $arg = $2;
6219 my $test = $3;
6220 my $otype = $4;
6221 my $trail = $5;
6222 my $op = "!";
6223
6224 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6225
6226 my $type = lc($otype);
6227 if ($type =~ /^(?:true|false)$/) {
6228 if (("$test" eq "==" && "$type" eq "true") ||
6229 ("$test" eq "!=" && "$type" eq "false")) {
6230 $op = "";
6231 }
6232
6233 CHK("BOOL_COMPARISON",
6234 "Using comparison to $otype is error prone\n" . $herecurr);
6235
6236## maybe suggesting a correct construct would better
6237## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6238
6239 }
6240 }
6241
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006242# check for semaphores initialized locked
6243 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006244 WARN("CONSIDER_COMPLETION",
6245 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006246 }
Joe Perches6712d852012-03-23 15:02:20 -07006247
Joe Perches67d0a072011-10-31 17:13:10 -07006248# recommend kstrto* over simple_strto* and strict_strto*
6249 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006250 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006251 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006252 }
Joe Perches6712d852012-03-23 15:02:20 -07006253
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006254# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006255 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006256 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006257 "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 -07006258 }
Joe Perches6712d852012-03-23 15:02:20 -07006259
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006260# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006261# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006262 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006263 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006264 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006265 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006266 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006267
6268# use of NR_CPUS is usually wrong
6269# ignore definitions of NR_CPUS and usage to define arrays as likely right
6270 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006271 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6272 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006273 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6274 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6275 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006276 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006277 WARN("NR_CPUS",
6278 "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 -07006279 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006280
Joe Perches52ea8502013-11-12 15:10:09 -08006281# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6282 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6283 ERROR("DEFINE_ARCH_HAS",
6284 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6285 }
6286
Joe Perchesacd93622015-02-13 14:38:38 -08006287# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6288 if ($^V && $^V ge 5.10.0 &&
6289 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6290 WARN("LIKELY_MISUSE",
6291 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6292 }
6293
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006294# whine mightly about in_atomic
6295 if ($line =~ /\bin_atomic\s*\(/) {
6296 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006297 ERROR("IN_ATOMIC",
6298 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006299 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006300 WARN("IN_ATOMIC",
6301 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006302 }
6303 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006304
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006305# check for mutex_trylock_recursive usage
6306 if ($line =~ /mutex_trylock_recursive/) {
6307 ERROR("LOCKING",
6308 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6309 }
6310
Peter Zijlstra1704f472010-03-19 01:37:42 +01006311# check for lockdep_set_novalidate_class
6312 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6313 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6314 if ($realfile !~ m@^kernel/lockdep@ &&
6315 $realfile !~ m@^include/linux/lockdep@ &&
6316 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006317 ERROR("LOCKDEP",
6318 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006319 }
6320 }
Dave Jones88f88312011-01-12 16:59:59 -08006321
Joe Perchesb392c642015-04-16 12:44:16 -07006322 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6323 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006324 WARN("EXPORTED_WORLD_WRITABLE",
6325 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006326 }
Joe Perches24358802014-04-03 14:49:13 -07006327
Joe Perches00180462018-02-06 15:38:55 -08006328# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6329# and whether or not function naming is typical and if
6330# DEVICE_ATTR permissions uses are unusual too
6331 if ($^V && $^V ge 5.10.0 &&
6332 defined $stat &&
6333 $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*\)/) {
6334 my $var = $1;
6335 my $perms = $2;
6336 my $show = $3;
6337 my $store = $4;
6338 my $octal_perms = perms_to_octal($perms);
6339 if ($show =~ /^${var}_show$/ &&
6340 $store =~ /^${var}_store$/ &&
6341 $octal_perms eq "0644") {
6342 if (WARN("DEVICE_ATTR_RW",
6343 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6344 $fix) {
6345 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6346 }
6347 } elsif ($show =~ /^${var}_show$/ &&
6348 $store =~ /^NULL$/ &&
6349 $octal_perms eq "0444") {
6350 if (WARN("DEVICE_ATTR_RO",
6351 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6352 $fix) {
6353 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6354 }
6355 } elsif ($show =~ /^NULL$/ &&
6356 $store =~ /^${var}_store$/ &&
6357 $octal_perms eq "0200") {
6358 if (WARN("DEVICE_ATTR_WO",
6359 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6360 $fix) {
6361 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6362 }
6363 } elsif ($octal_perms eq "0644" ||
6364 $octal_perms eq "0444" ||
6365 $octal_perms eq "0200") {
6366 my $newshow = "$show";
6367 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6368 my $newstore = $store;
6369 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6370 my $rename = "";
6371 if ($show ne $newshow) {
6372 $rename .= " '$show' to '$newshow'";
6373 }
6374 if ($store ne $newstore) {
6375 $rename .= " '$store' to '$newstore'";
6376 }
6377 WARN("DEVICE_ATTR_FUNCTIONS",
6378 "Consider renaming function(s)$rename\n" . $herecurr);
6379 } else {
6380 WARN("DEVICE_ATTR_PERMS",
6381 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6382 }
6383 }
6384
Joe Perches515a2352014-04-03 14:49:24 -07006385# Mode permission misuses where it seems decimal should be octal
6386# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006387# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6388# specific definition of not visible in sysfs.
6389# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6390# use the default permissions
Joe Perches515a2352014-04-03 14:49:24 -07006391 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006392 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006393 $line =~ /$mode_perms_search/) {
6394 foreach my $entry (@mode_permission_funcs) {
6395 my $func = $entry->[0];
6396 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006397
Joe Perches459cf0a2016-10-11 13:52:19 -07006398 my $lc = $stat =~ tr@\n@@;
6399 $lc = $lc + $linenr;
6400 my $stat_real = raw_line($linenr, 0);
6401 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6402 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6403 }
6404
Joe Perches515a2352014-04-03 14:49:24 -07006405 my $skip_args = "";
6406 if ($arg_pos > 1) {
6407 $arg_pos--;
6408 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6409 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006410 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006411 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006412 my $val = $1;
6413 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006414 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6415 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6416 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006417 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006418 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006419 }
6420 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006421 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006422 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006423 }
Joe Perches24358802014-04-03 14:49:13 -07006424 }
6425 }
6426 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006427
Joe Perches459cf0a2016-10-11 13:52:19 -07006428# check for uses of S_<PERMS> that could be octal for readability
Joe Perches00180462018-02-06 15:38:55 -08006429 if ($line =~ /\b($multi_mode_perms_string_search)\b/) {
6430 my $oval = $1;
6431 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006432 if (WARN("SYMBOLIC_PERMS",
6433 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6434 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006435 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006436 }
6437 }
6438
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006439# validate content of MODULE_LICENSE against list from include/linux/module.h
6440 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6441 my $extracted_string = get_quoted_string($line, $rawline);
6442 my $valid_licenses = qr{
6443 GPL|
6444 GPL\ v2|
6445 GPL\ and\ additional\ rights|
6446 Dual\ BSD/GPL|
6447 Dual\ MIT/GPL|
6448 Dual\ MPL/GPL|
6449 Proprietary
6450 }x;
6451 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6452 WARN("MODULE_LICENSE",
6453 "unknown module license " . $extracted_string . "\n" . $herecurr);
6454 }
6455 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006456 }
6457
6458 # If we have no input at all, then there is nothing to report on
6459 # so just keep quiet.
6460 if ($#rawlines == -1) {
6461 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006462 }
6463
Andy Whitcroft8905a672007-11-28 16:21:06 -08006464 # In mailback mode only produce a report in the negative, for
6465 # things that appear to be patches.
6466 if ($mailback && ($clean == 1 || !$is_patch)) {
6467 exit(0);
6468 }
6469
6470 # This is not a patch, and we are are in 'no-patch' mode so
6471 # just keep quiet.
6472 if (!$chk_patch && !$is_patch) {
6473 exit(0);
6474 }
6475
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006476 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006477 ERROR("NOT_UNIFIED_DIFF",
6478 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006479 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006480 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006481 ERROR("MISSING_SIGN_OFF",
6482 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006483 }
6484
Andy Whitcroft8905a672007-11-28 16:21:06 -08006485 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006486 if ($summary && !($clean == 1 && $quiet == 1)) {
6487 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006488 print "total: $cnt_error errors, $cnt_warn warnings, " .
6489 (($check)? "$cnt_chk checks, " : "") .
6490 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006491 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006492
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006493 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006494 # If there were any defects found and not already fixing them
6495 if (!$clean and !$fix) {
6496 print << "EOM"
6497
6498NOTE: For some of the reported defects, checkpatch may be able to
6499 mechanically convert to the typical style using --fix or --fix-inplace.
6500EOM
6501 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006502 # If there were whitespace errors which cleanpatch can fix
6503 # then suggest that.
6504 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006505 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006506 print << "EOM"
6507
6508NOTE: Whitespace errors detected.
6509 You may wish to use scripts/cleanpatch or scripts/cleanfile
6510EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006511 }
6512 }
6513
Joe Perchesd752fcc2014-08-06 16:11:05 -07006514 if ($clean == 0 && $fix &&
6515 ("@rawlines" ne "@fixed" ||
6516 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006517 my $newfile = $filename;
6518 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006519 my $linecount = 0;
6520 my $f;
6521
Joe Perchesd752fcc2014-08-06 16:11:05 -07006522 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6523
Joe Perches3705ce52013-07-03 15:05:31 -07006524 open($f, '>', $newfile)
6525 or die "$P: Can't open $newfile for write\n";
6526 foreach my $fixed_line (@fixed) {
6527 $linecount++;
6528 if ($file) {
6529 if ($linecount > 3) {
6530 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006531 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006532 }
6533 } else {
6534 print $f $fixed_line . "\n";
6535 }
6536 }
6537 close($f);
6538
6539 if (!$quiet) {
6540 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006541
Joe Perches3705ce52013-07-03 15:05:31 -07006542Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6543
6544Do _NOT_ trust the results written to this file.
6545Do _NOT_ submit these changes without inspecting them for correctness.
6546
6547This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6548No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006549EOM
6550 }
6551 }
6552
Joe Perchesd8469f12015-06-25 15:03:00 -07006553 if ($quiet == 0) {
6554 print "\n";
6555 if ($clean == 1) {
6556 print "$vname has no obvious style problems and is ready for submission.\n";
6557 } else {
6558 print "$vname has style problems, please review.\n";
6559 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006560 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006561 return $clean;
6562}