blob: 0f022b56f11717e27bc6b84f8b4f51492ba62028 [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*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700794 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
795)};
796
Joe Perches7d2367a2011-07-25 17:13:22 -0700797sub deparenthesize {
798 my ($string) = @_;
799 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700800
801 while ($string =~ /^\s*\(.*\)\s*$/) {
802 $string =~ s@^\s*\(\s*@@;
803 $string =~ s@\s*\)\s*$@@;
804 }
805
Joe Perches7d2367a2011-07-25 17:13:22 -0700806 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700807
Joe Perches7d2367a2011-07-25 17:13:22 -0700808 return $string;
809}
810
Joe Perches34456862013-07-03 15:05:34 -0700811sub seed_camelcase_file {
812 my ($file) = @_;
813
814 return if (!(-f $file));
815
816 local $/;
817
818 open(my $include_file, '<', "$file")
819 or warn "$P: Can't read '$file' $!\n";
820 my $text = <$include_file>;
821 close($include_file);
822
823 my @lines = split('\n', $text);
824
825 foreach my $line (@lines) {
826 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
827 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
828 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800829 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
830 $camelcase{$1} = 1;
831 } 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 -0700832 $camelcase{$1} = 1;
833 }
834 }
835}
836
Joe Perches85b0ee12016-10-11 13:51:44 -0700837sub is_maintained_obsolete {
838 my ($filename) = @_;
839
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800840 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700841
Joe Perches0616efa2016-10-11 13:52:02 -0700842 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 -0700843
844 return $status =~ /obsolete/i;
845}
846
Joe Perches34456862013-07-03 15:05:34 -0700847my $camelcase_seeded = 0;
848sub seed_camelcase_includes {
849 return if ($camelcase_seeded);
850
851 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700852 my $camelcase_cache = "";
853 my @include_files = ();
854
855 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700856
Richard Genoud3645e322014-02-10 14:25:32 -0800857 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700858 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
859 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700860 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700861 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700862 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700863 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700864 @include_files = split('\n', $files);
865 foreach my $file (@include_files) {
866 my $date = POSIX::strftime("%Y%m%d%H%M",
867 localtime((stat $file)[9]));
868 $last_mod_date = $date if ($last_mod_date < $date);
869 }
870 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700871 }
Joe Perchesc707a812013-07-08 16:00:43 -0700872
873 if ($camelcase_cache ne "" && -f $camelcase_cache) {
874 open(my $camelcase_file, '<', "$camelcase_cache")
875 or warn "$P: Can't read '$camelcase_cache' $!\n";
876 while (<$camelcase_file>) {
877 chomp;
878 $camelcase{$_} = 1;
879 }
880 close($camelcase_file);
881
882 return;
883 }
884
Richard Genoud3645e322014-02-10 14:25:32 -0800885 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700886 $files = `git ls-files "include/*.h"`;
887 @include_files = split('\n', $files);
888 }
889
Joe Perches34456862013-07-03 15:05:34 -0700890 foreach my $file (@include_files) {
891 seed_camelcase_file($file);
892 }
Joe Perches351b2a12013-07-03 15:05:36 -0700893
Joe Perchesc707a812013-07-08 16:00:43 -0700894 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700895 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700896 open(my $camelcase_file, '>', "$camelcase_cache")
897 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700898 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
899 print $camelcase_file ("$_\n");
900 }
901 close($camelcase_file);
902 }
Joe Perches34456862013-07-03 15:05:34 -0700903}
904
Joe Perchesd311cd42014-08-06 16:10:57 -0700905sub git_commit_info {
906 my ($commit, $id, $desc) = @_;
907
908 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
909
910 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
911 $output =~ s/^\s*//gm;
912 my @lines = split("\n", $output);
913
Joe Perches0d7835f2015-02-13 14:38:35 -0800914 return ($id, $desc) if ($#lines < 0);
915
Joe Perchesd311cd42014-08-06 16:10:57 -0700916 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
917# Maybe one day convert this block of bash into something that returns
918# all matching commit ids, but it's very slow...
919#
920# echo "checking commits $1..."
921# git rev-list --remotes | grep -i "^$1" |
922# while read line ; do
923# git log --format='%H %s' -1 $line |
924# echo "commit $(cut -c 1-12,41-)"
925# done
926 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700927 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700928 } else {
929 $id = substr($lines[0], 0, 12);
930 $desc = substr($lines[0], 41);
931 }
932
933 return ($id, $desc);
934}
935
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700936$chk_signoff = 0 if ($file);
937
Andy Whitcroft00df3442007-06-08 13:47:06 -0700938my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800939my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700940my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700941my @fixed_inserted = ();
942my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700943my $fixlinenr = -1;
944
Du, Changbin4a593c32016-05-20 17:04:16 -0700945# If input is git commits, extract all commits from the commit expressions.
946# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
947die "$P: No git repository found\n" if ($git && !-e ".git");
948
949if ($git) {
950 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700951 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700952 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700953 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
954 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700955 } elsif ($commit_expr =~ m/\.\./) {
956 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700957 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700958 $git_range = "-1 $commit_expr";
959 }
960 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
961 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700962 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
963 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700964 my $sha1 = $1;
965 my $subject = $2;
966 unshift(@commits, $sha1);
967 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700968 }
969 }
970 die "$P: no git commits after extraction!\n" if (@commits == 0);
971 @ARGV = @commits;
972}
973
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800974my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700975for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800976 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700977 if ($git) {
978 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
979 die "$P: $filename: git format-patch failed - $!\n";
980 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800981 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700982 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800983 } elsif ($filename eq '-') {
984 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700985 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800986 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700987 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700988 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800989 if ($filename eq '-') {
990 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700991 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700992 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800993 } else {
994 $vname = $filename;
995 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800996 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700997 chomp;
998 push(@rawlines, $_);
999 }
Andy Whitcroft21caa132009-01-06 14:41:30 -08001000 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -07001001
1002 if ($#ARGV > 0 && $quiet == 0) {
1003 print '-' x length($vname) . "\n";
1004 print "$vname\n";
1005 print '-' x length($vname) . "\n";
1006 }
1007
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001008 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001009 $exit = 1;
1010 }
1011 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001012 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -07001013 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -07001014 @fixed_inserted = ();
1015 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -07001016 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -07001017 @modifierListFile = ();
1018 @typeListFile = ();
1019 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001020}
1021
Joe Perchesd8469f12015-06-25 15:03:00 -07001022if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -07001023 hash_show_words(\%use_type, "Used");
1024 hash_show_words(\%ignore_type, "Ignored");
1025
Joe Perchesd8469f12015-06-25 15:03:00 -07001026 if ($^V lt 5.10.0) {
1027 print << "EOM"
1028
1029NOTE: perl $^V is not modern enough to detect all possible issues.
1030 An upgrade to at least perl v5.10.0 is suggested.
1031EOM
1032 }
1033 if ($exit) {
1034 print << "EOM"
1035
1036NOTE: If any of the errors are false positives, please report
1037 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1038EOM
1039 }
1040}
1041
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001042exit($exit);
1043
1044sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001045 my ($root) = @_;
1046
1047 my @tree_check = (
1048 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1049 "README", "Documentation", "arch", "include", "drivers",
1050 "fs", "init", "ipc", "kernel", "lib", "scripts",
1051 );
1052
1053 foreach my $check (@tree_check) {
1054 if (! -e $root . '/' . $check) {
1055 return 0;
1056 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001057 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001058 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001059}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001060
Joe Perches20112472011-07-25 17:13:23 -07001061sub parse_email {
1062 my ($formatted_email) = @_;
1063
1064 my $name = "";
1065 my $address = "";
1066 my $comment = "";
1067
1068 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1069 $name = $1;
1070 $address = $2;
1071 $comment = $3 if defined $3;
1072 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1073 $address = $1;
1074 $comment = $2 if defined $2;
1075 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1076 $address = $1;
1077 $comment = $2 if defined $2;
Joe Perches85e12062018-04-10 16:33:09 -07001078 $formatted_email =~ s/\Q$address\E.*$//;
Joe Perches20112472011-07-25 17:13:23 -07001079 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001080 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001081 $name =~ s/^\"|\"$//g;
1082 # If there's a name left after stripping spaces and
1083 # leading quotes, and the address doesn't have both
1084 # leading and trailing angle brackets, the address
1085 # is invalid. ie:
1086 # "joe smith joe@smith.com" bad
1087 # "joe smith <joe@smith.com" bad
1088 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1089 $name = "";
1090 $address = "";
1091 $comment = "";
1092 }
1093 }
1094
Joe Perches3705ce52013-07-03 15:05:31 -07001095 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001096 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001097 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001098 $address =~ s/^\<|\>$//g;
1099
1100 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1101 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1102 $name = "\"$name\"";
1103 }
1104
1105 return ($name, $address, $comment);
1106}
1107
1108sub format_email {
1109 my ($name, $address) = @_;
1110
1111 my $formatted_email;
1112
Joe Perches3705ce52013-07-03 15:05:31 -07001113 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001114 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001115 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001116
1117 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1118 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1119 $name = "\"$name\"";
1120 }
1121
1122 if ("$name" eq "") {
1123 $formatted_email = "$address";
1124 } else {
1125 $formatted_email = "$name <$address>";
1126 }
1127
1128 return $formatted_email;
1129}
1130
Joe Perchesd311cd42014-08-06 16:10:57 -07001131sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001132 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001133
Joe Perchesbd474ca2014-08-06 16:11:10 -07001134 foreach my $path (split(/:/, $ENV{PATH})) {
1135 if (-e "$path/$bin") {
1136 return "$path/$bin";
1137 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001138 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001139
Joe Perchesbd474ca2014-08-06 16:11:10 -07001140 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001141}
1142
Joe Perches000d1cc12011-07-25 17:13:25 -07001143sub which_conf {
1144 my ($conf) = @_;
1145
1146 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1147 if (-e "$path/$conf") {
1148 return "$path/$conf";
1149 }
1150 }
1151
1152 return "";
1153}
1154
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001155sub expand_tabs {
1156 my ($str) = @_;
1157
1158 my $res = '';
1159 my $n = 0;
1160 for my $c (split(//, $str)) {
1161 if ($c eq "\t") {
1162 $res .= ' ';
1163 $n++;
1164 for (; ($n % 8) != 0; $n++) {
1165 $res .= ' ';
1166 }
1167 next;
1168 }
1169 $res .= $c;
1170 $n++;
1171 }
1172
1173 return $res;
1174}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001175sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001176 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001177 return $res;
1178}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001179
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001180sub line_stats {
1181 my ($line) = @_;
1182
1183 # Drop the diff line leader and expand tabs
1184 $line =~ s/^.//;
1185 $line = expand_tabs($line);
1186
1187 # Pick the indent from the front of the line.
1188 my ($white) = ($line =~ /^(\s*)/);
1189
1190 return (length($line), length($white));
1191}
1192
Andy Whitcroft773647a2008-03-28 14:15:58 -07001193my $sanitise_quote = '';
1194
1195sub sanitise_line_reset {
1196 my ($in_comment) = @_;
1197
1198 if ($in_comment) {
1199 $sanitise_quote = '*/';
1200 } else {
1201 $sanitise_quote = '';
1202 }
1203}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001204sub sanitise_line {
1205 my ($line) = @_;
1206
1207 my $res = '';
1208 my $l = '';
1209
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001210 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001211 my $off = 0;
1212 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001213
Andy Whitcroft773647a2008-03-28 14:15:58 -07001214 # Always copy over the diff marker.
1215 $res = substr($line, 0, 1);
1216
1217 for ($off = 1; $off < length($line); $off++) {
1218 $c = substr($line, $off, 1);
1219
1220 # Comments we are wacking completly including the begin
1221 # and end, all to $;.
1222 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1223 $sanitise_quote = '*/';
1224
1225 substr($res, $off, 2, "$;$;");
1226 $off++;
1227 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001228 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001229 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001230 $sanitise_quote = '';
1231 substr($res, $off, 2, "$;$;");
1232 $off++;
1233 next;
1234 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001235 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1236 $sanitise_quote = '//';
1237
1238 substr($res, $off, 2, $sanitise_quote);
1239 $off++;
1240 next;
1241 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001242
1243 # A \ in a string means ignore the next character.
1244 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1245 $c eq "\\") {
1246 substr($res, $off, 2, 'XX');
1247 $off++;
1248 next;
1249 }
1250 # Regular quotes.
1251 if ($c eq "'" || $c eq '"') {
1252 if ($sanitise_quote eq '') {
1253 $sanitise_quote = $c;
1254
1255 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001256 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001257 } elsif ($sanitise_quote eq $c) {
1258 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001259 }
1260 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001261
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001262 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001263 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1264 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001265 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1266 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001267 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1268 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001269 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001270 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001271 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001272 }
1273
Daniel Walker113f04a2009-09-21 17:04:35 -07001274 if ($sanitise_quote eq '//') {
1275 $sanitise_quote = '';
1276 }
1277
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001278 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001279 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001280 my $clean = 'X' x length($1);
1281 $res =~ s@\<.*\>@<$clean>@;
1282
1283 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001284 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001285 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001286 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001287 }
1288
Joe Perchesdadf6802016-08-02 14:04:33 -07001289 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1290 my $match = $1;
1291 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1292 }
1293
Andy Whitcroft00df3442007-06-08 13:47:06 -07001294 return $res;
1295}
1296
Joe Perchesa6962d72013-04-29 16:18:13 -07001297sub get_quoted_string {
1298 my ($line, $rawline) = @_;
1299
Joe Perches33acb542015-06-25 15:02:54 -07001300 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001301 return substr($rawline, $-[0], $+[0] - $-[0]);
1302}
1303
Andy Whitcroft8905a672007-11-28 16:21:06 -08001304sub ctx_statement_block {
1305 my ($linenr, $remain, $off) = @_;
1306 my $line = $linenr - 1;
1307 my $blk = '';
1308 my $soff = $off;
1309 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001310 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001311
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001312 my $loff = 0;
1313
Andy Whitcroft8905a672007-11-28 16:21:06 -08001314 my $type = '';
1315 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001316 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001317 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001318 my $c;
1319 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001320
1321 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001322 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001323 @stack = (['', 0]) if ($#stack == -1);
1324
Andy Whitcroft773647a2008-03-28 14:15:58 -07001325 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001326 # If we are about to drop off the end, pull in more
1327 # context.
1328 if ($off >= $len) {
1329 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001330 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001331 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001332 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001333 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001334 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001335 $len = length($blk);
1336 $line++;
1337 last;
1338 }
1339 # Bail if there is no further context.
1340 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001341 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001342 last;
1343 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001344 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1345 $level++;
1346 $type = '#';
1347 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001348 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001349 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001350 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001351 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001352
Andy Whitcroft773647a2008-03-28 14:15:58 -07001353 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001354
1355 # Handle nested #if/#else.
1356 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1357 push(@stack, [ $type, $level ]);
1358 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1359 ($type, $level) = @{$stack[$#stack - 1]};
1360 } elsif ($remainder =~ /^#\s*endif\b/) {
1361 ($type, $level) = @{pop(@stack)};
1362 }
1363
Andy Whitcroft8905a672007-11-28 16:21:06 -08001364 # Statement ends at the ';' or a close '}' at the
1365 # outermost level.
1366 if ($level == 0 && $c eq ';') {
1367 last;
1368 }
1369
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001370 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001371 if ($level == 0 && $coff_set == 0 &&
1372 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1373 $remainder =~ /^(else)(?:\s|{)/ &&
1374 $remainder !~ /^else\s+if\b/) {
1375 $coff = $off + length($1) - 1;
1376 $coff_set = 1;
1377 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1378 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001379 }
1380
Andy Whitcroft8905a672007-11-28 16:21:06 -08001381 if (($type eq '' || $type eq '(') && $c eq '(') {
1382 $level++;
1383 $type = '(';
1384 }
1385 if ($type eq '(' && $c eq ')') {
1386 $level--;
1387 $type = ($level != 0)? '(' : '';
1388
1389 if ($level == 0 && $coff < $soff) {
1390 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001391 $coff_set = 1;
1392 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001393 }
1394 }
1395 if (($type eq '' || $type eq '{') && $c eq '{') {
1396 $level++;
1397 $type = '{';
1398 }
1399 if ($type eq '{' && $c eq '}') {
1400 $level--;
1401 $type = ($level != 0)? '{' : '';
1402
1403 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001404 if (substr($blk, $off + 1, 1) eq ';') {
1405 $off++;
1406 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001407 last;
1408 }
1409 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001410 # Preprocessor commands end at the newline unless escaped.
1411 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1412 $level--;
1413 $type = '';
1414 $off++;
1415 last;
1416 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001417 $off++;
1418 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001419 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001420 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001421 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001422 $line++;
1423 $remain--;
1424 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001425
1426 my $statement = substr($blk, $soff, $off - $soff + 1);
1427 my $condition = substr($blk, $soff, $coff - $soff + 1);
1428
1429 #warn "STATEMENT<$statement>\n";
1430 #warn "CONDITION<$condition>\n";
1431
Andy Whitcroft773647a2008-03-28 14:15:58 -07001432 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001433
1434 return ($statement, $condition,
1435 $line, $remain + 1, $off - $loff + 1, $level);
1436}
1437
Andy Whitcroftcf655042008-03-04 14:28:20 -08001438sub statement_lines {
1439 my ($stmt) = @_;
1440
1441 # Strip the diff line prefixes and rip blank lines at start and end.
1442 $stmt =~ s/(^|\n)./$1/g;
1443 $stmt =~ s/^\s*//;
1444 $stmt =~ s/\s*$//;
1445
1446 my @stmt_lines = ($stmt =~ /\n/g);
1447
1448 return $#stmt_lines + 2;
1449}
1450
1451sub statement_rawlines {
1452 my ($stmt) = @_;
1453
1454 my @stmt_lines = ($stmt =~ /\n/g);
1455
1456 return $#stmt_lines + 2;
1457}
1458
1459sub statement_block_size {
1460 my ($stmt) = @_;
1461
1462 $stmt =~ s/(^|\n)./$1/g;
1463 $stmt =~ s/^\s*{//;
1464 $stmt =~ s/}\s*$//;
1465 $stmt =~ s/^\s*//;
1466 $stmt =~ s/\s*$//;
1467
1468 my @stmt_lines = ($stmt =~ /\n/g);
1469 my @stmt_statements = ($stmt =~ /;/g);
1470
1471 my $stmt_lines = $#stmt_lines + 2;
1472 my $stmt_statements = $#stmt_statements + 1;
1473
1474 if ($stmt_lines > $stmt_statements) {
1475 return $stmt_lines;
1476 } else {
1477 return $stmt_statements;
1478 }
1479}
1480
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001481sub ctx_statement_full {
1482 my ($linenr, $remain, $off) = @_;
1483 my ($statement, $condition, $level);
1484
1485 my (@chunks);
1486
Andy Whitcroftcf655042008-03-04 14:28:20 -08001487 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001488 ($statement, $condition, $linenr, $remain, $off, $level) =
1489 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001490 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001491 push(@chunks, [ $condition, $statement ]);
1492 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1493 return ($level, $linenr, @chunks);
1494 }
1495
1496 # Pull in the following conditional/block pairs and see if they
1497 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001498 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001499 ($statement, $condition, $linenr, $remain, $off, $level) =
1500 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001501 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001502 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001503 #print "C: push\n";
1504 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001505 }
1506
1507 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001508}
1509
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001510sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001511 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001512 my $line;
1513 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001514 my $blk = '';
1515 my @o;
1516 my @c;
1517 my @res = ();
1518
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001519 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001520 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001521 for ($line = $start; $remain > 0; $line++) {
1522 next if ($rawlines[$line] =~ /^-/);
1523 $remain--;
1524
1525 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001526
1527 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001528 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001529 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001530 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001531 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001532 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001533 $level = pop(@stack);
1534 }
1535
Andy Whitcroft01464f32010-10-26 14:23:19 -07001536 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001537 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1538 if ($off > 0) {
1539 $off--;
1540 next;
1541 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001542
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001543 if ($c eq $close && $level > 0) {
1544 $level--;
1545 last if ($level == 0);
1546 } elsif ($c eq $open) {
1547 $level++;
1548 }
1549 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001550
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001551 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001552 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001553 }
1554
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001555 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001556 }
1557
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001558 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001559}
1560sub ctx_block_outer {
1561 my ($linenr, $remain) = @_;
1562
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001563 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1564 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001565}
1566sub ctx_block {
1567 my ($linenr, $remain) = @_;
1568
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001569 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1570 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001571}
1572sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001573 my ($linenr, $remain, $off) = @_;
1574
1575 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1576 return @r;
1577}
1578sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001579 my ($linenr, $remain) = @_;
1580
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001581 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001582}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001583sub ctx_statement_level {
1584 my ($linenr, $remain, $off) = @_;
1585
1586 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1587}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001588
1589sub ctx_locate_comment {
1590 my ($first_line, $end_line) = @_;
1591
1592 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001593 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001594 return $current_comment if (defined $current_comment);
1595
1596 # Look through the context and try and figure out if there is a
1597 # comment.
1598 my $in_comment = 0;
1599 $current_comment = '';
1600 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001601 my $line = $rawlines[$linenr - 1];
1602 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001603 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1604 $in_comment = 1;
1605 }
1606 if ($line =~ m@/\*@) {
1607 $in_comment = 1;
1608 }
1609 if (!$in_comment && $current_comment ne '') {
1610 $current_comment = '';
1611 }
1612 $current_comment .= $line . "\n" if ($in_comment);
1613 if ($line =~ m@\*/@) {
1614 $in_comment = 0;
1615 }
1616 }
1617
1618 chomp($current_comment);
1619 return($current_comment);
1620}
1621sub ctx_has_comment {
1622 my ($first_line, $end_line) = @_;
1623 my $cmt = ctx_locate_comment($first_line, $end_line);
1624
Andy Whitcroft00df3442007-06-08 13:47:06 -07001625 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001626 ##print "CMMT: $cmt\n";
1627
1628 return ($cmt ne '');
1629}
1630
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001631sub raw_line {
1632 my ($linenr, $cnt) = @_;
1633
1634 my $offset = $linenr - 1;
1635 $cnt++;
1636
1637 my $line;
1638 while ($cnt) {
1639 $line = $rawlines[$offset++];
1640 next if (defined($line) && $line =~ /^-/);
1641 $cnt--;
1642 }
1643
1644 return $line;
1645}
1646
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001647sub cat_vet {
1648 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001649 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001650
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001651 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1653 $res .= $1;
1654 if ($2 ne '') {
1655 $coded = sprintf("^%c", unpack('C', $2) + 64);
1656 $res .= $coded;
1657 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001658 }
1659 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001660
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001661 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001662}
1663
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001664my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001665my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001666my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001667my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001668
1669sub annotate_reset {
1670 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001671 $av_pending = '_';
1672 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001673 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001674}
1675
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001676sub annotate_values {
1677 my ($stream, $type) = @_;
1678
1679 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001680 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001681 my $cur = $stream;
1682
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001683 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001684
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001685 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001686 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001687 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001688 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001689 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001690 print "WS($1)\n" if ($dbg_values > 1);
1691 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001692 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001693 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001694 }
1695
Florian Micklerc023e4732011-01-12 16:59:58 -08001696 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001697 print "CAST($1)\n" if ($dbg_values > 1);
1698 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001699 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001700
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001701 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001702 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001703 $type = 'T';
1704
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001705 } elsif ($cur =~ /^($Modifier)\s*/) {
1706 print "MODIFIER($1)\n" if ($dbg_values > 1);
1707 $type = 'T';
1708
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001709 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001710 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001711 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001712 push(@av_paren_type, $type);
1713 if ($2 ne '') {
1714 $av_pending = 'N';
1715 }
1716 $type = 'E';
1717
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001718 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001719 print "UNDEF($1)\n" if ($dbg_values > 1);
1720 $av_preprocessor = 1;
1721 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001722
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001723 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001724 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001725 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001726
1727 push(@av_paren_type, $type);
1728 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001729 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001730
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001731 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001732 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1733 $av_preprocessor = 1;
1734
1735 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1736
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001737 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001738
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001739 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001740 print "PRE_END($1)\n" if ($dbg_values > 1);
1741
1742 $av_preprocessor = 1;
1743
1744 # Assume all arms of the conditional end as this
1745 # one does, and continue as if the #endif was not here.
1746 pop(@av_paren_type);
1747 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001748 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001749
1750 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001751 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001752
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001753 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1754 print "ATTR($1)\n" if ($dbg_values > 1);
1755 $av_pending = $type;
1756 $type = 'N';
1757
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001758 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001759 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001760 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001761 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001762 }
1763 $type = 'N';
1764
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001765 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001766 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001767 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001768 $type = 'N';
1769
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001770 } elsif ($cur =~/^(case)/o) {
1771 print "CASE($1)\n" if ($dbg_values > 1);
1772 $av_pend_colon = 'C';
1773 $type = 'N';
1774
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001775 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001776 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001777 $type = 'N';
1778
1779 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001780 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001781 push(@av_paren_type, $av_pending);
1782 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001783 $type = 'N';
1784
1785 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001786 my $new_type = pop(@av_paren_type);
1787 if ($new_type ne '_') {
1788 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001789 print "PAREN('$1') -> $type\n"
1790 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001791 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001792 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001793 }
1794
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001795 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001796 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001797 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001798 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001799
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001800 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1801 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001802 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001803 } elsif ($type eq 'E') {
1804 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001805 }
1806 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1807 $type = 'V';
1808
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001809 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001810 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001811 $type = 'V';
1812
1813 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001814 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001815 $type = 'N';
1816
Andy Whitcroftcf655042008-03-04 14:28:20 -08001817 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001818 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001819 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001820 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001821
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001822 } elsif ($cur =~/^(,)/) {
1823 print "COMMA($1)\n" if ($dbg_values > 1);
1824 $type = 'C';
1825
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001826 } elsif ($cur =~ /^(\?)/o) {
1827 print "QUESTION($1)\n" if ($dbg_values > 1);
1828 $type = 'N';
1829
1830 } elsif ($cur =~ /^(:)/o) {
1831 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1832
1833 substr($var, length($res), 1, $av_pend_colon);
1834 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1835 $type = 'E';
1836 } else {
1837 $type = 'N';
1838 }
1839 $av_pend_colon = 'O';
1840
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001841 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001842 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001843 $type = 'N';
1844
Andy Whitcroft0d413862008-10-15 22:02:16 -07001845 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001846 my $variant;
1847
1848 print "OPV($1)\n" if ($dbg_values > 1);
1849 if ($type eq 'V') {
1850 $variant = 'B';
1851 } else {
1852 $variant = 'U';
1853 }
1854
1855 substr($var, length($res), 1, $variant);
1856 $type = 'N';
1857
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001858 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001859 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001860 if ($1 ne '++' && $1 ne '--') {
1861 $type = 'N';
1862 }
1863
1864 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001865 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001866 }
1867 if (defined $1) {
1868 $cur = substr($cur, length($1));
1869 $res .= $type x length($1);
1870 }
1871 }
1872
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001873 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001874}
1875
Andy Whitcroft8905a672007-11-28 16:21:06 -08001876sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001877 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001878 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001879 ^(?:
1880 $Modifier|
1881 $Storage|
1882 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001883 DEFINE_\S+
1884 )$|
1885 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001886 goto|
1887 return|
1888 case|
1889 else|
1890 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001891 do|
1892 \#|
1893 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001894 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001895 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001896 )}x;
1897 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1898 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001899 # Check for modifiers.
1900 $possible =~ s/\s*$Storage\s*//g;
1901 $possible =~ s/\s*$Sparse\s*//g;
1902 if ($possible =~ /^\s*$/) {
1903
1904 } elsif ($possible =~ /\s/) {
1905 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001906 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001907 if ($modifier !~ $notPermitted) {
1908 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001909 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001910 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001911 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001912
1913 } else {
1914 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001915 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001916 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001917 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001918 } else {
1919 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001920 }
1921}
1922
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001923my $prefix = '';
1924
Joe Perches000d1cc12011-07-25 17:13:25 -07001925sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001926 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001927
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001928 $type =~ tr/[a-z]/[A-Z]/;
1929
Joe Perchescbec18a2014-04-03 14:49:19 -07001930 return defined $use_type{$type} if (scalar keys %use_type > 0);
1931
1932 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001933}
1934
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001935sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001936 my ($level, $type, $msg) = @_;
1937
1938 if (!show_type($type) ||
1939 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001940 return 0;
1941 }
Joe Perches57230292015-06-25 15:03:03 -07001942 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001943 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001944 if ($level eq 'ERROR') {
1945 $output .= RED;
1946 } elsif ($level eq 'WARNING') {
1947 $output .= YELLOW;
1948 } else {
1949 $output .= GREEN;
1950 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001951 }
Joe Perches57230292015-06-25 15:03:03 -07001952 $output .= $prefix . $level . ':';
1953 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001954 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001955 $output .= "$type:";
1956 }
John Brooks737c0762017-07-10 15:52:24 -07001957 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001958 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001959
1960 if ($showfile) {
1961 my @lines = split("\n", $output, -1);
1962 splice(@lines, 1, 1);
1963 $output = join("\n", @lines);
1964 }
Joe Perches57230292015-06-25 15:03:03 -07001965 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001966
Joe Perches57230292015-06-25 15:03:03 -07001967 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001968
1969 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001970}
Joe Perchescbec18a2014-04-03 14:49:19 -07001971
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001972sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001973 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001974}
Joe Perches000d1cc12011-07-25 17:13:25 -07001975
Joe Perchesd752fcc2014-08-06 16:11:05 -07001976sub fixup_current_range {
1977 my ($lineRef, $offset, $length) = @_;
1978
1979 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1980 my $o = $1;
1981 my $l = $2;
1982 my $no = $o + $offset;
1983 my $nl = $l + $length;
1984 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1985 }
1986}
1987
1988sub fix_inserted_deleted_lines {
1989 my ($linesRef, $insertedRef, $deletedRef) = @_;
1990
1991 my $range_last_linenr = 0;
1992 my $delta_offset = 0;
1993
1994 my $old_linenr = 0;
1995 my $new_linenr = 0;
1996
1997 my $next_insert = 0;
1998 my $next_delete = 0;
1999
2000 my @lines = ();
2001
2002 my $inserted = @{$insertedRef}[$next_insert++];
2003 my $deleted = @{$deletedRef}[$next_delete++];
2004
2005 foreach my $old_line (@{$linesRef}) {
2006 my $save_line = 1;
2007 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07002008 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07002009 $delta_offset = 0;
2010 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
2011 $range_last_linenr = $new_linenr;
2012 fixup_current_range(\$line, $delta_offset, 0);
2013 }
2014
2015 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
2016 $deleted = @{$deletedRef}[$next_delete++];
2017 $save_line = 0;
2018 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
2019 }
2020
2021 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
2022 push(@lines, ${$inserted}{'LINE'});
2023 $inserted = @{$insertedRef}[$next_insert++];
2024 $new_linenr++;
2025 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
2026 }
2027
2028 if ($save_line) {
2029 push(@lines, $line);
2030 $new_linenr++;
2031 }
2032
2033 $old_linenr++;
2034 }
2035
2036 return @lines;
2037}
2038
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002039sub fix_insert_line {
2040 my ($linenr, $line) = @_;
2041
2042 my $inserted = {
2043 LINENR => $linenr,
2044 LINE => $line,
2045 };
2046 push(@fixed_inserted, $inserted);
2047}
2048
2049sub fix_delete_line {
2050 my ($linenr, $line) = @_;
2051
2052 my $deleted = {
2053 LINENR => $linenr,
2054 LINE => $line,
2055 };
2056
2057 push(@fixed_deleted, $deleted);
2058}
2059
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002060sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002061 my ($type, $msg) = @_;
2062
2063 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002064 our $clean = 0;
2065 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002066 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002067 }
Joe Perches3705ce52013-07-03 15:05:31 -07002068 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002069}
2070sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002071 my ($type, $msg) = @_;
2072
2073 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002074 our $clean = 0;
2075 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002076 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002077 }
Joe Perches3705ce52013-07-03 15:05:31 -07002078 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002079}
2080sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002081 my ($type, $msg) = @_;
2082
2083 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002084 our $clean = 0;
2085 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002086 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002087 }
Joe Perches3705ce52013-07-03 15:05:31 -07002088 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002089}
2090
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002091sub check_absolute_file {
2092 my ($absolute, $herecurr) = @_;
2093 my $file = $absolute;
2094
2095 ##print "absolute<$absolute>\n";
2096
2097 # See if any suffix of this path is a path within the tree.
2098 while ($file =~ s@^[^/]*/@@) {
2099 if (-f "$root/$file") {
2100 ##print "file<$file>\n";
2101 last;
2102 }
2103 }
2104 if (! -f _) {
2105 return 0;
2106 }
2107
2108 # It is, so see if the prefix is acceptable.
2109 my $prefix = $absolute;
2110 substr($prefix, -length($file)) = '';
2111
2112 ##print "prefix<$prefix>\n";
2113 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002114 WARN("USE_RELATIVE_PATH",
2115 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002116 }
2117}
2118
Joe Perches3705ce52013-07-03 15:05:31 -07002119sub trim {
2120 my ($string) = @_;
2121
Joe Perchesb34c6482013-09-11 14:24:01 -07002122 $string =~ s/^\s+|\s+$//g;
2123
2124 return $string;
2125}
2126
2127sub ltrim {
2128 my ($string) = @_;
2129
2130 $string =~ s/^\s+//;
2131
2132 return $string;
2133}
2134
2135sub rtrim {
2136 my ($string) = @_;
2137
2138 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002139
2140 return $string;
2141}
2142
Joe Perches52ea8502013-11-12 15:10:09 -08002143sub string_find_replace {
2144 my ($string, $find, $replace) = @_;
2145
2146 $string =~ s/$find/$replace/g;
2147
2148 return $string;
2149}
2150
Joe Perches3705ce52013-07-03 15:05:31 -07002151sub tabify {
2152 my ($leading) = @_;
2153
2154 my $source_indent = 8;
2155 my $max_spaces_before_tab = $source_indent - 1;
2156 my $spaces_to_tab = " " x $source_indent;
2157
2158 #convert leading spaces to tabs
2159 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2160 #Remove spaces before a tab
2161 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2162
2163 return "$leading";
2164}
2165
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002166sub pos_last_openparen {
2167 my ($line) = @_;
2168
2169 my $pos = 0;
2170
2171 my $opens = $line =~ tr/\(/\(/;
2172 my $closes = $line =~ tr/\)/\)/;
2173
2174 my $last_openparen = 0;
2175
2176 if (($opens == 0) || ($closes >= $opens)) {
2177 return -1;
2178 }
2179
2180 my $len = length($line);
2181
2182 for ($pos = 0; $pos < $len; $pos++) {
2183 my $string = substr($line, $pos);
2184 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2185 $pos += length($1) - 1;
2186 } elsif (substr($line, $pos, 1) eq '(') {
2187 $last_openparen = $pos;
2188 } elsif (index($string, '(') == -1) {
2189 last;
2190 }
2191 }
2192
Joe Perches91cb5192014-04-03 14:49:32 -07002193 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002194}
2195
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002196sub process {
2197 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002198
2199 my $linenr=0;
2200 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002201 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002202 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002203 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002204
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002205 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002206 my $indent;
2207 my $previndent=0;
2208 my $stashindent=0;
2209
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002210 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002211 my $signoff = 0;
2212 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002213 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002214 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002215 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002216 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002217 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002218 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002219 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002220 my $non_utf8_charset = 0;
2221
Joe Perches365dd4e2014-08-06 16:10:42 -07002222 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002223 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002224
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002225 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002226 our $cnt_lines = 0;
2227 our $cnt_error = 0;
2228 our $cnt_warn = 0;
2229 our $cnt_chk = 0;
2230
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002231 # Trace the real file/line as we go.
2232 my $realfile = '';
2233 my $realline = 0;
2234 my $realcnt = 0;
2235 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002236 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002237 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002238 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002239 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002240 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002241
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002242 my $prev_values = 'E';
2243
2244 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002245 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002246 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002247 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002248 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002249
Joe Perches7e51f192013-09-11 14:23:57 -07002250 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002251
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002252 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002253 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002254 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002255 my @setup_docs = ();
2256 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002257
Joe Perchesd8b07712013-11-12 15:10:06 -08002258 my $camelcase_file_seeded = 0;
2259
Rob Herring9f3a8992018-04-10 16:33:13 -07002260 my $checklicenseline = 1;
2261
Andy Whitcroft773647a2008-03-28 14:15:58 -07002262 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002263 my $line;
2264 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002265 $linenr++;
2266 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002267
Joe Perches3705ce52013-07-03 15:05:31 -07002268 push(@fixed, $rawline) if ($fix);
2269
Andy Whitcroft773647a2008-03-28 14:15:58 -07002270 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002271 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002272 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002273 $setup_docs = 1;
2274 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002275 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002276 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002277 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002278 $realline=$1-1;
2279 if (defined $2) {
2280 $realcnt=$3+1;
2281 } else {
2282 $realcnt=1+1;
2283 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002284 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002285
2286 # Guestimate if this is a continuing comment. Run
2287 # the context looking for a comment "edge". If this
2288 # edge is a close comment then we must be in a comment
2289 # at context start.
2290 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002291 my $cnt = $realcnt;
2292 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2293 next if (defined $rawlines[$ln - 1] &&
2294 $rawlines[$ln - 1] =~ /^-/);
2295 $cnt--;
2296 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002297 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002298 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2299 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2300 ($edge) = $1;
2301 last;
2302 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002303 }
2304 if (defined $edge && $edge eq '*/') {
2305 $in_comment = 1;
2306 }
2307
2308 # Guestimate if this is a continuing comment. If this
2309 # is the start of a diff block and this line starts
2310 # ' *' then it is very likely a comment.
2311 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002312 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002313 {
2314 $in_comment = 1;
2315 }
2316
2317 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2318 sanitise_line_reset($in_comment);
2319
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002320 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002321 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002322 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002323 $line = sanitise_line($rawline);
2324 }
2325 push(@lines, $line);
2326
2327 if ($realcnt > 1) {
2328 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2329 } else {
2330 $realcnt = 0;
2331 }
2332
2333 #print "==>$rawline\n";
2334 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002335
2336 if ($setup_docs && $line =~ /^\+/) {
2337 push(@setup_docs, $line);
2338 }
2339 }
2340
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002341 $prefix = '';
2342
Andy Whitcroft773647a2008-03-28 14:15:58 -07002343 $realcnt = 0;
2344 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002345 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002346 foreach my $line (@lines) {
2347 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002348 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002349 my $sline = $line; #copy of $line
2350 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002351
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002352 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002353
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002354#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002355 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002356 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2357 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002358 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002359 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002360 $realline=$1-1;
2361 if (defined $2) {
2362 $realcnt=$3+1;
2363 } else {
2364 $realcnt=1+1;
2365 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002366 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002367 $prev_values = 'E';
2368
Andy Whitcroft773647a2008-03-28 14:15:58 -07002369 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002370 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002371 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002372 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002373 if ($context =~ /\b(\w+)\s*\(/) {
2374 $context_function = $1;
2375 } else {
2376 undef $context_function;
2377 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002378 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002379
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002380# track the line number as we move through the hunk, note that
2381# new versions of GNU diff omit the leading space on completely
2382# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002383 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002384 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002385 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002386
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002387 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002388 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002389
2390 # Track the previous line.
2391 ($prevline, $stashline) = ($stashline, $line);
2392 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002393 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2394
Andy Whitcroft773647a2008-03-28 14:15:58 -07002395 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002396
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002397 } elsif ($realcnt == 1) {
2398 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002399 }
2400
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002401 my $hunk_line = ($realcnt != 0);
2402
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002403 $here = "#$linenr: " if (!$file);
2404 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002405
Joe Perches2ac73b42014-06-04 16:12:05 -07002406 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002407 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002408 if ($line =~ /^diff --git.*?(\S+)$/) {
2409 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002410 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002411 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002412 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002413 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002414 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002415 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002416 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002417
2418 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002419 if (!$file && $tree && $p1_prefix ne '' &&
2420 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002421 WARN("PATCH_PREFIX",
2422 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002423 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002424
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002425 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002426 ERROR("MODIFIED_INCLUDE_ASM",
2427 "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 -07002428 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002429 $found_file = 1;
2430 }
2431
Joe Perches34d88152015-06-25 15:03:05 -07002432#make up the handle for any error we report on this line
2433 if ($showfile) {
2434 $prefix = "$realfile:$realline: "
2435 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002436 if ($file) {
2437 $prefix = "$filename:$realline: ";
2438 } else {
2439 $prefix = "$filename:$linenr: ";
2440 }
Joe Perches34d88152015-06-25 15:03:05 -07002441 }
2442
Joe Perches2ac73b42014-06-04 16:12:05 -07002443 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002444 if (is_maintained_obsolete($realfile)) {
2445 WARN("OBSOLETE",
2446 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2447 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002448 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002449 $check = 1;
2450 } else {
2451 $check = $check_orig;
2452 }
Rob Herring9f3a8992018-04-10 16:33:13 -07002453 $checklicenseline = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002454 next;
2455 }
2456
Randy Dunlap389834b2007-06-08 13:47:03 -07002457 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002458
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002459 my $hereline = "$here\n$rawline\n";
2460 my $herecurr = "$here\n$rawline\n";
2461 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002462
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002463 $cnt_lines++ if ($realcnt != 0);
2464
Joe Perchese518e9a2015-06-25 15:03:27 -07002465# Check if the commit log has what seems like a diff which can confuse patch
2466 if ($in_commit_log && !$commit_log_has_diff &&
2467 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2468 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2469 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2470 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2471 ERROR("DIFF_IN_COMMIT_MSG",
2472 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2473 $commit_log_has_diff = 1;
2474 }
2475
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002476# Check for incorrect file permissions
2477 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2478 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002479 if ($realfile !~ m@scripts/@ &&
2480 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002481 ERROR("EXECUTE_PERMISSIONS",
2482 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002483 }
2484 }
2485
Joe Perches20112472011-07-25 17:13:23 -07002486# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002487 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002488 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002489 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002490 }
2491
Joe Perchese0d975b2014-12-10 15:51:49 -08002492# Check if MAINTAINERS is being updated. If so, there's probably no need to
2493# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2494 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2495 $reported_maintainer_file = 1;
2496 }
2497
Joe Perches20112472011-07-25 17:13:23 -07002498# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002499 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002500 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002501 my $space_before = $1;
2502 my $sign_off = $2;
2503 my $space_after = $3;
2504 my $email = $4;
2505 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2506
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002507 if ($sign_off !~ /$signature_tags/) {
2508 WARN("BAD_SIGN_OFF",
2509 "Non-standard signature: $sign_off\n" . $herecurr);
2510 }
Joe Perches20112472011-07-25 17:13:23 -07002511 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002512 if (WARN("BAD_SIGN_OFF",
2513 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2514 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002515 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002516 "$ucfirst_sign_off $email";
2517 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002518 }
Joe Perches20112472011-07-25 17:13:23 -07002519 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002520 if (WARN("BAD_SIGN_OFF",
2521 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2522 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002523 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002524 "$ucfirst_sign_off $email";
2525 }
2526
Joe Perches20112472011-07-25 17:13:23 -07002527 }
2528 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002529 if (WARN("BAD_SIGN_OFF",
2530 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2531 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002532 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002533 "$ucfirst_sign_off $email";
2534 }
Joe Perches20112472011-07-25 17:13:23 -07002535 }
2536
2537 my ($email_name, $email_address, $comment) = parse_email($email);
2538 my $suggested_email = format_email(($email_name, $email_address));
2539 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002540 ERROR("BAD_SIGN_OFF",
2541 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002542 } else {
2543 my $dequoted = $suggested_email;
2544 $dequoted =~ s/^"//;
2545 $dequoted =~ s/" </ </;
2546 # Don't force email to have quotes
2547 # Allow just an angle bracketed address
2548 if ("$dequoted$comment" ne $email &&
2549 "<$email_address>$comment" ne $email &&
2550 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002551 WARN("BAD_SIGN_OFF",
2552 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002553 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002554 }
Joe Perches7e51f192013-09-11 14:23:57 -07002555
2556# Check for duplicate signatures
2557 my $sig_nospace = $line;
2558 $sig_nospace =~ s/\s//g;
2559 $sig_nospace = lc($sig_nospace);
2560 if (defined $signatures{$sig_nospace}) {
2561 WARN("BAD_SIGN_OFF",
2562 "Duplicate signature\n" . $herecurr);
2563 } else {
2564 $signatures{$sig_nospace} = 1;
2565 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002566 }
2567
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002568# Check email subject for common tools that don't need to be mentioned
2569 if ($in_header_lines &&
2570 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2571 WARN("EMAIL_SUBJECT",
2572 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2573 }
2574
Joe Perches9b3189e2014-06-04 16:12:10 -07002575# Check for old stable address
2576 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2577 ERROR("STABLE_ADDRESS",
2578 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2579 }
2580
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002581# Check for unwanted Gerrit info
2582 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2583 ERROR("GERRIT_CHANGE_ID",
2584 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2585 }
2586
Joe Perches369c8dd2015-11-06 16:31:34 -08002587# Check if the commit log is in a possible stack dump
2588 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2589 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2590 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2591 # timestamp
2592 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2593 # stack dump address
2594 $commit_log_possible_stack_dump = 1;
2595 }
2596
Joe Perches2a076f42015-04-16 12:44:28 -07002597# Check for line lengths > 75 in commit log, warn once
2598 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002599 length($line) > 75 &&
2600 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2601 # file delta changes
2602 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2603 # filename then :
2604 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2605 # A Fixes: or Link: line
2606 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002607 WARN("COMMIT_LOG_LONG_LINE",
2608 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2609 $commit_log_long_line = 1;
2610 }
2611
Joe Perchesbf4daf12015-09-09 15:37:50 -07002612# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002613 if ($in_commit_log && $commit_log_possible_stack_dump &&
2614 $line =~ /^\s*$/) {
2615 $commit_log_possible_stack_dump = 0;
2616 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002617
Joe Perches0d7835f2015-02-13 14:38:35 -08002618# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002619 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002620 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002621 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002622 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002623 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002624 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2625 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002626 my $init_char = "c";
2627 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002628 my $short = 1;
2629 my $long = 0;
2630 my $case = 1;
2631 my $space = 1;
2632 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002633 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002634 my $id = '0123456789ab';
2635 my $orig_desc = "commit description";
2636 my $description = "";
2637
Joe Perchesfe043ea2015-09-09 15:37:25 -07002638 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2639 $init_char = $1;
2640 $orig_commit = lc($2);
2641 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2642 $orig_commit = lc($1);
2643 }
2644
Joe Perches0d7835f2015-02-13 14:38:35 -08002645 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2646 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2647 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2648 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2649 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2650 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002651 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002652 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2653 defined $rawlines[$linenr] &&
2654 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2655 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002656 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002657 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2658 defined $rawlines[$linenr] &&
2659 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2660 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2661 $orig_desc = $1;
2662 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2663 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002664 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002665 }
2666
2667 ($id, $description) = git_commit_info($orig_commit,
2668 $id, $orig_desc);
2669
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002670 if (defined($id) &&
2671 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002672 ERROR("GIT_COMMIT_ID",
2673 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2674 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002675 }
2676
Joe Perches13f19372014-08-06 16:10:59 -07002677# Check for added, moved or deleted files
2678 if (!$reported_maintainer_file && !$in_commit_log &&
2679 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2680 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2681 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2682 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002683 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002684 $reported_maintainer_file = 1;
2685 WARN("FILE_PATH_CHANGES",
2686 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2687 }
2688
Andy Whitcroft00df3442007-06-08 13:47:06 -07002689# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002690 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002691 ERROR("CORRUPTED_PATCH",
2692 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002693 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002694 }
2695
2696# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2697 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002698 $rawline !~ m/^$UTF8*$/) {
2699 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2700
2701 my $blank = copy_spacing($rawline);
2702 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2703 my $hereptr = "$hereline$ptr\n";
2704
Joe Perches34d99212011-07-25 17:13:26 -07002705 CHK("INVALID_UTF8",
2706 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002707 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002708
Joe Perches15662b32011-10-31 17:13:12 -07002709# Check if it's the start of a commit log
2710# (not a header line and we haven't seen the patch filename)
2711 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002712 !($rawline =~ /^\s+(?:\S|$)/ ||
2713 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002714 $in_header_lines = 0;
2715 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002716 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002717 }
2718
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002719# Check if there is UTF-8 in a commit log when a mail header has explicitly
2720# declined it, i.e defined some charset where it is missing.
2721 if ($in_header_lines &&
2722 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2723 $1 !~ /utf-8/i) {
2724 $non_utf8_charset = 1;
2725 }
2726
2727 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002728 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002729 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002730 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2731 }
2732
Joe Perchesd6430f72016-12-12 16:46:28 -08002733# Check for absolute kernel paths in commit message
2734 if ($tree && $in_commit_log) {
2735 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2736 my $file = $1;
2737
2738 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2739 check_absolute_file($1, $herecurr)) {
2740 #
2741 } else {
2742 check_absolute_file($file, $herecurr);
2743 }
2744 }
2745 }
2746
Kees Cook66b47b42014-10-13 15:51:57 -07002747# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002748 if (defined($misspellings) &&
2749 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002750 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002751 my $typo = $1;
2752 my $typo_fix = $spelling_fix{lc($typo)};
2753 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2754 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002755 my $msg_level = \&WARN;
2756 $msg_level = \&CHK if ($file);
2757 if (&{$msg_level}("TYPO_SPELLING",
2758 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002759 $fix) {
2760 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2761 }
2762 }
2763 }
2764
Andy Whitcroft306708542008-10-15 22:02:28 -07002765# ignore non-hunk lines and lines being removed
2766 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002767
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002768#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002769 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002770 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002771 if (ERROR("DOS_LINE_ENDINGS",
2772 "DOS line endings\n" . $herevet) &&
2773 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002774 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002775 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002776 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2777 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002778 if (ERROR("TRAILING_WHITESPACE",
2779 "trailing whitespace\n" . $herevet) &&
2780 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002781 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002782 }
2783
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002784 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002785 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002786
Josh Triplett4783f892013-11-12 15:10:12 -08002787# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002788 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002789 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002790 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2791 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002792 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002793 my $msg_level = \&ERROR;
2794 $msg_level = \&CHK if ($file);
2795 &{$msg_level}("FSF_MAILING_ADDRESS",
2796 "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 -08002797 }
2798
Andi Kleen33549572010-05-24 14:33:29 -07002799# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002800# Only applies when adding the entry originally, after that we do not have
2801# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002802 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002803 # 'choice' is usually the last thing on the line (though
2804 # Kconfig supports named choices), so use a word boundary
2805 # (\b) rather than a whitespace character (\s)
2806 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002807 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002808 my $cnt = $realcnt;
2809 my $ln = $linenr + 1;
2810 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002811 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002812 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002813 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002814 $f = $lines[$ln - 1];
2815 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2816 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002817
2818 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002819 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002820
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002821 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002822 $is_start = 1;
Ulf Magnusson84af7a62018-02-16 21:22:55 +01002823 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:help|---help---)\s*$/) {
2824 if ($lines[$ln - 1] =~ "---help---") {
2825 WARN("CONFIG_DESCRIPTION",
2826 "prefer 'help' over '---help---' for new help texts\n" . $herecurr);
2827 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002828 $length = -1;
2829 }
2830
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002831 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002832 $f =~ s/#.*//;
2833 $f =~ s/^\s+//;
2834 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002835
2836 # This only checks context lines in the patch
2837 # and so hopefully shouldn't trigger false
2838 # positives, even though some of these are
2839 # common words in help texts
2840 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2841 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002842 $is_end = 1;
2843 last;
2844 }
Andi Kleen33549572010-05-24 14:33:29 -07002845 $length++;
2846 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002847 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2848 WARN("CONFIG_DESCRIPTION",
2849 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2850 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002851 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002852 }
2853
Joe Perches628f91a2017-07-10 15:52:07 -07002854# check for MAINTAINERS entries that don't have the right form
2855 if ($realfile =~ /^MAINTAINERS$/ &&
2856 $rawline =~ /^\+[A-Z]:/ &&
2857 $rawline !~ /^\+[A-Z]:\t\S/) {
2858 if (WARN("MAINTAINERS_STYLE",
2859 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2860 $fix) {
2861 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2862 }
2863 }
2864
Christoph Jaeger327953e2015-02-13 14:38:29 -08002865# discourage the use of boolean for type definition attributes of Kconfig options
2866 if ($realfile =~ /Kconfig/ &&
2867 $line =~ /^\+\s*\bboolean\b/) {
2868 WARN("CONFIG_TYPE_BOOLEAN",
2869 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2870 }
2871
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002872 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2873 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2874 my $flag = $1;
2875 my $replacement = {
2876 'EXTRA_AFLAGS' => 'asflags-y',
2877 'EXTRA_CFLAGS' => 'ccflags-y',
2878 'EXTRA_CPPFLAGS' => 'cppflags-y',
2879 'EXTRA_LDFLAGS' => 'ldflags-y',
2880 };
2881
2882 WARN("DEPRECATED_VARIABLE",
2883 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2884 }
2885
Rob Herringbff5da42014-01-23 15:54:51 -08002886# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002887 if (defined $root &&
2888 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2889 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2890
Rob Herringbff5da42014-01-23 15:54:51 -08002891 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2892
Florian Vaussardcc933192014-04-03 14:49:27 -07002893 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2894 my $vp_file = $dt_path . "vendor-prefixes.txt";
2895
Rob Herringbff5da42014-01-23 15:54:51 -08002896 foreach my $compat (@compats) {
2897 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002898 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2899 my $compat3 = $compat;
2900 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2901 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002902 if ( $? >> 8 ) {
2903 WARN("UNDOCUMENTED_DT_STRING",
2904 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2905 }
2906
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002907 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2908 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002909 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002910 if ( $? >> 8 ) {
2911 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002912 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002913 }
2914 }
2915 }
2916
Rob Herring9f3a8992018-04-10 16:33:13 -07002917# check for using SPDX license tag at beginning of files
2918 if ($realline == $checklicenseline) {
2919 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) {
2920 $checklicenseline = 2;
2921 } elsif ($rawline =~ /^\+/) {
2922 my $comment = "";
2923 if ($realfile =~ /\.(h|s|S)$/) {
2924 $comment = '/*';
2925 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) {
2926 $comment = '//';
2927 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc)$/) {
2928 $comment = '#';
2929 } elsif ($realfile =~ /\.rst$/) {
2930 $comment = '..';
2931 }
2932
2933 if ($comment !~ /^$/ &&
2934 $rawline !~ /^\+\Q$comment\E SPDX-License-Identifier: /) {
2935 WARN("SPDX_LICENSE_TAG",
2936 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr);
2937 }
2938 }
2939 }
2940
Andy Whitcroft5368df202008-10-15 22:02:27 -07002941# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002942 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002943
Joe Perches47e0c882015-06-25 15:02:57 -07002944# line length limit (with some exclusions)
2945#
2946# There are a few types of lines that may extend beyond $max_line_length:
2947# logging functions like pr_info that end in a string
2948# lines with a single string
2949# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002950# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07002951#
2952# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002953# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002954# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2955# LONG_LINE all other lines longer than $max_line_length
2956#
2957# if LONG_LINE is ignored, the other 2 types are also ignored
2958#
2959
Joe Perchesb4749e92015-07-17 16:24:01 -07002960 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002961 my $msg_type = "LONG_LINE";
2962
2963 # Check the allowed long line types first
2964
2965 # logging functions that end in a string that starts
2966 # before $max_line_length
2967 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2968 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2969 $msg_type = "";
2970
2971 # lines with only strings (w/ possible termination)
2972 # #defines with only strings
2973 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2974 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2975 $msg_type = "";
2976
Joe Perchescc147502017-11-17 15:28:44 -08002977 # More special cases
2978 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
2979 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07002980 $msg_type = "";
2981
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002982 # URL ($rawline is used in case the URL is in a comment)
2983 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
2984 $msg_type = "";
2985
Joe Perches47e0c882015-06-25 15:02:57 -07002986 # Otherwise set the alternate message types
2987
2988 # a comment starts before $max_line_length
2989 } elsif ($line =~ /($;[\s$;]*)$/ &&
2990 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2991 $msg_type = "LONG_LINE_COMMENT"
2992
2993 # a quoted string starts before $max_line_length
2994 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2995 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2996 $msg_type = "LONG_LINE_STRING"
2997 }
2998
2999 if ($msg_type ne "" &&
3000 (show_type("LONG_LINE") || show_type($msg_type))) {
3001 WARN($msg_type,
3002 "line over $max_line_length characters\n" . $herecurr);
3003 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003004 }
3005
Andy Whitcroft8905a672007-11-28 16:21:06 -08003006# check for adding lines without a newline.
3007 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003008 WARN("MISSING_EOF_NEWLINE",
3009 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003010 }
3011
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003012# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07003013 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003014
3015# at the beginning of a line any tabs must come first and anything
3016# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003017 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3018 $rawline =~ /^\+\s* \s*/) {
3019 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003020 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003021 if (ERROR("CODE_INDENT",
3022 "code indent should use tabs where possible\n" . $herevet) &&
3023 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003024 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003025 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003026 }
3027
Alberto Panizzo08e44362010-03-05 13:43:54 -08003028# check for space before tabs.
3029 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3030 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003031 if (WARN("SPACE_BEFORE_TAB",
3032 "please, no space before tabs\n" . $herevet) &&
3033 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003034 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003035 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003036 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003037 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003038 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003039 }
3040
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003041# check for && or || at the start of a line
3042 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3043 CHK("LOGICAL_CONTINUATIONS",
3044 "Logical continuations should be on the previous line\n" . $hereprev);
3045 }
3046
Joe Perchesa91e8992016-05-20 17:04:05 -07003047# check indentation starts on a tab stop
3048 if ($^V && $^V ge 5.10.0 &&
Joe Perchesbd491112018-02-06 15:39:06 -08003049 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003050 my $indent = length($1);
3051 if ($indent % 8) {
3052 if (WARN("TABSTOP",
3053 "Statements should start on a tabstop\n" . $herecurr) &&
3054 $fix) {
3055 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3056 }
3057 }
3058 }
3059
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003060# check multi-line statement indentation matches previous line
3061 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003062 $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 -07003063 $prevline =~ /^\+(\t*)(.*)$/;
3064 my $oldindent = $1;
3065 my $rest = $2;
3066
3067 my $pos = pos_last_openparen($rest);
3068 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003069 $line =~ /^(\+| )([ \t]*)/;
3070 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003071
3072 my $goodtabindent = $oldindent .
3073 "\t" x ($pos / 8) .
3074 " " x ($pos % 8);
3075 my $goodspaceindent = $oldindent . " " x $pos;
3076
3077 if ($newindent ne $goodtabindent &&
3078 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003079
3080 if (CHK("PARENTHESIS_ALIGNMENT",
3081 "Alignment should match open parenthesis\n" . $hereprev) &&
3082 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003083 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003084 s/^\+[ \t]*/\+$goodtabindent/;
3085 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003086 }
3087 }
3088 }
3089
Joe Perches6ab3a972015-04-16 12:44:05 -07003090# check for space after cast like "(int) foo" or "(struct foo) bar"
3091# avoid checking a few false positives:
3092# "sizeof(<type>)" or "__alignof__(<type>)"
3093# function pointer declarations like "(*foo)(int) = bar;"
3094# structure definitions like "(struct foo) { 0 };"
3095# multiline macros that define functions
3096# known attributes or the __attribute__ keyword
3097 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3098 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003099 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003100 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003101 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003102 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003103 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003104 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003105 }
3106
Joe Perches86406b12015-09-09 15:37:41 -07003107# Block comment styles
3108# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003109 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003110 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003111 $rawline =~ /^\+[ \t]*\*/ &&
3112 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003113 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3114 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3115 }
3116
Joe Perches86406b12015-09-09 15:37:41 -07003117# Block comments use * on subsequent lines
3118 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3119 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003120 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003121 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003122 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003123 WARN("BLOCK_COMMENT_STYLE",
3124 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003125 }
3126
Joe Perches86406b12015-09-09 15:37:41 -07003127# Block comments use */ on trailing lines
3128 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003129 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3130 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3131 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003132 WARN("BLOCK_COMMENT_STYLE",
3133 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003134 }
3135
Joe Perches08eb9b82016-10-11 13:51:50 -07003136# Block comment * alignment
3137 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003138 $line =~ /^\+[ \t]*$;/ && #leading comment
3139 $rawline =~ /^\+[ \t]*\*/ && #leading *
3140 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003141 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003142 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3143 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003144 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003145 if (defined($1)) {
3146 $oldindent = expand_tabs($1);
3147 } else {
3148 $prevrawline =~ m@^\+(.*/?)\*@;
3149 $oldindent = expand_tabs($1);
3150 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003151 $rawline =~ m@^\+([ \t]*)\*@;
3152 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003153 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003154 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003155 WARN("BLOCK_COMMENT_STYLE",
3156 "Block comments should align the * on each line\n" . $hereprev);
3157 }
3158 }
3159
Joe Perches7f619192014-08-06 16:10:39 -07003160# check for missing blank lines after struct/union declarations
3161# with exceptions for various attributes and macros
3162 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3163 $line =~ /^\+/ &&
3164 !($line =~ /^\+\s*$/ ||
3165 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3166 $line =~ /^\+\s*MODULE_/i ||
3167 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3168 $line =~ /^\+[a-z_]*init/ ||
3169 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3170 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003171 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003172 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003173 if (CHK("LINE_SPACING",
3174 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3175 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003176 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003177 }
Joe Perches7f619192014-08-06 16:10:39 -07003178 }
3179
Joe Perches365dd4e2014-08-06 16:10:42 -07003180# check for multiple consecutive blank lines
3181 if ($prevline =~ /^[\+ ]\s*$/ &&
3182 $line =~ /^\+\s*$/ &&
3183 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003184 if (CHK("LINE_SPACING",
3185 "Please don't use multiple blank lines\n" . $hereprev) &&
3186 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003187 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003188 }
3189
Joe Perches365dd4e2014-08-06 16:10:42 -07003190 $last_blank_line = $linenr;
3191 }
3192
Joe Perches3b617e32014-04-03 14:49:28 -07003193# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003194 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3195 # actual declarations
3196 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003197 # function pointer declarations
3198 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003199 # foo bar; where foo is some local typedef or #define
3200 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3201 # known declaration macros
3202 $prevline =~ /^\+\s+$declaration_macros/) &&
3203 # for "else if" which can look like "$Ident $Ident"
3204 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3205 # other possible extensions of declaration lines
3206 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3207 # not starting a section or a macro "\" extended line
3208 $prevline =~ /(?:\{\s*|\\)$/) &&
3209 # looks like a declaration
3210 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003211 # function pointer declarations
3212 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003213 # foo bar; where foo is some local typedef or #define
3214 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3215 # known declaration macros
3216 $sline =~ /^\+\s+$declaration_macros/ ||
3217 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003218 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003219 # start or end of block or continuation of declaration
3220 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3221 # bitfield continuation
3222 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3223 # other possible extensions of declaration lines
3224 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3225 # indentation of previous and current line are the same
3226 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003227 if (WARN("LINE_SPACING",
3228 "Missing a blank line after declarations\n" . $hereprev) &&
3229 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003230 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003231 }
Joe Perches3b617e32014-04-03 14:49:28 -07003232 }
3233
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003234# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003235# Exceptions:
3236# 1) within comments
3237# 2) indented preprocessor commands
3238# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003239 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003240 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003241 if (WARN("LEADING_SPACE",
3242 "please, no spaces at the start of a line\n" . $herevet) &&
3243 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003244 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003245 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003246 }
3247
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003248# check we are in a valid C source file if not then ignore this hunk
3249 next if ($realfile !~ /\.(h|c)$/);
3250
Joe Perches5751a242017-11-17 15:28:52 -08003251# check for unusual line ending [ or (
3252 if ($line =~ /^\+.*([\[\(])\s*$/) {
3253 CHK("OPEN_ENDED_LINE",
3254 "Lines should not end with a '$1'\n" . $herecurr);
3255 }
3256
Joe Perches4dbed762017-05-08 15:55:39 -07003257# check if this appears to be the start function declaration, save the name
3258 if ($sline =~ /^\+\{\s*$/ &&
3259 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3260 $context_function = $1;
3261 }
3262
3263# check if this appears to be the end of function declaration
3264 if ($sline =~ /^\+\}\s*$/) {
3265 undef $context_function;
3266 }
3267
Joe Perches032a4c02014-08-06 16:10:29 -07003268# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003269# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003270# if the previous line is a break or return and is indented 1 tab more...
3271 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3272 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003273 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3274 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3275 defined $lines[$linenr] &&
3276 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003277 WARN("UNNECESSARY_ELSE",
3278 "else is not generally useful after a break or return\n" . $hereprev);
3279 }
3280 }
3281
Joe Perchesc00df192014-08-06 16:11:01 -07003282# check indentation of a line with a break;
3283# if the previous line is a goto or return and is indented the same # of tabs
3284 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3285 my $tabs = $1;
3286 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3287 WARN("UNNECESSARY_BREAK",
3288 "break is not useful after a goto or return\n" . $hereprev);
3289 }
3290 }
3291
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003292# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003293 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003294 WARN("CVS_KEYWORD",
3295 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003296 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003297
Joe Perches56e77d72013-02-21 16:44:14 -08003298# check for old HOTPLUG __dev<foo> section markings
3299 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3300 WARN("HOTPLUG_SECTION",
3301 "Using $1 is unnecessary\n" . $herecurr);
3302 }
3303
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003304# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003305 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3306 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003307#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003308 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003309 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003310 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003311 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003312 $stat =~ s/\n./\n /g;
3313 $cond =~ s/\n./\n /g;
3314
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003315#print "linenr<$linenr> <$stat>\n";
3316 # If this statement has no statement boundaries within
3317 # it there is no point in retrying a statement scan
3318 # until we hit end of it.
3319 my $frag = $stat; $frag =~ s/;+\s*$//;
3320 if ($frag !~ /(?:{|;)/) {
3321#print "skip<$line_nr_next>\n";
3322 $suppress_statement = $line_nr_next;
3323 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003324
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003325 # Find the real next line.
3326 $realline_next = $line_nr_next;
3327 if (defined $realline_next &&
3328 (!defined $lines[$realline_next - 1] ||
3329 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3330 $realline_next++;
3331 }
3332
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003333 my $s = $stat;
3334 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003335
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003336 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003337 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003338
3339 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003340 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003341
Andy Whitcroft463f2862009-09-21 17:04:34 -07003342 } elsif ($s =~ /^.\s*else\b/s) {
3343
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003344 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003345 } 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 -07003346 my $type = $1;
3347 $type =~ s/\s+/ /g;
3348 possible($type, "A:" . $s);
3349
Andy Whitcroft8905a672007-11-28 16:21:06 -08003350 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003351 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003352 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003353 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003354
3355 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003356 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003357 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003358 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003359
3360 # Check for any sort of function declaration.
3361 # int foo(something bar, other baz);
3362 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003363 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 -08003364 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003365
Andy Whitcroftcf655042008-03-04 14:28:20 -08003366 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003367 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003368 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003369
Andy Whitcroft8905a672007-11-28 16:21:06 -08003370 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003371 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003372
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003373 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003374 }
3375 }
3376 }
3377
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003378 }
3379
Andy Whitcroft653d4872007-06-23 17:16:34 -07003380#
3381# Checks which may be anchored in the context.
3382#
3383
3384# Check for switch () and associated case and default
3385# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003386 if ($line=~/\bswitch\s*\(.*\)/) {
3387 my $err = '';
3388 my $sep = '';
3389 my @ctx = ctx_block_outer($linenr, $realcnt);
3390 shift(@ctx);
3391 for my $ctx (@ctx) {
3392 my ($clen, $cindent) = line_stats($ctx);
3393 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3394 $indent != $cindent) {
3395 $err .= "$sep$ctx\n";
3396 $sep = '';
3397 } else {
3398 $sep = "[...]\n";
3399 }
3400 }
3401 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003402 ERROR("SWITCH_CASE_INDENT_LEVEL",
3403 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003404 }
3405 }
3406
3407# if/while/etc brace do not go on next line, unless defining a do while loop,
3408# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003409 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 -07003410 my $pre_ctx = "$1$2";
3411
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003412 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003413
3414 if ($line =~ /^\+\t{6,}/) {
3415 WARN("DEEP_INDENTATION",
3416 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3417 }
3418
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003419 my $ctx_cnt = $realcnt - $#ctx - 1;
3420 my $ctx = join("\n", @ctx);
3421
Andy Whitcroft548596d2008-07-23 21:29:01 -07003422 my $ctx_ln = $linenr;
3423 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003424
Andy Whitcroft548596d2008-07-23 21:29:01 -07003425 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3426 defined $lines[$ctx_ln - 1] &&
3427 $lines[$ctx_ln - 1] =~ /^-/)) {
3428 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3429 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003430 $ctx_ln++;
3431 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003432
Andy Whitcroft53210162008-07-23 21:29:03 -07003433 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3434 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003435
Joe Perchesd752fcc2014-08-06 16:11:05 -07003436 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003437 ERROR("OPEN_BRACE",
3438 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003439 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003440 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003441 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3442 $ctx =~ /\)\s*\;\s*$/ &&
3443 defined $lines[$ctx_ln - 1])
3444 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003445 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3446 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003447 WARN("TRAILING_SEMICOLON",
3448 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003449 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003450 }
3451 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003452 }
3453
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003454# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003455 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 -08003456 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3457 ctx_statement_block($linenr, $realcnt, 0)
3458 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003459 my ($s, $c) = ($stat, $cond);
3460
3461 substr($s, 0, length($c), '');
3462
Joe Perches9f5af482015-09-09 15:37:30 -07003463 # remove inline comments
3464 $s =~ s/$;/ /g;
3465 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003466
3467 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003468 my @newlines = ($c =~ /\n/gs);
3469 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003470
Joe Perches9f5af482015-09-09 15:37:30 -07003471 # Make sure we remove the line prefixes as we have
3472 # none on the first line, and are going to readd them
3473 # where necessary.
3474 $s =~ s/\n./\n/gs;
3475 while ($s =~ /\n\s+\\\n/) {
3476 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3477 }
3478
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003479 # We want to check the first line inside the block
3480 # starting at the end of the conditional, so remove:
3481 # 1) any blank line termination
3482 # 2) any opening brace { on end of the line
3483 # 3) any do (...) {
3484 my $continuation = 0;
3485 my $check = 0;
3486 $s =~ s/^.*\bdo\b//;
3487 $s =~ s/^\s*{//;
3488 if ($s =~ s/^\s*\\//) {
3489 $continuation = 1;
3490 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003491 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003492 $check = 1;
3493 $cond_lines++;
3494 }
3495
3496 # Also ignore a loop construct at the end of a
3497 # preprocessor statement.
3498 if (($prevline =~ /^.\s*#\s*define\s/ ||
3499 $prevline =~ /\\\s*$/) && $continuation == 0) {
3500 $check = 0;
3501 }
3502
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003503 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003504 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003505 while ($cond_ptr != $cond_lines) {
3506 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003507
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003508 # If we see an #else/#elif then the code
3509 # is not linear.
3510 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3511 $check = 0;
3512 }
3513
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003514 # Ignore:
3515 # 1) blank lines, they should be at 0,
3516 # 2) preprocessor lines, and
3517 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003518 if ($continuation ||
3519 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003520 $s =~ /^\s*#\s*?/ ||
3521 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003522 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003523 if ($s =~ s/^.*?\n//) {
3524 $cond_lines++;
3525 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003526 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003527 }
3528
3529 my (undef, $sindent) = line_stats("+" . $s);
3530 my $stat_real = raw_line($linenr, $cond_lines);
3531
3532 # Check if either of these lines are modified, else
3533 # this is not this patch's fault.
3534 if (!defined($stat_real) ||
3535 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3536 $check = 0;
3537 }
3538 if (defined($stat_real) && $cond_lines > 1) {
3539 $stat_real = "[...]\n$stat_real";
3540 }
3541
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003542 #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 -07003543
Joe Perches9f5af482015-09-09 15:37:30 -07003544 if ($check && $s ne '' &&
3545 (($sindent % 8) != 0 ||
3546 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003547 ($sindent == $indent &&
3548 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003549 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003550 WARN("SUSPECT_CODE_INDENT",
3551 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003552 }
3553 }
3554
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003555 # Track the 'values' across context and added lines.
3556 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003557 my ($curr_values, $curr_vars) =
3558 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003559 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003560 if ($dbg_values) {
3561 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003562 print "$linenr > .$outline\n";
3563 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003564 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003565 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003566 $prev_values = substr($curr_values, -1);
3567
Andy Whitcroft00df3442007-06-08 13:47:06 -07003568#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003569 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003570
Joe Perches11ca40a2016-12-12 16:46:31 -08003571# check for dereferences that span multiple lines
3572 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3573 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3574 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3575 my $ref = $1;
3576 $line =~ /^.\s*($Lval)/;
3577 $ref .= $1;
3578 $ref =~ s/\s//g;
3579 WARN("MULTILINE_DEREFERENCE",
3580 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3581 }
3582
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003583# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003584 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 -07003585 my $type = $1;
3586 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003587 $var = "" if (!defined $var);
3588 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003589 my $sign = $1;
3590 my $pointer = $2;
3591
3592 $pointer = "" if (!defined $pointer);
3593
3594 if (WARN("UNSPECIFIED_INT",
3595 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3596 $fix) {
3597 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003598 my $comp_pointer = $pointer;
3599 $comp_pointer =~ s/\s//g;
3600 $decl .= $comp_pointer;
3601 $decl = rtrim($decl) if ($var eq "");
3602 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003603 }
3604 }
3605 }
3606
Andy Whitcroft653d4872007-06-23 17:16:34 -07003607# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003608 if ($dbg_type) {
3609 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003610 ERROR("TEST_TYPE",
3611 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003612 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003613 ERROR("TEST_NOT_TYPE",
3614 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003615 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003616 next;
3617 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003618# TEST: allow direct testing of the attribute matcher.
3619 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003620 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003621 ERROR("TEST_ATTR",
3622 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003623 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003624 ERROR("TEST_NOT_ATTR",
3625 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003626 }
3627 next;
3628 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003629
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003630# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003631 if ($line =~ /^.\s*{/ &&
3632 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003633 if (ERROR("OPEN_BRACE",
3634 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003635 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3636 fix_delete_line($fixlinenr - 1, $prevrawline);
3637 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003638 my $fixedline = $prevrawline;
3639 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003640 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003641 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003642 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003643 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003644 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003645 }
3646
Andy Whitcroft653d4872007-06-23 17:16:34 -07003647#
3648# Checks which are anchored on the added line.
3649#
3650
3651# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003652 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003653 my $path = $1;
3654 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003655 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003656 "malformed #include filename\n" . $herecurr);
3657 }
3658 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3659 ERROR("UAPI_INCLUDE",
3660 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003661 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003662 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003663
3664# no C99 // comments
3665 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003666 if (ERROR("C99_COMMENTS",
3667 "do not use C99 // comments\n" . $herecurr) &&
3668 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003669 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003670 if ($line =~ /\/\/(.*)$/) {
3671 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003672 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003673 }
3674 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003675 }
3676 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003677 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003678 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003679
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003680# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3681# the whole statement.
3682#print "APW <$lines[$realline_next - 1]>\n";
3683 if (defined $realline_next &&
3684 exists $lines[$realline_next - 1] &&
3685 !defined $suppress_export{$realline_next} &&
3686 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3687 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003688 # Handle definitions which produce identifiers with
3689 # a prefix:
3690 # XXX(foo);
3691 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003692 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003693 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003694 $name =~ /^${Ident}_$2/) {
3695#print "FOO C name<$name>\n";
3696 $suppress_export{$realline_next} = 1;
3697
3698 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003699 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003700 ^.DEFINE_$Ident\(\Q$name\E\)|
3701 ^.DECLARE_$Ident\(\Q$name\E\)|
3702 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003703 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3704 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003705 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003706#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3707 $suppress_export{$realline_next} = 2;
3708 } else {
3709 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003710 }
3711 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003712 if (!defined $suppress_export{$linenr} &&
3713 $prevline =~ /^.\s*$/ &&
3714 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3715 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3716#print "FOO B <$lines[$linenr - 1]>\n";
3717 $suppress_export{$linenr} = 2;
3718 }
3719 if (defined $suppress_export{$linenr} &&
3720 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003721 WARN("EXPORT_SYMBOL",
3722 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003723 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003724
Joe Eloff5150bda2010-08-09 17:21:00 -07003725# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003726 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003727 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003728 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003729 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003730 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003731 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003732 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003733# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003734 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003735 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003736 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003737 $herecurr) &&
3738 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003739 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003740 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003741 }
3742
Joe Perches18130872014-08-06 16:11:22 -07003743# check for misordered declarations of char/short/int/long with signed/unsigned
3744 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3745 my $tmp = trim($1);
3746 WARN("MISORDERED_TYPE",
3747 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3748 }
3749
Joe Perchescb710ec2010-10-26 14:23:20 -07003750# check for static const char * arrays.
3751 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003752 WARN("STATIC_CONST_CHAR_ARRAY",
3753 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003754 $herecurr);
3755 }
3756
3757# check for static char foo[] = "bar" declarations.
3758 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003759 WARN("STATIC_CONST_CHAR_ARRAY",
3760 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003761 $herecurr);
3762 }
3763
Joe Perchesab7e23f2015-04-16 12:44:22 -07003764# check for const <foo> const where <foo> is not a pointer or array type
3765 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3766 my $found = $1;
3767 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3768 WARN("CONST_CONST",
3769 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3770 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3771 WARN("CONST_CONST",
3772 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3773 }
3774 }
3775
Joe Perches9b0fa602014-04-03 14:49:18 -07003776# check for non-global char *foo[] = {"bar", ...} declarations.
3777 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3778 WARN("STATIC_CONST_CHAR_ARRAY",
3779 "char * array declaration might be better as static const\n" .
3780 $herecurr);
3781 }
3782
Joe Perchesb598b672015-04-16 12:44:36 -07003783# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3784 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3785 my $array = $1;
3786 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3787 my $array_div = $1;
3788 if (WARN("ARRAY_SIZE",
3789 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3790 $fix) {
3791 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3792 }
3793 }
3794 }
3795
Joe Perchesb36190c2014-01-27 17:07:18 -08003796# check for function declarations without arguments like "int foo()"
3797 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3798 if (ERROR("FUNCTION_WITHOUT_ARGS",
3799 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3800 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003801 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003802 }
3803 }
3804
Andy Whitcroft653d4872007-06-23 17:16:34 -07003805# check for new typedefs, only function parameters and sparse annotations
3806# make sense.
3807 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003808 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003809 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003810 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003811 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003812 WARN("NEW_TYPEDEFS",
3813 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003814 }
3815
3816# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003817 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003818 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3819 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003820 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003821
Andy Whitcroft65863862009-01-06 14:41:21 -08003822 # Should start with a space.
3823 $to =~ s/^(\S)/ $1/;
3824 # Should not end with a space.
3825 $to =~ s/\s+$//;
3826 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003827 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003828 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003829
Joe Perches3705ce52013-07-03 15:05:31 -07003830## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003831 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003832 if (ERROR("POINTER_LOCATION",
3833 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3834 $fix) {
3835 my $sub_from = $ident;
3836 my $sub_to = $ident;
3837 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003838 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003839 s@\Q$sub_from\E@$sub_to@;
3840 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003841 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003842 }
3843 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3844 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003845 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003846
Andy Whitcroft65863862009-01-06 14:41:21 -08003847 # Should start with a space.
3848 $to =~ s/^(\S)/ $1/;
3849 # Should not end with a space.
3850 $to =~ s/\s+$//;
3851 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003852 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003853 }
3854 # Modifiers should have spaces.
3855 $to =~ s/(\b$Modifier$)/$1 /;
3856
Joe Perches3705ce52013-07-03 15:05:31 -07003857## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003858 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003859 if (ERROR("POINTER_LOCATION",
3860 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3861 $fix) {
3862
3863 my $sub_from = $match;
3864 my $sub_to = $match;
3865 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003866 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003867 s@\Q$sub_from\E@$sub_to@;
3868 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003869 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003870 }
3871
Joe Perches9d3e3c72015-09-09 15:37:27 -07003872# avoid BUG() or BUG_ON()
3873 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003874 my $msg_level = \&WARN;
3875 $msg_level = \&CHK if ($file);
3876 &{$msg_level}("AVOID_BUG",
3877 "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 -07003878 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003879
Joe Perches9d3e3c72015-09-09 15:37:27 -07003880# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003881 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003882 WARN("LINUX_VERSION_CODE",
3883 "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 -08003884 }
3885
Joe Perches17441222011-06-15 15:08:17 -07003886# check for uses of printk_ratelimit
3887 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003888 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003889 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003890 }
3891
Joe Percheseeef5732017-11-17 15:28:41 -08003892# printk should use KERN_* levels
3893 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3894 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3895 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003896 }
3897
Joe Perches243f3802012-05-31 16:26:09 -07003898 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3899 my $orig = $1;
3900 my $level = lc($orig);
3901 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003902 my $level2 = $level;
3903 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003904 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003905 "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 -07003906 }
3907
3908 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003909 if (WARN("PREFER_PR_LEVEL",
3910 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3911 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003912 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003913 s/\bpr_warning\b/pr_warn/;
3914 }
Joe Perches243f3802012-05-31 16:26:09 -07003915 }
3916
Joe Perchesdc139312013-02-21 16:44:13 -08003917 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3918 my $orig = $1;
3919 my $level = lc($orig);
3920 $level = "warn" if ($level eq "warning");
3921 $level = "dbg" if ($level eq "debug");
3922 WARN("PREFER_DEV_LEVEL",
3923 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3924 }
3925
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003926# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3927# number of false positives, but assembly files are not checked, so at
3928# least the arch entry code will not trigger this warning.
3929 if ($line =~ /\bENOSYS\b/) {
3930 WARN("ENOSYS",
3931 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3932 }
3933
Andy Whitcroft653d4872007-06-23 17:16:34 -07003934# function brace can't be on same line, except for #defines of do while,
3935# or if closed on same line
Joe Perches2d453e32018-02-06 15:39:09 -08003936 if ($^V && $^V ge 5.10.0 &&
3937 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3938 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3939 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07003940 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08003941 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07003942 $fix) {
3943 fix_delete_line($fixlinenr, $rawline);
3944 my $fixed_line = $rawline;
3945 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3946 my $line1 = $1;
3947 my $line2 = $2;
3948 fix_insert_line($fixlinenr, ltrim($line1));
3949 fix_insert_line($fixlinenr, "\+{");
3950 if ($line2 !~ /^\s*$/) {
3951 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3952 }
3953 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003954 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003955
Andy Whitcroft8905a672007-11-28 16:21:06 -08003956# open braces for enum, union and struct go on the same line.
3957 if ($line =~ /^.\s*{/ &&
3958 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003959 if (ERROR("OPEN_BRACE",
3960 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3961 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3962 fix_delete_line($fixlinenr - 1, $prevrawline);
3963 fix_delete_line($fixlinenr, $rawline);
3964 my $fixedline = rtrim($prevrawline) . " {";
3965 fix_insert_line($fixlinenr, $fixedline);
3966 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003967 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003968 if ($fixedline !~ /^\+\s*$/) {
3969 fix_insert_line($fixlinenr, $fixedline);
3970 }
3971 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003972 }
3973
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003974# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003975 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3976 if (WARN("SPACING",
3977 "missing space after $1 definition\n" . $herecurr) &&
3978 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003979 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003980 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3981 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003982 }
3983
Joe Perches31070b52014-01-23 15:54:49 -08003984# Function pointer declarations
3985# check spacing between type, funcptr, and args
3986# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003987 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003988 my $declare = $1;
3989 my $pre_pointer_space = $2;
3990 my $post_pointer_space = $3;
3991 my $funcname = $4;
3992 my $post_funcname_space = $5;
3993 my $pre_args_space = $6;
3994
Joe Perches91f72e92014-04-03 14:49:12 -07003995# the $Declare variable will capture all spaces after the type
3996# so check it for a missing trailing missing space but pointer return types
3997# don't need a space so don't warn for those.
3998 my $post_declare_space = "";
3999 if ($declare =~ /(\s+)$/) {
4000 $post_declare_space = $1;
4001 $declare = rtrim($declare);
4002 }
4003 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08004004 WARN("SPACING",
4005 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004006 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004007 }
4008
4009# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004010# This test is not currently implemented because these declarations are
4011# equivalent to
4012# int foo(int bar, ...)
4013# and this is form shouldn't/doesn't generate a checkpatch warning.
4014#
4015# elsif ($declare =~ /\s{2,}$/) {
4016# WARN("SPACING",
4017# "Multiple spaces after return type\n" . $herecurr);
4018# }
Joe Perches31070b52014-01-23 15:54:49 -08004019
4020# unnecessary space "type ( *funcptr)(args...)"
4021 if (defined $pre_pointer_space &&
4022 $pre_pointer_space =~ /^\s/) {
4023 WARN("SPACING",
4024 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4025 }
4026
4027# unnecessary space "type (* funcptr)(args...)"
4028 if (defined $post_pointer_space &&
4029 $post_pointer_space =~ /^\s/) {
4030 WARN("SPACING",
4031 "Unnecessary space before function pointer name\n" . $herecurr);
4032 }
4033
4034# unnecessary space "type (*funcptr )(args...)"
4035 if (defined $post_funcname_space &&
4036 $post_funcname_space =~ /^\s/) {
4037 WARN("SPACING",
4038 "Unnecessary space after function pointer name\n" . $herecurr);
4039 }
4040
4041# unnecessary space "type (*funcptr) (args...)"
4042 if (defined $pre_args_space &&
4043 $pre_args_space =~ /^\s/) {
4044 WARN("SPACING",
4045 "Unnecessary space before function pointer arguments\n" . $herecurr);
4046 }
4047
4048 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004049 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004050 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004051 }
4052 }
4053
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004054# check for spacing round square brackets; allowed:
4055# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004056# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4057# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004058 while ($line =~ /(.*?\s)\[/g) {
4059 my ($where, $prefix) = ($-[1], $1);
4060 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004061 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004062 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004063 if (ERROR("BRACKET_SPACE",
4064 "space prohibited before open square bracket '['\n" . $herecurr) &&
4065 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004066 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004067 s/^(\+.*?)\s+\[/$1\[/;
4068 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004069 }
4070 }
4071
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004072# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004073 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004074 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004075 my $ctx_before = substr($line, 0, $-[1]);
4076 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004077
4078 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004079 if ($name =~ /^(?:
4080 if|for|while|switch|return|case|
4081 volatile|__volatile__|
4082 __attribute__|format|__extension__|
4083 asm|__asm__)$/x)
4084 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004085 # cpp #define statements have non-optional spaces, ie
4086 # if there is a space between the name and the open
4087 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004088 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004089
4090 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004091 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004092
4093 # If this whole things ends with a type its most
4094 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004095 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004096
4097 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004098 if (WARN("SPACING",
4099 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4100 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004101 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004102 s/\b$name\s+\(/$name\(/;
4103 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004104 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004105 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004106
Andy Whitcroft653d4872007-06-23 17:16:34 -07004107# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004108 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004109 my $fixed_line = "";
4110 my $line_fixed = 0;
4111
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004112 my $ops = qr{
4113 <<=|>>=|<=|>=|==|!=|
4114 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4115 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004116 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004117 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004118 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004119 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004120
4121## print("element count: <" . $#elements . ">\n");
4122## foreach my $el (@elements) {
4123## print("el: <$el>\n");
4124## }
4125
4126 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004127 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004128
Joe Perches3705ce52013-07-03 15:05:31 -07004129 foreach my $el (@elements) {
4130 push(@fix_elements, substr($rawline, $off, length($el)));
4131 $off += length($el);
4132 }
4133
4134 $off = 0;
4135
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004136 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004137 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004138
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004139 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004140
4141 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4142
4143## print("n: <$n> good: <$good>\n");
4144
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004145 $off += length($elements[$n]);
4146
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004147 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004148 my $ca = substr($opline, 0, $off);
4149 my $cc = '';
4150 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4151 $cc = substr($opline, $off + length($elements[$n + 1]));
4152 }
4153 my $cb = "$ca$;$cc";
4154
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004155 my $a = '';
4156 $a = 'V' if ($elements[$n] ne '');
4157 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004158 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004159 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4160 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004161 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004162
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004163 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004164
4165 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004166 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004167 $c = 'V' if ($elements[$n + 2] ne '');
4168 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004169 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004170 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4171 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004172 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004173 } else {
4174 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004175 }
4176
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004177 my $ctx = "${a}x${c}";
4178
4179 my $at = "(ctx:$ctx)";
4180
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004181 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004182 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004183
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004184 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004185 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004186
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004187 # Get the full operator variant.
4188 my $opv = $op . substr($curr_vars, $off, 1);
4189
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004190 # Ignore operators passed as parameters.
4191 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004192 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004193
Andy Whitcroftcf655042008-03-04 14:28:20 -08004194# # Ignore comments
4195# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004196
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004197 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004198 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004199 if ($ctx !~ /.x[WEBC]/ &&
4200 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004201 if (ERROR("SPACING",
4202 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004203 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004204 $line_fixed = 1;
4205 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004206 }
4207
4208 # // is a comment
4209 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004210
Joe Perchesb00e4812014-04-03 14:49:33 -07004211 # : when part of a bitfield
4212 } elsif ($opv eq ':B') {
4213 # skip the bitfield test for now
4214
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004215 # No spaces for:
4216 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004217 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004218 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004219 if (ERROR("SPACING",
4220 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004221 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004222 if (defined $fix_elements[$n + 2]) {
4223 $fix_elements[$n + 2] =~ s/^\s+//;
4224 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004225 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004226 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004227 }
4228
Joe Perches23810972014-12-10 15:51:32 -08004229 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004230 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004231 my $rtrim_before = 0;
4232 my $space_after = 0;
4233 if ($ctx =~ /Wx./) {
4234 if (ERROR("SPACING",
4235 "space prohibited before that '$op' $at\n" . $hereptr)) {
4236 $line_fixed = 1;
4237 $rtrim_before = 1;
4238 }
4239 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004240 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004241 if (ERROR("SPACING",
4242 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004243 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004244 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004245 $space_after = 1;
4246 }
4247 }
4248 if ($rtrim_before || $space_after) {
4249 if ($rtrim_before) {
4250 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4251 } else {
4252 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4253 }
4254 if ($space_after) {
4255 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004256 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004257 }
4258
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004259 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004260 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004261 #warn "'*' is part of type\n";
4262
4263 # unary operators should have a space before and
4264 # none after. May be left adjacent to another
4265 # unary operator, or a cast
4266 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004267 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004268 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004269 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004270 if (ERROR("SPACING",
4271 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004272 if ($n != $last_after + 2) {
4273 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4274 $line_fixed = 1;
4275 }
Joe Perches3705ce52013-07-03 15:05:31 -07004276 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004277 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004278 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004279 # A unary '*' may be const
4280
4281 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004282 if (ERROR("SPACING",
4283 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004284 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004285 if (defined $fix_elements[$n + 2]) {
4286 $fix_elements[$n + 2] =~ s/^\s+//;
4287 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004288 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004289 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004290 }
4291
4292 # unary ++ and unary -- are allowed no space on one side.
4293 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004294 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004295 if (ERROR("SPACING",
4296 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004297 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004298 $line_fixed = 1;
4299 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004300 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004301 if ($ctx =~ /Wx[BE]/ ||
4302 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004303 if (ERROR("SPACING",
4304 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004305 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004306 $line_fixed = 1;
4307 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004308 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004309 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004310 if (ERROR("SPACING",
4311 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004312 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004313 if (defined $fix_elements[$n + 2]) {
4314 $fix_elements[$n + 2] =~ s/^\s+//;
4315 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004316 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004317 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004318 }
4319
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004320 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004321 } elsif ($op eq '<<' or $op eq '>>' or
4322 $op eq '&' or $op eq '^' or $op eq '|' or
4323 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004324 $op eq '*' or $op eq '/' or
4325 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004326 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004327 if ($check) {
4328 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4329 if (CHK("SPACING",
4330 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4331 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4332 $fix_elements[$n + 2] =~ s/^\s+//;
4333 $line_fixed = 1;
4334 }
4335 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4336 if (CHK("SPACING",
4337 "space preferred before that '$op' $at\n" . $hereptr)) {
4338 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4339 $line_fixed = 1;
4340 }
4341 }
4342 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004343 if (ERROR("SPACING",
4344 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004345 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4346 if (defined $fix_elements[$n + 2]) {
4347 $fix_elements[$n + 2] =~ s/^\s+//;
4348 }
Joe Perches3705ce52013-07-03 15:05:31 -07004349 $line_fixed = 1;
4350 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004351 }
4352
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004353 # A colon needs no spaces before when it is
4354 # terminating a case value or a label.
4355 } elsif ($opv eq ':C' || $opv eq ':L') {
4356 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004357 if (ERROR("SPACING",
4358 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004359 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004360 $line_fixed = 1;
4361 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004362 }
4363
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004364 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004365 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004366 my $ok = 0;
4367
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004368 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004369 if (($op eq '<' &&
4370 $cc =~ /^\S+\@\S+>/) ||
4371 ($op eq '>' &&
4372 $ca =~ /<\S+\@\S+$/))
4373 {
4374 $ok = 1;
4375 }
4376
Joe Perchese0df7e12015-04-16 12:44:53 -07004377 # for asm volatile statements
4378 # ignore a colon with another
4379 # colon immediately before or after
4380 if (($op eq ':') &&
4381 ($ca =~ /:$/ || $cc =~ /^:/)) {
4382 $ok = 1;
4383 }
4384
Joe Perches84731622013-11-12 15:10:05 -08004385 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004386 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004387 my $msg_level = \&ERROR;
4388 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004389
Jean Delvare0675a8f2017-09-08 16:16:07 -07004390 if (&{$msg_level}("SPACING",
4391 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004392 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4393 if (defined $fix_elements[$n + 2]) {
4394 $fix_elements[$n + 2] =~ s/^\s+//;
4395 }
Joe Perches3705ce52013-07-03 15:05:31 -07004396 $line_fixed = 1;
4397 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004398 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004399 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004400 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004401
4402## print("n: <$n> GOOD: <$good>\n");
4403
4404 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004405 }
Joe Perches3705ce52013-07-03 15:05:31 -07004406
4407 if (($#elements % 2) == 0) {
4408 $fixed_line = $fixed_line . $fix_elements[$#elements];
4409 }
4410
Joe Perches194f66f2014-08-06 16:11:03 -07004411 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4412 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004413 }
4414
4415
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004416 }
4417
Joe Perches786b6322013-07-03 15:05:32 -07004418# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004419 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004420 if (WARN("SPACING",
4421 "space prohibited before semicolon\n" . $herecurr) &&
4422 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004423 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004424 s/^(\+.*\S)\s+;/$1;/;
4425 }
4426 }
4427
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004428# check for multiple assignments
4429 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004430 CHK("MULTIPLE_ASSIGNMENTS",
4431 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004432 }
4433
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004434## # check for multiple declarations, allowing for a function declaration
4435## # continuation.
4436## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4437## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4438##
4439## # Remove any bracketed sections to ensure we do not
4440## # falsly report the parameters of functions.
4441## my $ln = $line;
4442## while ($ln =~ s/\([^\(\)]*\)//g) {
4443## }
4444## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004445## WARN("MULTIPLE_DECLARATION",
4446## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004447## }
4448## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004449
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004450#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004451 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004452 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004453 if (ERROR("SPACING",
4454 "space required before the open brace '{'\n" . $herecurr) &&
4455 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004456 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004457 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004458 }
4459
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004460## # check for blank lines before declarations
4461## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4462## $prevrawline =~ /^.\s*$/) {
4463## WARN("SPACING",
4464## "No blank lines before declarations\n" . $hereprev);
4465## }
4466##
4467
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004468# closing brace should have a space following it when it has anything
4469# on the line
4470 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004471 if (ERROR("SPACING",
4472 "space required after that close brace '}'\n" . $herecurr) &&
4473 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004474 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004475 s/}((?!(?:,|;|\)))\S)/} $1/;
4476 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004477 }
4478
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004479# check spacing on square brackets
4480 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004481 if (ERROR("SPACING",
4482 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4483 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004484 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004485 s/\[\s+/\[/;
4486 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004487 }
4488 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004489 if (ERROR("SPACING",
4490 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4491 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004492 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004493 s/\s+\]/\]/;
4494 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004495 }
4496
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004497# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004498 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4499 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004500 if (ERROR("SPACING",
4501 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4502 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004503 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004504 s/\(\s+/\(/;
4505 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004506 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004507 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004508 $line !~ /for\s*\(.*;\s+\)/ &&
4509 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004510 if (ERROR("SPACING",
4511 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4512 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004513 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004514 s/\s+\)/\)/;
4515 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004516 }
4517
Joe Perchese2826fd2014-08-06 16:10:48 -07004518# check unnecessary parentheses around addressof/dereference single $Lvals
4519# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4520
4521 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004522 my $var = $1;
4523 if (CHK("UNNECESSARY_PARENTHESES",
4524 "Unnecessary parentheses around $var\n" . $herecurr) &&
4525 $fix) {
4526 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4527 }
4528 }
4529
4530# check for unnecessary parentheses around function pointer uses
4531# ie: (foo->bar)(); should be foo->bar();
4532# but not "if (foo->bar) (" to avoid some false positives
4533 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4534 my $var = $2;
4535 if (CHK("UNNECESSARY_PARENTHESES",
4536 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4537 $fix) {
4538 my $var2 = deparenthesize($var);
4539 $var2 =~ s/\s//g;
4540 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4541 }
4542 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004543
Joe Perches63b7c732017-09-08 16:16:01 -07004544# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004545# when !drivers/staging or command-line uses --strict
4546 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4547 $^V && $^V ge 5.10.0 && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004548 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4549 my $if_stat = $1;
4550 my $test = substr($2, 1, -1);
4551 my $herectx;
4552 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4553 my $match = $1;
4554 # avoid parentheses around potential macro args
4555 next if ($match =~ /^\s*\w+\s*$/);
4556 if (!defined($herectx)) {
4557 $herectx = $here . "\n";
4558 my $cnt = statement_rawlines($if_stat);
4559 for (my $n = 0; $n < $cnt; $n++) {
4560 my $rl = raw_line($linenr, $n);
4561 $herectx .= $rl . "\n";
4562 last if $rl =~ /^[ \+].*\{/;
4563 }
4564 }
4565 CHK("UNNECESSARY_PARENTHESES",
4566 "Unnecessary parentheses around '$match'\n" . $herectx);
4567 }
4568 }
4569
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004570#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004571 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004572 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004573 if (WARN("INDENTED_LABEL",
4574 "labels should not be indented\n" . $herecurr) &&
4575 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004576 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004577 s/^(.)\s+/$1/;
4578 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004579 }
4580
Joe Perches5b9553a2014-04-03 14:49:21 -07004581# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004582 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004583 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004584 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004585 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4586 my $value = $1;
4587 $value = deparenthesize($value);
4588 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4589 ERROR("RETURN_PARENTHESES",
4590 "return is not a function, parentheses are not required\n" . $herecurr);
4591 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004592 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004593 ERROR("SPACING",
4594 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004595 }
4596 }
Joe Perches507e5142013-11-12 15:10:13 -08004597
Joe Perchesb43ae212014-06-23 13:22:07 -07004598# unnecessary return in a void function
4599# at end-of-function, with the previous line a single leading tab, then return;
4600# and the line before that not a goto label target like "out:"
4601 if ($sline =~ /^[ \+]}\s*$/ &&
4602 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4603 $linenr >= 3 &&
4604 $lines[$linenr - 3] =~ /^[ +]/ &&
4605 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004606 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004607 "void function return statements are not generally useful\n" . $hereprev);
4608 }
Joe Perches9819cf22014-06-04 16:12:09 -07004609
Joe Perches189248d2014-01-23 15:54:47 -08004610# if statements using unnecessary parentheses - ie: if ((foo == bar))
4611 if ($^V && $^V ge 5.10.0 &&
4612 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4613 my $openparens = $1;
4614 my $count = $openparens =~ tr@\(@\(@;
4615 my $msg = "";
4616 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4617 my $comp = $4; #Not $1 because of $LvalOrFunc
4618 $msg = " - maybe == should be = ?" if ($comp eq "==");
4619 WARN("UNNECESSARY_PARENTHESES",
4620 "Unnecessary parentheses$msg\n" . $herecurr);
4621 }
4622 }
4623
Joe Perchesc5595fa2015-09-09 15:37:58 -07004624# comparisons with a constant or upper case identifier on the left
4625# avoid cases like "foo + BAR < baz"
4626# only fix matches surrounded by parentheses to avoid incorrect
4627# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4628 if ($^V && $^V ge 5.10.0 &&
4629 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4630 my $lead = $1;
4631 my $const = $2;
4632 my $comp = $3;
4633 my $to = $4;
4634 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004635 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004636 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4637 WARN("CONSTANT_COMPARISON",
4638 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4639 $fix) {
4640 if ($comp eq "<") {
4641 $newcomp = ">";
4642 } elsif ($comp eq "<=") {
4643 $newcomp = ">=";
4644 } elsif ($comp eq ">") {
4645 $newcomp = "<";
4646 } elsif ($comp eq ">=") {
4647 $newcomp = "<=";
4648 }
4649 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4650 }
4651 }
4652
Joe Perchesf34e4a42015-04-16 12:44:19 -07004653# Return of what appears to be an errno should normally be negative
4654 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004655 my $name = $1;
4656 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004657 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004658 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004659 }
4660 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004661
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004662# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004663 if ($line =~ /\b(if|while|for|switch)\(/) {
4664 if (ERROR("SPACING",
4665 "space required before the open parenthesis '('\n" . $herecurr) &&
4666 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004667 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004668 s/\b(if|while|for|switch)\(/$1 \(/;
4669 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004670 }
4671
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004672# Check for illegal assignment in if conditional -- and check for trailing
4673# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004674 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004675 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4676 ctx_statement_block($linenr, $realcnt, 0)
4677 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004678 my ($stat_next) = ctx_statement_block($line_nr_next,
4679 $remain_next, $off_next);
4680 $stat_next =~ s/\n./\n /g;
4681 ##print "stat<$stat> stat_next<$stat_next>\n";
4682
4683 if ($stat_next =~ /^\s*while\b/) {
4684 # If the statement carries leading newlines,
4685 # then count those as offsets.
4686 my ($whitespace) =
4687 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4688 my $offset =
4689 statement_rawlines($whitespace) - 1;
4690
4691 $suppress_whiletrailers{$line_nr_next +
4692 $offset} = 1;
4693 }
4694 }
4695 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004696 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004697 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004698 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004699
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004700 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004701 ERROR("ASSIGN_IN_IF",
4702 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004703 }
4704
4705 # Find out what is on the end of the line after the
4706 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004707 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004708 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004709 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004710 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4711 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004712 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004713 # Find out how long the conditional actually is.
4714 my @newlines = ($c =~ /\n/gs);
4715 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004716 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004717
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004718 $stat_real = raw_line($linenr, $cond_lines)
4719 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004720 if (defined($stat_real) && $cond_lines > 1) {
4721 $stat_real = "[...]\n$stat_real";
4722 }
4723
Joe Perches000d1cc12011-07-25 17:13:25 -07004724 ERROR("TRAILING_STATEMENTS",
4725 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004726 }
4727 }
4728
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004729# Check for bitwise tests written as boolean
4730 if ($line =~ /
4731 (?:
4732 (?:\[|\(|\&\&|\|\|)
4733 \s*0[xX][0-9]+\s*
4734 (?:\&\&|\|\|)
4735 |
4736 (?:\&\&|\|\|)
4737 \s*0[xX][0-9]+\s*
4738 (?:\&\&|\|\||\)|\])
4739 )/x)
4740 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004741 WARN("HEXADECIMAL_BOOLEAN_TEST",
4742 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004743 }
4744
Andy Whitcroft8905a672007-11-28 16:21:06 -08004745# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004746 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4747 my $s = $1;
4748 $s =~ s/$;//g; # Remove any comments
4749 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004750 ERROR("TRAILING_STATEMENTS",
4751 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004752 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004753 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004754# if should not continue a brace
4755 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004756 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004757 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004758 $herecurr);
4759 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004760# case and default should not have general statements after them
4761 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4762 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004763 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004764 \s*return\s+
4765 )/xg)
4766 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004767 ERROR("TRAILING_STATEMENTS",
4768 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004769 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004770
4771 # Check for }<nl>else {, these must be at the same
4772 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004773 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4774 $previndent == $indent) {
4775 if (ERROR("ELSE_AFTER_BRACE",
4776 "else should follow close brace '}'\n" . $hereprev) &&
4777 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4778 fix_delete_line($fixlinenr - 1, $prevrawline);
4779 fix_delete_line($fixlinenr, $rawline);
4780 my $fixedline = $prevrawline;
4781 $fixedline =~ s/}\s*$//;
4782 if ($fixedline !~ /^\+\s*$/) {
4783 fix_insert_line($fixlinenr, $fixedline);
4784 }
4785 $fixedline = $rawline;
4786 $fixedline =~ s/^(.\s*)else/$1} else/;
4787 fix_insert_line($fixlinenr, $fixedline);
4788 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004789 }
4790
Joe Perches8b8856f2014-08-06 16:11:14 -07004791 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4792 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004793 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4794
4795 # Find out what is on the end of the line after the
4796 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004797 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004798 $s =~ s/\n.*//g;
4799
4800 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004801 if (ERROR("WHILE_AFTER_BRACE",
4802 "while should follow close brace '}'\n" . $hereprev) &&
4803 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4804 fix_delete_line($fixlinenr - 1, $prevrawline);
4805 fix_delete_line($fixlinenr, $rawline);
4806 my $fixedline = $prevrawline;
4807 my $trailing = $rawline;
4808 $trailing =~ s/^\+//;
4809 $trailing = trim($trailing);
4810 $fixedline =~ s/}\s*$/} $trailing/;
4811 fix_insert_line($fixlinenr, $fixedline);
4812 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004813 }
4814 }
4815
Joe Perches95e2c602013-07-03 15:05:20 -07004816#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004817 while ($line =~ m{($Constant|$Lval)}g) {
4818 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004819
4820#gcc binary extension
4821 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004822 if (WARN("GCC_BINARY_CONSTANT",
4823 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4824 $fix) {
4825 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004826 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004827 s/\b$var\b/$hexval/;
4828 }
Joe Perches95e2c602013-07-03 15:05:20 -07004829 }
4830
4831#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004832 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004833 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004834#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004835 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004836#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004837 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4838#Ignore some three character SI units explicitly, like MiB and KHz
4839 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004840 while ($var =~ m{($Ident)}g) {
4841 my $word = $1;
4842 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004843 if ($check) {
4844 seed_camelcase_includes();
4845 if (!$file && !$camelcase_file_seeded) {
4846 seed_camelcase_file($realfile);
4847 $camelcase_file_seeded = 1;
4848 }
4849 }
Joe Perches7e781f62013-09-11 14:23:55 -07004850 if (!defined $camelcase{$word}) {
4851 $camelcase{$word} = 1;
4852 CHK("CAMELCASE",
4853 "Avoid CamelCase: <$word>\n" . $herecurr);
4854 }
Joe Perches34456862013-07-03 15:05:34 -07004855 }
Joe Perches323c1262012-12-17 16:02:07 -08004856 }
4857 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004858
4859#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004860 if ($line =~ /\#\s*define.*\\\s+$/) {
4861 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4862 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4863 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004864 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004865 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004866 }
4867
Fabian Frederick0e212e02015-04-16 12:44:25 -07004868# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4869# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004870 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004871 my $file = "$1.h";
4872 my $checkfile = "include/linux/$file";
4873 if (-f "$root/$checkfile" &&
4874 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004875 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004876 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004877 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4878 if ($asminclude > 0) {
4879 if ($realfile =~ m{^arch/}) {
4880 CHK("ARCH_INCLUDE_LINUX",
4881 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4882 } else {
4883 WARN("INCLUDE_LINUX",
4884 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4885 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004886 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004887 }
4888 }
4889
Andy Whitcroft653d4872007-06-23 17:16:34 -07004890# multi-statement macros should be enclosed in a do while loop, grab the
4891# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004892# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004893 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4894 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004895 my $ln = $linenr;
4896 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004897 my ($off, $dstat, $dcond, $rest);
4898 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004899 my $has_flow_statement = 0;
4900 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004901 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004902 ctx_statement_block($linenr, $realcnt, 0);
4903 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004904 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004905 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004906
Joe Perches08a28432014-10-13 15:51:55 -07004907 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004908 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004909
Joe Perchesf59b64b2016-10-11 13:52:08 -07004910 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4911 my $define_args = $1;
4912 my $define_stmt = $dstat;
4913 my @def_args = ();
4914
4915 if (defined $define_args && $define_args ne "") {
4916 $define_args = substr($define_args, 1, length($define_args) - 2);
4917 $define_args =~ s/\s*//g;
4918 @def_args = split(",", $define_args);
4919 }
4920
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004921 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004922 $dstat =~ s/\\\n.//g;
4923 $dstat =~ s/^\s*//s;
4924 $dstat =~ s/\s*$//s;
4925
4926 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004927 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4928 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004929 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004930 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004931 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004932
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004933 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004934 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4935 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004936 {
4937 }
4938
Joe Perches42e15292016-03-15 14:58:01 -07004939 # Make asm volatile uses seem like a generic function
4940 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4941
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004942 my $exceptions = qr{
4943 $Declare|
4944 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004945 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004946 DECLARE_PER_CPU|
4947 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004948 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004949 union|
4950 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004951 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004952 ^\"|\"$|
4953 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004954 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004955 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004956
4957 $ctx =~ s/\n*$//;
4958 my $herectx = $here . "\n";
4959 my $stmt_cnt = statement_rawlines($ctx);
4960
4961 for (my $n = 0; $n < $stmt_cnt; $n++) {
4962 $herectx .= raw_line($linenr, $n) . "\n";
4963 }
4964
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004965 if ($dstat ne '' &&
4966 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4967 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004968 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004969 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004970 $dstat !~ /$exceptions/ &&
4971 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004972 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004973 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004974 $dstat !~ /^for\s*$Constant$/ && # for (...)
4975 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4976 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004977 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004978 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004979 {
Joe Perchese7955562017-05-08 15:55:48 -07004980 if ($dstat =~ /^\s*if\b/) {
4981 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4982 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4983 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004984 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4985 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4986 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004987 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004988 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004989 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004990
4991 }
Joe Perches52076492016-10-11 13:52:14 -07004992
4993 # Make $define_stmt single line, comment-free, etc
4994 my @stmt_array = split('\n', $define_stmt);
4995 my $first = 1;
4996 $define_stmt = "";
4997 foreach my $l (@stmt_array) {
4998 $l =~ s/\\$//;
4999 if ($first) {
5000 $define_stmt = $l;
5001 $first = 0;
5002 } elsif ($l =~ /^[\+ ]/) {
5003 $define_stmt .= substr($l, 1);
5004 }
5005 }
5006 $define_stmt =~ s/$;//g;
5007 $define_stmt =~ s/\s+/ /g;
5008 $define_stmt = trim($define_stmt);
5009
Joe Perchesf59b64b2016-10-11 13:52:08 -07005010# check if any macro arguments are reused (ignore '...' and 'type')
5011 foreach my $arg (@def_args) {
5012 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005013 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005014 my $tmp_stmt = $define_stmt;
5015 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5016 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5017 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5018 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005019 if ($use_cnt > 1) {
5020 CHK("MACRO_ARG_REUSE",
5021 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005022 }
5023# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005024 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005025 ((defined($1) && $1 ne ',') ||
5026 (defined($2) && $2 ne ','))) {
5027 CHK("MACRO_ARG_PRECEDENCE",
5028 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005029 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005030 }
Joe Perches5023d342012-12-17 16:01:47 -08005031
Joe Perches08a28432014-10-13 15:51:55 -07005032# check for macros with flow control, but without ## concatenation
5033# ## concatenation is commonly a macro that defines a function so ignore those
5034 if ($has_flow_statement && !$has_arg_concat) {
5035 my $herectx = $here . "\n";
5036 my $cnt = statement_rawlines($ctx);
5037
5038 for (my $n = 0; $n < $cnt; $n++) {
5039 $herectx .= raw_line($linenr, $n) . "\n";
5040 }
5041 WARN("MACRO_WITH_FLOW_CONTROL",
5042 "Macros with flow control statements should be avoided\n" . "$herectx");
5043 }
5044
Joe Perches481eb482012-12-17 16:01:56 -08005045# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005046
5047 } else {
5048 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005049 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5050 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005051 $line =~ /^\+.*\\$/) {
5052 WARN("LINE_CONTINUATIONS",
5053 "Avoid unnecessary line continuations\n" . $herecurr);
5054 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005055 }
5056
Joe Perchesb13edf72012-07-30 14:41:24 -07005057# do {} while (0) macro tests:
5058# single-statement macros do not need to be enclosed in do while (0) loop,
5059# macro should not end with a semicolon
5060 if ($^V && $^V ge 5.10.0 &&
5061 $realfile !~ m@/vmlinux.lds.h$@ &&
5062 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5063 my $ln = $linenr;
5064 my $cnt = $realcnt;
5065 my ($off, $dstat, $dcond, $rest);
5066 my $ctx = '';
5067 ($dstat, $dcond, $ln, $cnt, $off) =
5068 ctx_statement_block($linenr, $realcnt, 0);
5069 $ctx = $dstat;
5070
5071 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005072 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005073
5074 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5075 my $stmts = $2;
5076 my $semis = $3;
5077
5078 $ctx =~ s/\n*$//;
5079 my $cnt = statement_rawlines($ctx);
5080 my $herectx = $here . "\n";
5081
5082 for (my $n = 0; $n < $cnt; $n++) {
5083 $herectx .= raw_line($linenr, $n) . "\n";
5084 }
5085
Joe Perchesac8e97f2012-08-21 16:15:53 -07005086 if (($stmts =~ tr/;/;/) == 1 &&
5087 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005088 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5089 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5090 }
5091 if (defined $semis && $semis ne "") {
5092 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5093 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5094 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005095 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5096 $ctx =~ s/\n*$//;
5097 my $cnt = statement_rawlines($ctx);
5098 my $herectx = $here . "\n";
5099
5100 for (my $n = 0; $n < $cnt; $n++) {
5101 $herectx .= raw_line($linenr, $n) . "\n";
5102 }
5103
5104 WARN("TRAILING_SEMICOLON",
5105 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005106 }
5107 }
5108
Mike Frysinger080ba922009-01-06 14:41:25 -08005109# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5110# all assignments may have only one of the following with an assignment:
5111# .
5112# ALIGN(...)
5113# VMLINUX_SYMBOL(...)
5114 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005115 WARN("MISSING_VMLINUX_SYMBOL",
5116 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005117 }
5118
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005119# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005120 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5121 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005122 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005123 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005124 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5125 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005126 my @allowed = ();
5127 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005128 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005129 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005130 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005131 for my $chunk (@chunks) {
5132 my ($cond, $block) = @{$chunk};
5133
Andy Whitcroft773647a2008-03-28 14:15:58 -07005134 # If the condition carries leading newlines, then count those as offsets.
5135 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5136 my $offset = statement_rawlines($whitespace) - 1;
5137
Joe Perchesaad4f612012-03-23 15:02:19 -07005138 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005139 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5140
5141 # We have looked at and allowed this specific line.
5142 $suppress_ifbraces{$ln + $offset} = 1;
5143
5144 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005145 $ln += statement_rawlines($block) - 1;
5146
Andy Whitcroft773647a2008-03-28 14:15:58 -07005147 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005148
5149 $seen++ if ($block =~ /^\s*{/);
5150
Joe Perchesaad4f612012-03-23 15:02:19 -07005151 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005152 if (statement_lines($cond) > 1) {
5153 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005154 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005155 }
5156 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005157 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005158 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005159 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005160 if (statement_block_size($block) > 1) {
5161 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005162 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005163 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005164 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005165 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005166 if ($seen) {
5167 my $sum_allowed = 0;
5168 foreach (@allowed) {
5169 $sum_allowed += $_;
5170 }
5171 if ($sum_allowed == 0) {
5172 WARN("BRACES",
5173 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5174 } elsif ($sum_allowed != $allow &&
5175 $seen != $allow) {
5176 CHK("BRACES",
5177 "braces {} should be used on all arms of this statement\n" . $herectx);
5178 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005179 }
5180 }
5181 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005182 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005183 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005184 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005185
Andy Whitcroftcf655042008-03-04 14:28:20 -08005186 # Check the pre-context.
5187 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5188 #print "APW: ALLOWED: pre<$1>\n";
5189 $allowed = 1;
5190 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005191
5192 my ($level, $endln, @chunks) =
5193 ctx_statement_full($linenr, $realcnt, $-[0]);
5194
Andy Whitcroftcf655042008-03-04 14:28:20 -08005195 # Check the condition.
5196 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005197 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005198 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005199 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005200 }
5201 if (statement_lines($cond) > 1) {
5202 #print "APW: ALLOWED: cond<$cond>\n";
5203 $allowed = 1;
5204 }
5205 if ($block =~/\b(?:if|for|while)\b/) {
5206 #print "APW: ALLOWED: block<$block>\n";
5207 $allowed = 1;
5208 }
5209 if (statement_block_size($block) > 1) {
5210 #print "APW: ALLOWED: lines block<$block>\n";
5211 $allowed = 1;
5212 }
5213 # Check the post-context.
5214 if (defined $chunks[1]) {
5215 my ($cond, $block) = @{$chunks[1]};
5216 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005217 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005218 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005219 if ($block =~ /^\s*\{/) {
5220 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5221 $allowed = 1;
5222 }
5223 }
5224 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005225 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005226 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005227
Andy Whitcroftf0556632008-10-15 22:02:23 -07005228 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005229 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005230 }
5231
Joe Perches000d1cc12011-07-25 17:13:25 -07005232 WARN("BRACES",
5233 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005234 }
5235 }
5236
Joe Perchese4c5bab2017-02-24 15:01:41 -08005237# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005238 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5239 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005240 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5241 }
5242
Joe Perches0979ae62012-12-17 16:01:59 -08005243# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005244 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005245 if (CHK("BRACES",
5246 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5247 $fix && $prevrawline =~ /^\+/) {
5248 fix_delete_line($fixlinenr - 1, $prevrawline);
5249 }
Joe Perches0979ae62012-12-17 16:01:59 -08005250 }
Joe Perches77b9a532013-07-03 15:05:29 -07005251 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005252 if (CHK("BRACES",
5253 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5254 $fix) {
5255 fix_delete_line($fixlinenr, $rawline);
5256 }
Joe Perches0979ae62012-12-17 16:01:59 -08005257 }
5258
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005259# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005260 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5261 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005262 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005263 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005264 }
5265
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005266# Check for user-visible strings broken across lines, which breaks the ability
5267# to grep for the string. Make exceptions when the previous string ends in a
5268# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5269# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005270 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005271 $prevline =~ /"\s*$/ &&
5272 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5273 if (WARN("SPLIT_STRING",
5274 "quoted string split across lines\n" . $hereprev) &&
5275 $fix &&
5276 $prevrawline =~ /^\+.*"\s*$/ &&
5277 $last_coalesced_string_linenr != $linenr - 1) {
5278 my $extracted_string = get_quoted_string($line, $rawline);
5279 my $comma_close = "";
5280 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5281 $comma_close = $1;
5282 }
5283
5284 fix_delete_line($fixlinenr - 1, $prevrawline);
5285 fix_delete_line($fixlinenr, $rawline);
5286 my $fixedline = $prevrawline;
5287 $fixedline =~ s/"\s*$//;
5288 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5289 fix_insert_line($fixlinenr - 1, $fixedline);
5290 $fixedline = $rawline;
5291 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5292 if ($fixedline !~ /\+\s*$/) {
5293 fix_insert_line($fixlinenr, $fixedline);
5294 }
5295 $last_coalesced_string_linenr = $linenr;
5296 }
5297 }
5298
5299# check for missing a space in a string concatenation
5300 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5301 WARN('MISSING_SPACE',
5302 "break quoted strings at a space character\n" . $hereprev);
5303 }
5304
Joe Perchese4b7d302017-05-08 15:55:51 -07005305# check for an embedded function name in a string when the function is known
5306# This does not work very well for -f --file checking as it depends on patch
5307# context providing the function name or a single line form for in-file
5308# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005309 if ($line =~ /^\+.*$String/ &&
5310 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005311 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5312 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005313 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005314 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005315 }
5316
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005317# check for spaces before a quoted newline
5318 if ($rawline =~ /^.*\".*\s\\n/) {
5319 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5320 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5321 $fix) {
5322 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5323 }
5324
5325 }
5326
Joe Perchesf17dba42014-10-13 15:51:51 -07005327# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005328 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005329 CHK("CONCATENATED_STRING",
5330 "Concatenated strings should use spaces between elements\n" . $herecurr);
5331 }
5332
Joe Perches90ad30e2014-12-10 15:51:59 -08005333# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005334 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005335 WARN("STRING_FRAGMENTS",
5336 "Consecutive strings are generally better as a single string\n" . $herecurr);
5337 }
5338
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005339# check for non-standard and hex prefixed decimal printf formats
5340 my $show_L = 1; #don't show the same defect twice
5341 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005342 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005343 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005344 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005345 # check for %L
5346 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005347 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005348 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5349 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005350 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005351 # check for %Z
5352 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5353 WARN("PRINTF_Z",
5354 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5355 $show_Z = 0;
5356 }
5357 # check for 0x<decimal>
5358 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5359 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005360 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5361 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005362 }
5363
5364# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005365 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005366 WARN("LINE_CONTINUATIONS",
5367 "Avoid line continuations in quoted strings\n" . $herecurr);
5368 }
5369
Andy Whitcroft00df3442007-06-08 13:47:06 -07005370# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005371 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005372 CHK("REDUNDANT_CODE",
5373 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005374 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005375 }
5376
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005377# check for needless "if (<foo>) fn(<foo>)" uses
5378 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005379 my $tested = quotemeta($1);
5380 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5381 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5382 my $func = $1;
5383 if (WARN('NEEDLESS_IF',
5384 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5385 $fix) {
5386 my $do_fix = 1;
5387 my $leading_tabs = "";
5388 my $new_leading_tabs = "";
5389 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5390 $leading_tabs = $1;
5391 } else {
5392 $do_fix = 0;
5393 }
5394 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5395 $new_leading_tabs = $1;
5396 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5397 $do_fix = 0;
5398 }
5399 } else {
5400 $do_fix = 0;
5401 }
5402 if ($do_fix) {
5403 fix_delete_line($fixlinenr - 1, $prevrawline);
5404 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5405 }
5406 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005407 }
5408 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005409
Joe Perchesebfdc402014-08-06 16:10:27 -07005410# check for unnecessary "Out of Memory" messages
5411 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5412 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5413 (defined $1 || defined $3) &&
5414 $linenr > 3) {
5415 my $testval = $2;
5416 my $testline = $lines[$linenr - 3];
5417
5418 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5419# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5420
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005421 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 -07005422 WARN("OOM_MESSAGE",
5423 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5424 }
5425 }
5426
Joe Perchesf78d98f2014-10-13 15:52:01 -07005427# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005428 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005429 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5430 my $level = $1;
5431 if (WARN("UNNECESSARY_KERN_LEVEL",
5432 "Possible unnecessary $level\n" . $herecurr) &&
5433 $fix) {
5434 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5435 }
5436 }
5437
Joe Perches45c55e92017-02-24 15:01:31 -08005438# check for logging continuations
5439 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5440 WARN("LOGGING_CONTINUATION",
5441 "Avoid logging continuation uses where feasible\n" . $herecurr);
5442 }
5443
Joe Perchesabb08a52014-12-10 15:51:46 -08005444# check for mask then right shift without a parentheses
5445 if ($^V && $^V ge 5.10.0 &&
5446 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5447 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5448 WARN("MASK_THEN_SHIFT",
5449 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5450 }
5451
Joe Perchesb75ac612014-12-10 15:52:02 -08005452# check for pointer comparisons to NULL
5453 if ($^V && $^V ge 5.10.0) {
5454 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5455 my $val = $1;
5456 my $equal = "!";
5457 $equal = "" if ($4 eq "!=");
5458 if (CHK("COMPARISON_TO_NULL",
5459 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5460 $fix) {
5461 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5462 }
5463 }
5464 }
5465
Joe Perches8716de32013-09-11 14:24:05 -07005466# check for bad placement of section $InitAttribute (e.g.: __initdata)
5467 if ($line =~ /(\b$InitAttribute\b)/) {
5468 my $attr = $1;
5469 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5470 my $ptr = $1;
5471 my $var = $2;
5472 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5473 ERROR("MISPLACED_INIT",
5474 "$attr should be placed after $var\n" . $herecurr)) ||
5475 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5476 WARN("MISPLACED_INIT",
5477 "$attr should be placed after $var\n" . $herecurr))) &&
5478 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005479 $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 -07005480 }
5481 }
5482 }
5483
Joe Perchese970b8842013-11-12 15:10:10 -08005484# check for $InitAttributeData (ie: __initdata) with const
5485 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5486 my $attr = $1;
5487 $attr =~ /($InitAttributePrefix)(.*)/;
5488 my $attr_prefix = $1;
5489 my $attr_type = $2;
5490 if (ERROR("INIT_ATTRIBUTE",
5491 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5492 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005493 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005494 s/$InitAttributeData/${attr_prefix}initconst/;
5495 }
5496 }
5497
5498# check for $InitAttributeConst (ie: __initconst) without const
5499 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5500 my $attr = $1;
5501 if (ERROR("INIT_ATTRIBUTE",
5502 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5503 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005504 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005505 /(^\+\s*(?:static\s+))/;
5506 $lead = rtrim($1);
5507 $lead = "$lead " if ($lead !~ /^\+$/);
5508 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005509 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005510 }
5511 }
5512
Joe Perchesc17893c2015-04-16 12:44:42 -07005513# check for __read_mostly with const non-pointer (should just be const)
5514 if ($line =~ /\b__read_mostly\b/ &&
5515 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5516 if (ERROR("CONST_READ_MOSTLY",
5517 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5518 $fix) {
5519 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5520 }
5521 }
5522
Joe Perchesfbdb8132014-04-03 14:49:14 -07005523# don't use __constant_<foo> functions outside of include/uapi/
5524 if ($realfile !~ m@^include/uapi/@ &&
5525 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5526 my $constant_func = $1;
5527 my $func = $constant_func;
5528 $func =~ s/^__constant_//;
5529 if (WARN("CONSTANT_CONVERSION",
5530 "$constant_func should be $func\n" . $herecurr) &&
5531 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005532 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005533 }
5534 }
5535
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005536# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005537 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005538 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005539 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005540 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005541 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005542 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5543 }
5544 if ($delay > 2000) {
5545 WARN("LONG_UDELAY",
5546 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005547 }
5548 }
5549
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005550# warn about unexpectedly long msleep's
5551 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5552 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005553 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005554 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005555 }
5556 }
5557
Joe Perches36ec1932013-07-03 15:05:25 -07005558# check for comparisons of jiffies
5559 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5560 WARN("JIFFIES_COMPARISON",
5561 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5562 }
5563
Joe Perches9d7a34a2013-07-03 15:05:26 -07005564# check for comparisons of get_jiffies_64()
5565 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5566 WARN("JIFFIES_COMPARISON",
5567 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5568 }
5569
Andy Whitcroft00df3442007-06-08 13:47:06 -07005570# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005571# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005572# print "#ifdef in C files should be avoided\n";
5573# print "$herecurr";
5574# $clean = 0;
5575# }
5576
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005577# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005578 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005579 if (ERROR("SPACING",
5580 "exactly one space required after that #$1\n" . $herecurr) &&
5581 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005582 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005583 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5584 }
5585
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005586 }
5587
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005588# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005589 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5590 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005591 my $which = $1;
5592 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005593 CHK("UNCOMMENTED_DEFINITION",
5594 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005595 }
5596 }
5597# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005598
5599 my $barriers = qr{
5600 mb|
5601 rmb|
5602 wmb|
5603 read_barrier_depends
5604 }x;
5605 my $barrier_stems = qr{
5606 mb__before_atomic|
5607 mb__after_atomic|
5608 store_release|
5609 load_acquire|
5610 store_mb|
5611 (?:$barriers)
5612 }x;
5613 my $all_barriers = qr{
5614 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005615 smp_(?:$barrier_stems)|
5616 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005617 }x;
5618
5619 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005620 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005621 WARN("MEMORY_BARRIER",
5622 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005623 }
5624 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005625
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005626 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5627
5628 if ($realfile !~ m@^include/asm-generic/@ &&
5629 $realfile !~ m@/barrier\.h$@ &&
5630 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5631 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5632 WARN("MEMORY_BARRIER",
5633 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5634 }
5635
Joe Perchescb426e92015-06-25 15:02:46 -07005636# check for waitqueue_active without a comment.
5637 if ($line =~ /\bwaitqueue_active\s*\(/) {
5638 if (!ctx_has_comment($first_line, $linenr)) {
5639 WARN("WAITQUEUE_ACTIVE",
5640 "waitqueue_active without comment\n" . $herecurr);
5641 }
5642 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005643
Paul E. McKenney91db2592017-11-27 09:37:35 -08005644# check for smp_read_barrier_depends and read_barrier_depends
5645 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5646 WARN("READ_BARRIER_DEPENDS",
5647 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5648 }
5649
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005650# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005651 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005652 CHK("ARCH_DEFINES",
5653 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005654 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005655
Joe Perches596ed452017-07-12 14:37:02 -07005656# check that the storage class is not after a type
5657 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005658 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005659 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5660 }
5661# Check that the storage class is at the beginning of a declaration
5662 if ($line =~ /\b$Storage\b/ &&
5663 $line !~ /^.\s*$Storage/ &&
5664 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5665 $1 !~ /[\,\)]\s*$/) {
5666 WARN("STORAGE_CLASS",
5667 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005668 }
5669
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005670# check the location of the inline attribute, that it is between
5671# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005672 if ($line =~ /\b$Type\s+$Inline\b/ ||
5673 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005674 ERROR("INLINE_LOCATION",
5675 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005676 }
5677
Andy Whitcroft8905a672007-11-28 16:21:06 -08005678# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005679 if ($realfile !~ m@\binclude/uapi/@ &&
5680 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005681 if (WARN("INLINE",
5682 "plain inline is preferred over $1\n" . $herecurr) &&
5683 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005684 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005685
5686 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005687 }
5688
Joe Perches3d130fd2011-01-12 17:00:00 -08005689# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005690 if ($realfile !~ m@\binclude/uapi/@ &&
5691 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005692 WARN("PREFER_PACKED",
5693 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005694 }
5695
Joe Perches39b7e282011-07-25 17:13:24 -07005696# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005697 if ($realfile !~ m@\binclude/uapi/@ &&
5698 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005699 WARN("PREFER_ALIGNED",
5700 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005701 }
5702
Joe Perches5f14d3b2012-01-10 15:09:52 -08005703# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005704 if ($realfile !~ m@\binclude/uapi/@ &&
5705 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005706 if (WARN("PREFER_PRINTF",
5707 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5708 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005709 $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 -07005710
5711 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005712 }
5713
Joe Perches6061d942012-03-23 15:02:16 -07005714# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005715 if ($realfile !~ m@\binclude/uapi/@ &&
5716 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005717 if (WARN("PREFER_SCANF",
5718 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5719 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005720 $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 -07005721 }
Joe Perches6061d942012-03-23 15:02:16 -07005722 }
5723
Joe Perches619a9082014-12-10 15:51:35 -08005724# Check for __attribute__ weak, or __weak declarations (may have link issues)
5725 if ($^V && $^V ge 5.10.0 &&
5726 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5727 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5728 $line =~ /\b__weak\b/)) {
5729 ERROR("WEAK_DECLARATION",
5730 "Using weak declarations can have unintended link defects\n" . $herecurr);
5731 }
5732
Tomas Winklerfd39f902016-12-12 16:46:34 -08005733# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005734 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005735 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005736 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5737 my $type = $1;
5738 if ($type =~ /\b($typeC99Typedefs)\b/) {
5739 $type = $1;
5740 my $kernel_type = 'u';
5741 $kernel_type = 's' if ($type =~ /^_*[si]/);
5742 $type =~ /(\d+)/;
5743 $kernel_type .= $1;
5744 if (CHK("PREFER_KERNEL_TYPES",
5745 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5746 $fix) {
5747 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5748 }
5749 }
5750 }
5751
Joe Perches938224b2016-01-20 14:59:15 -08005752# check for cast of C90 native int or longer types constants
5753 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5754 my $cast = $1;
5755 my $const = $2;
5756 if (WARN("TYPECAST_INT_CONSTANT",
5757 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5758 $fix) {
5759 my $suffix = "";
5760 my $newconst = $const;
5761 $newconst =~ s/${Int_type}$//;
5762 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5763 if ($cast =~ /\blong\s+long\b/) {
5764 $suffix .= 'LL';
5765 } elsif ($cast =~ /\blong\b/) {
5766 $suffix .= 'L';
5767 }
5768 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5769 }
5770 }
5771
Joe Perches8f53a9b2010-03-05 13:43:48 -08005772# check for sizeof(&)
5773 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005774 WARN("SIZEOF_ADDRESS",
5775 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005776 }
5777
Joe Perches66c80b62012-07-30 14:41:22 -07005778# check for sizeof without parenthesis
5779 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005780 if (WARN("SIZEOF_PARENTHESIS",
5781 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5782 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005783 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005784 }
Joe Perches66c80b62012-07-30 14:41:22 -07005785 }
5786
Joe Perches88982fe2012-12-17 16:02:00 -08005787# check for struct spinlock declarations
5788 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5789 WARN("USE_SPINLOCK_T",
5790 "struct spinlock should be spinlock_t\n" . $herecurr);
5791 }
5792
Joe Perchesa6962d72013-04-29 16:18:13 -07005793# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005794 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005795 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005796 $fmt =~ s/%%//g;
5797 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005798 if (WARN("PREFER_SEQ_PUTS",
5799 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5800 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005801 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005802 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005803 }
5804 }
5805
Joe Perches0b523762017-05-08 15:55:36 -07005806 # check for vsprintf extension %p<foo> misuses
5807 if ($^V && $^V ge 5.10.0 &&
5808 defined $stat &&
5809 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5810 $1 !~ /^_*volatile_*$/) {
5811 my $bad_extension = "";
5812 my $lc = $stat =~ tr@\n@@;
5813 $lc = $lc + $linenr;
5814 for (my $count = $linenr; $count <= $lc; $count++) {
5815 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5816 $fmt =~ s/%%//g;
Linus Torvaldsab486bc2018-02-01 13:36:15 -08005817 if ($fmt =~ /(\%[\*\d\.]*p(?![\WSsBKRraEhMmIiUDdgVCbGNOx]).)/) {
Joe Perches0b523762017-05-08 15:55:36 -07005818 $bad_extension = $1;
5819 last;
5820 }
5821 }
5822 if ($bad_extension ne "") {
5823 my $stat_real = raw_line($linenr, 0);
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005824 my $ext_type = "Invalid";
5825 my $use = "";
Joe Perches0b523762017-05-08 15:55:36 -07005826 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5827 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5828 }
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005829 if ($bad_extension =~ /p[Ff]/) {
5830 $ext_type = "Deprecated";
5831 $use = " - use %pS instead";
5832 $use =~ s/pS/ps/ if ($bad_extension =~ /pf/);
5833 }
Joe Perches0b523762017-05-08 15:55:36 -07005834 WARN("VSPRINTF_POINTER_EXTENSION",
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005835 "$ext_type vsprintf pointer extension '$bad_extension'$use\n" . "$here\n$stat_real\n");
Joe Perches0b523762017-05-08 15:55:36 -07005836 }
5837 }
5838
Andy Whitcroft554e1652012-01-10 15:09:57 -08005839# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005840 if ($^V && $^V ge 5.10.0 &&
5841 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005842 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005843
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005844 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005845 my $ms_val = $7;
5846 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005847
Andy Whitcroft554e1652012-01-10 15:09:57 -08005848 if ($ms_size =~ /^(0x|)0$/i) {
5849 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005850 "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 -08005851 } elsif ($ms_size =~ /^(0x|)1$/i) {
5852 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005853 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5854 }
5855 }
5856
Joe Perches98a9bba2014-01-23 15:54:52 -08005857# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005858# if ($^V && $^V ge 5.10.0 &&
5859# defined $stat &&
5860# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5861# if (WARN("PREFER_ETHER_ADDR_COPY",
5862# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5863# $fix) {
5864# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5865# }
5866# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005867
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005868# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005869# if ($^V && $^V ge 5.10.0 &&
5870# defined $stat &&
5871# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5872# WARN("PREFER_ETHER_ADDR_EQUAL",
5873# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5874# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005875
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005876# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5877# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf333195d2016-10-11 13:51:53 -07005878# if ($^V && $^V ge 5.10.0 &&
5879# defined $stat &&
5880# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5881#
5882# my $ms_val = $7;
5883#
5884# if ($ms_val =~ /^(?:0x|)0+$/i) {
5885# if (WARN("PREFER_ETH_ZERO_ADDR",
5886# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5887# $fix) {
5888# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5889# }
5890# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5891# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5892# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5893# $fix) {
5894# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5895# }
5896# }
5897# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005898
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005899# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005900 if ($^V && $^V ge 5.10.0 &&
5901 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005902 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005903 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005904 my $call = $1;
5905 my $cast1 = deparenthesize($2);
5906 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005907 my $cast2 = deparenthesize($7);
5908 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005909 my $cast;
5910
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005911 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005912 $cast = "$cast1 or $cast2";
5913 } elsif ($cast1 ne "") {
5914 $cast = $cast1;
5915 } else {
5916 $cast = $cast2;
5917 }
5918 WARN("MINMAX",
5919 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005920 }
5921 }
5922
Joe Perches4a273192012-07-30 14:41:20 -07005923# check usleep_range arguments
5924 if ($^V && $^V ge 5.10.0 &&
5925 defined $stat &&
5926 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5927 my $min = $1;
5928 my $max = $7;
5929 if ($min eq $max) {
5930 WARN("USLEEP_RANGE",
5931 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5932 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5933 $min > $max) {
5934 WARN("USLEEP_RANGE",
5935 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5936 }
5937 }
5938
Joe Perches823b7942013-11-12 15:10:15 -08005939# check for naked sscanf
5940 if ($^V && $^V ge 5.10.0 &&
5941 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005942 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005943 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5944 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5945 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5946 my $lc = $stat =~ tr@\n@@;
5947 $lc = $lc + $linenr;
5948 my $stat_real = raw_line($linenr, 0);
5949 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5950 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5951 }
5952 WARN("NAKED_SSCANF",
5953 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5954 }
5955
Joe Perchesafc819a2014-06-04 16:12:08 -07005956# check for simple sscanf that should be kstrto<foo>
5957 if ($^V && $^V ge 5.10.0 &&
5958 defined $stat &&
5959 $line =~ /\bsscanf\b/) {
5960 my $lc = $stat =~ tr@\n@@;
5961 $lc = $lc + $linenr;
5962 my $stat_real = raw_line($linenr, 0);
5963 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5964 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5965 }
5966 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5967 my $format = $6;
5968 my $count = $format =~ tr@%@%@;
5969 if ($count == 1 &&
5970 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5971 WARN("SSCANF_TO_KSTRTO",
5972 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5973 }
5974 }
5975 }
5976
Joe Perches70dc8a42013-09-11 14:23:58 -07005977# check for new externs in .h files.
5978 if ($realfile =~ /\.h$/ &&
5979 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005980 if (CHK("AVOID_EXTERNS",
5981 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005982 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005983 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005984 }
5985 }
5986
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005987# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005988 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005989 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005990 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005991 my $function_name = $1;
5992 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005993
5994 my $s = $stat;
5995 if (defined $cond) {
5996 substr($s, 0, length($cond), '');
5997 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005998 if ($s =~ /^\s*;/ &&
5999 $function_name ne 'uninitialized_var')
6000 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006001 WARN("AVOID_EXTERNS",
6002 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006003 }
6004
6005 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006006 WARN("FUNCTION_ARGUMENTS",
6007 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006008 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006009
6010 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6011 $stat =~ /^.\s*extern\s+/)
6012 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006013 WARN("AVOID_EXTERNS",
6014 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006015 }
6016
Joe Perchesa0ad7592017-07-10 15:52:19 -07006017# check for function declarations that have arguments without identifier names
6018 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006019 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006020 $1 ne "void") {
6021 my $args = trim($1);
6022 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6023 my $arg = trim($1);
6024 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6025 WARN("FUNCTION_ARGUMENTS",
6026 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6027 }
6028 }
6029 }
6030
Joe Perchesa0ad7592017-07-10 15:52:19 -07006031# check for function definitions
6032 if ($^V && $^V ge 5.10.0 &&
6033 defined $stat &&
6034 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6035 $context_function = $1;
6036
6037# check for multiline function definition with misplaced open brace
6038 my $ok = 0;
6039 my $cnt = statement_rawlines($stat);
6040 my $herectx = $here . "\n";
6041 for (my $n = 0; $n < $cnt; $n++) {
6042 my $rl = raw_line($linenr, $n);
6043 $herectx .= $rl . "\n";
6044 $ok = 1 if ($rl =~ /^[ \+]\{/);
6045 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6046 last if $rl =~ /^[ \+].*\{/;
6047 }
6048 if (!$ok) {
6049 ERROR("OPEN_BRACE",
6050 "open brace '{' following function definitions go on the next line\n" . $herectx);
6051 }
6052 }
6053
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006054# checks for new __setup's
6055 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6056 my $name = $1;
6057
6058 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006059 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006060 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006061 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006062 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006063
6064# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08006065 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006066 WARN("UNNECESSARY_CASTS",
6067 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006068 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006069
Joe Perchesa640d252013-07-03 15:05:21 -07006070# alloc style
6071# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6072 if ($^V && $^V ge 5.10.0 &&
6073 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6074 CHK("ALLOC_SIZEOF_STRUCT",
6075 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6076 }
6077
Joe Perches60a55362014-06-04 16:12:07 -07006078# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6079 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006080 defined $stat &&
6081 $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 -07006082 my $oldfunc = $3;
6083 my $a1 = $4;
6084 my $a2 = $10;
6085 my $newfunc = "kmalloc_array";
6086 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006087 my $r1 = $a1;
6088 my $r2 = $a2;
6089 if ($a1 =~ /^sizeof\s*\S/) {
6090 $r1 = $a2;
6091 $r2 = $a1;
6092 }
6093 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6094 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006095 my $ctx = '';
6096 my $herectx = $here . "\n";
6097 my $cnt = statement_rawlines($stat);
6098 for (my $n = 0; $n < $cnt; $n++) {
6099 $herectx .= raw_line($linenr, $n) . "\n";
6100 }
Joe Perches60a55362014-06-04 16:12:07 -07006101 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006102 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6103 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006104 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006105 $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 -07006106 }
6107 }
6108 }
6109
Joe Perches972fdea2013-04-29 16:18:12 -07006110# check for krealloc arg reuse
6111 if ($^V && $^V ge 5.10.0 &&
6112 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6113 WARN("KREALLOC_ARG_REUSE",
6114 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6115 }
6116
Joe Perches5ce59ae2013-02-21 16:44:18 -08006117# check for alloc argument mismatch
6118 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6119 WARN("ALLOC_ARRAY_ARGS",
6120 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6121 }
6122
Joe Perchescaf2a542011-01-12 16:59:56 -08006123# check for multiple semicolons
6124 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006125 if (WARN("ONE_SEMICOLON",
6126 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6127 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006128 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006129 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006130 }
6131
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006132# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6133 if ($realfile !~ m@^include/uapi/@ &&
6134 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006135 my $ull = "";
6136 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6137 if (CHK("BIT_MACRO",
6138 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6139 $fix) {
6140 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6141 }
6142 }
6143
Joe Perches2d632742016-05-20 17:04:00 -07006144# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6145 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6146 my $config = $1;
6147 if (WARN("PREFER_IS_ENABLED",
6148 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6149 $fix) {
6150 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6151 }
6152 }
6153
Joe Perchese81f2392014-08-06 16:11:25 -07006154# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006155 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6156 my $has_break = 0;
6157 my $has_statement = 0;
6158 my $count = 0;
6159 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006160 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006161 $prevline--;
6162 my $rline = $rawlines[$prevline - 1];
6163 my $fline = $lines[$prevline - 1];
6164 last if ($fline =~ /^\@\@/);
6165 next if ($fline =~ /^\-/);
6166 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6167 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6168 next if ($fline =~ /^.[\s$;]*$/);
6169 $has_statement = 1;
6170 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006171 $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 -08006172 }
6173 if (!$has_break && $has_statement) {
6174 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006175 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006176 }
6177 }
6178
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006179# check for switch/default statements without a break;
6180 if ($^V && $^V ge 5.10.0 &&
6181 defined $stat &&
6182 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6183 my $ctx = '';
6184 my $herectx = $here . "\n";
6185 my $cnt = statement_rawlines($stat);
6186 for (my $n = 0; $n < $cnt; $n++) {
6187 $herectx .= raw_line($linenr, $n) . "\n";
6188 }
6189 WARN("DEFAULT_NO_BREAK",
6190 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006191 }
6192
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006193# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006194 if ($line =~ /\b__FUNCTION__\b/) {
6195 if (WARN("USE_FUNC",
6196 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6197 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006198 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006199 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006200 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006201
Joe Perches62ec8182015-02-13 14:38:18 -08006202# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6203 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6204 ERROR("DATE_TIME",
6205 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6206 }
6207
Joe Perches2c924882012-03-23 15:02:20 -07006208# check for use of yield()
6209 if ($line =~ /\byield\s*\(\s*\)/) {
6210 WARN("YIELD",
6211 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6212 }
6213
Joe Perches179f8f42013-07-03 15:05:30 -07006214# check for comparisons against true and false
6215 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6216 my $lead = $1;
6217 my $arg = $2;
6218 my $test = $3;
6219 my $otype = $4;
6220 my $trail = $5;
6221 my $op = "!";
6222
6223 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6224
6225 my $type = lc($otype);
6226 if ($type =~ /^(?:true|false)$/) {
6227 if (("$test" eq "==" && "$type" eq "true") ||
6228 ("$test" eq "!=" && "$type" eq "false")) {
6229 $op = "";
6230 }
6231
6232 CHK("BOOL_COMPARISON",
6233 "Using comparison to $otype is error prone\n" . $herecurr);
6234
6235## maybe suggesting a correct construct would better
6236## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6237
6238 }
6239 }
6240
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006241# check for semaphores initialized locked
6242 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006243 WARN("CONSIDER_COMPLETION",
6244 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006245 }
Joe Perches6712d852012-03-23 15:02:20 -07006246
Joe Perches67d0a072011-10-31 17:13:10 -07006247# recommend kstrto* over simple_strto* and strict_strto*
6248 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006249 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006250 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006251 }
Joe Perches6712d852012-03-23 15:02:20 -07006252
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006253# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006254 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006255 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006256 "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 -07006257 }
Joe Perches6712d852012-03-23 15:02:20 -07006258
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006259# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006260# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006261 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006262 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006263 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006264 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006265 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006266
6267# use of NR_CPUS is usually wrong
6268# ignore definitions of NR_CPUS and usage to define arrays as likely right
6269 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006270 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6271 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006272 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6273 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6274 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006275 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006276 WARN("NR_CPUS",
6277 "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 -07006278 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006279
Joe Perches52ea8502013-11-12 15:10:09 -08006280# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6281 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6282 ERROR("DEFINE_ARCH_HAS",
6283 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6284 }
6285
Joe Perchesacd93622015-02-13 14:38:38 -08006286# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6287 if ($^V && $^V ge 5.10.0 &&
6288 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6289 WARN("LIKELY_MISUSE",
6290 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6291 }
6292
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006293# whine mightly about in_atomic
6294 if ($line =~ /\bin_atomic\s*\(/) {
6295 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006296 ERROR("IN_ATOMIC",
6297 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006298 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006299 WARN("IN_ATOMIC",
6300 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006301 }
6302 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006303
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006304# check for mutex_trylock_recursive usage
6305 if ($line =~ /mutex_trylock_recursive/) {
6306 ERROR("LOCKING",
6307 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6308 }
6309
Peter Zijlstra1704f472010-03-19 01:37:42 +01006310# check for lockdep_set_novalidate_class
6311 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6312 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6313 if ($realfile !~ m@^kernel/lockdep@ &&
6314 $realfile !~ m@^include/linux/lockdep@ &&
6315 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006316 ERROR("LOCKDEP",
6317 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006318 }
6319 }
Dave Jones88f88312011-01-12 16:59:59 -08006320
Joe Perchesb392c642015-04-16 12:44:16 -07006321 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6322 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006323 WARN("EXPORTED_WORLD_WRITABLE",
6324 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006325 }
Joe Perches24358802014-04-03 14:49:13 -07006326
Joe Perches00180462018-02-06 15:38:55 -08006327# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6328# and whether or not function naming is typical and if
6329# DEVICE_ATTR permissions uses are unusual too
6330 if ($^V && $^V ge 5.10.0 &&
6331 defined $stat &&
6332 $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*\)/) {
6333 my $var = $1;
6334 my $perms = $2;
6335 my $show = $3;
6336 my $store = $4;
6337 my $octal_perms = perms_to_octal($perms);
6338 if ($show =~ /^${var}_show$/ &&
6339 $store =~ /^${var}_store$/ &&
6340 $octal_perms eq "0644") {
6341 if (WARN("DEVICE_ATTR_RW",
6342 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6343 $fix) {
6344 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6345 }
6346 } elsif ($show =~ /^${var}_show$/ &&
6347 $store =~ /^NULL$/ &&
6348 $octal_perms eq "0444") {
6349 if (WARN("DEVICE_ATTR_RO",
6350 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6351 $fix) {
6352 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6353 }
6354 } elsif ($show =~ /^NULL$/ &&
6355 $store =~ /^${var}_store$/ &&
6356 $octal_perms eq "0200") {
6357 if (WARN("DEVICE_ATTR_WO",
6358 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6359 $fix) {
6360 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6361 }
6362 } elsif ($octal_perms eq "0644" ||
6363 $octal_perms eq "0444" ||
6364 $octal_perms eq "0200") {
6365 my $newshow = "$show";
6366 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6367 my $newstore = $store;
6368 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6369 my $rename = "";
6370 if ($show ne $newshow) {
6371 $rename .= " '$show' to '$newshow'";
6372 }
6373 if ($store ne $newstore) {
6374 $rename .= " '$store' to '$newstore'";
6375 }
6376 WARN("DEVICE_ATTR_FUNCTIONS",
6377 "Consider renaming function(s)$rename\n" . $herecurr);
6378 } else {
6379 WARN("DEVICE_ATTR_PERMS",
6380 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6381 }
6382 }
6383
Joe Perches515a2352014-04-03 14:49:24 -07006384# Mode permission misuses where it seems decimal should be octal
6385# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006386# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6387# specific definition of not visible in sysfs.
6388# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6389# use the default permissions
Joe Perches515a2352014-04-03 14:49:24 -07006390 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006391 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006392 $line =~ /$mode_perms_search/) {
6393 foreach my $entry (@mode_permission_funcs) {
6394 my $func = $entry->[0];
6395 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006396
Joe Perches459cf0a2016-10-11 13:52:19 -07006397 my $lc = $stat =~ tr@\n@@;
6398 $lc = $lc + $linenr;
6399 my $stat_real = raw_line($linenr, 0);
6400 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6401 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6402 }
6403
Joe Perches515a2352014-04-03 14:49:24 -07006404 my $skip_args = "";
6405 if ($arg_pos > 1) {
6406 $arg_pos--;
6407 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6408 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006409 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006410 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006411 my $val = $1;
6412 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006413 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6414 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6415 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006416 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006417 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006418 }
6419 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006420 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006421 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006422 }
Joe Perches24358802014-04-03 14:49:13 -07006423 }
6424 }
6425 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006426
Joe Perches459cf0a2016-10-11 13:52:19 -07006427# check for uses of S_<PERMS> that could be octal for readability
Joe Perches00180462018-02-06 15:38:55 -08006428 if ($line =~ /\b($multi_mode_perms_string_search)\b/) {
6429 my $oval = $1;
6430 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006431 if (WARN("SYMBOLIC_PERMS",
6432 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6433 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006434 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006435 }
6436 }
6437
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006438# validate content of MODULE_LICENSE against list from include/linux/module.h
6439 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6440 my $extracted_string = get_quoted_string($line, $rawline);
6441 my $valid_licenses = qr{
6442 GPL|
6443 GPL\ v2|
6444 GPL\ and\ additional\ rights|
6445 Dual\ BSD/GPL|
6446 Dual\ MIT/GPL|
6447 Dual\ MPL/GPL|
6448 Proprietary
6449 }x;
6450 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6451 WARN("MODULE_LICENSE",
6452 "unknown module license " . $extracted_string . "\n" . $herecurr);
6453 }
6454 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006455 }
6456
6457 # If we have no input at all, then there is nothing to report on
6458 # so just keep quiet.
6459 if ($#rawlines == -1) {
6460 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006461 }
6462
Andy Whitcroft8905a672007-11-28 16:21:06 -08006463 # In mailback mode only produce a report in the negative, for
6464 # things that appear to be patches.
6465 if ($mailback && ($clean == 1 || !$is_patch)) {
6466 exit(0);
6467 }
6468
6469 # This is not a patch, and we are are in 'no-patch' mode so
6470 # just keep quiet.
6471 if (!$chk_patch && !$is_patch) {
6472 exit(0);
6473 }
6474
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006475 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006476 ERROR("NOT_UNIFIED_DIFF",
6477 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006478 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006479 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006480 ERROR("MISSING_SIGN_OFF",
6481 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006482 }
6483
Andy Whitcroft8905a672007-11-28 16:21:06 -08006484 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006485 if ($summary && !($clean == 1 && $quiet == 1)) {
6486 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006487 print "total: $cnt_error errors, $cnt_warn warnings, " .
6488 (($check)? "$cnt_chk checks, " : "") .
6489 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006490 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006491
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006492 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006493 # If there were any defects found and not already fixing them
6494 if (!$clean and !$fix) {
6495 print << "EOM"
6496
6497NOTE: For some of the reported defects, checkpatch may be able to
6498 mechanically convert to the typical style using --fix or --fix-inplace.
6499EOM
6500 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006501 # If there were whitespace errors which cleanpatch can fix
6502 # then suggest that.
6503 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006504 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006505 print << "EOM"
6506
6507NOTE: Whitespace errors detected.
6508 You may wish to use scripts/cleanpatch or scripts/cleanfile
6509EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006510 }
6511 }
6512
Joe Perchesd752fcc2014-08-06 16:11:05 -07006513 if ($clean == 0 && $fix &&
6514 ("@rawlines" ne "@fixed" ||
6515 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006516 my $newfile = $filename;
6517 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006518 my $linecount = 0;
6519 my $f;
6520
Joe Perchesd752fcc2014-08-06 16:11:05 -07006521 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6522
Joe Perches3705ce52013-07-03 15:05:31 -07006523 open($f, '>', $newfile)
6524 or die "$P: Can't open $newfile for write\n";
6525 foreach my $fixed_line (@fixed) {
6526 $linecount++;
6527 if ($file) {
6528 if ($linecount > 3) {
6529 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006530 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006531 }
6532 } else {
6533 print $f $fixed_line . "\n";
6534 }
6535 }
6536 close($f);
6537
6538 if (!$quiet) {
6539 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006540
Joe Perches3705ce52013-07-03 15:05:31 -07006541Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6542
6543Do _NOT_ trust the results written to this file.
6544Do _NOT_ submit these changes without inspecting them for correctness.
6545
6546This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6547No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006548EOM
6549 }
6550 }
6551
Joe Perchesd8469f12015-06-25 15:03:00 -07006552 if ($quiet == 0) {
6553 print "\n";
6554 if ($clean == 1) {
6555 print "$vname has no obvious style problems and is ready for submission.\n";
6556 } else {
6557 print "$vname has style problems, please review.\n";
6558 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006559 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006560 return $clean;
6561}