blob: 18bf4bf1d0fc6242739dd3bc173d939145976247 [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 Perches478b1792018-04-10 16:33:34 -07001301 return "" if (!defined($line) || !defined($rawline));
Joe Perches33acb542015-06-25 15:02:54 -07001302 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001303 return substr($rawline, $-[0], $+[0] - $-[0]);
1304}
1305
Andy Whitcroft8905a672007-11-28 16:21:06 -08001306sub ctx_statement_block {
1307 my ($linenr, $remain, $off) = @_;
1308 my $line = $linenr - 1;
1309 my $blk = '';
1310 my $soff = $off;
1311 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001312 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001313
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001314 my $loff = 0;
1315
Andy Whitcroft8905a672007-11-28 16:21:06 -08001316 my $type = '';
1317 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001318 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001319 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001320 my $c;
1321 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001322
1323 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001324 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001325 @stack = (['', 0]) if ($#stack == -1);
1326
Andy Whitcroft773647a2008-03-28 14:15:58 -07001327 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001328 # If we are about to drop off the end, pull in more
1329 # context.
1330 if ($off >= $len) {
1331 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001332 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001333 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001334 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001335 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001336 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001337 $len = length($blk);
1338 $line++;
1339 last;
1340 }
1341 # Bail if there is no further context.
1342 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001343 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001344 last;
1345 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001346 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1347 $level++;
1348 $type = '#';
1349 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001350 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001351 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001352 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001353 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001354
Andy Whitcroft773647a2008-03-28 14:15:58 -07001355 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001356
1357 # Handle nested #if/#else.
1358 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1359 push(@stack, [ $type, $level ]);
1360 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1361 ($type, $level) = @{$stack[$#stack - 1]};
1362 } elsif ($remainder =~ /^#\s*endif\b/) {
1363 ($type, $level) = @{pop(@stack)};
1364 }
1365
Andy Whitcroft8905a672007-11-28 16:21:06 -08001366 # Statement ends at the ';' or a close '}' at the
1367 # outermost level.
1368 if ($level == 0 && $c eq ';') {
1369 last;
1370 }
1371
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001372 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001373 if ($level == 0 && $coff_set == 0 &&
1374 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1375 $remainder =~ /^(else)(?:\s|{)/ &&
1376 $remainder !~ /^else\s+if\b/) {
1377 $coff = $off + length($1) - 1;
1378 $coff_set = 1;
1379 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1380 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001381 }
1382
Andy Whitcroft8905a672007-11-28 16:21:06 -08001383 if (($type eq '' || $type eq '(') && $c eq '(') {
1384 $level++;
1385 $type = '(';
1386 }
1387 if ($type eq '(' && $c eq ')') {
1388 $level--;
1389 $type = ($level != 0)? '(' : '';
1390
1391 if ($level == 0 && $coff < $soff) {
1392 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001393 $coff_set = 1;
1394 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001395 }
1396 }
1397 if (($type eq '' || $type eq '{') && $c eq '{') {
1398 $level++;
1399 $type = '{';
1400 }
1401 if ($type eq '{' && $c eq '}') {
1402 $level--;
1403 $type = ($level != 0)? '{' : '';
1404
1405 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001406 if (substr($blk, $off + 1, 1) eq ';') {
1407 $off++;
1408 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001409 last;
1410 }
1411 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001412 # Preprocessor commands end at the newline unless escaped.
1413 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1414 $level--;
1415 $type = '';
1416 $off++;
1417 last;
1418 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001419 $off++;
1420 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001421 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001422 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001423 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001424 $line++;
1425 $remain--;
1426 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001427
1428 my $statement = substr($blk, $soff, $off - $soff + 1);
1429 my $condition = substr($blk, $soff, $coff - $soff + 1);
1430
1431 #warn "STATEMENT<$statement>\n";
1432 #warn "CONDITION<$condition>\n";
1433
Andy Whitcroft773647a2008-03-28 14:15:58 -07001434 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001435
1436 return ($statement, $condition,
1437 $line, $remain + 1, $off - $loff + 1, $level);
1438}
1439
Andy Whitcroftcf655042008-03-04 14:28:20 -08001440sub statement_lines {
1441 my ($stmt) = @_;
1442
1443 # Strip the diff line prefixes and rip blank lines at start and end.
1444 $stmt =~ s/(^|\n)./$1/g;
1445 $stmt =~ s/^\s*//;
1446 $stmt =~ s/\s*$//;
1447
1448 my @stmt_lines = ($stmt =~ /\n/g);
1449
1450 return $#stmt_lines + 2;
1451}
1452
1453sub statement_rawlines {
1454 my ($stmt) = @_;
1455
1456 my @stmt_lines = ($stmt =~ /\n/g);
1457
1458 return $#stmt_lines + 2;
1459}
1460
1461sub statement_block_size {
1462 my ($stmt) = @_;
1463
1464 $stmt =~ s/(^|\n)./$1/g;
1465 $stmt =~ s/^\s*{//;
1466 $stmt =~ s/}\s*$//;
1467 $stmt =~ s/^\s*//;
1468 $stmt =~ s/\s*$//;
1469
1470 my @stmt_lines = ($stmt =~ /\n/g);
1471 my @stmt_statements = ($stmt =~ /;/g);
1472
1473 my $stmt_lines = $#stmt_lines + 2;
1474 my $stmt_statements = $#stmt_statements + 1;
1475
1476 if ($stmt_lines > $stmt_statements) {
1477 return $stmt_lines;
1478 } else {
1479 return $stmt_statements;
1480 }
1481}
1482
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001483sub ctx_statement_full {
1484 my ($linenr, $remain, $off) = @_;
1485 my ($statement, $condition, $level);
1486
1487 my (@chunks);
1488
Andy Whitcroftcf655042008-03-04 14:28:20 -08001489 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001490 ($statement, $condition, $linenr, $remain, $off, $level) =
1491 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001492 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001493 push(@chunks, [ $condition, $statement ]);
1494 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1495 return ($level, $linenr, @chunks);
1496 }
1497
1498 # Pull in the following conditional/block pairs and see if they
1499 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001500 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001501 ($statement, $condition, $linenr, $remain, $off, $level) =
1502 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001503 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001504 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001505 #print "C: push\n";
1506 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001507 }
1508
1509 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001510}
1511
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001512sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001513 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001514 my $line;
1515 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001516 my $blk = '';
1517 my @o;
1518 my @c;
1519 my @res = ();
1520
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001521 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001522 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001523 for ($line = $start; $remain > 0; $line++) {
1524 next if ($rawlines[$line] =~ /^-/);
1525 $remain--;
1526
1527 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001528
1529 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001530 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001531 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001532 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001533 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001534 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001535 $level = pop(@stack);
1536 }
1537
Andy Whitcroft01464f32010-10-26 14:23:19 -07001538 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001539 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1540 if ($off > 0) {
1541 $off--;
1542 next;
1543 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001544
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001545 if ($c eq $close && $level > 0) {
1546 $level--;
1547 last if ($level == 0);
1548 } elsif ($c eq $open) {
1549 $level++;
1550 }
1551 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001552
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001553 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001554 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001555 }
1556
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001557 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001558 }
1559
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001560 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001561}
1562sub ctx_block_outer {
1563 my ($linenr, $remain) = @_;
1564
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001565 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1566 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001567}
1568sub ctx_block {
1569 my ($linenr, $remain) = @_;
1570
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001571 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1572 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001573}
1574sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001575 my ($linenr, $remain, $off) = @_;
1576
1577 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1578 return @r;
1579}
1580sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001581 my ($linenr, $remain) = @_;
1582
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001583 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001584}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001585sub ctx_statement_level {
1586 my ($linenr, $remain, $off) = @_;
1587
1588 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1589}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001590
1591sub ctx_locate_comment {
1592 my ($first_line, $end_line) = @_;
1593
1594 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001595 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001596 return $current_comment if (defined $current_comment);
1597
1598 # Look through the context and try and figure out if there is a
1599 # comment.
1600 my $in_comment = 0;
1601 $current_comment = '';
1602 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001603 my $line = $rawlines[$linenr - 1];
1604 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001605 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1606 $in_comment = 1;
1607 }
1608 if ($line =~ m@/\*@) {
1609 $in_comment = 1;
1610 }
1611 if (!$in_comment && $current_comment ne '') {
1612 $current_comment = '';
1613 }
1614 $current_comment .= $line . "\n" if ($in_comment);
1615 if ($line =~ m@\*/@) {
1616 $in_comment = 0;
1617 }
1618 }
1619
1620 chomp($current_comment);
1621 return($current_comment);
1622}
1623sub ctx_has_comment {
1624 my ($first_line, $end_line) = @_;
1625 my $cmt = ctx_locate_comment($first_line, $end_line);
1626
Andy Whitcroft00df3442007-06-08 13:47:06 -07001627 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001628 ##print "CMMT: $cmt\n";
1629
1630 return ($cmt ne '');
1631}
1632
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001633sub raw_line {
1634 my ($linenr, $cnt) = @_;
1635
1636 my $offset = $linenr - 1;
1637 $cnt++;
1638
1639 my $line;
1640 while ($cnt) {
1641 $line = $rawlines[$offset++];
1642 next if (defined($line) && $line =~ /^-/);
1643 $cnt--;
1644 }
1645
1646 return $line;
1647}
1648
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07001649sub get_stat_real {
1650 my ($linenr, $lc) = @_;
1651
1652 my $stat_real = raw_line($linenr, 0);
1653 for (my $count = $linenr + 1; $count <= $lc; $count++) {
1654 $stat_real = $stat_real . "\n" . raw_line($count, 0);
1655 }
1656
1657 return $stat_real;
1658}
1659
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07001660sub get_stat_here {
1661 my ($linenr, $cnt, $here) = @_;
1662
1663 my $herectx = $here . "\n";
1664 for (my $n = 0; $n < $cnt; $n++) {
1665 $herectx .= raw_line($linenr, $n) . "\n";
1666 }
1667
1668 return $herectx;
1669}
1670
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001671sub cat_vet {
1672 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001673 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001674
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001675 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001676 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1677 $res .= $1;
1678 if ($2 ne '') {
1679 $coded = sprintf("^%c", unpack('C', $2) + 64);
1680 $res .= $coded;
1681 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001682 }
1683 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001684
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001685 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001686}
1687
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001688my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001689my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001690my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001691my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001692
1693sub annotate_reset {
1694 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001695 $av_pending = '_';
1696 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001697 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001698}
1699
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001700sub annotate_values {
1701 my ($stream, $type) = @_;
1702
1703 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001704 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001705 my $cur = $stream;
1706
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001707 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001708
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001709 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001710 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001711 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001712 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001713 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001714 print "WS($1)\n" if ($dbg_values > 1);
1715 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001716 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001717 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001718 }
1719
Florian Micklerc023e4732011-01-12 16:59:58 -08001720 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001721 print "CAST($1)\n" if ($dbg_values > 1);
1722 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001723 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001724
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001725 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001726 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001727 $type = 'T';
1728
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001729 } elsif ($cur =~ /^($Modifier)\s*/) {
1730 print "MODIFIER($1)\n" if ($dbg_values > 1);
1731 $type = 'T';
1732
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001733 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001734 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001735 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001736 push(@av_paren_type, $type);
1737 if ($2 ne '') {
1738 $av_pending = 'N';
1739 }
1740 $type = 'E';
1741
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001742 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001743 print "UNDEF($1)\n" if ($dbg_values > 1);
1744 $av_preprocessor = 1;
1745 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001746
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001747 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001748 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001749 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001750
1751 push(@av_paren_type, $type);
1752 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001753 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001754
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001755 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001756 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1757 $av_preprocessor = 1;
1758
1759 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1760
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001761 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001762
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001763 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001764 print "PRE_END($1)\n" if ($dbg_values > 1);
1765
1766 $av_preprocessor = 1;
1767
1768 # Assume all arms of the conditional end as this
1769 # one does, and continue as if the #endif was not here.
1770 pop(@av_paren_type);
1771 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001772 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001773
1774 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001775 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001776
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001777 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1778 print "ATTR($1)\n" if ($dbg_values > 1);
1779 $av_pending = $type;
1780 $type = 'N';
1781
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001782 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001783 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001784 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001785 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001786 }
1787 $type = 'N';
1788
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001789 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001790 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001791 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001792 $type = 'N';
1793
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001794 } elsif ($cur =~/^(case)/o) {
1795 print "CASE($1)\n" if ($dbg_values > 1);
1796 $av_pend_colon = 'C';
1797 $type = 'N';
1798
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001799 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001800 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001801 $type = 'N';
1802
1803 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001804 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001805 push(@av_paren_type, $av_pending);
1806 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001807 $type = 'N';
1808
1809 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001810 my $new_type = pop(@av_paren_type);
1811 if ($new_type ne '_') {
1812 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001813 print "PAREN('$1') -> $type\n"
1814 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001815 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001816 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001817 }
1818
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001819 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001820 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001821 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001822 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001823
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001824 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1825 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001826 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001827 } elsif ($type eq 'E') {
1828 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001829 }
1830 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1831 $type = 'V';
1832
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001833 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001834 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001835 $type = 'V';
1836
1837 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001838 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001839 $type = 'N';
1840
Andy Whitcroftcf655042008-03-04 14:28:20 -08001841 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001842 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001843 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001844 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001845
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001846 } elsif ($cur =~/^(,)/) {
1847 print "COMMA($1)\n" if ($dbg_values > 1);
1848 $type = 'C';
1849
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001850 } elsif ($cur =~ /^(\?)/o) {
1851 print "QUESTION($1)\n" if ($dbg_values > 1);
1852 $type = 'N';
1853
1854 } elsif ($cur =~ /^(:)/o) {
1855 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1856
1857 substr($var, length($res), 1, $av_pend_colon);
1858 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1859 $type = 'E';
1860 } else {
1861 $type = 'N';
1862 }
1863 $av_pend_colon = 'O';
1864
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001865 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001866 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001867 $type = 'N';
1868
Andy Whitcroft0d413862008-10-15 22:02:16 -07001869 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001870 my $variant;
1871
1872 print "OPV($1)\n" if ($dbg_values > 1);
1873 if ($type eq 'V') {
1874 $variant = 'B';
1875 } else {
1876 $variant = 'U';
1877 }
1878
1879 substr($var, length($res), 1, $variant);
1880 $type = 'N';
1881
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001882 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001883 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001884 if ($1 ne '++' && $1 ne '--') {
1885 $type = 'N';
1886 }
1887
1888 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001889 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001890 }
1891 if (defined $1) {
1892 $cur = substr($cur, length($1));
1893 $res .= $type x length($1);
1894 }
1895 }
1896
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001897 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001898}
1899
Andy Whitcroft8905a672007-11-28 16:21:06 -08001900sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001901 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001902 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001903 ^(?:
1904 $Modifier|
1905 $Storage|
1906 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001907 DEFINE_\S+
1908 )$|
1909 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001910 goto|
1911 return|
1912 case|
1913 else|
1914 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001915 do|
1916 \#|
1917 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001918 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001919 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001920 )}x;
1921 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1922 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001923 # Check for modifiers.
1924 $possible =~ s/\s*$Storage\s*//g;
1925 $possible =~ s/\s*$Sparse\s*//g;
1926 if ($possible =~ /^\s*$/) {
1927
1928 } elsif ($possible =~ /\s/) {
1929 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001930 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001931 if ($modifier !~ $notPermitted) {
1932 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001933 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001934 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001935 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001936
1937 } else {
1938 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001939 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001940 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001941 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001942 } else {
1943 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001944 }
1945}
1946
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001947my $prefix = '';
1948
Joe Perches000d1cc12011-07-25 17:13:25 -07001949sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001950 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001951
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001952 $type =~ tr/[a-z]/[A-Z]/;
1953
Joe Perchescbec18a2014-04-03 14:49:19 -07001954 return defined $use_type{$type} if (scalar keys %use_type > 0);
1955
1956 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001957}
1958
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001959sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001960 my ($level, $type, $msg) = @_;
1961
1962 if (!show_type($type) ||
1963 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001964 return 0;
1965 }
Joe Perches57230292015-06-25 15:03:03 -07001966 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001967 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001968 if ($level eq 'ERROR') {
1969 $output .= RED;
1970 } elsif ($level eq 'WARNING') {
1971 $output .= YELLOW;
1972 } else {
1973 $output .= GREEN;
1974 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001975 }
Joe Perches57230292015-06-25 15:03:03 -07001976 $output .= $prefix . $level . ':';
1977 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001978 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001979 $output .= "$type:";
1980 }
John Brooks737c0762017-07-10 15:52:24 -07001981 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001982 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001983
1984 if ($showfile) {
1985 my @lines = split("\n", $output, -1);
1986 splice(@lines, 1, 1);
1987 $output = join("\n", @lines);
1988 }
Joe Perches57230292015-06-25 15:03:03 -07001989 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001990
Joe Perches57230292015-06-25 15:03:03 -07001991 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001992
1993 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001994}
Joe Perchescbec18a2014-04-03 14:49:19 -07001995
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001996sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001997 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001998}
Joe Perches000d1cc12011-07-25 17:13:25 -07001999
Joe Perchesd752fcc2014-08-06 16:11:05 -07002000sub fixup_current_range {
2001 my ($lineRef, $offset, $length) = @_;
2002
2003 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
2004 my $o = $1;
2005 my $l = $2;
2006 my $no = $o + $offset;
2007 my $nl = $l + $length;
2008 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
2009 }
2010}
2011
2012sub fix_inserted_deleted_lines {
2013 my ($linesRef, $insertedRef, $deletedRef) = @_;
2014
2015 my $range_last_linenr = 0;
2016 my $delta_offset = 0;
2017
2018 my $old_linenr = 0;
2019 my $new_linenr = 0;
2020
2021 my $next_insert = 0;
2022 my $next_delete = 0;
2023
2024 my @lines = ();
2025
2026 my $inserted = @{$insertedRef}[$next_insert++];
2027 my $deleted = @{$deletedRef}[$next_delete++];
2028
2029 foreach my $old_line (@{$linesRef}) {
2030 my $save_line = 1;
2031 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002032 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002033 $delta_offset = 0;
2034 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2035 $range_last_linenr = $new_linenr;
2036 fixup_current_range(\$line, $delta_offset, 0);
2037 }
2038
2039 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2040 $deleted = @{$deletedRef}[$next_delete++];
2041 $save_line = 0;
2042 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2043 }
2044
2045 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2046 push(@lines, ${$inserted}{'LINE'});
2047 $inserted = @{$insertedRef}[$next_insert++];
2048 $new_linenr++;
2049 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2050 }
2051
2052 if ($save_line) {
2053 push(@lines, $line);
2054 $new_linenr++;
2055 }
2056
2057 $old_linenr++;
2058 }
2059
2060 return @lines;
2061}
2062
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002063sub fix_insert_line {
2064 my ($linenr, $line) = @_;
2065
2066 my $inserted = {
2067 LINENR => $linenr,
2068 LINE => $line,
2069 };
2070 push(@fixed_inserted, $inserted);
2071}
2072
2073sub fix_delete_line {
2074 my ($linenr, $line) = @_;
2075
2076 my $deleted = {
2077 LINENR => $linenr,
2078 LINE => $line,
2079 };
2080
2081 push(@fixed_deleted, $deleted);
2082}
2083
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002084sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002085 my ($type, $msg) = @_;
2086
2087 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002088 our $clean = 0;
2089 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002090 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002091 }
Joe Perches3705ce52013-07-03 15:05:31 -07002092 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002093}
2094sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002095 my ($type, $msg) = @_;
2096
2097 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002098 our $clean = 0;
2099 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002100 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002101 }
Joe Perches3705ce52013-07-03 15:05:31 -07002102 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002103}
2104sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002105 my ($type, $msg) = @_;
2106
2107 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002108 our $clean = 0;
2109 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002110 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002111 }
Joe Perches3705ce52013-07-03 15:05:31 -07002112 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002113}
2114
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002115sub check_absolute_file {
2116 my ($absolute, $herecurr) = @_;
2117 my $file = $absolute;
2118
2119 ##print "absolute<$absolute>\n";
2120
2121 # See if any suffix of this path is a path within the tree.
2122 while ($file =~ s@^[^/]*/@@) {
2123 if (-f "$root/$file") {
2124 ##print "file<$file>\n";
2125 last;
2126 }
2127 }
2128 if (! -f _) {
2129 return 0;
2130 }
2131
2132 # It is, so see if the prefix is acceptable.
2133 my $prefix = $absolute;
2134 substr($prefix, -length($file)) = '';
2135
2136 ##print "prefix<$prefix>\n";
2137 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002138 WARN("USE_RELATIVE_PATH",
2139 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002140 }
2141}
2142
Joe Perches3705ce52013-07-03 15:05:31 -07002143sub trim {
2144 my ($string) = @_;
2145
Joe Perchesb34c6482013-09-11 14:24:01 -07002146 $string =~ s/^\s+|\s+$//g;
2147
2148 return $string;
2149}
2150
2151sub ltrim {
2152 my ($string) = @_;
2153
2154 $string =~ s/^\s+//;
2155
2156 return $string;
2157}
2158
2159sub rtrim {
2160 my ($string) = @_;
2161
2162 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002163
2164 return $string;
2165}
2166
Joe Perches52ea8502013-11-12 15:10:09 -08002167sub string_find_replace {
2168 my ($string, $find, $replace) = @_;
2169
2170 $string =~ s/$find/$replace/g;
2171
2172 return $string;
2173}
2174
Joe Perches3705ce52013-07-03 15:05:31 -07002175sub tabify {
2176 my ($leading) = @_;
2177
2178 my $source_indent = 8;
2179 my $max_spaces_before_tab = $source_indent - 1;
2180 my $spaces_to_tab = " " x $source_indent;
2181
2182 #convert leading spaces to tabs
2183 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2184 #Remove spaces before a tab
2185 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2186
2187 return "$leading";
2188}
2189
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002190sub pos_last_openparen {
2191 my ($line) = @_;
2192
2193 my $pos = 0;
2194
2195 my $opens = $line =~ tr/\(/\(/;
2196 my $closes = $line =~ tr/\)/\)/;
2197
2198 my $last_openparen = 0;
2199
2200 if (($opens == 0) || ($closes >= $opens)) {
2201 return -1;
2202 }
2203
2204 my $len = length($line);
2205
2206 for ($pos = 0; $pos < $len; $pos++) {
2207 my $string = substr($line, $pos);
2208 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2209 $pos += length($1) - 1;
2210 } elsif (substr($line, $pos, 1) eq '(') {
2211 $last_openparen = $pos;
2212 } elsif (index($string, '(') == -1) {
2213 last;
2214 }
2215 }
2216
Joe Perches91cb5192014-04-03 14:49:32 -07002217 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002218}
2219
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002220sub process {
2221 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002222
2223 my $linenr=0;
2224 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002225 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002226 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002227 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002228
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002229 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002230 my $indent;
2231 my $previndent=0;
2232 my $stashindent=0;
2233
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002234 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002235 my $signoff = 0;
2236 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002237 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002238 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002239 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002240 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002241 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002242 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002243 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002244 my $non_utf8_charset = 0;
2245
Joe Perches365dd4e2014-08-06 16:10:42 -07002246 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002247 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002248
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002249 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002250 our $cnt_lines = 0;
2251 our $cnt_error = 0;
2252 our $cnt_warn = 0;
2253 our $cnt_chk = 0;
2254
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002255 # Trace the real file/line as we go.
2256 my $realfile = '';
2257 my $realline = 0;
2258 my $realcnt = 0;
2259 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002260 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002261 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002262 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002263 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002264 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002265
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002266 my $prev_values = 'E';
2267
2268 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002269 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002270 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002271 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002272 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002273
Joe Perches7e51f192013-09-11 14:23:57 -07002274 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002275
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002276 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002277 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002278 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002279 my @setup_docs = ();
2280 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002281
Joe Perchesd8b07712013-11-12 15:10:06 -08002282 my $camelcase_file_seeded = 0;
2283
Rob Herring9f3a8992018-04-10 16:33:13 -07002284 my $checklicenseline = 1;
2285
Andy Whitcroft773647a2008-03-28 14:15:58 -07002286 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002287 my $line;
2288 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002289 $linenr++;
2290 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002291
Joe Perches3705ce52013-07-03 15:05:31 -07002292 push(@fixed, $rawline) if ($fix);
2293
Andy Whitcroft773647a2008-03-28 14:15:58 -07002294 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002295 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002296 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002297 $setup_docs = 1;
2298 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002299 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002300 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002301 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002302 $realline=$1-1;
2303 if (defined $2) {
2304 $realcnt=$3+1;
2305 } else {
2306 $realcnt=1+1;
2307 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002308 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002309
2310 # Guestimate if this is a continuing comment. Run
2311 # the context looking for a comment "edge". If this
2312 # edge is a close comment then we must be in a comment
2313 # at context start.
2314 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002315 my $cnt = $realcnt;
2316 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2317 next if (defined $rawlines[$ln - 1] &&
2318 $rawlines[$ln - 1] =~ /^-/);
2319 $cnt--;
2320 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002321 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002322 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2323 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2324 ($edge) = $1;
2325 last;
2326 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002327 }
2328 if (defined $edge && $edge eq '*/') {
2329 $in_comment = 1;
2330 }
2331
2332 # Guestimate if this is a continuing comment. If this
2333 # is the start of a diff block and this line starts
2334 # ' *' then it is very likely a comment.
2335 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002336 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002337 {
2338 $in_comment = 1;
2339 }
2340
2341 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2342 sanitise_line_reset($in_comment);
2343
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002344 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002345 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002346 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002347 $line = sanitise_line($rawline);
2348 }
2349 push(@lines, $line);
2350
2351 if ($realcnt > 1) {
2352 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2353 } else {
2354 $realcnt = 0;
2355 }
2356
2357 #print "==>$rawline\n";
2358 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002359
2360 if ($setup_docs && $line =~ /^\+/) {
2361 push(@setup_docs, $line);
2362 }
2363 }
2364
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002365 $prefix = '';
2366
Andy Whitcroft773647a2008-03-28 14:15:58 -07002367 $realcnt = 0;
2368 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002369 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002370 foreach my $line (@lines) {
2371 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002372 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002373 my $sline = $line; #copy of $line
2374 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002375
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002376 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002377
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002378#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002379 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002380 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2381 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002382 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002383 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002384 $realline=$1-1;
2385 if (defined $2) {
2386 $realcnt=$3+1;
2387 } else {
2388 $realcnt=1+1;
2389 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002390 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002391 $prev_values = 'E';
2392
Andy Whitcroft773647a2008-03-28 14:15:58 -07002393 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002394 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002395 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002396 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002397 if ($context =~ /\b(\w+)\s*\(/) {
2398 $context_function = $1;
2399 } else {
2400 undef $context_function;
2401 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002402 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002403
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002404# track the line number as we move through the hunk, note that
2405# new versions of GNU diff omit the leading space on completely
2406# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002407 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002408 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002409 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002410
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002411 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002412 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002413
2414 # Track the previous line.
2415 ($prevline, $stashline) = ($stashline, $line);
2416 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002417 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2418
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002420
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002421 } elsif ($realcnt == 1) {
2422 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002423 }
2424
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002425 my $hunk_line = ($realcnt != 0);
2426
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002427 $here = "#$linenr: " if (!$file);
2428 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002429
Joe Perches2ac73b42014-06-04 16:12:05 -07002430 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002431 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002432 if ($line =~ /^diff --git.*?(\S+)$/) {
2433 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002434 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002435 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002436 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002437 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002438 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002439 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002440 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002441
2442 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002443 if (!$file && $tree && $p1_prefix ne '' &&
2444 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002445 WARN("PATCH_PREFIX",
2446 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002447 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002448
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002449 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002450 ERROR("MODIFIED_INCLUDE_ASM",
2451 "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 -07002452 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002453 $found_file = 1;
2454 }
2455
Joe Perches34d88152015-06-25 15:03:05 -07002456#make up the handle for any error we report on this line
2457 if ($showfile) {
2458 $prefix = "$realfile:$realline: "
2459 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002460 if ($file) {
2461 $prefix = "$filename:$realline: ";
2462 } else {
2463 $prefix = "$filename:$linenr: ";
2464 }
Joe Perches34d88152015-06-25 15:03:05 -07002465 }
2466
Joe Perches2ac73b42014-06-04 16:12:05 -07002467 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002468 if (is_maintained_obsolete($realfile)) {
2469 WARN("OBSOLETE",
2470 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2471 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002472 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002473 $check = 1;
2474 } else {
2475 $check = $check_orig;
2476 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002477 $checklicenseline = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002478 next;
2479 }
2480
Randy Dunlap389834b2007-06-08 13:47:03 -07002481 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002482
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002483 my $hereline = "$here\n$rawline\n";
2484 my $herecurr = "$here\n$rawline\n";
2485 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002486
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002487 $cnt_lines++ if ($realcnt != 0);
2488
Joe Perchese518e9a2015-06-25 15:03:27 -07002489# Check if the commit log has what seems like a diff which can confuse patch
2490 if ($in_commit_log && !$commit_log_has_diff &&
2491 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2492 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2493 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2494 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2495 ERROR("DIFF_IN_COMMIT_MSG",
2496 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2497 $commit_log_has_diff = 1;
2498 }
2499
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002500# Check for incorrect file permissions
2501 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2502 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002503 if ($realfile !~ m@scripts/@ &&
2504 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002505 ERROR("EXECUTE_PERMISSIONS",
2506 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002507 }
2508 }
2509
Joe Perches20112472011-07-25 17:13:23 -07002510# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002511 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002512 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002513 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002514 }
2515
Joe Perchese0d975b2014-12-10 15:51:49 -08002516# Check if MAINTAINERS is being updated. If so, there's probably no need to
2517# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2518 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2519 $reported_maintainer_file = 1;
2520 }
2521
Joe Perches20112472011-07-25 17:13:23 -07002522# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002523 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002524 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002525 my $space_before = $1;
2526 my $sign_off = $2;
2527 my $space_after = $3;
2528 my $email = $4;
2529 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2530
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002531 if ($sign_off !~ /$signature_tags/) {
2532 WARN("BAD_SIGN_OFF",
2533 "Non-standard signature: $sign_off\n" . $herecurr);
2534 }
Joe Perches20112472011-07-25 17:13:23 -07002535 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002536 if (WARN("BAD_SIGN_OFF",
2537 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2538 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002539 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002540 "$ucfirst_sign_off $email";
2541 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002542 }
Joe Perches20112472011-07-25 17:13:23 -07002543 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002544 if (WARN("BAD_SIGN_OFF",
2545 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2546 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002547 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002548 "$ucfirst_sign_off $email";
2549 }
2550
Joe Perches20112472011-07-25 17:13:23 -07002551 }
2552 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002553 if (WARN("BAD_SIGN_OFF",
2554 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2555 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002556 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002557 "$ucfirst_sign_off $email";
2558 }
Joe Perches20112472011-07-25 17:13:23 -07002559 }
2560
2561 my ($email_name, $email_address, $comment) = parse_email($email);
2562 my $suggested_email = format_email(($email_name, $email_address));
2563 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002564 ERROR("BAD_SIGN_OFF",
2565 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002566 } else {
2567 my $dequoted = $suggested_email;
2568 $dequoted =~ s/^"//;
2569 $dequoted =~ s/" </ </;
2570 # Don't force email to have quotes
2571 # Allow just an angle bracketed address
2572 if ("$dequoted$comment" ne $email &&
2573 "<$email_address>$comment" ne $email &&
2574 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002575 WARN("BAD_SIGN_OFF",
2576 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002577 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002578 }
Joe Perches7e51f192013-09-11 14:23:57 -07002579
2580# Check for duplicate signatures
2581 my $sig_nospace = $line;
2582 $sig_nospace =~ s/\s//g;
2583 $sig_nospace = lc($sig_nospace);
2584 if (defined $signatures{$sig_nospace}) {
2585 WARN("BAD_SIGN_OFF",
2586 "Duplicate signature\n" . $herecurr);
2587 } else {
2588 $signatures{$sig_nospace} = 1;
2589 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002590 }
2591
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002592# Check email subject for common tools that don't need to be mentioned
2593 if ($in_header_lines &&
2594 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2595 WARN("EMAIL_SUBJECT",
2596 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2597 }
2598
Joe Perches9b3189e2014-06-04 16:12:10 -07002599# Check for old stable address
2600 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2601 ERROR("STABLE_ADDRESS",
2602 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2603 }
2604
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002605# Check for unwanted Gerrit info
2606 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2607 ERROR("GERRIT_CHANGE_ID",
2608 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2609 }
2610
Joe Perches369c8dd2015-11-06 16:31:34 -08002611# Check if the commit log is in a possible stack dump
2612 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2613 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2614 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2615 # timestamp
2616 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2617 # stack dump address
2618 $commit_log_possible_stack_dump = 1;
2619 }
2620
Joe Perches2a076f42015-04-16 12:44:28 -07002621# Check for line lengths > 75 in commit log, warn once
2622 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002623 length($line) > 75 &&
2624 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2625 # file delta changes
2626 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2627 # filename then :
2628 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2629 # A Fixes: or Link: line
2630 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002631 WARN("COMMIT_LOG_LONG_LINE",
2632 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2633 $commit_log_long_line = 1;
2634 }
2635
Joe Perchesbf4daf12015-09-09 15:37:50 -07002636# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002637 if ($in_commit_log && $commit_log_possible_stack_dump &&
2638 $line =~ /^\s*$/) {
2639 $commit_log_possible_stack_dump = 0;
2640 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002641
Joe Perches0d7835f2015-02-13 14:38:35 -08002642# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002643 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002644 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002645 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002646 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002647 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002648 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2649 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002650 my $init_char = "c";
2651 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002652 my $short = 1;
2653 my $long = 0;
2654 my $case = 1;
2655 my $space = 1;
2656 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002657 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002658 my $id = '0123456789ab';
2659 my $orig_desc = "commit description";
2660 my $description = "";
2661
Joe Perchesfe043ea2015-09-09 15:37:25 -07002662 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2663 $init_char = $1;
2664 $orig_commit = lc($2);
2665 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2666 $orig_commit = lc($1);
2667 }
2668
Joe Perches0d7835f2015-02-13 14:38:35 -08002669 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2670 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2671 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2672 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2673 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2674 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002675 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002676 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2677 defined $rawlines[$linenr] &&
2678 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2679 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002680 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002681 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2682 defined $rawlines[$linenr] &&
2683 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2684 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2685 $orig_desc = $1;
2686 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2687 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002688 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002689 }
2690
2691 ($id, $description) = git_commit_info($orig_commit,
2692 $id, $orig_desc);
2693
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002694 if (defined($id) &&
2695 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002696 ERROR("GIT_COMMIT_ID",
2697 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2698 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002699 }
2700
Joe Perches13f19372014-08-06 16:10:59 -07002701# Check for added, moved or deleted files
2702 if (!$reported_maintainer_file && !$in_commit_log &&
2703 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2704 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2705 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2706 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002707 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002708 $reported_maintainer_file = 1;
2709 WARN("FILE_PATH_CHANGES",
2710 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2711 }
2712
Andy Whitcroft00df3442007-06-08 13:47:06 -07002713# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002714 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002715 ERROR("CORRUPTED_PATCH",
2716 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002717 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002718 }
2719
2720# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2721 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002722 $rawline !~ m/^$UTF8*$/) {
2723 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2724
2725 my $blank = copy_spacing($rawline);
2726 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2727 my $hereptr = "$hereline$ptr\n";
2728
Joe Perches34d99212011-07-25 17:13:26 -07002729 CHK("INVALID_UTF8",
2730 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002731 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002732
Joe Perches15662b32011-10-31 17:13:12 -07002733# Check if it's the start of a commit log
2734# (not a header line and we haven't seen the patch filename)
2735 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002736 !($rawline =~ /^\s+(?:\S|$)/ ||
2737 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002738 $in_header_lines = 0;
2739 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002740 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002741 }
2742
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002743# Check if there is UTF-8 in a commit log when a mail header has explicitly
2744# declined it, i.e defined some charset where it is missing.
2745 if ($in_header_lines &&
2746 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2747 $1 !~ /utf-8/i) {
2748 $non_utf8_charset = 1;
2749 }
2750
2751 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002752 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002753 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002754 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2755 }
2756
Joe Perchesd6430f72016-12-12 16:46:28 -08002757# Check for absolute kernel paths in commit message
2758 if ($tree && $in_commit_log) {
2759 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2760 my $file = $1;
2761
2762 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2763 check_absolute_file($1, $herecurr)) {
2764 #
2765 } else {
2766 check_absolute_file($file, $herecurr);
2767 }
2768 }
2769 }
2770
Kees Cook66b47b42014-10-13 15:51:57 -07002771# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002772 if (defined($misspellings) &&
2773 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002774 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002775 my $typo = $1;
2776 my $typo_fix = $spelling_fix{lc($typo)};
2777 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2778 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002779 my $msg_level = \&WARN;
2780 $msg_level = \&CHK if ($file);
2781 if (&{$msg_level}("TYPO_SPELLING",
2782 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002783 $fix) {
2784 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2785 }
2786 }
2787 }
2788
Andy Whitcroft306708542008-10-15 22:02:28 -07002789# ignore non-hunk lines and lines being removed
2790 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002791
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002792#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002793 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002794 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002795 if (ERROR("DOS_LINE_ENDINGS",
2796 "DOS line endings\n" . $herevet) &&
2797 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002798 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002799 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002800 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2801 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002802 if (ERROR("TRAILING_WHITESPACE",
2803 "trailing whitespace\n" . $herevet) &&
2804 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002805 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002806 }
2807
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002808 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002809 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002810
Josh Triplett4783f892013-11-12 15:10:12 -08002811# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002812 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002813 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002814 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2815 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002816 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002817 my $msg_level = \&ERROR;
2818 $msg_level = \&CHK if ($file);
2819 &{$msg_level}("FSF_MAILING_ADDRESS",
2820 "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 -08002821 }
2822
Andi Kleen33549572010-05-24 14:33:29 -07002823# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002824# Only applies when adding the entry originally, after that we do not have
2825# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002826 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002827 # 'choice' is usually the last thing on the line (though
2828 # Kconfig supports named choices), so use a word boundary
2829 # (\b) rather than a whitespace character (\s)
2830 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002831 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002832 my $cnt = $realcnt;
2833 my $ln = $linenr + 1;
2834 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002835 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002836 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002837 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002838 $f = $lines[$ln - 1];
2839 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2840 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002841
2842 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002843 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002844
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002845 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002846 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002847 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2848 if ($lines[$ln - 1] =~ "---help---") {
2849 WARN("CONFIG_DESCRIPTION",
2850 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2851 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002852 $length = -1;
2853 }
2854
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002855 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002856 $f =~ s/#.*//;
2857 $f =~ s/^\s+//;
2858 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002859
2860 # This only checks context lines in the patch
2861 # and so hopefully shouldn't trigger false
2862 # positives, even though some of these are
2863 # common words in help texts
2864 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2865 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002866 $is_end = 1;
2867 last;
2868 }
Andi Kleen33549572010-05-24 14:33:29 -07002869 $length++;
2870 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002871 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2872 WARN("CONFIG_DESCRIPTION",
2873 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2874 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002875 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002876 }
2877
Joe Perches628f91a2017-07-10 15:52:07 -07002878# check for MAINTAINERS entries that don't have the right form
2879 if ($realfile =~ /^MAINTAINERS$/ &&
2880 $rawline =~ /^\+[A-Z]:/ &&
2881 $rawline !~ /^\+[A-Z]:\t\S/) {
2882 if (WARN("MAINTAINERS_STYLE",
2883 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2884 $fix) {
2885 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2886 }
2887 }
2888
Christoph Jaeger327953e2015-02-13 14:38:29 -08002889# discourage the use of boolean for type definition attributes of Kconfig options
2890 if ($realfile =~ /Kconfig/ &&
2891 $line =~ /^\+\s*\bboolean\b/) {
2892 WARN("CONFIG_TYPE_BOOLEAN",
2893 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2894 }
2895
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002896 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2897 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2898 my $flag = $1;
2899 my $replacement = {
2900 'EXTRA_AFLAGS' => 'asflags-y',
2901 'EXTRA_CFLAGS' => 'ccflags-y',
2902 'EXTRA_CPPFLAGS' => 'cppflags-y',
2903 'EXTRA_LDFLAGS' => 'ldflags-y',
2904 };
2905
2906 WARN("DEPRECATED_VARIABLE",
2907 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2908 }
2909
Rob Herringbff5da42014-01-23 15:54:51 -08002910# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002911 if (defined $root &&
2912 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2913 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2914
Rob Herringbff5da42014-01-23 15:54:51 -08002915 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2916
Florian Vaussardcc933192014-04-03 14:49:27 -07002917 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2918 my $vp_file = $dt_path . "vendor-prefixes.txt";
2919
Rob Herringbff5da42014-01-23 15:54:51 -08002920 foreach my $compat (@compats) {
2921 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002922 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2923 my $compat3 = $compat;
2924 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2925 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002926 if ( $? >> 8 ) {
2927 WARN("UNDOCUMENTED_DT_STRING",
2928 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2929 }
2930
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002931 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2932 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002933 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002934 if ( $? >> 8 ) {
2935 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002936 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002937 }
2938 }
2939 }
2940
Rob Herring9f3a8992018-04-10 16:33:13 -07002941# check for using SPDX license tag at beginning of files
2942 if ($realline == $checklicenseline) {
2943 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2944 $checklicenseline = 2;
2945 } elsif ($rawline =~ /^\+/) {
2946 my $comment = "";
2947 if ($realfile =~ /\.(h|s|S)$/) {
2948 $comment = '/*';
2949 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2950 $comment = '//';
2951 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2952 $comment = '#';
2953 } elsif ($realfile =~ /\.rst$/) {
2954 $comment = '..';
2955 }
2956
2957 if ($comment !~ /^$/ &&
2958 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
2959 WARN("SPDX_LICENSE_TAG",
2960 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
2961 }
2962 }
2963 }
2964
Andy Whitcroft5368df202008-10-15 22:02:27 -07002965# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002966 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002967
Joe Perches47e0c882015-06-25 15:02:57 -07002968# line length limit (with some exclusions)
2969#
2970# There are a few types of lines that may extend beyond $max_line_length:
2971# logging functions like pr_info that end in a string
2972# lines with a single string
2973# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002974# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07002975#
2976# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002977# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002978# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2979# LONG_LINE all other lines longer than $max_line_length
2980#
2981# if LONG_LINE is ignored, the other 2 types are also ignored
2982#
2983
Joe Perchesb4749e92015-07-17 16:24:01 -07002984 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002985 my $msg_type = "LONG_LINE";
2986
2987 # Check the allowed long line types first
2988
2989 # logging functions that end in a string that starts
2990 # before $max_line_length
2991 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2992 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2993 $msg_type = "";
2994
2995 # lines with only strings (w/ possible termination)
2996 # #defines with only strings
2997 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2998 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2999 $msg_type = "";
3000
Joe Perchescc147502017-11-17 15:28:44 -08003001 # More special cases
3002 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
3003 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07003004 $msg_type = "";
3005
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08003006 # URL ($rawline is used in case the URL is in a comment)
3007 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
3008 $msg_type = "";
3009
Joe Perches47e0c882015-06-25 15:02:57 -07003010 # Otherwise set the alternate message types
3011
3012 # a comment starts before $max_line_length
3013 } elsif ($line =~ /($;[\s$;]*)$/ &&
3014 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3015 $msg_type = "LONG_LINE_COMMENT"
3016
3017 # a quoted string starts before $max_line_length
3018 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
3019 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
3020 $msg_type = "LONG_LINE_STRING"
3021 }
3022
3023 if ($msg_type ne "" &&
3024 (show_type("LONG_LINE") || show_type($msg_type))) {
3025 WARN($msg_type,
3026 "line over $max_line_length characters\n" . $herecurr);
3027 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003028 }
3029
Andy Whitcroft8905a672007-11-28 16:21:06 -08003030# check for adding lines without a newline.
3031 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003032 WARN("MISSING_EOF_NEWLINE",
3033 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003034 }
3035
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003036# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003037 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003038
3039# at the beginning of a line any tabs must come first and anything
3040# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003041 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3042 $rawline =~ /^\+\s* \s*/) {
3043 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003044 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003045 if (ERROR("CODE_INDENT",
3046 "code indent should use tabs where possible\n" . $herevet) &&
3047 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003048 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003049 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003050 }
3051
Alberto Panizzo08e44362010-03-05 13:43:54 -08003052# check for space before tabs.
3053 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3054 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003055 if (WARN("SPACE_BEFORE_TAB",
3056 "please, no space before tabs\n" . $herevet) &&
3057 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003058 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003059 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003060 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003061 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003062 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003063 }
3064
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003065# check for && or || at the start of a line
3066 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3067 CHK("LOGICAL_CONTINUATIONS",
3068 "Logical continuations should be on the previous line\n" . $hereprev);
3069 }
3070
Joe Perchesa91e8992016-05-20 17:04:05 -07003071# check indentation starts on a tab stop
3072 if ($^V && $^V ge 5.10.0 &&
Joe Perchesbd491112018-02-06 15:39:06 -08003073 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003074 my $indent = length($1);
3075 if ($indent % 8) {
3076 if (WARN("TABSTOP",
3077 "Statements should start on a tabstop\n" . $herecurr) &&
3078 $fix) {
3079 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3080 }
3081 }
3082 }
3083
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003084# check multi-line statement indentation matches previous line
3085 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003086 $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 -07003087 $prevline =~ /^\+(\t*)(.*)$/;
3088 my $oldindent = $1;
3089 my $rest = $2;
3090
3091 my $pos = pos_last_openparen($rest);
3092 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003093 $line =~ /^(\+| )([ \t]*)/;
3094 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003095
3096 my $goodtabindent = $oldindent .
3097 "\t" x ($pos / 8) .
3098 " " x ($pos % 8);
3099 my $goodspaceindent = $oldindent . " " x $pos;
3100
3101 if ($newindent ne $goodtabindent &&
3102 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003103
3104 if (CHK("PARENTHESIS_ALIGNMENT",
3105 "Alignment should match open parenthesis\n" . $hereprev) &&
3106 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003107 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003108 s/^\+[ \t]*/\+$goodtabindent/;
3109 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003110 }
3111 }
3112 }
3113
Joe Perches6ab3a972015-04-16 12:44:05 -07003114# check for space after cast like "(int) foo" or "(struct foo) bar"
3115# avoid checking a few false positives:
3116# "sizeof(<type>)" or "__alignof__(<type>)"
3117# function pointer declarations like "(*foo)(int) = bar;"
3118# structure definitions like "(struct foo) { 0 };"
3119# multiline macros that define functions
3120# known attributes or the __attribute__ keyword
3121 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3122 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003123 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003124 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003125 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003126 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003127 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003128 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003129 }
3130
Joe Perches86406b12015-09-09 15:37:41 -07003131# Block comment styles
3132# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003133 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003134 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003135 $rawline =~ /^\+[ \t]*\*/ &&
3136 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003137 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3138 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3139 }
3140
Joe Perches86406b12015-09-09 15:37:41 -07003141# Block comments use * on subsequent lines
3142 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3143 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003144 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003145 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003146 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003147 WARN("BLOCK_COMMENT_STYLE",
3148 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003149 }
3150
Joe Perches86406b12015-09-09 15:37:41 -07003151# Block comments use */ on trailing lines
3152 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003153 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3154 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3155 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003156 WARN("BLOCK_COMMENT_STYLE",
3157 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003158 }
3159
Joe Perches08eb9b82016-10-11 13:51:50 -07003160# Block comment * alignment
3161 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003162 $line =~ /^\+[ \t]*$;/ && #leading comment
3163 $rawline =~ /^\+[ \t]*\*/ && #leading *
3164 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003165 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003166 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3167 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003168 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003169 if (defined($1)) {
3170 $oldindent = expand_tabs($1);
3171 } else {
3172 $prevrawline =~ m@^\+(.*/?)\*@;
3173 $oldindent = expand_tabs($1);
3174 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003175 $rawline =~ m@^\+([ \t]*)\*@;
3176 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003177 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003178 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003179 WARN("BLOCK_COMMENT_STYLE",
3180 "Block comments should align the * on each line\n" . $hereprev);
3181 }
3182 }
3183
Joe Perches7f619192014-08-06 16:10:39 -07003184# check for missing blank lines after struct/union declarations
3185# with exceptions for various attributes and macros
3186 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3187 $line =~ /^\+/ &&
3188 !($line =~ /^\+\s*$/ ||
3189 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3190 $line =~ /^\+\s*MODULE_/i ||
3191 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3192 $line =~ /^\+[a-z_]*init/ ||
3193 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3194 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003195 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003196 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003197 if (CHK("LINE_SPACING",
3198 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3199 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003200 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003201 }
Joe Perches7f619192014-08-06 16:10:39 -07003202 }
3203
Joe Perches365dd4e2014-08-06 16:10:42 -07003204# check for multiple consecutive blank lines
3205 if ($prevline =~ /^[\+ ]\s*$/ &&
3206 $line =~ /^\+\s*$/ &&
3207 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003208 if (CHK("LINE_SPACING",
3209 "Please don't use multiple blank lines\n" . $hereprev) &&
3210 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003211 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003212 }
3213
Joe Perches365dd4e2014-08-06 16:10:42 -07003214 $last_blank_line = $linenr;
3215 }
3216
Joe Perches3b617e32014-04-03 14:49:28 -07003217# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003218 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3219 # actual declarations
3220 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003221 # function pointer declarations
3222 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003223 # foo bar; where foo is some local typedef or #define
3224 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3225 # known declaration macros
3226 $prevline =~ /^\+\s+$declaration_macros/) &&
3227 # for "else if" which can look like "$Ident $Ident"
3228 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3229 # other possible extensions of declaration lines
3230 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3231 # not starting a section or a macro "\" extended line
3232 $prevline =~ /(?:\{\s*|\\)$/) &&
3233 # looks like a declaration
3234 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003235 # function pointer declarations
3236 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003237 # foo bar; where foo is some local typedef or #define
3238 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3239 # known declaration macros
3240 $sline =~ /^\+\s+$declaration_macros/ ||
3241 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003242 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003243 # start or end of block or continuation of declaration
3244 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3245 # bitfield continuation
3246 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3247 # other possible extensions of declaration lines
3248 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3249 # indentation of previous and current line are the same
3250 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003251 if (WARN("LINE_SPACING",
3252 "Missing a blank line after declarations\n" . $hereprev) &&
3253 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003254 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003255 }
Joe Perches3b617e32014-04-03 14:49:28 -07003256 }
3257
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003258# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003259# Exceptions:
3260# 1) within comments
3261# 2) indented preprocessor commands
3262# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003263 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003264 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003265 if (WARN("LEADING_SPACE",
3266 "please, no spaces at the start of a line\n" . $herevet) &&
3267 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003268 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003269 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003270 }
3271
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003272# check we are in a valid C source file if not then ignore this hunk
3273 next if ($realfile !~ /\.(h|c)$/);
3274
Joe Perches5751a242017-11-17 15:28:52 -08003275# check for unusual line ending [ or (
3276 if ($line =~ /^\+.*([\[\(])\s*$/) {
3277 CHK("OPEN_ENDED_LINE",
3278 "Lines should not end with a '$1'\n" . $herecurr);
3279 }
3280
Joe Perches4dbed762017-05-08 15:55:39 -07003281# check if this appears to be the start function declaration, save the name
3282 if ($sline =~ /^\+\{\s*$/ &&
3283 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3284 $context_function = $1;
3285 }
3286
3287# check if this appears to be the end of function declaration
3288 if ($sline =~ /^\+\}\s*$/) {
3289 undef $context_function;
3290 }
3291
Joe Perches032a4c02014-08-06 16:10:29 -07003292# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003293# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003294# if the previous line is a break or return and is indented 1 tab more...
3295 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3296 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003297 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3298 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3299 defined $lines[$linenr] &&
3300 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003301 WARN("UNNECESSARY_ELSE",
3302 "else is not generally useful after a break or return\n" . $hereprev);
3303 }
3304 }
3305
Joe Perchesc00df192014-08-06 16:11:01 -07003306# check indentation of a line with a break;
3307# if the previous line is a goto or return and is indented the same # of tabs
3308 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3309 my $tabs = $1;
3310 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3311 WARN("UNNECESSARY_BREAK",
3312 "break is not useful after a goto or return\n" . $hereprev);
3313 }
3314 }
3315
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003316# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003317 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003318 WARN("CVS_KEYWORD",
3319 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003320 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003321
Joe Perches56e77d72013-02-21 16:44:14 -08003322# check for old HOTPLUG __dev<foo> section markings
3323 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3324 WARN("HOTPLUG_SECTION",
3325 "Using $1 is unnecessary\n" . $herecurr);
3326 }
3327
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003328# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003329 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3330 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003331#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003332 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003333 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003334 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003335 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003336 $stat =~ s/\n./\n /g;
3337 $cond =~ s/\n./\n /g;
3338
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003339#print "linenr<$linenr> <$stat>\n";
3340 # If this statement has no statement boundaries within
3341 # it there is no point in retrying a statement scan
3342 # until we hit end of it.
3343 my $frag = $stat; $frag =~ s/;+\s*$//;
3344 if ($frag !~ /(?:{|;)/) {
3345#print "skip<$line_nr_next>\n";
3346 $suppress_statement = $line_nr_next;
3347 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003348
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003349 # Find the real next line.
3350 $realline_next = $line_nr_next;
3351 if (defined $realline_next &&
3352 (!defined $lines[$realline_next - 1] ||
3353 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3354 $realline_next++;
3355 }
3356
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003357 my $s = $stat;
3358 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003359
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003360 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003361 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003362
3363 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003364 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003365
Andy Whitcroft463f2862009-09-21 17:04:34 -07003366 } elsif ($s =~ /^.\s*else\b/s) {
3367
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003368 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003369 } 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 -07003370 my $type = $1;
3371 $type =~ s/\s+/ /g;
3372 possible($type, "A:" . $s);
3373
Andy Whitcroft8905a672007-11-28 16:21:06 -08003374 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003375 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003376 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003377 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003378
3379 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003380 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003381 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003382 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003383
3384 # Check for any sort of function declaration.
3385 # int foo(something bar, other baz);
3386 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003387 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 -08003388 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003389
Andy Whitcroftcf655042008-03-04 14:28:20 -08003390 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003391 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003392 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003393
Andy Whitcroft8905a672007-11-28 16:21:06 -08003394 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003395 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003396
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003397 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003398 }
3399 }
3400 }
3401
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003402 }
3403
Andy Whitcroft653d4872007-06-23 17:16:34 -07003404#
3405# Checks which may be anchored in the context.
3406#
3407
3408# Check for switch () and associated case and default
3409# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003410 if ($line=~/\bswitch\s*\(.*\)/) {
3411 my $err = '';
3412 my $sep = '';
3413 my @ctx = ctx_block_outer($linenr, $realcnt);
3414 shift(@ctx);
3415 for my $ctx (@ctx) {
3416 my ($clen, $cindent) = line_stats($ctx);
3417 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3418 $indent != $cindent) {
3419 $err .= "$sep$ctx\n";
3420 $sep = '';
3421 } else {
3422 $sep = "[...]\n";
3423 }
3424 }
3425 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003426 ERROR("SWITCH_CASE_INDENT_LEVEL",
3427 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003428 }
3429 }
3430
3431# if/while/etc brace do not go on next line, unless defining a do while loop,
3432# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003433 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 -07003434 my $pre_ctx = "$1$2";
3435
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003436 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003437
3438 if ($line =~ /^\+\t{6,}/) {
3439 WARN("DEEP_INDENTATION",
3440 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3441 }
3442
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003443 my $ctx_cnt = $realcnt - $#ctx - 1;
3444 my $ctx = join("\n", @ctx);
3445
Andy Whitcroft548596d2008-07-23 21:29:01 -07003446 my $ctx_ln = $linenr;
3447 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003448
Andy Whitcroft548596d2008-07-23 21:29:01 -07003449 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3450 defined $lines[$ctx_ln - 1] &&
3451 $lines[$ctx_ln - 1] =~ /^-/)) {
3452 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3453 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003454 $ctx_ln++;
3455 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003456
Andy Whitcroft53210162008-07-23 21:29:03 -07003457 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3458 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003459
Joe Perchesd752fcc2014-08-06 16:11:05 -07003460 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003461 ERROR("OPEN_BRACE",
3462 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003463 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003464 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003465 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3466 $ctx =~ /\)\s*\;\s*$/ &&
3467 defined $lines[$ctx_ln - 1])
3468 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003469 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3470 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003471 WARN("TRAILING_SEMICOLON",
3472 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003473 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003474 }
3475 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003476 }
3477
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003478# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003479 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 -08003480 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3481 ctx_statement_block($linenr, $realcnt, 0)
3482 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003483 my ($s, $c) = ($stat, $cond);
3484
3485 substr($s, 0, length($c), '');
3486
Joe Perches9f5af482015-09-09 15:37:30 -07003487 # remove inline comments
3488 $s =~ s/$;/ /g;
3489 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003490
3491 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003492 my @newlines = ($c =~ /\n/gs);
3493 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003494
Joe Perches9f5af482015-09-09 15:37:30 -07003495 # Make sure we remove the line prefixes as we have
3496 # none on the first line, and are going to readd them
3497 # where necessary.
3498 $s =~ s/\n./\n/gs;
3499 while ($s =~ /\n\s+\\\n/) {
3500 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3501 }
3502
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003503 # We want to check the first line inside the block
3504 # starting at the end of the conditional, so remove:
3505 # 1) any blank line termination
3506 # 2) any opening brace { on end of the line
3507 # 3) any do (...) {
3508 my $continuation = 0;
3509 my $check = 0;
3510 $s =~ s/^.*\bdo\b//;
3511 $s =~ s/^\s*{//;
3512 if ($s =~ s/^\s*\\//) {
3513 $continuation = 1;
3514 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003515 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003516 $check = 1;
3517 $cond_lines++;
3518 }
3519
3520 # Also ignore a loop construct at the end of a
3521 # preprocessor statement.
3522 if (($prevline =~ /^.\s*#\s*define\s/ ||
3523 $prevline =~ /\\\s*$/) && $continuation == 0) {
3524 $check = 0;
3525 }
3526
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003527 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003528 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003529 while ($cond_ptr != $cond_lines) {
3530 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003531
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003532 # If we see an #else/#elif then the code
3533 # is not linear.
3534 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3535 $check = 0;
3536 }
3537
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003538 # Ignore:
3539 # 1) blank lines, they should be at 0,
3540 # 2) preprocessor lines, and
3541 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003542 if ($continuation ||
3543 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003544 $s =~ /^\s*#\s*?/ ||
3545 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003546 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003547 if ($s =~ s/^.*?\n//) {
3548 $cond_lines++;
3549 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003550 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003551 }
3552
3553 my (undef, $sindent) = line_stats("+" . $s);
3554 my $stat_real = raw_line($linenr, $cond_lines);
3555
3556 # Check if either of these lines are modified, else
3557 # this is not this patch's fault.
3558 if (!defined($stat_real) ||
3559 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3560 $check = 0;
3561 }
3562 if (defined($stat_real) && $cond_lines > 1) {
3563 $stat_real = "[...]\n$stat_real";
3564 }
3565
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003566 #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 -07003567
Joe Perches9f5af482015-09-09 15:37:30 -07003568 if ($check && $s ne '' &&
3569 (($sindent % 8) != 0 ||
3570 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003571 ($sindent == $indent &&
3572 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003573 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003574 WARN("SUSPECT_CODE_INDENT",
3575 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003576 }
3577 }
3578
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003579 # Track the 'values' across context and added lines.
3580 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003581 my ($curr_values, $curr_vars) =
3582 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003583 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003584 if ($dbg_values) {
3585 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003586 print "$linenr > .$outline\n";
3587 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003588 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003589 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003590 $prev_values = substr($curr_values, -1);
3591
Andy Whitcroft00df3442007-06-08 13:47:06 -07003592#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003593 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003594
Joe Perches11ca40a2016-12-12 16:46:31 -08003595# check for dereferences that span multiple lines
3596 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3597 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3598 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3599 my $ref = $1;
3600 $line =~ /^.\s*($Lval)/;
3601 $ref .= $1;
3602 $ref =~ s/\s//g;
3603 WARN("MULTILINE_DEREFERENCE",
3604 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3605 }
3606
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003607# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003608 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 -07003609 my $type = $1;
3610 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003611 $var = "" if (!defined $var);
3612 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003613 my $sign = $1;
3614 my $pointer = $2;
3615
3616 $pointer = "" if (!defined $pointer);
3617
3618 if (WARN("UNSPECIFIED_INT",
3619 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3620 $fix) {
3621 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003622 my $comp_pointer = $pointer;
3623 $comp_pointer =~ s/\s//g;
3624 $decl .= $comp_pointer;
3625 $decl = rtrim($decl) if ($var eq "");
3626 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003627 }
3628 }
3629 }
3630
Andy Whitcroft653d4872007-06-23 17:16:34 -07003631# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003632 if ($dbg_type) {
3633 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003634 ERROR("TEST_TYPE",
3635 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003636 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003637 ERROR("TEST_NOT_TYPE",
3638 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003639 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003640 next;
3641 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003642# TEST: allow direct testing of the attribute matcher.
3643 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003644 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003645 ERROR("TEST_ATTR",
3646 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003647 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003648 ERROR("TEST_NOT_ATTR",
3649 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003650 }
3651 next;
3652 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003653
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003654# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003655 if ($line =~ /^.\s*{/ &&
3656 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003657 if (ERROR("OPEN_BRACE",
3658 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003659 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3660 fix_delete_line($fixlinenr - 1, $prevrawline);
3661 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003662 my $fixedline = $prevrawline;
3663 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003664 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003665 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003666 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003667 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003668 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003669 }
3670
Andy Whitcroft653d4872007-06-23 17:16:34 -07003671#
3672# Checks which are anchored on the added line.
3673#
3674
3675# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003676 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003677 my $path = $1;
3678 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003679 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003680 "malformed #include filename\n" . $herecurr);
3681 }
3682 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3683 ERROR("UAPI_INCLUDE",
3684 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003685 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003686 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003687
3688# no C99 // comments
3689 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003690 if (ERROR("C99_COMMENTS",
3691 "do not use C99 // comments\n" . $herecurr) &&
3692 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003693 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003694 if ($line =~ /\/\/(.*)$/) {
3695 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003696 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003697 }
3698 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003699 }
3700 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003701 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003702 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003703
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003704# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3705# the whole statement.
3706#print "APW <$lines[$realline_next - 1]>\n";
3707 if (defined $realline_next &&
3708 exists $lines[$realline_next - 1] &&
3709 !defined $suppress_export{$realline_next} &&
3710 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3711 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003712 # Handle definitions which produce identifiers with
3713 # a prefix:
3714 # XXX(foo);
3715 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003716 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003717 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003718 $name =~ /^${Ident}_$2/) {
3719#print "FOO C name<$name>\n";
3720 $suppress_export{$realline_next} = 1;
3721
3722 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003723 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003724 ^.DEFINE_$Ident\(\Q$name\E\)|
3725 ^.DECLARE_$Ident\(\Q$name\E\)|
3726 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003727 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3728 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003729 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003730#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3731 $suppress_export{$realline_next} = 2;
3732 } else {
3733 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003734 }
3735 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003736 if (!defined $suppress_export{$linenr} &&
3737 $prevline =~ /^.\s*$/ &&
3738 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3739 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3740#print "FOO B <$lines[$linenr - 1]>\n";
3741 $suppress_export{$linenr} = 2;
3742 }
3743 if (defined $suppress_export{$linenr} &&
3744 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003745 WARN("EXPORT_SYMBOL",
3746 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003747 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003748
Joe Eloff5150bda2010-08-09 17:21:00 -07003749# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003750 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003751 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003752 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003753 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003754 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003755 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003756 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003757# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003758 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003759 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003760 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003761 $herecurr) &&
3762 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003763 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003764 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003765 }
3766
Joe Perches18130872014-08-06 16:11:22 -07003767# check for misordered declarations of char/short/int/long with signed/unsigned
3768 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3769 my $tmp = trim($1);
3770 WARN("MISORDERED_TYPE",
3771 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3772 }
3773
Joe Perchescb710ec2010-10-26 14:23:20 -07003774# check for static const char * arrays.
3775 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003776 WARN("STATIC_CONST_CHAR_ARRAY",
3777 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003778 $herecurr);
3779 }
3780
3781# check for static char foo[] = "bar" declarations.
3782 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003783 WARN("STATIC_CONST_CHAR_ARRAY",
3784 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003785 $herecurr);
3786 }
3787
Joe Perchesab7e23f2015-04-16 12:44:22 -07003788# check for const <foo> const where <foo> is not a pointer or array type
3789 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3790 my $found = $1;
3791 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3792 WARN("CONST_CONST",
3793 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3794 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3795 WARN("CONST_CONST",
3796 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3797 }
3798 }
3799
Joe Perches9b0fa602014-04-03 14:49:18 -07003800# check for non-global char *foo[] = {"bar", ...} declarations.
3801 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3802 WARN("STATIC_CONST_CHAR_ARRAY",
3803 "char * array declaration might be better as static const\n" .
3804 $herecurr);
3805 }
3806
Joe Perchesb598b672015-04-16 12:44:36 -07003807# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3808 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3809 my $array = $1;
3810 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3811 my $array_div = $1;
3812 if (WARN("ARRAY_SIZE",
3813 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3814 $fix) {
3815 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3816 }
3817 }
3818 }
3819
Joe Perchesb36190c2014-01-27 17:07:18 -08003820# check for function declarations without arguments like "int foo()"
3821 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3822 if (ERROR("FUNCTION_WITHOUT_ARGS",
3823 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3824 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003825 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003826 }
3827 }
3828
Andy Whitcroft653d4872007-06-23 17:16:34 -07003829# check for new typedefs, only function parameters and sparse annotations
3830# make sense.
3831 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003832 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003833 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003834 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003835 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003836 WARN("NEW_TYPEDEFS",
3837 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003838 }
3839
3840# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003841 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003842 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3843 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003844 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003845
Andy Whitcroft65863862009-01-06 14:41:21 -08003846 # Should start with a space.
3847 $to =~ s/^(\S)/ $1/;
3848 # Should not end with a space.
3849 $to =~ s/\s+$//;
3850 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003851 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003852 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003853
Joe Perches3705ce52013-07-03 15:05:31 -07003854## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003855 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003856 if (ERROR("POINTER_LOCATION",
3857 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3858 $fix) {
3859 my $sub_from = $ident;
3860 my $sub_to = $ident;
3861 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003862 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003863 s@\Q$sub_from\E@$sub_to@;
3864 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003865 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003866 }
3867 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3868 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003869 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003870
Andy Whitcroft65863862009-01-06 14:41:21 -08003871 # Should start with a space.
3872 $to =~ s/^(\S)/ $1/;
3873 # Should not end with a space.
3874 $to =~ s/\s+$//;
3875 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003876 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003877 }
3878 # Modifiers should have spaces.
3879 $to =~ s/(\b$Modifier$)/$1 /;
3880
Joe Perches3705ce52013-07-03 15:05:31 -07003881## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003882 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003883 if (ERROR("POINTER_LOCATION",
3884 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3885 $fix) {
3886
3887 my $sub_from = $match;
3888 my $sub_to = $match;
3889 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003890 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003891 s@\Q$sub_from\E@$sub_to@;
3892 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003893 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003894 }
3895
Joe Perches9d3e3c72015-09-09 15:37:27 -07003896# avoid BUG() or BUG_ON()
3897 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003898 my $msg_level = \&WARN;
3899 $msg_level = \&CHK if ($file);
3900 &{$msg_level}("AVOID_BUG",
3901 "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 -07003902 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003903
Joe Perches9d3e3c72015-09-09 15:37:27 -07003904# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003905 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003906 WARN("LINUX_VERSION_CODE",
3907 "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 -08003908 }
3909
Joe Perches17441222011-06-15 15:08:17 -07003910# check for uses of printk_ratelimit
3911 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003912 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003913 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003914 }
3915
Joe Percheseeef5732017-11-17 15:28:41 -08003916# printk should use KERN_* levels
3917 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3918 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3919 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003920 }
3921
Joe Perches243f3802012-05-31 16:26:09 -07003922 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3923 my $orig = $1;
3924 my $level = lc($orig);
3925 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003926 my $level2 = $level;
3927 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003928 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003929 "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 -07003930 }
3931
3932 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003933 if (WARN("PREFER_PR_LEVEL",
3934 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3935 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003936 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003937 s/\bpr_warning\b/pr_warn/;
3938 }
Joe Perches243f3802012-05-31 16:26:09 -07003939 }
3940
Joe Perchesdc139312013-02-21 16:44:13 -08003941 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3942 my $orig = $1;
3943 my $level = lc($orig);
3944 $level = "warn" if ($level eq "warning");
3945 $level = "dbg" if ($level eq "debug");
3946 WARN("PREFER_DEV_LEVEL",
3947 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3948 }
3949
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003950# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3951# number of false positives, but assembly files are not checked, so at
3952# least the arch entry code will not trigger this warning.
3953 if ($line =~ /\bENOSYS\b/) {
3954 WARN("ENOSYS",
3955 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3956 }
3957
Andy Whitcroft653d4872007-06-23 17:16:34 -07003958# function brace can't be on same line, except for #defines of do while,
3959# or if closed on same line
Joe Perches2d453e32018-02-06 15:39:09 -08003960 if ($^V && $^V ge 5.10.0 &&
3961 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3962 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3963 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07003964 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08003965 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07003966 $fix) {
3967 fix_delete_line($fixlinenr, $rawline);
3968 my $fixed_line = $rawline;
3969 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3970 my $line1 = $1;
3971 my $line2 = $2;
3972 fix_insert_line($fixlinenr, ltrim($line1));
3973 fix_insert_line($fixlinenr, "\+{");
3974 if ($line2 !~ /^\s*$/) {
3975 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3976 }
3977 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003978 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003979
Andy Whitcroft8905a672007-11-28 16:21:06 -08003980# open braces for enum, union and struct go on the same line.
3981 if ($line =~ /^.\s*{/ &&
3982 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003983 if (ERROR("OPEN_BRACE",
3984 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3985 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3986 fix_delete_line($fixlinenr - 1, $prevrawline);
3987 fix_delete_line($fixlinenr, $rawline);
3988 my $fixedline = rtrim($prevrawline) . " {";
3989 fix_insert_line($fixlinenr, $fixedline);
3990 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003991 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003992 if ($fixedline !~ /^\+\s*$/) {
3993 fix_insert_line($fixlinenr, $fixedline);
3994 }
3995 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003996 }
3997
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003998# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003999 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
4000 if (WARN("SPACING",
4001 "missing space after $1 definition\n" . $herecurr) &&
4002 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004003 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004004 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
4005 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07004006 }
4007
Joe Perches31070b52014-01-23 15:54:49 -08004008# Function pointer declarations
4009# check spacing between type, funcptr, and args
4010# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004011 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08004012 my $declare = $1;
4013 my $pre_pointer_space = $2;
4014 my $post_pointer_space = $3;
4015 my $funcname = $4;
4016 my $post_funcname_space = $5;
4017 my $pre_args_space = $6;
4018
Joe Perches91f72e92014-04-03 14:49:12 -07004019# the $Declare variable will capture all spaces after the type
4020# so check it for a missing trailing missing space but pointer return types
4021# don't need a space so don't warn for those.
4022 my $post_declare_space = "";
4023 if ($declare =~ /(\s+)$/) {
4024 $post_declare_space = $1;
4025 $declare = rtrim($declare);
4026 }
4027 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004028 WARN("SPACING",
4029 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004030 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004031 }
4032
4033# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004034# This test is not currently implemented because these declarations are
4035# equivalent to
4036# int foo(int bar, ...)
4037# and this is form shouldn't/doesn't generate a checkpatch warning.
4038#
4039# elsif ($declare =~ /\s{2,}$/) {
4040# WARN("SPACING",
4041# "Multiple spaces after return type\n" . $herecurr);
4042# }
Joe Perches31070b52014-01-23 15:54:49 -08004043
4044# unnecessary space "type ( *funcptr)(args...)"
4045 if (defined $pre_pointer_space &&
4046 $pre_pointer_space =~ /^\s/) {
4047 WARN("SPACING",
4048 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4049 }
4050
4051# unnecessary space "type (* funcptr)(args...)"
4052 if (defined $post_pointer_space &&
4053 $post_pointer_space =~ /^\s/) {
4054 WARN("SPACING",
4055 "Unnecessary space before function pointer name\n" . $herecurr);
4056 }
4057
4058# unnecessary space "type (*funcptr )(args...)"
4059 if (defined $post_funcname_space &&
4060 $post_funcname_space =~ /^\s/) {
4061 WARN("SPACING",
4062 "Unnecessary space after function pointer name\n" . $herecurr);
4063 }
4064
4065# unnecessary space "type (*funcptr) (args...)"
4066 if (defined $pre_args_space &&
4067 $pre_args_space =~ /^\s/) {
4068 WARN("SPACING",
4069 "Unnecessary space before function pointer arguments\n" . $herecurr);
4070 }
4071
4072 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004073 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004074 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004075 }
4076 }
4077
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004078# check for spacing round square brackets; allowed:
4079# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004080# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4081# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004082 while ($line =~ /(.*?\s)\[/g) {
4083 my ($where, $prefix) = ($-[1], $1);
4084 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004085 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004086 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004087 if (ERROR("BRACKET_SPACE",
4088 "space prohibited before open square bracket '['\n" . $herecurr) &&
4089 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004090 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004091 s/^(\+.*?)\s+\[/$1\[/;
4092 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004093 }
4094 }
4095
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004096# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004097 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004098 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004099 my $ctx_before = substr($line, 0, $-[1]);
4100 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004101
4102 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004103 if ($name =~ /^(?:
4104 if|for|while|switch|return|case|
4105 volatile|__volatile__|
4106 __attribute__|format|__extension__|
4107 asm|__asm__)$/x)
4108 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004109 # cpp #define statements have non-optional spaces, ie
4110 # if there is a space between the name and the open
4111 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004112 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004113
4114 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004115 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004116
4117 # If this whole things ends with a type its most
4118 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004119 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004120
4121 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004122 if (WARN("SPACING",
4123 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4124 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004125 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004126 s/\b$name\s+\(/$name\(/;
4127 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004128 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004129 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004130
Andy Whitcroft653d4872007-06-23 17:16:34 -07004131# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004132 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004133 my $fixed_line = "";
4134 my $line_fixed = 0;
4135
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004136 my $ops = qr{
4137 <<=|>>=|<=|>=|==|!=|
4138 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4139 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004140 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004141 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004142 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004143 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004144
4145## print("element count: <" . $#elements . ">\n");
4146## foreach my $el (@elements) {
4147## print("el: <$el>\n");
4148## }
4149
4150 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004151 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004152
Joe Perches3705ce52013-07-03 15:05:31 -07004153 foreach my $el (@elements) {
4154 push(@fix_elements, substr($rawline, $off, length($el)));
4155 $off += length($el);
4156 }
4157
4158 $off = 0;
4159
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004160 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004161 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004162
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004163 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004164
4165 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4166
4167## print("n: <$n> good: <$good>\n");
4168
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004169 $off += length($elements[$n]);
4170
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004171 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004172 my $ca = substr($opline, 0, $off);
4173 my $cc = '';
4174 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4175 $cc = substr($opline, $off + length($elements[$n + 1]));
4176 }
4177 my $cb = "$ca$;$cc";
4178
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004179 my $a = '';
4180 $a = 'V' if ($elements[$n] ne '');
4181 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004182 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004183 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4184 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004185 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004186
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004187 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004188
4189 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004190 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004191 $c = 'V' if ($elements[$n + 2] ne '');
4192 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004193 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004194 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4195 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004196 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004197 } else {
4198 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004199 }
4200
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004201 my $ctx = "${a}x${c}";
4202
4203 my $at = "(ctx:$ctx)";
4204
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004205 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004206 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004207
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004208 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004209 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004210
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004211 # Get the full operator variant.
4212 my $opv = $op . substr($curr_vars, $off, 1);
4213
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004214 # Ignore operators passed as parameters.
4215 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004216 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004217
Andy Whitcroftcf655042008-03-04 14:28:20 -08004218# # Ignore comments
4219# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004220
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004221 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004222 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004223 if ($ctx !~ /.x[WEBC]/ &&
4224 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004225 if (ERROR("SPACING",
4226 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004227 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004228 $line_fixed = 1;
4229 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004230 }
4231
4232 # // is a comment
4233 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004234
Joe Perchesb00e4812014-04-03 14:49:33 -07004235 # : when part of a bitfield
4236 } elsif ($opv eq ':B') {
4237 # skip the bitfield test for now
4238
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004239 # No spaces for:
4240 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004241 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004242 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004243 if (ERROR("SPACING",
4244 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004245 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004246 if (defined $fix_elements[$n + 2]) {
4247 $fix_elements[$n + 2] =~ s/^\s+//;
4248 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004249 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004250 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004251 }
4252
Joe Perches23810972014-12-10 15:51:32 -08004253 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004254 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004255 my $rtrim_before = 0;
4256 my $space_after = 0;
4257 if ($ctx =~ /Wx./) {
4258 if (ERROR("SPACING",
4259 "space prohibited before that '$op' $at\n" . $hereptr)) {
4260 $line_fixed = 1;
4261 $rtrim_before = 1;
4262 }
4263 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004264 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004265 if (ERROR("SPACING",
4266 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004267 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004268 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004269 $space_after = 1;
4270 }
4271 }
4272 if ($rtrim_before || $space_after) {
4273 if ($rtrim_before) {
4274 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4275 } else {
4276 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4277 }
4278 if ($space_after) {
4279 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004280 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004281 }
4282
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004283 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004284 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004285 #warn "'*' is part of type\n";
4286
4287 # unary operators should have a space before and
4288 # none after. May be left adjacent to another
4289 # unary operator, or a cast
4290 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004291 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004292 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004293 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004294 if (ERROR("SPACING",
4295 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004296 if ($n != $last_after + 2) {
4297 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4298 $line_fixed = 1;
4299 }
Joe Perches3705ce52013-07-03 15:05:31 -07004300 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004301 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004302 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004303 # A unary '*' may be const
4304
4305 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004306 if (ERROR("SPACING",
4307 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004308 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004309 if (defined $fix_elements[$n + 2]) {
4310 $fix_elements[$n + 2] =~ s/^\s+//;
4311 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004312 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004313 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004314 }
4315
4316 # unary ++ and unary -- are allowed no space on one side.
4317 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004318 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004319 if (ERROR("SPACING",
4320 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004321 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004322 $line_fixed = 1;
4323 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004324 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004325 if ($ctx =~ /Wx[BE]/ ||
4326 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004327 if (ERROR("SPACING",
4328 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004329 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004330 $line_fixed = 1;
4331 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004332 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004333 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004334 if (ERROR("SPACING",
4335 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004336 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004337 if (defined $fix_elements[$n + 2]) {
4338 $fix_elements[$n + 2] =~ s/^\s+//;
4339 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004340 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004341 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004342 }
4343
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004344 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004345 } elsif ($op eq '<<' or $op eq '>>' or
4346 $op eq '&' or $op eq '^' or $op eq '|' or
4347 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004348 $op eq '*' or $op eq '/' or
4349 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004350 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004351 if ($check) {
4352 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4353 if (CHK("SPACING",
4354 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4355 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4356 $fix_elements[$n + 2] =~ s/^\s+//;
4357 $line_fixed = 1;
4358 }
4359 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4360 if (CHK("SPACING",
4361 "space preferred before that '$op' $at\n" . $hereptr)) {
4362 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4363 $line_fixed = 1;
4364 }
4365 }
4366 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004367 if (ERROR("SPACING",
4368 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004369 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4370 if (defined $fix_elements[$n + 2]) {
4371 $fix_elements[$n + 2] =~ s/^\s+//;
4372 }
Joe Perches3705ce52013-07-03 15:05:31 -07004373 $line_fixed = 1;
4374 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004375 }
4376
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004377 # A colon needs no spaces before when it is
4378 # terminating a case value or a label.
4379 } elsif ($opv eq ':C' || $opv eq ':L') {
4380 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004381 if (ERROR("SPACING",
4382 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004383 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004384 $line_fixed = 1;
4385 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004386 }
4387
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004388 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004389 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004390 my $ok = 0;
4391
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004392 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004393 if (($op eq '<' &&
4394 $cc =~ /^\S+\@\S+>/) ||
4395 ($op eq '>' &&
4396 $ca =~ /<\S+\@\S+$/))
4397 {
4398 $ok = 1;
4399 }
4400
Joe Perchese0df7e12015-04-16 12:44:53 -07004401 # for asm volatile statements
4402 # ignore a colon with another
4403 # colon immediately before or after
4404 if (($op eq ':') &&
4405 ($ca =~ /:$/ || $cc =~ /^:/)) {
4406 $ok = 1;
4407 }
4408
Joe Perches84731622013-11-12 15:10:05 -08004409 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004410 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004411 my $msg_level = \&ERROR;
4412 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004413
Jean Delvare0675a8f2017-09-08 16:16:07 -07004414 if (&{$msg_level}("SPACING",
4415 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004416 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4417 if (defined $fix_elements[$n + 2]) {
4418 $fix_elements[$n + 2] =~ s/^\s+//;
4419 }
Joe Perches3705ce52013-07-03 15:05:31 -07004420 $line_fixed = 1;
4421 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004422 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004423 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004424 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004425
4426## print("n: <$n> GOOD: <$good>\n");
4427
4428 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004429 }
Joe Perches3705ce52013-07-03 15:05:31 -07004430
4431 if (($#elements % 2) == 0) {
4432 $fixed_line = $fixed_line . $fix_elements[$#elements];
4433 }
4434
Joe Perches194f66f2014-08-06 16:11:03 -07004435 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4436 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004437 }
4438
4439
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004440 }
4441
Joe Perches786b6322013-07-03 15:05:32 -07004442# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004443 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004444 if (WARN("SPACING",
4445 "space prohibited before semicolon\n" . $herecurr) &&
4446 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004447 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004448 s/^(\+.*\S)\s+;/$1;/;
4449 }
4450 }
4451
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004452# check for multiple assignments
4453 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004454 CHK("MULTIPLE_ASSIGNMENTS",
4455 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004456 }
4457
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004458## # check for multiple declarations, allowing for a function declaration
4459## # continuation.
4460## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4461## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4462##
4463## # Remove any bracketed sections to ensure we do not
4464## # falsly report the parameters of functions.
4465## my $ln = $line;
4466## while ($ln =~ s/\([^\(\)]*\)//g) {
4467## }
4468## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004469## WARN("MULTIPLE_DECLARATION",
4470## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004471## }
4472## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004473
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004474#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004475 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004476 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004477 if (ERROR("SPACING",
4478 "space required before the open brace '{'\n" . $herecurr) &&
4479 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004480 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004481 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004482 }
4483
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004484## # check for blank lines before declarations
4485## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4486## $prevrawline =~ /^.\s*$/) {
4487## WARN("SPACING",
4488## "No blank lines before declarations\n" . $hereprev);
4489## }
4490##
4491
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004492# closing brace should have a space following it when it has anything
4493# on the line
4494 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004495 if (ERROR("SPACING",
4496 "space required after that close brace '}'\n" . $herecurr) &&
4497 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004498 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004499 s/}((?!(?:,|;|\)))\S)/} $1/;
4500 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004501 }
4502
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004503# check spacing on square brackets
4504 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004505 if (ERROR("SPACING",
4506 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4507 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004508 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004509 s/\[\s+/\[/;
4510 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004511 }
4512 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004513 if (ERROR("SPACING",
4514 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4515 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004516 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004517 s/\s+\]/\]/;
4518 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004519 }
4520
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004521# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004522 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4523 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004524 if (ERROR("SPACING",
4525 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4526 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004527 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004528 s/\(\s+/\(/;
4529 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004530 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004531 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004532 $line !~ /for\s*\(.*;\s+\)/ &&
4533 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004534 if (ERROR("SPACING",
4535 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4536 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004537 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004538 s/\s+\)/\)/;
4539 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004540 }
4541
Joe Perchese2826fd2014-08-06 16:10:48 -07004542# check unnecessary parentheses around addressof/dereference single $Lvals
4543# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4544
4545 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004546 my $var = $1;
4547 if (CHK("UNNECESSARY_PARENTHESES",
4548 "Unnecessary parentheses around $var\n" . $herecurr) &&
4549 $fix) {
4550 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4551 }
4552 }
4553
4554# check for unnecessary parentheses around function pointer uses
4555# ie: (foo->bar)(); should be foo->bar();
4556# but not "if (foo->bar) (" to avoid some false positives
4557 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4558 my $var = $2;
4559 if (CHK("UNNECESSARY_PARENTHESES",
4560 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4561 $fix) {
4562 my $var2 = deparenthesize($var);
4563 $var2 =~ s/\s//g;
4564 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4565 }
4566 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004567
Joe Perches63b7c732017-09-08 16:16:01 -07004568# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004569# when !drivers/staging or command-line uses --strict
4570 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4571 $^V && $^V ge 5.10.0 && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004572 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4573 my $if_stat = $1;
4574 my $test = substr($2, 1, -1);
4575 my $herectx;
4576 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4577 my $match = $1;
4578 # avoid parentheses around potential macro args
4579 next if ($match =~ /^\s*\w+\s*$/);
4580 if (!defined($herectx)) {
4581 $herectx = $here . "\n";
4582 my $cnt = statement_rawlines($if_stat);
4583 for (my $n = 0; $n < $cnt; $n++) {
4584 my $rl = raw_line($linenr, $n);
4585 $herectx .= $rl . "\n";
4586 last if $rl =~ /^[ \+].*\{/;
4587 }
4588 }
4589 CHK("UNNECESSARY_PARENTHESES",
4590 "Unnecessary parentheses around '$match'\n" . $herectx);
4591 }
4592 }
4593
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004594#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004595 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004596 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004597 if (WARN("INDENTED_LABEL",
4598 "labels should not be indented\n" . $herecurr) &&
4599 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004600 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004601 s/^(.)\s+/$1/;
4602 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004603 }
4604
Joe Perches5b9553a2014-04-03 14:49:21 -07004605# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004606 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004607 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004608 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004609 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4610 my $value = $1;
4611 $value = deparenthesize($value);
4612 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4613 ERROR("RETURN_PARENTHESES",
4614 "return is not a function, parentheses are not required\n" . $herecurr);
4615 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004616 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004617 ERROR("SPACING",
4618 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004619 }
4620 }
Joe Perches507e5142013-11-12 15:10:13 -08004621
Joe Perchesb43ae212014-06-23 13:22:07 -07004622# unnecessary return in a void function
4623# at end-of-function, with the previous line a single leading tab, then return;
4624# and the line before that not a goto label target like "out:"
4625 if ($sline =~ /^[ \+]}\s*$/ &&
4626 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4627 $linenr >= 3 &&
4628 $lines[$linenr - 3] =~ /^[ +]/ &&
4629 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004630 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004631 "void function return statements are not generally useful\n" . $hereprev);
4632 }
Joe Perches9819cf22014-06-04 16:12:09 -07004633
Joe Perches189248d2014-01-23 15:54:47 -08004634# if statements using unnecessary parentheses - ie: if ((foo == bar))
4635 if ($^V && $^V ge 5.10.0 &&
4636 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4637 my $openparens = $1;
4638 my $count = $openparens =~ tr@\(@\(@;
4639 my $msg = "";
4640 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4641 my $comp = $4; #Not $1 because of $LvalOrFunc
4642 $msg = " - maybe == should be = ?" if ($comp eq "==");
4643 WARN("UNNECESSARY_PARENTHESES",
4644 "Unnecessary parentheses$msg\n" . $herecurr);
4645 }
4646 }
4647
Joe Perchesc5595fa2015-09-09 15:37:58 -07004648# comparisons with a constant or upper case identifier on the left
4649# avoid cases like "foo + BAR < baz"
4650# only fix matches surrounded by parentheses to avoid incorrect
4651# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4652 if ($^V && $^V ge 5.10.0 &&
4653 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4654 my $lead = $1;
4655 my $const = $2;
4656 my $comp = $3;
4657 my $to = $4;
4658 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004659 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004660 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4661 WARN("CONSTANT_COMPARISON",
4662 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4663 $fix) {
4664 if ($comp eq "<") {
4665 $newcomp = ">";
4666 } elsif ($comp eq "<=") {
4667 $newcomp = ">=";
4668 } elsif ($comp eq ">") {
4669 $newcomp = "<";
4670 } elsif ($comp eq ">=") {
4671 $newcomp = "<=";
4672 }
4673 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4674 }
4675 }
4676
Joe Perchesf34e4a42015-04-16 12:44:19 -07004677# Return of what appears to be an errno should normally be negative
4678 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004679 my $name = $1;
4680 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004681 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004682 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004683 }
4684 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004685
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004686# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004687 if ($line =~ /\b(if|while|for|switch)\(/) {
4688 if (ERROR("SPACING",
4689 "space required before the open parenthesis '('\n" . $herecurr) &&
4690 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004691 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004692 s/\b(if|while|for|switch)\(/$1 \(/;
4693 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004694 }
4695
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004696# Check for illegal assignment in if conditional -- and check for trailing
4697# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004698 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004699 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4700 ctx_statement_block($linenr, $realcnt, 0)
4701 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004702 my ($stat_next) = ctx_statement_block($line_nr_next,
4703 $remain_next, $off_next);
4704 $stat_next =~ s/\n./\n /g;
4705 ##print "stat<$stat> stat_next<$stat_next>\n";
4706
4707 if ($stat_next =~ /^\s*while\b/) {
4708 # If the statement carries leading newlines,
4709 # then count those as offsets.
4710 my ($whitespace) =
4711 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4712 my $offset =
4713 statement_rawlines($whitespace) - 1;
4714
4715 $suppress_whiletrailers{$line_nr_next +
4716 $offset} = 1;
4717 }
4718 }
4719 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004720 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004721 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004722 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004723
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004724 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004725 ERROR("ASSIGN_IN_IF",
4726 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004727 }
4728
4729 # Find out what is on the end of the line after the
4730 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004731 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004732 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004733 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004734 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4735 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004736 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004737 # Find out how long the conditional actually is.
4738 my @newlines = ($c =~ /\n/gs);
4739 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004740 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004741
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004742 $stat_real = raw_line($linenr, $cond_lines)
4743 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004744 if (defined($stat_real) && $cond_lines > 1) {
4745 $stat_real = "[...]\n$stat_real";
4746 }
4747
Joe Perches000d1cc12011-07-25 17:13:25 -07004748 ERROR("TRAILING_STATEMENTS",
4749 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004750 }
4751 }
4752
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004753# Check for bitwise tests written as boolean
4754 if ($line =~ /
4755 (?:
4756 (?:\[|\(|\&\&|\|\|)
4757 \s*0[xX][0-9]+\s*
4758 (?:\&\&|\|\|)
4759 |
4760 (?:\&\&|\|\|)
4761 \s*0[xX][0-9]+\s*
4762 (?:\&\&|\|\||\)|\])
4763 )/x)
4764 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004765 WARN("HEXADECIMAL_BOOLEAN_TEST",
4766 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004767 }
4768
Andy Whitcroft8905a672007-11-28 16:21:06 -08004769# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004770 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4771 my $s = $1;
4772 $s =~ s/$;//g; # Remove any comments
4773 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004774 ERROR("TRAILING_STATEMENTS",
4775 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004776 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004777 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004778# if should not continue a brace
4779 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004780 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004781 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004782 $herecurr);
4783 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004784# case and default should not have general statements after them
4785 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4786 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004787 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004788 \s*return\s+
4789 )/xg)
4790 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004791 ERROR("TRAILING_STATEMENTS",
4792 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004793 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004794
4795 # Check for }<nl>else {, these must be at the same
4796 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004797 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4798 $previndent == $indent) {
4799 if (ERROR("ELSE_AFTER_BRACE",
4800 "else should follow close brace '}'\n" . $hereprev) &&
4801 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4802 fix_delete_line($fixlinenr - 1, $prevrawline);
4803 fix_delete_line($fixlinenr, $rawline);
4804 my $fixedline = $prevrawline;
4805 $fixedline =~ s/}\s*$//;
4806 if ($fixedline !~ /^\+\s*$/) {
4807 fix_insert_line($fixlinenr, $fixedline);
4808 }
4809 $fixedline = $rawline;
4810 $fixedline =~ s/^(.\s*)else/$1} else/;
4811 fix_insert_line($fixlinenr, $fixedline);
4812 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004813 }
4814
Joe Perches8b8856f2014-08-06 16:11:14 -07004815 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4816 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004817 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4818
4819 # Find out what is on the end of the line after the
4820 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004821 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004822 $s =~ s/\n.*//g;
4823
4824 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004825 if (ERROR("WHILE_AFTER_BRACE",
4826 "while should follow close brace '}'\n" . $hereprev) &&
4827 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4828 fix_delete_line($fixlinenr - 1, $prevrawline);
4829 fix_delete_line($fixlinenr, $rawline);
4830 my $fixedline = $prevrawline;
4831 my $trailing = $rawline;
4832 $trailing =~ s/^\+//;
4833 $trailing = trim($trailing);
4834 $fixedline =~ s/}\s*$/} $trailing/;
4835 fix_insert_line($fixlinenr, $fixedline);
4836 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004837 }
4838 }
4839
Joe Perches95e2c602013-07-03 15:05:20 -07004840#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004841 while ($line =~ m{($Constant|$Lval)}g) {
4842 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004843
4844#gcc binary extension
4845 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004846 if (WARN("GCC_BINARY_CONSTANT",
4847 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4848 $fix) {
4849 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004850 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004851 s/\b$var\b/$hexval/;
4852 }
Joe Perches95e2c602013-07-03 15:05:20 -07004853 }
4854
4855#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004856 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004857 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004858#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004859 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004860#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004861 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4862#Ignore some three character SI units explicitly, like MiB and KHz
4863 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004864 while ($var =~ m{($Ident)}g) {
4865 my $word = $1;
4866 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004867 if ($check) {
4868 seed_camelcase_includes();
4869 if (!$file && !$camelcase_file_seeded) {
4870 seed_camelcase_file($realfile);
4871 $camelcase_file_seeded = 1;
4872 }
4873 }
Joe Perches7e781f62013-09-11 14:23:55 -07004874 if (!defined $camelcase{$word}) {
4875 $camelcase{$word} = 1;
4876 CHK("CAMELCASE",
4877 "Avoid CamelCase: <$word>\n" . $herecurr);
4878 }
Joe Perches34456862013-07-03 15:05:34 -07004879 }
Joe Perches323c1262012-12-17 16:02:07 -08004880 }
4881 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004882
4883#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004884 if ($line =~ /\#\s*define.*\\\s+$/) {
4885 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4886 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4887 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004888 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004889 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004890 }
4891
Fabian Frederick0e212e02015-04-16 12:44:25 -07004892# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4893# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004894 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004895 my $file = "$1.h";
4896 my $checkfile = "include/linux/$file";
4897 if (-f "$root/$checkfile" &&
4898 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004899 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004900 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004901 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4902 if ($asminclude > 0) {
4903 if ($realfile =~ m{^arch/}) {
4904 CHK("ARCH_INCLUDE_LINUX",
4905 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4906 } else {
4907 WARN("INCLUDE_LINUX",
4908 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4909 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004910 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004911 }
4912 }
4913
Andy Whitcroft653d4872007-06-23 17:16:34 -07004914# multi-statement macros should be enclosed in a do while loop, grab the
4915# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004916# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004917 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4918 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004919 my $ln = $linenr;
4920 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004921 my ($off, $dstat, $dcond, $rest);
4922 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004923 my $has_flow_statement = 0;
4924 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004925 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004926 ctx_statement_block($linenr, $realcnt, 0);
4927 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004928 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004929 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004930
Joe Perches08a28432014-10-13 15:51:55 -07004931 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004932 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004933
Joe Perchesf59b64b2016-10-11 13:52:08 -07004934 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4935 my $define_args = $1;
4936 my $define_stmt = $dstat;
4937 my @def_args = ();
4938
4939 if (defined $define_args && $define_args ne "") {
4940 $define_args = substr($define_args, 1, length($define_args) - 2);
4941 $define_args =~ s/\s*//g;
4942 @def_args = split(",", $define_args);
4943 }
4944
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004945 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004946 $dstat =~ s/\\\n.//g;
4947 $dstat =~ s/^\s*//s;
4948 $dstat =~ s/\s*$//s;
4949
4950 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004951 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4952 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004953 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004954 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004955 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004956
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004957 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004958 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4959 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004960 {
4961 }
4962
Joe Perches42e15292016-03-15 14:58:01 -07004963 # Make asm volatile uses seem like a generic function
4964 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4965
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004966 my $exceptions = qr{
4967 $Declare|
4968 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004969 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004970 DECLARE_PER_CPU|
4971 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004972 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004973 union|
4974 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004975 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004976 ^\"|\"$|
4977 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004978 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004979 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004980
4981 $ctx =~ s/\n*$//;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004982 my $stmt_cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07004983 my $herectx = get_stat_here($linenr, $stmt_cnt, $here);
Joe Perchesf59b64b2016-10-11 13:52:08 -07004984
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004985 if ($dstat ne '' &&
4986 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4987 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004988 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004989 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004990 $dstat !~ /$exceptions/ &&
4991 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004992 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004993 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004994 $dstat !~ /^for\s*$Constant$/ && # for (...)
4995 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4996 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004997 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004998 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004999 {
Joe Perchese7955562017-05-08 15:55:48 -07005000 if ($dstat =~ /^\s*if\b/) {
5001 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5002 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5003 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08005004 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
5005 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
5006 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07005007 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07005008 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07005009 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07005010
5011 }
Joe Perches52076492016-10-11 13:52:14 -07005012
5013 # Make $define_stmt single line, comment-free, etc
5014 my @stmt_array = split('\n', $define_stmt);
5015 my $first = 1;
5016 $define_stmt = "";
5017 foreach my $l (@stmt_array) {
5018 $l =~ s/\\$//;
5019 if ($first) {
5020 $define_stmt = $l;
5021 $first = 0;
5022 } elsif ($l =~ /^[\+ ]/) {
5023 $define_stmt .= substr($l, 1);
5024 }
5025 }
5026 $define_stmt =~ s/$;//g;
5027 $define_stmt =~ s/\s+/ /g;
5028 $define_stmt = trim($define_stmt);
5029
Joe Perchesf59b64b2016-10-11 13:52:08 -07005030# check if any macro arguments are reused (ignore '...' and 'type')
5031 foreach my $arg (@def_args) {
5032 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005033 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005034 my $tmp_stmt = $define_stmt;
5035 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5036 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5037 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5038 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005039 if ($use_cnt > 1) {
5040 CHK("MACRO_ARG_REUSE",
5041 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005042 }
5043# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005044 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005045 ((defined($1) && $1 ne ',') ||
5046 (defined($2) && $2 ne ','))) {
5047 CHK("MACRO_ARG_PRECEDENCE",
5048 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005049 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005050 }
Joe Perches5023d342012-12-17 16:01:47 -08005051
Joe Perches08a28432014-10-13 15:51:55 -07005052# check for macros with flow control, but without ## concatenation
5053# ## concatenation is commonly a macro that defines a function so ignore those
5054 if ($has_flow_statement && !$has_arg_concat) {
Joe Perches08a28432014-10-13 15:51:55 -07005055 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005056 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perches08a28432014-10-13 15:51:55 -07005057
Joe Perches08a28432014-10-13 15:51:55 -07005058 WARN("MACRO_WITH_FLOW_CONTROL",
5059 "Macros with flow control statements should be avoided\n" . "$herectx");
5060 }
5061
Joe Perches481eb482012-12-17 16:01:56 -08005062# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005063
5064 } else {
5065 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005066 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5067 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005068 $line =~ /^\+.*\\$/) {
5069 WARN("LINE_CONTINUATIONS",
5070 "Avoid unnecessary line continuations\n" . $herecurr);
5071 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005072 }
5073
Joe Perchesb13edf72012-07-30 14:41:24 -07005074# do {} while (0) macro tests:
5075# single-statement macros do not need to be enclosed in do while (0) loop,
5076# macro should not end with a semicolon
5077 if ($^V && $^V ge 5.10.0 &&
5078 $realfile !~ m@/vmlinux.lds.h$@ &&
5079 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5080 my $ln = $linenr;
5081 my $cnt = $realcnt;
5082 my ($off, $dstat, $dcond, $rest);
5083 my $ctx = '';
5084 ($dstat, $dcond, $ln, $cnt, $off) =
5085 ctx_statement_block($linenr, $realcnt, 0);
5086 $ctx = $dstat;
5087
5088 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005089 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005090
5091 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5092 my $stmts = $2;
5093 my $semis = $3;
5094
5095 $ctx =~ s/\n*$//;
5096 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005097 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesb13edf72012-07-30 14:41:24 -07005098
Joe Perchesac8e97f2012-08-21 16:15:53 -07005099 if (($stmts =~ tr/;/;/) == 1 &&
5100 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005101 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5102 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5103 }
5104 if (defined $semis && $semis ne "") {
5105 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5106 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5107 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005108 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5109 $ctx =~ s/\n*$//;
5110 my $cnt = statement_rawlines($ctx);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005111 my $herectx = get_stat_here($linenr, $cnt, $here);
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005112
5113 WARN("TRAILING_SEMICOLON",
5114 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005115 }
5116 }
5117
Mike Frysinger080ba922009-01-06 14:41:25 -08005118# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5119# all assignments may have only one of the following with an assignment:
5120# .
5121# ALIGN(...)
5122# VMLINUX_SYMBOL(...)
5123 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005124 WARN("MISSING_VMLINUX_SYMBOL",
5125 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005126 }
5127
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005128# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005129 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5130 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005131 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005132 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005133 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5134 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005135 my @allowed = ();
5136 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005137 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005138 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005139 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005140 for my $chunk (@chunks) {
5141 my ($cond, $block) = @{$chunk};
5142
Andy Whitcroft773647a2008-03-28 14:15:58 -07005143 # If the condition carries leading newlines, then count those as offsets.
5144 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5145 my $offset = statement_rawlines($whitespace) - 1;
5146
Joe Perchesaad4f612012-03-23 15:02:19 -07005147 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005148 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5149
5150 # We have looked at and allowed this specific line.
5151 $suppress_ifbraces{$ln + $offset} = 1;
5152
5153 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005154 $ln += statement_rawlines($block) - 1;
5155
Andy Whitcroft773647a2008-03-28 14:15:58 -07005156 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005157
5158 $seen++ if ($block =~ /^\s*{/);
5159
Joe Perchesaad4f612012-03-23 15:02:19 -07005160 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005161 if (statement_lines($cond) > 1) {
5162 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005163 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005164 }
5165 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005166 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005167 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005168 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005169 if (statement_block_size($block) > 1) {
5170 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005171 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005172 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005173 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005174 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005175 if ($seen) {
5176 my $sum_allowed = 0;
5177 foreach (@allowed) {
5178 $sum_allowed += $_;
5179 }
5180 if ($sum_allowed == 0) {
5181 WARN("BRACES",
5182 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5183 } elsif ($sum_allowed != $allow &&
5184 $seen != $allow) {
5185 CHK("BRACES",
5186 "braces {} should be used on all arms of this statement\n" . $herectx);
5187 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005188 }
5189 }
5190 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005191 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005192 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005193 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005194
Andy Whitcroftcf655042008-03-04 14:28:20 -08005195 # Check the pre-context.
5196 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5197 #print "APW: ALLOWED: pre<$1>\n";
5198 $allowed = 1;
5199 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005200
5201 my ($level, $endln, @chunks) =
5202 ctx_statement_full($linenr, $realcnt, $-[0]);
5203
Andy Whitcroftcf655042008-03-04 14:28:20 -08005204 # Check the condition.
5205 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005206 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005207 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005208 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005209 }
5210 if (statement_lines($cond) > 1) {
5211 #print "APW: ALLOWED: cond<$cond>\n";
5212 $allowed = 1;
5213 }
5214 if ($block =~/\b(?:if|for|while)\b/) {
5215 #print "APW: ALLOWED: block<$block>\n";
5216 $allowed = 1;
5217 }
5218 if (statement_block_size($block) > 1) {
5219 #print "APW: ALLOWED: lines block<$block>\n";
5220 $allowed = 1;
5221 }
5222 # Check the post-context.
5223 if (defined $chunks[1]) {
5224 my ($cond, $block) = @{$chunks[1]};
5225 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005226 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005227 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005228 if ($block =~ /^\s*\{/) {
5229 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5230 $allowed = 1;
5231 }
5232 }
5233 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Andy Whitcroftf0556632008-10-15 22:02:23 -07005234 my $cnt = statement_rawlines($block);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07005235 my $herectx = get_stat_here($linenr, $cnt, $here);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005236
Joe Perches000d1cc12011-07-25 17:13:25 -07005237 WARN("BRACES",
5238 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005239 }
5240 }
5241
Joe Perchese4c5bab2017-02-24 15:01:41 -08005242# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005243 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5244 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005245 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5246 }
5247
Joe Perches0979ae62012-12-17 16:01:59 -08005248# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005249 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005250 if (CHK("BRACES",
5251 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5252 $fix && $prevrawline =~ /^\+/) {
5253 fix_delete_line($fixlinenr - 1, $prevrawline);
5254 }
Joe Perches0979ae62012-12-17 16:01:59 -08005255 }
Joe Perches77b9a532013-07-03 15:05:29 -07005256 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005257 if (CHK("BRACES",
5258 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5259 $fix) {
5260 fix_delete_line($fixlinenr, $rawline);
5261 }
Joe Perches0979ae62012-12-17 16:01:59 -08005262 }
5263
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005264# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005265 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5266 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005267 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005268 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005269 }
5270
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005271# Check for user-visible strings broken across lines, which breaks the ability
5272# to grep for the string. Make exceptions when the previous string ends in a
5273# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5274# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005275 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005276 $prevline =~ /"\s*$/ &&
5277 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5278 if (WARN("SPLIT_STRING",
5279 "quoted string split across lines\n" . $hereprev) &&
5280 $fix &&
5281 $prevrawline =~ /^\+.*"\s*$/ &&
5282 $last_coalesced_string_linenr != $linenr - 1) {
5283 my $extracted_string = get_quoted_string($line, $rawline);
5284 my $comma_close = "";
5285 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5286 $comma_close = $1;
5287 }
5288
5289 fix_delete_line($fixlinenr - 1, $prevrawline);
5290 fix_delete_line($fixlinenr, $rawline);
5291 my $fixedline = $prevrawline;
5292 $fixedline =~ s/"\s*$//;
5293 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5294 fix_insert_line($fixlinenr - 1, $fixedline);
5295 $fixedline = $rawline;
5296 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5297 if ($fixedline !~ /\+\s*$/) {
5298 fix_insert_line($fixlinenr, $fixedline);
5299 }
5300 $last_coalesced_string_linenr = $linenr;
5301 }
5302 }
5303
5304# check for missing a space in a string concatenation
5305 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5306 WARN('MISSING_SPACE',
5307 "break quoted strings at a space character\n" . $hereprev);
5308 }
5309
Joe Perchese4b7d302017-05-08 15:55:51 -07005310# check for an embedded function name in a string when the function is known
5311# This does not work very well for -f --file checking as it depends on patch
5312# context providing the function name or a single line form for in-file
5313# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005314 if ($line =~ /^\+.*$String/ &&
5315 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005316 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5317 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005318 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005319 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005320 }
5321
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005322# check for spaces before a quoted newline
5323 if ($rawline =~ /^.*\".*\s\\n/) {
5324 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5325 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5326 $fix) {
5327 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5328 }
5329
5330 }
5331
Joe Perchesf17dba42014-10-13 15:51:51 -07005332# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005333 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005334 CHK("CONCATENATED_STRING",
5335 "Concatenated strings should use spaces between elements\n" . $herecurr);
5336 }
5337
Joe Perches90ad30e2014-12-10 15:51:59 -08005338# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005339 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005340 WARN("STRING_FRAGMENTS",
5341 "Consecutive strings are generally better as a single string\n" . $herecurr);
5342 }
5343
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005344# check for non-standard and hex prefixed decimal printf formats
5345 my $show_L = 1; #don't show the same defect twice
5346 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005347 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005348 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005349 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005350 # check for %L
5351 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005352 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005353 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5354 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005355 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005356 # check for %Z
5357 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5358 WARN("PRINTF_Z",
5359 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5360 $show_Z = 0;
5361 }
5362 # check for 0x<decimal>
5363 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5364 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005365 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5366 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005367 }
5368
5369# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005370 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005371 WARN("LINE_CONTINUATIONS",
5372 "Avoid line continuations in quoted strings\n" . $herecurr);
5373 }
5374
Andy Whitcroft00df3442007-06-08 13:47:06 -07005375# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005376 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005377 CHK("REDUNDANT_CODE",
5378 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005379 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005380 }
5381
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005382# check for needless "if (<foo>) fn(<foo>)" uses
5383 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005384 my $tested = quotemeta($1);
5385 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5386 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5387 my $func = $1;
5388 if (WARN('NEEDLESS_IF',
5389 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5390 $fix) {
5391 my $do_fix = 1;
5392 my $leading_tabs = "";
5393 my $new_leading_tabs = "";
5394 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5395 $leading_tabs = $1;
5396 } else {
5397 $do_fix = 0;
5398 }
5399 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5400 $new_leading_tabs = $1;
5401 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5402 $do_fix = 0;
5403 }
5404 } else {
5405 $do_fix = 0;
5406 }
5407 if ($do_fix) {
5408 fix_delete_line($fixlinenr - 1, $prevrawline);
5409 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5410 }
5411 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005412 }
5413 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005414
Joe Perchesebfdc402014-08-06 16:10:27 -07005415# check for unnecessary "Out of Memory" messages
5416 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5417 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5418 (defined $1 || defined $3) &&
5419 $linenr > 3) {
5420 my $testval = $2;
5421 my $testline = $lines[$linenr - 3];
5422
5423 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5424# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5425
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005426 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 -07005427 WARN("OOM_MESSAGE",
5428 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5429 }
5430 }
5431
Joe Perchesf78d98f2014-10-13 15:52:01 -07005432# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005433 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005434 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5435 my $level = $1;
5436 if (WARN("UNNECESSARY_KERN_LEVEL",
5437 "Possible unnecessary $level\n" . $herecurr) &&
5438 $fix) {
5439 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5440 }
5441 }
5442
Joe Perches45c55e92017-02-24 15:01:31 -08005443# check for logging continuations
5444 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5445 WARN("LOGGING_CONTINUATION",
5446 "Avoid logging continuation uses where feasible\n" . $herecurr);
5447 }
5448
Joe Perchesabb08a52014-12-10 15:51:46 -08005449# check for mask then right shift without a parentheses
5450 if ($^V && $^V ge 5.10.0 &&
5451 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5452 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5453 WARN("MASK_THEN_SHIFT",
5454 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5455 }
5456
Joe Perchesb75ac612014-12-10 15:52:02 -08005457# check for pointer comparisons to NULL
5458 if ($^V && $^V ge 5.10.0) {
5459 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5460 my $val = $1;
5461 my $equal = "!";
5462 $equal = "" if ($4 eq "!=");
5463 if (CHK("COMPARISON_TO_NULL",
5464 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5465 $fix) {
5466 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5467 }
5468 }
5469 }
5470
Joe Perches8716de32013-09-11 14:24:05 -07005471# check for bad placement of section $InitAttribute (e.g.: __initdata)
5472 if ($line =~ /(\b$InitAttribute\b)/) {
5473 my $attr = $1;
5474 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5475 my $ptr = $1;
5476 my $var = $2;
5477 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5478 ERROR("MISPLACED_INIT",
5479 "$attr should be placed after $var\n" . $herecurr)) ||
5480 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5481 WARN("MISPLACED_INIT",
5482 "$attr should be placed after $var\n" . $herecurr))) &&
5483 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005484 $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 -07005485 }
5486 }
5487 }
5488
Joe Perchese970b8842013-11-12 15:10:10 -08005489# check for $InitAttributeData (ie: __initdata) with const
5490 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5491 my $attr = $1;
5492 $attr =~ /($InitAttributePrefix)(.*)/;
5493 my $attr_prefix = $1;
5494 my $attr_type = $2;
5495 if (ERROR("INIT_ATTRIBUTE",
5496 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5497 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005498 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005499 s/$InitAttributeData/${attr_prefix}initconst/;
5500 }
5501 }
5502
5503# check for $InitAttributeConst (ie: __initconst) without const
5504 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5505 my $attr = $1;
5506 if (ERROR("INIT_ATTRIBUTE",
5507 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5508 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005509 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005510 /(^\+\s*(?:static\s+))/;
5511 $lead = rtrim($1);
5512 $lead = "$lead " if ($lead !~ /^\+$/);
5513 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005514 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005515 }
5516 }
5517
Joe Perchesc17893c2015-04-16 12:44:42 -07005518# check for __read_mostly with const non-pointer (should just be const)
5519 if ($line =~ /\b__read_mostly\b/ &&
5520 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5521 if (ERROR("CONST_READ_MOSTLY",
5522 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5523 $fix) {
5524 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5525 }
5526 }
5527
Joe Perchesfbdb8132014-04-03 14:49:14 -07005528# don't use __constant_<foo> functions outside of include/uapi/
5529 if ($realfile !~ m@^include/uapi/@ &&
5530 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5531 my $constant_func = $1;
5532 my $func = $constant_func;
5533 $func =~ s/^__constant_//;
5534 if (WARN("CONSTANT_CONVERSION",
5535 "$constant_func should be $func\n" . $herecurr) &&
5536 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005537 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005538 }
5539 }
5540
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005541# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005542 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005543 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005544 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005545 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005546 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005547 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5548 }
5549 if ($delay > 2000) {
5550 WARN("LONG_UDELAY",
5551 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005552 }
5553 }
5554
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005555# warn about unexpectedly long msleep's
5556 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5557 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005558 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005559 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005560 }
5561 }
5562
Joe Perches36ec1932013-07-03 15:05:25 -07005563# check for comparisons of jiffies
5564 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5565 WARN("JIFFIES_COMPARISON",
5566 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5567 }
5568
Joe Perches9d7a34a2013-07-03 15:05:26 -07005569# check for comparisons of get_jiffies_64()
5570 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5571 WARN("JIFFIES_COMPARISON",
5572 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5573 }
5574
Andy Whitcroft00df3442007-06-08 13:47:06 -07005575# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005576# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005577# print "#ifdef in C files should be avoided\n";
5578# print "$herecurr";
5579# $clean = 0;
5580# }
5581
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005582# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005583 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005584 if (ERROR("SPACING",
5585 "exactly one space required after that #$1\n" . $herecurr) &&
5586 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005587 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005588 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5589 }
5590
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005591 }
5592
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005593# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005594 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5595 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005596 my $which = $1;
5597 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005598 CHK("UNCOMMENTED_DEFINITION",
5599 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005600 }
5601 }
5602# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005603
5604 my $barriers = qr{
5605 mb|
5606 rmb|
5607 wmb|
5608 read_barrier_depends
5609 }x;
5610 my $barrier_stems = qr{
5611 mb__before_atomic|
5612 mb__after_atomic|
5613 store_release|
5614 load_acquire|
5615 store_mb|
5616 (?:$barriers)
5617 }x;
5618 my $all_barriers = qr{
5619 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005620 smp_(?:$barrier_stems)|
5621 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005622 }x;
5623
5624 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005625 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005626 WARN("MEMORY_BARRIER",
5627 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005628 }
5629 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005630
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005631 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5632
5633 if ($realfile !~ m@^include/asm-generic/@ &&
5634 $realfile !~ m@/barrier\.h$@ &&
5635 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5636 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5637 WARN("MEMORY_BARRIER",
5638 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5639 }
5640
Joe Perchescb426e92015-06-25 15:02:46 -07005641# check for waitqueue_active without a comment.
5642 if ($line =~ /\bwaitqueue_active\s*\(/) {
5643 if (!ctx_has_comment($first_line, $linenr)) {
5644 WARN("WAITQUEUE_ACTIVE",
5645 "waitqueue_active without comment\n" . $herecurr);
5646 }
5647 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005648
Paul E. McKenney91db2592017-11-27 09:37:35 -08005649# check for smp_read_barrier_depends and read_barrier_depends
5650 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5651 WARN("READ_BARRIER_DEPENDS",
5652 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5653 }
5654
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005655# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005656 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005657 CHK("ARCH_DEFINES",
5658 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005659 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005660
Joe Perches596ed452017-07-12 14:37:02 -07005661# check that the storage class is not after a type
5662 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005663 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005664 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5665 }
5666# Check that the storage class is at the beginning of a declaration
5667 if ($line =~ /\b$Storage\b/ &&
5668 $line !~ /^.\s*$Storage/ &&
5669 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5670 $1 !~ /[\,\)]\s*$/) {
5671 WARN("STORAGE_CLASS",
5672 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005673 }
5674
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005675# check the location of the inline attribute, that it is between
5676# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005677 if ($line =~ /\b$Type\s+$Inline\b/ ||
5678 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005679 ERROR("INLINE_LOCATION",
5680 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005681 }
5682
Andy Whitcroft8905a672007-11-28 16:21:06 -08005683# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005684 if ($realfile !~ m@\binclude/uapi/@ &&
5685 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005686 if (WARN("INLINE",
5687 "plain inline is preferred over $1\n" . $herecurr) &&
5688 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005689 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005690
5691 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005692 }
5693
Joe Perches3d130fd2011-01-12 17:00:00 -08005694# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005695 if ($realfile !~ m@\binclude/uapi/@ &&
5696 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005697 WARN("PREFER_PACKED",
5698 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005699 }
5700
Joe Perches39b7e282011-07-25 17:13:24 -07005701# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005702 if ($realfile !~ m@\binclude/uapi/@ &&
5703 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005704 WARN("PREFER_ALIGNED",
5705 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005706 }
5707
Joe Perches5f14d3b2012-01-10 15:09:52 -08005708# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005709 if ($realfile !~ m@\binclude/uapi/@ &&
5710 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005711 if (WARN("PREFER_PRINTF",
5712 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5713 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005714 $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 -07005715
5716 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005717 }
5718
Joe Perches6061d942012-03-23 15:02:16 -07005719# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005720 if ($realfile !~ m@\binclude/uapi/@ &&
5721 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005722 if (WARN("PREFER_SCANF",
5723 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5724 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005725 $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 -07005726 }
Joe Perches6061d942012-03-23 15:02:16 -07005727 }
5728
Joe Perches619a9082014-12-10 15:51:35 -08005729# Check for __attribute__ weak, or __weak declarations (may have link issues)
5730 if ($^V && $^V ge 5.10.0 &&
5731 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5732 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5733 $line =~ /\b__weak\b/)) {
5734 ERROR("WEAK_DECLARATION",
5735 "Using weak declarations can have unintended link defects\n" . $herecurr);
5736 }
5737
Tomas Winklerfd39f902016-12-12 16:46:34 -08005738# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005739 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005740 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005741 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5742 my $type = $1;
5743 if ($type =~ /\b($typeC99Typedefs)\b/) {
5744 $type = $1;
5745 my $kernel_type = 'u';
5746 $kernel_type = 's' if ($type =~ /^_*[si]/);
5747 $type =~ /(\d+)/;
5748 $kernel_type .= $1;
5749 if (CHK("PREFER_KERNEL_TYPES",
5750 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5751 $fix) {
5752 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5753 }
5754 }
5755 }
5756
Joe Perches938224b2016-01-20 14:59:15 -08005757# check for cast of C90 native int or longer types constants
5758 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5759 my $cast = $1;
5760 my $const = $2;
5761 if (WARN("TYPECAST_INT_CONSTANT",
5762 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5763 $fix) {
5764 my $suffix = "";
5765 my $newconst = $const;
5766 $newconst =~ s/${Int_type}$//;
5767 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5768 if ($cast =~ /\blong\s+long\b/) {
5769 $suffix .= 'LL';
5770 } elsif ($cast =~ /\blong\b/) {
5771 $suffix .= 'L';
5772 }
5773 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5774 }
5775 }
5776
Joe Perches8f53a9b2010-03-05 13:43:48 -08005777# check for sizeof(&)
5778 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005779 WARN("SIZEOF_ADDRESS",
5780 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005781 }
5782
Joe Perches66c80b62012-07-30 14:41:22 -07005783# check for sizeof without parenthesis
5784 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005785 if (WARN("SIZEOF_PARENTHESIS",
5786 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5787 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005788 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005789 }
Joe Perches66c80b62012-07-30 14:41:22 -07005790 }
5791
Joe Perches88982fe2012-12-17 16:02:00 -08005792# check for struct spinlock declarations
5793 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5794 WARN("USE_SPINLOCK_T",
5795 "struct spinlock should be spinlock_t\n" . $herecurr);
5796 }
5797
Joe Perchesa6962d72013-04-29 16:18:13 -07005798# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005799 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005800 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005801 $fmt =~ s/%%//g;
5802 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005803 if (WARN("PREFER_SEQ_PUTS",
5804 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5805 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005806 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005807 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005808 }
5809 }
5810
Joe Perches478b1792018-04-10 16:33:34 -07005811# check for vsprintf extension %p<foo> misuses
Joe Perches0b523762017-05-08 15:55:36 -07005812 if ($^V && $^V ge 5.10.0 &&
5813 defined $stat &&
5814 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5815 $1 !~ /^_*volatile_*$/) {
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07005816 my $specifier;
5817 my $extension;
5818 my $bad_specifier = "";
5819 my $stat_real;
5820
Joe Perches0b523762017-05-08 15:55:36 -07005821 my $lc = $stat =~ tr@\n@@;
5822 $lc = $lc + $linenr;
5823 for (my $count = $linenr; $count <= $lc; $count++) {
5824 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5825 $fmt =~ s/%%//g;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005826
Tobin C. Hardinge3c6bc92018-04-10 16:33:31 -07005827 while ($fmt =~ /(\%[\*\d\.]*p(\w))/g) {
5828 $specifier = $1;
5829 $extension = $2;
5830 if ($extension !~ /[SsBKRraEhMmIiUDdgVCbGNOx]/) {
5831 $bad_specifier = $specifier;
5832 last;
5833 }
5834 if ($extension eq "x" && !defined($stat_real)) {
5835 if (!defined($stat_real)) {
5836 $stat_real = get_stat_real($linenr, $lc);
5837 }
5838 WARN("VSPRINTF_SPECIFIER_PX",
5839 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
5840 }
5841 }
5842 if ($bad_specifier ne "") {
5843 my $stat_real = get_stat_real($linenr, $lc);
5844 my $ext_type = "Invalid";
5845 my $use = "";
5846 if ($bad_specifier =~ /p[Ff]/) {
5847 $ext_type = "Deprecated";
5848 $use = " - use %pS instead";
5849 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/);
5850 }
5851
5852 WARN("VSPRINTF_POINTER_EXTENSION",
5853 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n");
5854 }
Joe Perches0b523762017-05-08 15:55:36 -07005855 }
5856 }
5857
Andy Whitcroft554e1652012-01-10 15:09:57 -08005858# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005859 if ($^V && $^V ge 5.10.0 &&
5860 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005861 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005862
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005863 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005864 my $ms_val = $7;
5865 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005866
Andy Whitcroft554e1652012-01-10 15:09:57 -08005867 if ($ms_size =~ /^(0x|)0$/i) {
5868 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005869 "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 -08005870 } elsif ($ms_size =~ /^(0x|)1$/i) {
5871 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005872 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5873 }
5874 }
5875
Joe Perches98a9bba2014-01-23 15:54:52 -08005876# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005877# if ($^V && $^V ge 5.10.0 &&
5878# defined $stat &&
5879# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5880# if (WARN("PREFER_ETHER_ADDR_COPY",
5881# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5882# $fix) {
5883# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5884# }
5885# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005886
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005887# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005888# if ($^V && $^V ge 5.10.0 &&
5889# defined $stat &&
5890# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5891# WARN("PREFER_ETHER_ADDR_EQUAL",
5892# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5893# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005894
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005895# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5896# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf3331952016-10-11 13:51:53 -07005897# if ($^V && $^V ge 5.10.0 &&
5898# defined $stat &&
5899# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5900#
5901# my $ms_val = $7;
5902#
5903# if ($ms_val =~ /^(?:0x|)0+$/i) {
5904# if (WARN("PREFER_ETH_ZERO_ADDR",
5905# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5906# $fix) {
5907# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5908# }
5909# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5910# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5911# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5912# $fix) {
5913# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5914# }
5915# }
5916# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005917
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005918# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005919 if ($^V && $^V ge 5.10.0 &&
5920 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005921 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005922 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005923 my $call = $1;
5924 my $cast1 = deparenthesize($2);
5925 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005926 my $cast2 = deparenthesize($7);
5927 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005928 my $cast;
5929
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005930 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005931 $cast = "$cast1 or $cast2";
5932 } elsif ($cast1 ne "") {
5933 $cast = $cast1;
5934 } else {
5935 $cast = $cast2;
5936 }
5937 WARN("MINMAX",
5938 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005939 }
5940 }
5941
Joe Perches4a273192012-07-30 14:41:20 -07005942# check usleep_range arguments
5943 if ($^V && $^V ge 5.10.0 &&
5944 defined $stat &&
5945 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5946 my $min = $1;
5947 my $max = $7;
5948 if ($min eq $max) {
5949 WARN("USLEEP_RANGE",
5950 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5951 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5952 $min > $max) {
5953 WARN("USLEEP_RANGE",
5954 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5955 }
5956 }
5957
Joe Perches823b7942013-11-12 15:10:15 -08005958# check for naked sscanf
5959 if ($^V && $^V ge 5.10.0 &&
5960 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005961 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005962 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5963 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5964 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5965 my $lc = $stat =~ tr@\n@@;
5966 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005967 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches823b7942013-11-12 15:10:15 -08005968 WARN("NAKED_SSCANF",
5969 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5970 }
5971
Joe Perchesafc819a2014-06-04 16:12:08 -07005972# check for simple sscanf that should be kstrto<foo>
5973 if ($^V && $^V ge 5.10.0 &&
5974 defined $stat &&
5975 $line =~ /\bsscanf\b/) {
5976 my $lc = $stat =~ tr@\n@@;
5977 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07005978 my $stat_real = get_stat_real($linenr, $lc);
Joe Perchesafc819a2014-06-04 16:12:08 -07005979 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5980 my $format = $6;
5981 my $count = $format =~ tr@%@%@;
5982 if ($count == 1 &&
5983 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5984 WARN("SSCANF_TO_KSTRTO",
5985 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5986 }
5987 }
5988 }
5989
Joe Perches70dc8a42013-09-11 14:23:58 -07005990# check for new externs in .h files.
5991 if ($realfile =~ /\.h$/ &&
5992 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005993 if (CHK("AVOID_EXTERNS",
5994 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005995 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005996 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005997 }
5998 }
5999
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006000# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006001 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006002 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006003 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006004 my $function_name = $1;
6005 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006006
6007 my $s = $stat;
6008 if (defined $cond) {
6009 substr($s, 0, length($cond), '');
6010 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006011 if ($s =~ /^\s*;/ &&
6012 $function_name ne 'uninitialized_var')
6013 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006014 WARN("AVOID_EXTERNS",
6015 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006016 }
6017
6018 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006019 WARN("FUNCTION_ARGUMENTS",
6020 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006021 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006022
6023 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6024 $stat =~ /^.\s*extern\s+/)
6025 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006026 WARN("AVOID_EXTERNS",
6027 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006028 }
6029
Joe Perchesa0ad7592017-07-10 15:52:19 -07006030# check for function declarations that have arguments without identifier names
6031 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006032 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006033 $1 ne "void") {
6034 my $args = trim($1);
6035 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6036 my $arg = trim($1);
6037 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6038 WARN("FUNCTION_ARGUMENTS",
6039 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6040 }
6041 }
6042 }
6043
Joe Perchesa0ad7592017-07-10 15:52:19 -07006044# check for function definitions
6045 if ($^V && $^V ge 5.10.0 &&
6046 defined $stat &&
6047 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6048 $context_function = $1;
6049
6050# check for multiline function definition with misplaced open brace
6051 my $ok = 0;
6052 my $cnt = statement_rawlines($stat);
6053 my $herectx = $here . "\n";
6054 for (my $n = 0; $n < $cnt; $n++) {
6055 my $rl = raw_line($linenr, $n);
6056 $herectx .= $rl . "\n";
6057 $ok = 1 if ($rl =~ /^[ \+]\{/);
6058 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6059 last if $rl =~ /^[ \+].*\{/;
6060 }
6061 if (!$ok) {
6062 ERROR("OPEN_BRACE",
6063 "open brace '{' following function definitions go on the next line\n" . $herectx);
6064 }
6065 }
6066
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006067# checks for new __setup's
6068 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6069 my $name = $1;
6070
6071 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006072 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006073 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006074 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006075 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006076
6077# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08006078 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006079 WARN("UNNECESSARY_CASTS",
6080 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006081 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006082
Joe Perchesa640d252013-07-03 15:05:21 -07006083# alloc style
6084# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6085 if ($^V && $^V ge 5.10.0 &&
6086 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6087 CHK("ALLOC_SIZEOF_STRUCT",
6088 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6089 }
6090
Joe Perches60a55362014-06-04 16:12:07 -07006091# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6092 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006093 defined $stat &&
6094 $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 -07006095 my $oldfunc = $3;
6096 my $a1 = $4;
6097 my $a2 = $10;
6098 my $newfunc = "kmalloc_array";
6099 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006100 my $r1 = $a1;
6101 my $r2 = $a2;
6102 if ($a1 =~ /^sizeof\s*\S/) {
6103 $r1 = $a2;
6104 $r2 = $a1;
6105 }
6106 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6107 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006108 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006109 my $herectx = get_stat_here($linenr, $cnt, $here);
6110
Joe Perches60a55362014-06-04 16:12:07 -07006111 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006112 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6113 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006114 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006115 $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 -07006116 }
6117 }
6118 }
6119
Joe Perches972fdea2013-04-29 16:18:12 -07006120# check for krealloc arg reuse
6121 if ($^V && $^V ge 5.10.0 &&
6122 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6123 WARN("KREALLOC_ARG_REUSE",
6124 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6125 }
6126
Joe Perches5ce59ae2013-02-21 16:44:18 -08006127# check for alloc argument mismatch
6128 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6129 WARN("ALLOC_ARRAY_ARGS",
6130 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6131 }
6132
Joe Perchescaf2a542011-01-12 16:59:56 -08006133# check for multiple semicolons
6134 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006135 if (WARN("ONE_SEMICOLON",
6136 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6137 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006138 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006139 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006140 }
6141
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006142# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6143 if ($realfile !~ m@^include/uapi/@ &&
6144 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006145 my $ull = "";
6146 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6147 if (CHK("BIT_MACRO",
6148 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6149 $fix) {
6150 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6151 }
6152 }
6153
Joe Perches2d632742016-05-20 17:04:00 -07006154# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6155 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6156 my $config = $1;
6157 if (WARN("PREFER_IS_ENABLED",
6158 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6159 $fix) {
6160 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6161 }
6162 }
6163
Joe Perchese81f2392014-08-06 16:11:25 -07006164# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006165 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6166 my $has_break = 0;
6167 my $has_statement = 0;
6168 my $count = 0;
6169 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006170 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006171 $prevline--;
6172 my $rline = $rawlines[$prevline - 1];
6173 my $fline = $lines[$prevline - 1];
6174 last if ($fline =~ /^\@\@/);
6175 next if ($fline =~ /^\-/);
6176 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6177 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6178 next if ($fline =~ /^.[\s$;]*$/);
6179 $has_statement = 1;
6180 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006181 $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 -08006182 }
6183 if (!$has_break && $has_statement) {
6184 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006185 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006186 }
6187 }
6188
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006189# check for switch/default statements without a break;
6190 if ($^V && $^V ge 5.10.0 &&
6191 defined $stat &&
6192 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006193 my $cnt = statement_rawlines($stat);
Tobin C. Hardinge3d95a22018-04-10 16:33:27 -07006194 my $herectx = get_stat_here($linenr, $cnt, $here);
6195
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006196 WARN("DEFAULT_NO_BREAK",
6197 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006198 }
6199
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006200# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006201 if ($line =~ /\b__FUNCTION__\b/) {
6202 if (WARN("USE_FUNC",
6203 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6204 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006205 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006206 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006207 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006208
Joe Perches62ec8182015-02-13 14:38:18 -08006209# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6210 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6211 ERROR("DATE_TIME",
6212 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6213 }
6214
Joe Perches2c924882012-03-23 15:02:20 -07006215# check for use of yield()
6216 if ($line =~ /\byield\s*\(\s*\)/) {
6217 WARN("YIELD",
6218 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6219 }
6220
Joe Perches179f8f42013-07-03 15:05:30 -07006221# check for comparisons against true and false
6222 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6223 my $lead = $1;
6224 my $arg = $2;
6225 my $test = $3;
6226 my $otype = $4;
6227 my $trail = $5;
6228 my $op = "!";
6229
6230 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6231
6232 my $type = lc($otype);
6233 if ($type =~ /^(?:true|false)$/) {
6234 if (("$test" eq "==" && "$type" eq "true") ||
6235 ("$test" eq "!=" && "$type" eq "false")) {
6236 $op = "";
6237 }
6238
6239 CHK("BOOL_COMPARISON",
6240 "Using comparison to $otype is error prone\n" . $herecurr);
6241
6242## maybe suggesting a correct construct would better
6243## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6244
6245 }
6246 }
6247
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006248# check for semaphores initialized locked
6249 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006250 WARN("CONSIDER_COMPLETION",
6251 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006252 }
Joe Perches6712d852012-03-23 15:02:20 -07006253
Joe Perches67d0a072011-10-31 17:13:10 -07006254# recommend kstrto* over simple_strto* and strict_strto*
6255 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006256 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006257 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006258 }
Joe Perches6712d852012-03-23 15:02:20 -07006259
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006260# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006261 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006262 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006263 "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 -07006264 }
Joe Perches6712d852012-03-23 15:02:20 -07006265
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006266# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006267# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006268 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006269 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006270 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006271 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006272 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006273
6274# use of NR_CPUS is usually wrong
6275# ignore definitions of NR_CPUS and usage to define arrays as likely right
6276 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006277 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6278 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006279 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6280 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6281 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006282 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006283 WARN("NR_CPUS",
6284 "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 -07006285 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006286
Joe Perches52ea8502013-11-12 15:10:09 -08006287# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6288 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6289 ERROR("DEFINE_ARCH_HAS",
6290 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6291 }
6292
Joe Perchesacd93622015-02-13 14:38:38 -08006293# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6294 if ($^V && $^V ge 5.10.0 &&
6295 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6296 WARN("LIKELY_MISUSE",
6297 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6298 }
6299
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006300# whine mightly about in_atomic
6301 if ($line =~ /\bin_atomic\s*\(/) {
6302 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006303 ERROR("IN_ATOMIC",
6304 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006305 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006306 WARN("IN_ATOMIC",
6307 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006308 }
6309 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006310
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006311# check for mutex_trylock_recursive usage
6312 if ($line =~ /mutex_trylock_recursive/) {
6313 ERROR("LOCKING",
6314 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6315 }
6316
Peter Zijlstra1704f472010-03-19 01:37:42 +01006317# check for lockdep_set_novalidate_class
6318 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6319 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6320 if ($realfile !~ m@^kernel/lockdep@ &&
6321 $realfile !~ m@^include/linux/lockdep@ &&
6322 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006323 ERROR("LOCKDEP",
6324 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006325 }
6326 }
Dave Jones88f88312011-01-12 16:59:59 -08006327
Joe Perchesb392c642015-04-16 12:44:16 -07006328 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6329 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006330 WARN("EXPORTED_WORLD_WRITABLE",
6331 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006332 }
Joe Perches24358802014-04-03 14:49:13 -07006333
Joe Perches00180462018-02-06 15:38:55 -08006334# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6335# and whether or not function naming is typical and if
6336# DEVICE_ATTR permissions uses are unusual too
6337 if ($^V && $^V ge 5.10.0 &&
6338 defined $stat &&
6339 $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*\)/) {
6340 my $var = $1;
6341 my $perms = $2;
6342 my $show = $3;
6343 my $store = $4;
6344 my $octal_perms = perms_to_octal($perms);
6345 if ($show =~ /^${var}_show$/ &&
6346 $store =~ /^${var}_store$/ &&
6347 $octal_perms eq "0644") {
6348 if (WARN("DEVICE_ATTR_RW",
6349 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6350 $fix) {
6351 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6352 }
6353 } elsif ($show =~ /^${var}_show$/ &&
6354 $store =~ /^NULL$/ &&
6355 $octal_perms eq "0444") {
6356 if (WARN("DEVICE_ATTR_RO",
6357 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6358 $fix) {
6359 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6360 }
6361 } elsif ($show =~ /^NULL$/ &&
6362 $store =~ /^${var}_store$/ &&
6363 $octal_perms eq "0200") {
6364 if (WARN("DEVICE_ATTR_WO",
6365 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6366 $fix) {
6367 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6368 }
6369 } elsif ($octal_perms eq "0644" ||
6370 $octal_perms eq "0444" ||
6371 $octal_perms eq "0200") {
6372 my $newshow = "$show";
6373 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6374 my $newstore = $store;
6375 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6376 my $rename = "";
6377 if ($show ne $newshow) {
6378 $rename .= " '$show' to '$newshow'";
6379 }
6380 if ($store ne $newstore) {
6381 $rename .= " '$store' to '$newstore'";
6382 }
6383 WARN("DEVICE_ATTR_FUNCTIONS",
6384 "Consider renaming function(s)$rename\n" . $herecurr);
6385 } else {
6386 WARN("DEVICE_ATTR_PERMS",
6387 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6388 }
6389 }
6390
Joe Perches515a2352014-04-03 14:49:24 -07006391# Mode permission misuses where it seems decimal should be octal
6392# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006393# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6394# specific definition of not visible in sysfs.
6395# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6396# use the default permissions
Joe Perches515a2352014-04-03 14:49:24 -07006397 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006398 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006399 $line =~ /$mode_perms_search/) {
6400 foreach my $entry (@mode_permission_funcs) {
6401 my $func = $entry->[0];
6402 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006403
Joe Perches459cf0a2016-10-11 13:52:19 -07006404 my $lc = $stat =~ tr@\n@@;
6405 $lc = $lc + $linenr;
Tobin C. Harding2a9f9d82018-04-10 16:33:20 -07006406 my $stat_real = get_stat_real($linenr, $lc);
Joe Perches459cf0a2016-10-11 13:52:19 -07006407
Joe Perches515a2352014-04-03 14:49:24 -07006408 my $skip_args = "";
6409 if ($arg_pos > 1) {
6410 $arg_pos--;
6411 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6412 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006413 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006414 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006415 my $val = $1;
6416 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006417 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6418 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6419 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006420 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006421 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006422 }
6423 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006424 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006425 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006426 }
Joe Perches24358802014-04-03 14:49:13 -07006427 }
6428 }
6429 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006430
Joe Perches459cf0a2016-10-11 13:52:19 -07006431# check for uses of S_<PERMS> that could be octal for readability
Joe Perches00180462018-02-06 15:38:55 -08006432 if ($line =~ /\b($multi_mode_perms_string_search)\b/) {
6433 my $oval = $1;
6434 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006435 if (WARN("SYMBOLIC_PERMS",
6436 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6437 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006438 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006439 }
6440 }
6441
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006442# validate content of MODULE_LICENSE against list from include/linux/module.h
6443 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6444 my $extracted_string = get_quoted_string($line, $rawline);
6445 my $valid_licenses = qr{
6446 GPL|
6447 GPL\ v2|
6448 GPL\ and\ additional\ rights|
6449 Dual\ BSD/GPL|
6450 Dual\ MIT/GPL|
6451 Dual\ MPL/GPL|
6452 Proprietary
6453 }x;
6454 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6455 WARN("MODULE_LICENSE",
6456 "unknown module license " . $extracted_string . "\n" . $herecurr);
6457 }
6458 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006459 }
6460
6461 # If we have no input at all, then there is nothing to report on
6462 # so just keep quiet.
6463 if ($#rawlines == -1) {
6464 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006465 }
6466
Andy Whitcroft8905a672007-11-28 16:21:06 -08006467 # In mailback mode only produce a report in the negative, for
6468 # things that appear to be patches.
6469 if ($mailback && ($clean == 1 || !$is_patch)) {
6470 exit(0);
6471 }
6472
6473 # This is not a patch, and we are are in 'no-patch' mode so
6474 # just keep quiet.
6475 if (!$chk_patch && !$is_patch) {
6476 exit(0);
6477 }
6478
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006479 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006480 ERROR("NOT_UNIFIED_DIFF",
6481 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006482 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006483 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006484 ERROR("MISSING_SIGN_OFF",
6485 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006486 }
6487
Andy Whitcroft8905a672007-11-28 16:21:06 -08006488 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006489 if ($summary && !($clean == 1 && $quiet == 1)) {
6490 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006491 print "total: $cnt_error errors, $cnt_warn warnings, " .
6492 (($check)? "$cnt_chk checks, " : "") .
6493 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006494 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006495
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006496 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006497 # If there were any defects found and not already fixing them
6498 if (!$clean and !$fix) {
6499 print << "EOM"
6500
6501NOTE: For some of the reported defects, checkpatch may be able to
6502 mechanically convert to the typical style using --fix or --fix-inplace.
6503EOM
6504 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006505 # If there were whitespace errors which cleanpatch can fix
6506 # then suggest that.
6507 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006508 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006509 print << "EOM"
6510
6511NOTE: Whitespace errors detected.
6512 You may wish to use scripts/cleanpatch or scripts/cleanfile
6513EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006514 }
6515 }
6516
Joe Perchesd752fcc2014-08-06 16:11:05 -07006517 if ($clean == 0 && $fix &&
6518 ("@rawlines" ne "@fixed" ||
6519 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006520 my $newfile = $filename;
6521 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006522 my $linecount = 0;
6523 my $f;
6524
Joe Perchesd752fcc2014-08-06 16:11:05 -07006525 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6526
Joe Perches3705ce52013-07-03 15:05:31 -07006527 open($f, '>', $newfile)
6528 or die "$P: Can't open $newfile for write\n";
6529 foreach my $fixed_line (@fixed) {
6530 $linecount++;
6531 if ($file) {
6532 if ($linecount > 3) {
6533 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006534 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006535 }
6536 } else {
6537 print $f $fixed_line . "\n";
6538 }
6539 }
6540 close($f);
6541
6542 if (!$quiet) {
6543 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006544
Joe Perches3705ce52013-07-03 15:05:31 -07006545Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6546
6547Do _NOT_ trust the results written to this file.
6548Do _NOT_ submit these changes without inspecting them for correctness.
6549
6550This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6551No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006552EOM
6553 }
6554 }
6555
Joe Perchesd8469f12015-06-25 15:03:00 -07006556 if ($quiet == 0) {
6557 print "\n";
6558 if ($clean == 1) {
6559 print "$vname has no obvious style problems and is ready for submission.\n";
6560 } else {
6561 print "$vname has style problems, please review.\n";
6562 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006563 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006564 return $clean;
6565}