blob: 54b782fab4fd7dade07bf8ef4000e7e60bcee740 [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;
1078 $formatted_email =~ s/$address.*$//;
1079 $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
Andy Whitcroft773647a2008-03-28 14:15:58 -07002260 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002261 my $line;
2262 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002263 $linenr++;
2264 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002265
Joe Perches3705ce52013-07-03 15:05:31 -07002266 push(@fixed, $rawline) if ($fix);
2267
Andy Whitcroft773647a2008-03-28 14:15:58 -07002268 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002269 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002270 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002271 $setup_docs = 1;
2272 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002273 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002274 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002275 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002276 $realline=$1-1;
2277 if (defined $2) {
2278 $realcnt=$3+1;
2279 } else {
2280 $realcnt=1+1;
2281 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002282 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002283
2284 # Guestimate if this is a continuing comment. Run
2285 # the context looking for a comment "edge". If this
2286 # edge is a close comment then we must be in a comment
2287 # at context start.
2288 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002289 my $cnt = $realcnt;
2290 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2291 next if (defined $rawlines[$ln - 1] &&
2292 $rawlines[$ln - 1] =~ /^-/);
2293 $cnt--;
2294 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002295 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002296 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2297 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2298 ($edge) = $1;
2299 last;
2300 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002301 }
2302 if (defined $edge && $edge eq '*/') {
2303 $in_comment = 1;
2304 }
2305
2306 # Guestimate if this is a continuing comment. If this
2307 # is the start of a diff block and this line starts
2308 # ' *' then it is very likely a comment.
2309 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002310 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002311 {
2312 $in_comment = 1;
2313 }
2314
2315 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2316 sanitise_line_reset($in_comment);
2317
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002318 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002319 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002320 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002321 $line = sanitise_line($rawline);
2322 }
2323 push(@lines, $line);
2324
2325 if ($realcnt > 1) {
2326 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2327 } else {
2328 $realcnt = 0;
2329 }
2330
2331 #print "==>$rawline\n";
2332 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002333
2334 if ($setup_docs && $line =~ /^\+/) {
2335 push(@setup_docs, $line);
2336 }
2337 }
2338
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002339 $prefix = '';
2340
Andy Whitcroft773647a2008-03-28 14:15:58 -07002341 $realcnt = 0;
2342 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002343 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002344 foreach my $line (@lines) {
2345 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002346 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002347 my $sline = $line; #copy of $line
2348 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002349
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002350 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002351
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002352#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002353 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002354 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2355 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002356 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002357 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002358 $realline=$1-1;
2359 if (defined $2) {
2360 $realcnt=$3+1;
2361 } else {
2362 $realcnt=1+1;
2363 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002364 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002365 $prev_values = 'E';
2366
Andy Whitcroft773647a2008-03-28 14:15:58 -07002367 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002368 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002369 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002370 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002371 if ($context =~ /\b(\w+)\s*\(/) {
2372 $context_function = $1;
2373 } else {
2374 undef $context_function;
2375 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002376 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002377
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002378# track the line number as we move through the hunk, note that
2379# new versions of GNU diff omit the leading space on completely
2380# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002381 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002382 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002383 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002384
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002385 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002386 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002387
2388 # Track the previous line.
2389 ($prevline, $stashline) = ($stashline, $line);
2390 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002391 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2392
Andy Whitcroft773647a2008-03-28 14:15:58 -07002393 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002394
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002395 } elsif ($realcnt == 1) {
2396 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002397 }
2398
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002399 my $hunk_line = ($realcnt != 0);
2400
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002401 $here = "#$linenr: " if (!$file);
2402 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002403
Joe Perches2ac73b42014-06-04 16:12:05 -07002404 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002405 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002406 if ($line =~ /^diff --git.*?(\S+)$/) {
2407 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002408 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002409 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002410 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002411 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002412 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002413 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002414 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002415
2416 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002417 if (!$file && $tree && $p1_prefix ne '' &&
2418 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002419 WARN("PATCH_PREFIX",
2420 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002421 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002422
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002423 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002424 ERROR("MODIFIED_INCLUDE_ASM",
2425 "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 -07002426 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002427 $found_file = 1;
2428 }
2429
Joe Perches34d88152015-06-25 15:03:05 -07002430#make up the handle for any error we report on this line
2431 if ($showfile) {
2432 $prefix = "$realfile:$realline: "
2433 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002434 if ($file) {
2435 $prefix = "$filename:$realline: ";
2436 } else {
2437 $prefix = "$filename:$linenr: ";
2438 }
Joe Perches34d88152015-06-25 15:03:05 -07002439 }
2440
Joe Perches2ac73b42014-06-04 16:12:05 -07002441 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002442 if (is_maintained_obsolete($realfile)) {
2443 WARN("OBSOLETE",
2444 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2445 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002446 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002447 $check = 1;
2448 } else {
2449 $check = $check_orig;
2450 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002451 next;
2452 }
2453
Randy Dunlap389834b2007-06-08 13:47:03 -07002454 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002455
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002456 my $hereline = "$here\n$rawline\n";
2457 my $herecurr = "$here\n$rawline\n";
2458 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002459
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002460 $cnt_lines++ if ($realcnt != 0);
2461
Joe Perchese518e9a2015-06-25 15:03:27 -07002462# Check if the commit log has what seems like a diff which can confuse patch
2463 if ($in_commit_log && !$commit_log_has_diff &&
2464 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2465 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2466 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2467 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2468 ERROR("DIFF_IN_COMMIT_MSG",
2469 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2470 $commit_log_has_diff = 1;
2471 }
2472
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002473# Check for incorrect file permissions
2474 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2475 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002476 if ($realfile !~ m@scripts/@ &&
2477 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002478 ERROR("EXECUTE_PERMISSIONS",
2479 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002480 }
2481 }
2482
Joe Perches20112472011-07-25 17:13:23 -07002483# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002484 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002485 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002486 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002487 }
2488
Joe Perchese0d975b2014-12-10 15:51:49 -08002489# Check if MAINTAINERS is being updated. If so, there's probably no need to
2490# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2491 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2492 $reported_maintainer_file = 1;
2493 }
2494
Joe Perches20112472011-07-25 17:13:23 -07002495# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002496 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002497 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002498 my $space_before = $1;
2499 my $sign_off = $2;
2500 my $space_after = $3;
2501 my $email = $4;
2502 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2503
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002504 if ($sign_off !~ /$signature_tags/) {
2505 WARN("BAD_SIGN_OFF",
2506 "Non-standard signature: $sign_off\n" . $herecurr);
2507 }
Joe Perches20112472011-07-25 17:13:23 -07002508 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002509 if (WARN("BAD_SIGN_OFF",
2510 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2511 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002512 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002513 "$ucfirst_sign_off $email";
2514 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002515 }
Joe Perches20112472011-07-25 17:13:23 -07002516 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002517 if (WARN("BAD_SIGN_OFF",
2518 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2519 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002520 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002521 "$ucfirst_sign_off $email";
2522 }
2523
Joe Perches20112472011-07-25 17:13:23 -07002524 }
2525 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002526 if (WARN("BAD_SIGN_OFF",
2527 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2528 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002529 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002530 "$ucfirst_sign_off $email";
2531 }
Joe Perches20112472011-07-25 17:13:23 -07002532 }
2533
2534 my ($email_name, $email_address, $comment) = parse_email($email);
2535 my $suggested_email = format_email(($email_name, $email_address));
2536 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002537 ERROR("BAD_SIGN_OFF",
2538 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002539 } else {
2540 my $dequoted = $suggested_email;
2541 $dequoted =~ s/^"//;
2542 $dequoted =~ s/" </ </;
2543 # Don't force email to have quotes
2544 # Allow just an angle bracketed address
2545 if ("$dequoted$comment" ne $email &&
2546 "<$email_address>$comment" ne $email &&
2547 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002548 WARN("BAD_SIGN_OFF",
2549 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002550 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002551 }
Joe Perches7e51f192013-09-11 14:23:57 -07002552
2553# Check for duplicate signatures
2554 my $sig_nospace = $line;
2555 $sig_nospace =~ s/\s//g;
2556 $sig_nospace = lc($sig_nospace);
2557 if (defined $signatures{$sig_nospace}) {
2558 WARN("BAD_SIGN_OFF",
2559 "Duplicate signature\n" . $herecurr);
2560 } else {
2561 $signatures{$sig_nospace} = 1;
2562 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002563 }
2564
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002565# Check email subject for common tools that don't need to be mentioned
2566 if ($in_header_lines &&
2567 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2568 WARN("EMAIL_SUBJECT",
2569 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2570 }
2571
Joe Perches9b3189e2014-06-04 16:12:10 -07002572# Check for old stable address
2573 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2574 ERROR("STABLE_ADDRESS",
2575 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2576 }
2577
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002578# Check for unwanted Gerrit info
2579 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2580 ERROR("GERRIT_CHANGE_ID",
2581 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2582 }
2583
Joe Perches369c8dd2015-11-06 16:31:34 -08002584# Check if the commit log is in a possible stack dump
2585 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2586 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2587 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2588 # timestamp
2589 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2590 # stack dump address
2591 $commit_log_possible_stack_dump = 1;
2592 }
2593
Joe Perches2a076f42015-04-16 12:44:28 -07002594# Check for line lengths > 75 in commit log, warn once
2595 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002596 length($line) > 75 &&
2597 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2598 # file delta changes
2599 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2600 # filename then :
2601 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2602 # A Fixes: or Link: line
2603 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002604 WARN("COMMIT_LOG_LONG_LINE",
2605 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2606 $commit_log_long_line = 1;
2607 }
2608
Joe Perchesbf4daf12015-09-09 15:37:50 -07002609# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002610 if ($in_commit_log && $commit_log_possible_stack_dump &&
2611 $line =~ /^\s*$/) {
2612 $commit_log_possible_stack_dump = 0;
2613 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002614
Joe Perches0d7835f2015-02-13 14:38:35 -08002615# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002616 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002617 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002618 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002619 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002620 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002621 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2622 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002623 my $init_char = "c";
2624 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002625 my $short = 1;
2626 my $long = 0;
2627 my $case = 1;
2628 my $space = 1;
2629 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002630 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002631 my $id = '0123456789ab';
2632 my $orig_desc = "commit description";
2633 my $description = "";
2634
Joe Perchesfe043ea2015-09-09 15:37:25 -07002635 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2636 $init_char = $1;
2637 $orig_commit = lc($2);
2638 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2639 $orig_commit = lc($1);
2640 }
2641
Joe Perches0d7835f2015-02-13 14:38:35 -08002642 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2643 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2644 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2645 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2646 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2647 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002648 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002649 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2650 defined $rawlines[$linenr] &&
2651 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2652 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002653 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002654 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2655 defined $rawlines[$linenr] &&
2656 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2657 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2658 $orig_desc = $1;
2659 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2660 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002661 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002662 }
2663
2664 ($id, $description) = git_commit_info($orig_commit,
2665 $id, $orig_desc);
2666
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002667 if (defined($id) &&
2668 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002669 ERROR("GIT_COMMIT_ID",
2670 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2671 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002672 }
2673
Joe Perches13f19372014-08-06 16:10:59 -07002674# Check for added, moved or deleted files
2675 if (!$reported_maintainer_file && !$in_commit_log &&
2676 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2677 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2678 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2679 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002680 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002681 $reported_maintainer_file = 1;
2682 WARN("FILE_PATH_CHANGES",
2683 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2684 }
2685
Andy Whitcroft00df3442007-06-08 13:47:06 -07002686# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002687 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002688 ERROR("CORRUPTED_PATCH",
2689 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002690 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002691 }
2692
2693# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2694 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002695 $rawline !~ m/^$UTF8*$/) {
2696 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2697
2698 my $blank = copy_spacing($rawline);
2699 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2700 my $hereptr = "$hereline$ptr\n";
2701
Joe Perches34d99212011-07-25 17:13:26 -07002702 CHK("INVALID_UTF8",
2703 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002704 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002705
Joe Perches15662b32011-10-31 17:13:12 -07002706# Check if it's the start of a commit log
2707# (not a header line and we haven't seen the patch filename)
2708 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002709 !($rawline =~ /^\s+(?:\S|$)/ ||
2710 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002711 $in_header_lines = 0;
2712 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002713 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002714 }
2715
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002716# Check if there is UTF-8 in a commit log when a mail header has explicitly
2717# declined it, i.e defined some charset where it is missing.
2718 if ($in_header_lines &&
2719 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2720 $1 !~ /utf-8/i) {
2721 $non_utf8_charset = 1;
2722 }
2723
2724 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002725 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002726 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002727 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2728 }
2729
Joe Perchesd6430f72016-12-12 16:46:28 -08002730# Check for absolute kernel paths in commit message
2731 if ($tree && $in_commit_log) {
2732 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2733 my $file = $1;
2734
2735 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2736 check_absolute_file($1, $herecurr)) {
2737 #
2738 } else {
2739 check_absolute_file($file, $herecurr);
2740 }
2741 }
2742 }
2743
Kees Cook66b47b42014-10-13 15:51:57 -07002744# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002745 if (defined($misspellings) &&
2746 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002747 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002748 my $typo = $1;
2749 my $typo_fix = $spelling_fix{lc($typo)};
2750 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2751 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002752 my $msg_level = \&WARN;
2753 $msg_level = \&CHK if ($file);
2754 if (&{$msg_level}("TYPO_SPELLING",
2755 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002756 $fix) {
2757 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2758 }
2759 }
2760 }
2761
Andy Whitcroft306708542008-10-15 22:02:28 -07002762# ignore non-hunk lines and lines being removed
2763 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002764
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002765#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002766 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002767 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002768 if (ERROR("DOS_LINE_ENDINGS",
2769 "DOS line endings\n" . $herevet) &&
2770 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002771 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002772 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002773 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2774 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002775 if (ERROR("TRAILING_WHITESPACE",
2776 "trailing whitespace\n" . $herevet) &&
2777 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002778 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002779 }
2780
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002781 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002782 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002783
Josh Triplett4783f892013-11-12 15:10:12 -08002784# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002785 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002786 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002787 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2788 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002789 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002790 my $msg_level = \&ERROR;
2791 $msg_level = \&CHK if ($file);
2792 &{$msg_level}("FSF_MAILING_ADDRESS",
2793 "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 -08002794 }
2795
Andi Kleen33549572010-05-24 14:33:29 -07002796# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002797# Only applies when adding the entry originally, after that we do not have
2798# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002799 if ($realfile =~ /Kconfig/ &&
Ulf Magnusson678ae162018-02-16 21:22:54 +01002800 # 'choice' is usually the last thing on the line (though
2801 # Kconfig supports named choices), so use a word boundary
2802 # (\b) rather than a whitespace character (\s)
2803 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) {
Andi Kleen33549572010-05-24 14:33:29 -07002804 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002805 my $cnt = $realcnt;
2806 my $ln = $linenr + 1;
2807 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002808 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002809 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002810 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002811 $f = $lines[$ln - 1];
2812 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2813 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002814
2815 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002816 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002817
Ulf Magnusson86adf1a2018-02-16 21:22:53 +01002818 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002819 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002820 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002821 $length = -1;
2822 }
2823
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002824 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002825 $f =~ s/#.*//;
2826 $f =~ s/^\s+//;
2827 next if ($f =~ /^$/);
Ulf Magnusson678ae162018-02-16 21:22:54 +01002828
2829 # This only checks context lines in the patch
2830 # and so hopefully shouldn't trigger false
2831 # positives, even though some of these are
2832 # common words in help texts
2833 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice|
2834 if|endif|menu|endmenu|source)\b/x) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002835 $is_end = 1;
2836 last;
2837 }
Andi Kleen33549572010-05-24 14:33:29 -07002838 $length++;
2839 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002840 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2841 WARN("CONFIG_DESCRIPTION",
2842 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2843 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002844 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002845 }
2846
Joe Perches628f91a2017-07-10 15:52:07 -07002847# check for MAINTAINERS entries that don't have the right form
2848 if ($realfile =~ /^MAINTAINERS$/ &&
2849 $rawline =~ /^\+[A-Z]:/ &&
2850 $rawline !~ /^\+[A-Z]:\t\S/) {
2851 if (WARN("MAINTAINERS_STYLE",
2852 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2853 $fix) {
2854 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2855 }
2856 }
2857
Christoph Jaeger327953e2015-02-13 14:38:29 -08002858# discourage the use of boolean for type definition attributes of Kconfig options
2859 if ($realfile =~ /Kconfig/ &&
2860 $line =~ /^\+\s*\bboolean\b/) {
2861 WARN("CONFIG_TYPE_BOOLEAN",
2862 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2863 }
2864
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002865 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2866 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2867 my $flag = $1;
2868 my $replacement = {
2869 'EXTRA_AFLAGS' => 'asflags-y',
2870 'EXTRA_CFLAGS' => 'ccflags-y',
2871 'EXTRA_CPPFLAGS' => 'cppflags-y',
2872 'EXTRA_LDFLAGS' => 'ldflags-y',
2873 };
2874
2875 WARN("DEPRECATED_VARIABLE",
2876 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2877 }
2878
Rob Herringbff5da42014-01-23 15:54:51 -08002879# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002880 if (defined $root &&
2881 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2882 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2883
Rob Herringbff5da42014-01-23 15:54:51 -08002884 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2885
Florian Vaussardcc933192014-04-03 14:49:27 -07002886 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2887 my $vp_file = $dt_path . "vendor-prefixes.txt";
2888
Rob Herringbff5da42014-01-23 15:54:51 -08002889 foreach my $compat (@compats) {
2890 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002891 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2892 my $compat3 = $compat;
2893 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2894 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002895 if ( $? >> 8 ) {
2896 WARN("UNDOCUMENTED_DT_STRING",
2897 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2898 }
2899
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002900 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2901 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002902 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002903 if ( $? >> 8 ) {
2904 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002905 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002906 }
2907 }
2908 }
2909
Andy Whitcroft5368df202008-10-15 22:02:27 -07002910# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002911 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002912
Joe Perches47e0c882015-06-25 15:02:57 -07002913# line length limit (with some exclusions)
2914#
2915# There are a few types of lines that may extend beyond $max_line_length:
2916# logging functions like pr_info that end in a string
2917# lines with a single string
2918# #defines that are a single string
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002919# lines with an RFC3986 like URL
Joe Perches47e0c882015-06-25 15:02:57 -07002920#
2921# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002922# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002923# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2924# LONG_LINE all other lines longer than $max_line_length
2925#
2926# if LONG_LINE is ignored, the other 2 types are also ignored
2927#
2928
Joe Perchesb4749e92015-07-17 16:24:01 -07002929 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002930 my $msg_type = "LONG_LINE";
2931
2932 # Check the allowed long line types first
2933
2934 # logging functions that end in a string that starts
2935 # before $max_line_length
2936 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2937 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2938 $msg_type = "";
2939
2940 # lines with only strings (w/ possible termination)
2941 # #defines with only strings
2942 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2943 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2944 $msg_type = "";
2945
Joe Perchescc147502017-11-17 15:28:44 -08002946 # More special cases
2947 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
2948 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07002949 $msg_type = "";
2950
Andreas Brauchli2e4bbbc2018-02-06 15:38:45 -08002951 # URL ($rawline is used in case the URL is in a comment)
2952 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) {
2953 $msg_type = "";
2954
Joe Perches47e0c882015-06-25 15:02:57 -07002955 # Otherwise set the alternate message types
2956
2957 # a comment starts before $max_line_length
2958 } elsif ($line =~ /($;[\s$;]*)$/ &&
2959 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2960 $msg_type = "LONG_LINE_COMMENT"
2961
2962 # a quoted string starts before $max_line_length
2963 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2964 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2965 $msg_type = "LONG_LINE_STRING"
2966 }
2967
2968 if ($msg_type ne "" &&
2969 (show_type("LONG_LINE") || show_type($msg_type))) {
2970 WARN($msg_type,
2971 "line over $max_line_length characters\n" . $herecurr);
2972 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002973 }
2974
Andy Whitcroft8905a672007-11-28 16:21:06 -08002975# check for adding lines without a newline.
2976 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002977 WARN("MISSING_EOF_NEWLINE",
2978 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002979 }
2980
Mike Frysinger42e41c52009-09-21 17:04:40 -07002981# Blackfin: use hi/lo macros
2982 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2983 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2984 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002985 ERROR("LO_MACRO",
2986 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002987 }
2988 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2989 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002990 ERROR("HI_MACRO",
2991 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002992 }
2993 }
2994
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002995# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002996 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002997
2998# at the beginning of a line any tabs must come first and anything
2999# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003000 if ($rawline =~ /^\+\s* \t\s*\S/ ||
3001 $rawline =~ /^\+\s* \s*/) {
3002 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07003003 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003004 if (ERROR("CODE_INDENT",
3005 "code indent should use tabs where possible\n" . $herevet) &&
3006 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003007 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003008 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003009 }
3010
Alberto Panizzo08e44362010-03-05 13:43:54 -08003011# check for space before tabs.
3012 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
3013 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003014 if (WARN("SPACE_BEFORE_TAB",
3015 "please, no space before tabs\n" . $herevet) &&
3016 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003017 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07003018 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07003019 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08003020 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07003021 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08003022 }
3023
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003024# check for && or || at the start of a line
3025 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3026 CHK("LOGICAL_CONTINUATIONS",
3027 "Logical continuations should be on the previous line\n" . $hereprev);
3028 }
3029
Joe Perchesa91e8992016-05-20 17:04:05 -07003030# check indentation starts on a tab stop
3031 if ($^V && $^V ge 5.10.0 &&
Joe Perchesbd491112018-02-06 15:39:06 -08003032 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
Joe Perchesa91e8992016-05-20 17:04:05 -07003033 my $indent = length($1);
3034 if ($indent % 8) {
3035 if (WARN("TABSTOP",
3036 "Statements should start on a tabstop\n" . $herecurr) &&
3037 $fix) {
3038 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3039 }
3040 }
3041 }
3042
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003043# check multi-line statement indentation matches previous line
3044 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07003045 $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 -07003046 $prevline =~ /^\+(\t*)(.*)$/;
3047 my $oldindent = $1;
3048 my $rest = $2;
3049
3050 my $pos = pos_last_openparen($rest);
3051 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003052 $line =~ /^(\+| )([ \t]*)/;
3053 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003054
3055 my $goodtabindent = $oldindent .
3056 "\t" x ($pos / 8) .
3057 " " x ($pos % 8);
3058 my $goodspaceindent = $oldindent . " " x $pos;
3059
3060 if ($newindent ne $goodtabindent &&
3061 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003062
3063 if (CHK("PARENTHESIS_ALIGNMENT",
3064 "Alignment should match open parenthesis\n" . $hereprev) &&
3065 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003066 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003067 s/^\+[ \t]*/\+$goodtabindent/;
3068 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003069 }
3070 }
3071 }
3072
Joe Perches6ab3a972015-04-16 12:44:05 -07003073# check for space after cast like "(int) foo" or "(struct foo) bar"
3074# avoid checking a few false positives:
3075# "sizeof(<type>)" or "__alignof__(<type>)"
3076# function pointer declarations like "(*foo)(int) = bar;"
3077# structure definitions like "(struct foo) { 0 };"
3078# multiline macros that define functions
3079# known attributes or the __attribute__ keyword
3080 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3081 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003082 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003083 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003084 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003085 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003086 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003087 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003088 }
3089
Joe Perches86406b12015-09-09 15:37:41 -07003090# Block comment styles
3091# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003092 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003093 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003094 $rawline =~ /^\+[ \t]*\*/ &&
3095 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003096 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3097 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3098 }
3099
Joe Perches86406b12015-09-09 15:37:41 -07003100# Block comments use * on subsequent lines
3101 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3102 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003103 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003104 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003105 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003106 WARN("BLOCK_COMMENT_STYLE",
3107 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003108 }
3109
Joe Perches86406b12015-09-09 15:37:41 -07003110# Block comments use */ on trailing lines
3111 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003112 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3113 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3114 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003115 WARN("BLOCK_COMMENT_STYLE",
3116 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003117 }
3118
Joe Perches08eb9b82016-10-11 13:51:50 -07003119# Block comment * alignment
3120 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003121 $line =~ /^\+[ \t]*$;/ && #leading comment
3122 $rawline =~ /^\+[ \t]*\*/ && #leading *
3123 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003124 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003125 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3126 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003127 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003128 if (defined($1)) {
3129 $oldindent = expand_tabs($1);
3130 } else {
3131 $prevrawline =~ m@^\+(.*/?)\*@;
3132 $oldindent = expand_tabs($1);
3133 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003134 $rawline =~ m@^\+([ \t]*)\*@;
3135 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003136 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003137 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003138 WARN("BLOCK_COMMENT_STYLE",
3139 "Block comments should align the * on each line\n" . $hereprev);
3140 }
3141 }
3142
Joe Perches7f619192014-08-06 16:10:39 -07003143# check for missing blank lines after struct/union declarations
3144# with exceptions for various attributes and macros
3145 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3146 $line =~ /^\+/ &&
3147 !($line =~ /^\+\s*$/ ||
3148 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3149 $line =~ /^\+\s*MODULE_/i ||
3150 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3151 $line =~ /^\+[a-z_]*init/ ||
3152 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3153 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003154 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003155 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003156 if (CHK("LINE_SPACING",
3157 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3158 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003159 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003160 }
Joe Perches7f619192014-08-06 16:10:39 -07003161 }
3162
Joe Perches365dd4e2014-08-06 16:10:42 -07003163# check for multiple consecutive blank lines
3164 if ($prevline =~ /^[\+ ]\s*$/ &&
3165 $line =~ /^\+\s*$/ &&
3166 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003167 if (CHK("LINE_SPACING",
3168 "Please don't use multiple blank lines\n" . $hereprev) &&
3169 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003170 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003171 }
3172
Joe Perches365dd4e2014-08-06 16:10:42 -07003173 $last_blank_line = $linenr;
3174 }
3175
Joe Perches3b617e32014-04-03 14:49:28 -07003176# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003177 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3178 # actual declarations
3179 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003180 # function pointer declarations
3181 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003182 # foo bar; where foo is some local typedef or #define
3183 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3184 # known declaration macros
3185 $prevline =~ /^\+\s+$declaration_macros/) &&
3186 # for "else if" which can look like "$Ident $Ident"
3187 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3188 # other possible extensions of declaration lines
3189 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3190 # not starting a section or a macro "\" extended line
3191 $prevline =~ /(?:\{\s*|\\)$/) &&
3192 # looks like a declaration
3193 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003194 # function pointer declarations
3195 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003196 # foo bar; where foo is some local typedef or #define
3197 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3198 # known declaration macros
3199 $sline =~ /^\+\s+$declaration_macros/ ||
3200 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003201 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003202 # start or end of block or continuation of declaration
3203 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3204 # bitfield continuation
3205 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3206 # other possible extensions of declaration lines
3207 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3208 # indentation of previous and current line are the same
3209 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003210 if (WARN("LINE_SPACING",
3211 "Missing a blank line after declarations\n" . $hereprev) &&
3212 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003213 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003214 }
Joe Perches3b617e32014-04-03 14:49:28 -07003215 }
3216
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003217# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003218# Exceptions:
3219# 1) within comments
3220# 2) indented preprocessor commands
3221# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003222 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003223 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003224 if (WARN("LEADING_SPACE",
3225 "please, no spaces at the start of a line\n" . $herevet) &&
3226 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003227 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003228 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003229 }
3230
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003231# check we are in a valid C source file if not then ignore this hunk
3232 next if ($realfile !~ /\.(h|c)$/);
3233
Joe Perches5751a242017-11-17 15:28:52 -08003234# check for unusual line ending [ or (
3235 if ($line =~ /^\+.*([\[\(])\s*$/) {
3236 CHK("OPEN_ENDED_LINE",
3237 "Lines should not end with a '$1'\n" . $herecurr);
3238 }
3239
Joe Perches4dbed762017-05-08 15:55:39 -07003240# check if this appears to be the start function declaration, save the name
3241 if ($sline =~ /^\+\{\s*$/ &&
3242 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3243 $context_function = $1;
3244 }
3245
3246# check if this appears to be the end of function declaration
3247 if ($sline =~ /^\+\}\s*$/) {
3248 undef $context_function;
3249 }
3250
Joe Perches032a4c02014-08-06 16:10:29 -07003251# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003252# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003253# if the previous line is a break or return and is indented 1 tab more...
3254 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3255 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003256 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3257 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3258 defined $lines[$linenr] &&
3259 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003260 WARN("UNNECESSARY_ELSE",
3261 "else is not generally useful after a break or return\n" . $hereprev);
3262 }
3263 }
3264
Joe Perchesc00df192014-08-06 16:11:01 -07003265# check indentation of a line with a break;
3266# if the previous line is a goto or return and is indented the same # of tabs
3267 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3268 my $tabs = $1;
3269 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3270 WARN("UNNECESSARY_BREAK",
3271 "break is not useful after a goto or return\n" . $hereprev);
3272 }
3273 }
3274
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003275# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003276 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003277 WARN("CVS_KEYWORD",
3278 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003279 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003280
Mike Frysinger42e41c52009-09-21 17:04:40 -07003281# Blackfin: don't use __builtin_bfin_[cs]sync
3282 if ($line =~ /__builtin_bfin_csync/) {
3283 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003284 ERROR("CSYNC",
3285 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003286 }
3287 if ($line =~ /__builtin_bfin_ssync/) {
3288 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003289 ERROR("SSYNC",
3290 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003291 }
3292
Joe Perches56e77d72013-02-21 16:44:14 -08003293# check for old HOTPLUG __dev<foo> section markings
3294 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3295 WARN("HOTPLUG_SECTION",
3296 "Using $1 is unnecessary\n" . $herecurr);
3297 }
3298
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003299# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003300 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3301 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003302#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003303 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003304 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003305 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003306 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003307 $stat =~ s/\n./\n /g;
3308 $cond =~ s/\n./\n /g;
3309
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003310#print "linenr<$linenr> <$stat>\n";
3311 # If this statement has no statement boundaries within
3312 # it there is no point in retrying a statement scan
3313 # until we hit end of it.
3314 my $frag = $stat; $frag =~ s/;+\s*$//;
3315 if ($frag !~ /(?:{|;)/) {
3316#print "skip<$line_nr_next>\n";
3317 $suppress_statement = $line_nr_next;
3318 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003319
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003320 # Find the real next line.
3321 $realline_next = $line_nr_next;
3322 if (defined $realline_next &&
3323 (!defined $lines[$realline_next - 1] ||
3324 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3325 $realline_next++;
3326 }
3327
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003328 my $s = $stat;
3329 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003330
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003331 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003332 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003333
3334 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003335 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003336
Andy Whitcroft463f2862009-09-21 17:04:34 -07003337 } elsif ($s =~ /^.\s*else\b/s) {
3338
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003339 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003340 } 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 -07003341 my $type = $1;
3342 $type =~ s/\s+/ /g;
3343 possible($type, "A:" . $s);
3344
Andy Whitcroft8905a672007-11-28 16:21:06 -08003345 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003346 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003347 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003348 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003349
3350 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003351 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003352 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003353 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003354
3355 # Check for any sort of function declaration.
3356 # int foo(something bar, other baz);
3357 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003358 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 -08003359 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003360
Andy Whitcroftcf655042008-03-04 14:28:20 -08003361 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003362 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003363 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003364
Andy Whitcroft8905a672007-11-28 16:21:06 -08003365 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003366 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003367
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003368 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003369 }
3370 }
3371 }
3372
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003373 }
3374
Andy Whitcroft653d4872007-06-23 17:16:34 -07003375#
3376# Checks which may be anchored in the context.
3377#
3378
3379# Check for switch () and associated case and default
3380# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003381 if ($line=~/\bswitch\s*\(.*\)/) {
3382 my $err = '';
3383 my $sep = '';
3384 my @ctx = ctx_block_outer($linenr, $realcnt);
3385 shift(@ctx);
3386 for my $ctx (@ctx) {
3387 my ($clen, $cindent) = line_stats($ctx);
3388 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3389 $indent != $cindent) {
3390 $err .= "$sep$ctx\n";
3391 $sep = '';
3392 } else {
3393 $sep = "[...]\n";
3394 }
3395 }
3396 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003397 ERROR("SWITCH_CASE_INDENT_LEVEL",
3398 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003399 }
3400 }
3401
3402# if/while/etc brace do not go on next line, unless defining a do while loop,
3403# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003404 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 -07003405 my $pre_ctx = "$1$2";
3406
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003407 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003408
3409 if ($line =~ /^\+\t{6,}/) {
3410 WARN("DEEP_INDENTATION",
3411 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3412 }
3413
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003414 my $ctx_cnt = $realcnt - $#ctx - 1;
3415 my $ctx = join("\n", @ctx);
3416
Andy Whitcroft548596d2008-07-23 21:29:01 -07003417 my $ctx_ln = $linenr;
3418 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003419
Andy Whitcroft548596d2008-07-23 21:29:01 -07003420 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3421 defined $lines[$ctx_ln - 1] &&
3422 $lines[$ctx_ln - 1] =~ /^-/)) {
3423 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3424 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003425 $ctx_ln++;
3426 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003427
Andy Whitcroft53210162008-07-23 21:29:03 -07003428 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3429 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003430
Joe Perchesd752fcc2014-08-06 16:11:05 -07003431 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003432 ERROR("OPEN_BRACE",
3433 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003434 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003435 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003436 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3437 $ctx =~ /\)\s*\;\s*$/ &&
3438 defined $lines[$ctx_ln - 1])
3439 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003440 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3441 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003442 WARN("TRAILING_SEMICOLON",
3443 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003444 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003445 }
3446 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003447 }
3448
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003449# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003450 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 -08003451 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3452 ctx_statement_block($linenr, $realcnt, 0)
3453 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003454 my ($s, $c) = ($stat, $cond);
3455
3456 substr($s, 0, length($c), '');
3457
Joe Perches9f5af482015-09-09 15:37:30 -07003458 # remove inline comments
3459 $s =~ s/$;/ /g;
3460 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003461
3462 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003463 my @newlines = ($c =~ /\n/gs);
3464 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003465
Joe Perches9f5af482015-09-09 15:37:30 -07003466 # Make sure we remove the line prefixes as we have
3467 # none on the first line, and are going to readd them
3468 # where necessary.
3469 $s =~ s/\n./\n/gs;
3470 while ($s =~ /\n\s+\\\n/) {
3471 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3472 }
3473
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003474 # We want to check the first line inside the block
3475 # starting at the end of the conditional, so remove:
3476 # 1) any blank line termination
3477 # 2) any opening brace { on end of the line
3478 # 3) any do (...) {
3479 my $continuation = 0;
3480 my $check = 0;
3481 $s =~ s/^.*\bdo\b//;
3482 $s =~ s/^\s*{//;
3483 if ($s =~ s/^\s*\\//) {
3484 $continuation = 1;
3485 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003486 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003487 $check = 1;
3488 $cond_lines++;
3489 }
3490
3491 # Also ignore a loop construct at the end of a
3492 # preprocessor statement.
3493 if (($prevline =~ /^.\s*#\s*define\s/ ||
3494 $prevline =~ /\\\s*$/) && $continuation == 0) {
3495 $check = 0;
3496 }
3497
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003498 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003499 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003500 while ($cond_ptr != $cond_lines) {
3501 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003502
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003503 # If we see an #else/#elif then the code
3504 # is not linear.
3505 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3506 $check = 0;
3507 }
3508
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003509 # Ignore:
3510 # 1) blank lines, they should be at 0,
3511 # 2) preprocessor lines, and
3512 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003513 if ($continuation ||
3514 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003515 $s =~ /^\s*#\s*?/ ||
3516 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003517 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003518 if ($s =~ s/^.*?\n//) {
3519 $cond_lines++;
3520 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003521 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003522 }
3523
3524 my (undef, $sindent) = line_stats("+" . $s);
3525 my $stat_real = raw_line($linenr, $cond_lines);
3526
3527 # Check if either of these lines are modified, else
3528 # this is not this patch's fault.
3529 if (!defined($stat_real) ||
3530 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3531 $check = 0;
3532 }
3533 if (defined($stat_real) && $cond_lines > 1) {
3534 $stat_real = "[...]\n$stat_real";
3535 }
3536
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003537 #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 -07003538
Joe Perches9f5af482015-09-09 15:37:30 -07003539 if ($check && $s ne '' &&
3540 (($sindent % 8) != 0 ||
3541 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003542 ($sindent == $indent &&
3543 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003544 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003545 WARN("SUSPECT_CODE_INDENT",
3546 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003547 }
3548 }
3549
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003550 # Track the 'values' across context and added lines.
3551 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003552 my ($curr_values, $curr_vars) =
3553 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003554 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003555 if ($dbg_values) {
3556 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003557 print "$linenr > .$outline\n";
3558 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003559 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003560 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003561 $prev_values = substr($curr_values, -1);
3562
Andy Whitcroft00df3442007-06-08 13:47:06 -07003563#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003564 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003565
Joe Perches11ca40a2016-12-12 16:46:31 -08003566# check for dereferences that span multiple lines
3567 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3568 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3569 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3570 my $ref = $1;
3571 $line =~ /^.\s*($Lval)/;
3572 $ref .= $1;
3573 $ref =~ s/\s//g;
3574 WARN("MULTILINE_DEREFERENCE",
3575 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3576 }
3577
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003578# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003579 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 -07003580 my $type = $1;
3581 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003582 $var = "" if (!defined $var);
3583 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003584 my $sign = $1;
3585 my $pointer = $2;
3586
3587 $pointer = "" if (!defined $pointer);
3588
3589 if (WARN("UNSPECIFIED_INT",
3590 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3591 $fix) {
3592 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003593 my $comp_pointer = $pointer;
3594 $comp_pointer =~ s/\s//g;
3595 $decl .= $comp_pointer;
3596 $decl = rtrim($decl) if ($var eq "");
3597 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003598 }
3599 }
3600 }
3601
Andy Whitcroft653d4872007-06-23 17:16:34 -07003602# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003603 if ($dbg_type) {
3604 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003605 ERROR("TEST_TYPE",
3606 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003607 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003608 ERROR("TEST_NOT_TYPE",
3609 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003610 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003611 next;
3612 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003613# TEST: allow direct testing of the attribute matcher.
3614 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003615 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003616 ERROR("TEST_ATTR",
3617 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003618 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003619 ERROR("TEST_NOT_ATTR",
3620 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003621 }
3622 next;
3623 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003624
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003625# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003626 if ($line =~ /^.\s*{/ &&
3627 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003628 if (ERROR("OPEN_BRACE",
3629 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003630 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3631 fix_delete_line($fixlinenr - 1, $prevrawline);
3632 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003633 my $fixedline = $prevrawline;
3634 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003635 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003636 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003637 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003638 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003639 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003640 }
3641
Andy Whitcroft653d4872007-06-23 17:16:34 -07003642#
3643# Checks which are anchored on the added line.
3644#
3645
3646# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003647 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003648 my $path = $1;
3649 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003650 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003651 "malformed #include filename\n" . $herecurr);
3652 }
3653 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3654 ERROR("UAPI_INCLUDE",
3655 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003656 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003657 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003658
3659# no C99 // comments
3660 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003661 if (ERROR("C99_COMMENTS",
3662 "do not use C99 // comments\n" . $herecurr) &&
3663 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003664 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003665 if ($line =~ /\/\/(.*)$/) {
3666 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003667 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003668 }
3669 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003670 }
3671 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003672 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003673 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003674
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003675# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3676# the whole statement.
3677#print "APW <$lines[$realline_next - 1]>\n";
3678 if (defined $realline_next &&
3679 exists $lines[$realline_next - 1] &&
3680 !defined $suppress_export{$realline_next} &&
3681 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3682 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003683 # Handle definitions which produce identifiers with
3684 # a prefix:
3685 # XXX(foo);
3686 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003687 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003688 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003689 $name =~ /^${Ident}_$2/) {
3690#print "FOO C name<$name>\n";
3691 $suppress_export{$realline_next} = 1;
3692
3693 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003694 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003695 ^.DEFINE_$Ident\(\Q$name\E\)|
3696 ^.DECLARE_$Ident\(\Q$name\E\)|
3697 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003698 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3699 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003700 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003701#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3702 $suppress_export{$realline_next} = 2;
3703 } else {
3704 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003705 }
3706 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003707 if (!defined $suppress_export{$linenr} &&
3708 $prevline =~ /^.\s*$/ &&
3709 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3710 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3711#print "FOO B <$lines[$linenr - 1]>\n";
3712 $suppress_export{$linenr} = 2;
3713 }
3714 if (defined $suppress_export{$linenr} &&
3715 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003716 WARN("EXPORT_SYMBOL",
3717 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003718 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003719
Joe Eloff5150bda2010-08-09 17:21:00 -07003720# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003721 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003722 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003723 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003724 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003725 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003726 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003727 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003728# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003729 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003730 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003731 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003732 $herecurr) &&
3733 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003734 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003735 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003736 }
3737
Joe Perches18130872014-08-06 16:11:22 -07003738# check for misordered declarations of char/short/int/long with signed/unsigned
3739 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3740 my $tmp = trim($1);
3741 WARN("MISORDERED_TYPE",
3742 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3743 }
3744
Joe Perchescb710ec2010-10-26 14:23:20 -07003745# check for static const char * arrays.
3746 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003747 WARN("STATIC_CONST_CHAR_ARRAY",
3748 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003749 $herecurr);
3750 }
3751
3752# check for static char foo[] = "bar" declarations.
3753 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003754 WARN("STATIC_CONST_CHAR_ARRAY",
3755 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003756 $herecurr);
3757 }
3758
Joe Perchesab7e23f2015-04-16 12:44:22 -07003759# check for const <foo> const where <foo> is not a pointer or array type
3760 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3761 my $found = $1;
3762 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3763 WARN("CONST_CONST",
3764 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3765 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3766 WARN("CONST_CONST",
3767 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3768 }
3769 }
3770
Joe Perches9b0fa602014-04-03 14:49:18 -07003771# check for non-global char *foo[] = {"bar", ...} declarations.
3772 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3773 WARN("STATIC_CONST_CHAR_ARRAY",
3774 "char * array declaration might be better as static const\n" .
3775 $herecurr);
3776 }
3777
Joe Perchesb598b672015-04-16 12:44:36 -07003778# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3779 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3780 my $array = $1;
3781 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3782 my $array_div = $1;
3783 if (WARN("ARRAY_SIZE",
3784 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3785 $fix) {
3786 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3787 }
3788 }
3789 }
3790
Joe Perchesb36190c2014-01-27 17:07:18 -08003791# check for function declarations without arguments like "int foo()"
3792 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3793 if (ERROR("FUNCTION_WITHOUT_ARGS",
3794 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3795 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003796 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003797 }
3798 }
3799
Andy Whitcroft653d4872007-06-23 17:16:34 -07003800# check for new typedefs, only function parameters and sparse annotations
3801# make sense.
3802 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003803 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003804 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003805 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003806 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003807 WARN("NEW_TYPEDEFS",
3808 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003809 }
3810
3811# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003812 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003813 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3814 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003815 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003816
Andy Whitcroft65863862009-01-06 14:41:21 -08003817 # Should start with a space.
3818 $to =~ s/^(\S)/ $1/;
3819 # Should not end with a space.
3820 $to =~ s/\s+$//;
3821 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003822 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003823 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003824
Joe Perches3705ce52013-07-03 15:05:31 -07003825## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003826 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003827 if (ERROR("POINTER_LOCATION",
3828 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3829 $fix) {
3830 my $sub_from = $ident;
3831 my $sub_to = $ident;
3832 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003833 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003834 s@\Q$sub_from\E@$sub_to@;
3835 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003836 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003837 }
3838 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3839 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003840 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003841
Andy Whitcroft65863862009-01-06 14:41:21 -08003842 # Should start with a space.
3843 $to =~ s/^(\S)/ $1/;
3844 # Should not end with a space.
3845 $to =~ s/\s+$//;
3846 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003847 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003848 }
3849 # Modifiers should have spaces.
3850 $to =~ s/(\b$Modifier$)/$1 /;
3851
Joe Perches3705ce52013-07-03 15:05:31 -07003852## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003853 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003854 if (ERROR("POINTER_LOCATION",
3855 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3856 $fix) {
3857
3858 my $sub_from = $match;
3859 my $sub_to = $match;
3860 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003861 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003862 s@\Q$sub_from\E@$sub_to@;
3863 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003864 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003865 }
3866
Joe Perches9d3e3c72015-09-09 15:37:27 -07003867# avoid BUG() or BUG_ON()
3868 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003869 my $msg_level = \&WARN;
3870 $msg_level = \&CHK if ($file);
3871 &{$msg_level}("AVOID_BUG",
3872 "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 -07003873 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003874
Joe Perches9d3e3c72015-09-09 15:37:27 -07003875# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003876 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003877 WARN("LINUX_VERSION_CODE",
3878 "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 -08003879 }
3880
Joe Perches17441222011-06-15 15:08:17 -07003881# check for uses of printk_ratelimit
3882 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003883 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003884 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003885 }
3886
Joe Percheseeef5732017-11-17 15:28:41 -08003887# printk should use KERN_* levels
3888 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3889 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3890 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003891 }
3892
Joe Perches243f3802012-05-31 16:26:09 -07003893 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3894 my $orig = $1;
3895 my $level = lc($orig);
3896 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003897 my $level2 = $level;
3898 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003899 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003900 "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 -07003901 }
3902
3903 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003904 if (WARN("PREFER_PR_LEVEL",
3905 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3906 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003907 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003908 s/\bpr_warning\b/pr_warn/;
3909 }
Joe Perches243f3802012-05-31 16:26:09 -07003910 }
3911
Joe Perchesdc139312013-02-21 16:44:13 -08003912 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3913 my $orig = $1;
3914 my $level = lc($orig);
3915 $level = "warn" if ($level eq "warning");
3916 $level = "dbg" if ($level eq "debug");
3917 WARN("PREFER_DEV_LEVEL",
3918 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3919 }
3920
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003921# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3922# number of false positives, but assembly files are not checked, so at
3923# least the arch entry code will not trigger this warning.
3924 if ($line =~ /\bENOSYS\b/) {
3925 WARN("ENOSYS",
3926 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3927 }
3928
Andy Whitcroft653d4872007-06-23 17:16:34 -07003929# function brace can't be on same line, except for #defines of do while,
3930# or if closed on same line
Joe Perches2d453e32018-02-06 15:39:09 -08003931 if ($^V && $^V ge 5.10.0 &&
3932 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ &&
3933 $sline !~ /\#\s*define\b.*do\s*\{/ &&
3934 $sline !~ /}/) {
Joe Perches8d182472014-08-06 16:11:12 -07003935 if (ERROR("OPEN_BRACE",
Joe Perches2d453e32018-02-06 15:39:09 -08003936 "open brace '{' following function definitions go on the next line\n" . $herecurr) &&
Joe Perches8d182472014-08-06 16:11:12 -07003937 $fix) {
3938 fix_delete_line($fixlinenr, $rawline);
3939 my $fixed_line = $rawline;
3940 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3941 my $line1 = $1;
3942 my $line2 = $2;
3943 fix_insert_line($fixlinenr, ltrim($line1));
3944 fix_insert_line($fixlinenr, "\+{");
3945 if ($line2 !~ /^\s*$/) {
3946 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3947 }
3948 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003949 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003950
Andy Whitcroft8905a672007-11-28 16:21:06 -08003951# open braces for enum, union and struct go on the same line.
3952 if ($line =~ /^.\s*{/ &&
3953 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003954 if (ERROR("OPEN_BRACE",
3955 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3956 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3957 fix_delete_line($fixlinenr - 1, $prevrawline);
3958 fix_delete_line($fixlinenr, $rawline);
3959 my $fixedline = rtrim($prevrawline) . " {";
3960 fix_insert_line($fixlinenr, $fixedline);
3961 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003962 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003963 if ($fixedline !~ /^\+\s*$/) {
3964 fix_insert_line($fixlinenr, $fixedline);
3965 }
3966 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003967 }
3968
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003969# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003970 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3971 if (WARN("SPACING",
3972 "missing space after $1 definition\n" . $herecurr) &&
3973 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003974 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003975 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3976 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003977 }
3978
Joe Perches31070b52014-01-23 15:54:49 -08003979# Function pointer declarations
3980# check spacing between type, funcptr, and args
3981# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003982 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003983 my $declare = $1;
3984 my $pre_pointer_space = $2;
3985 my $post_pointer_space = $3;
3986 my $funcname = $4;
3987 my $post_funcname_space = $5;
3988 my $pre_args_space = $6;
3989
Joe Perches91f72e92014-04-03 14:49:12 -07003990# the $Declare variable will capture all spaces after the type
3991# so check it for a missing trailing missing space but pointer return types
3992# don't need a space so don't warn for those.
3993 my $post_declare_space = "";
3994 if ($declare =~ /(\s+)$/) {
3995 $post_declare_space = $1;
3996 $declare = rtrim($declare);
3997 }
3998 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003999 WARN("SPACING",
4000 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07004001 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08004002 }
4003
4004# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07004005# This test is not currently implemented because these declarations are
4006# equivalent to
4007# int foo(int bar, ...)
4008# and this is form shouldn't/doesn't generate a checkpatch warning.
4009#
4010# elsif ($declare =~ /\s{2,}$/) {
4011# WARN("SPACING",
4012# "Multiple spaces after return type\n" . $herecurr);
4013# }
Joe Perches31070b52014-01-23 15:54:49 -08004014
4015# unnecessary space "type ( *funcptr)(args...)"
4016 if (defined $pre_pointer_space &&
4017 $pre_pointer_space =~ /^\s/) {
4018 WARN("SPACING",
4019 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
4020 }
4021
4022# unnecessary space "type (* funcptr)(args...)"
4023 if (defined $post_pointer_space &&
4024 $post_pointer_space =~ /^\s/) {
4025 WARN("SPACING",
4026 "Unnecessary space before function pointer name\n" . $herecurr);
4027 }
4028
4029# unnecessary space "type (*funcptr )(args...)"
4030 if (defined $post_funcname_space &&
4031 $post_funcname_space =~ /^\s/) {
4032 WARN("SPACING",
4033 "Unnecessary space after function pointer name\n" . $herecurr);
4034 }
4035
4036# unnecessary space "type (*funcptr) (args...)"
4037 if (defined $pre_args_space &&
4038 $pre_args_space =~ /^\s/) {
4039 WARN("SPACING",
4040 "Unnecessary space before function pointer arguments\n" . $herecurr);
4041 }
4042
4043 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004044 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004045 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004046 }
4047 }
4048
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004049# check for spacing round square brackets; allowed:
4050# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004051# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4052# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004053 while ($line =~ /(.*?\s)\[/g) {
4054 my ($where, $prefix) = ($-[1], $1);
4055 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004056 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004057 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004058 if (ERROR("BRACKET_SPACE",
4059 "space prohibited before open square bracket '['\n" . $herecurr) &&
4060 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004061 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004062 s/^(\+.*?)\s+\[/$1\[/;
4063 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004064 }
4065 }
4066
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004067# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004068 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004069 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004070 my $ctx_before = substr($line, 0, $-[1]);
4071 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004072
4073 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004074 if ($name =~ /^(?:
4075 if|for|while|switch|return|case|
4076 volatile|__volatile__|
4077 __attribute__|format|__extension__|
4078 asm|__asm__)$/x)
4079 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004080 # cpp #define statements have non-optional spaces, ie
4081 # if there is a space between the name and the open
4082 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004083 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004084
4085 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004086 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004087
4088 # If this whole things ends with a type its most
4089 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004090 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004091
4092 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004093 if (WARN("SPACING",
4094 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4095 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004096 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004097 s/\b$name\s+\(/$name\(/;
4098 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004099 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004100 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004101
Andy Whitcroft653d4872007-06-23 17:16:34 -07004102# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004103 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004104 my $fixed_line = "";
4105 my $line_fixed = 0;
4106
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004107 my $ops = qr{
4108 <<=|>>=|<=|>=|==|!=|
4109 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4110 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004111 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004112 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004113 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004114 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004115
4116## print("element count: <" . $#elements . ">\n");
4117## foreach my $el (@elements) {
4118## print("el: <$el>\n");
4119## }
4120
4121 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004122 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004123
Joe Perches3705ce52013-07-03 15:05:31 -07004124 foreach my $el (@elements) {
4125 push(@fix_elements, substr($rawline, $off, length($el)));
4126 $off += length($el);
4127 }
4128
4129 $off = 0;
4130
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004131 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004132 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004133
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004134 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004135
4136 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4137
4138## print("n: <$n> good: <$good>\n");
4139
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004140 $off += length($elements[$n]);
4141
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004142 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004143 my $ca = substr($opline, 0, $off);
4144 my $cc = '';
4145 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4146 $cc = substr($opline, $off + length($elements[$n + 1]));
4147 }
4148 my $cb = "$ca$;$cc";
4149
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004150 my $a = '';
4151 $a = 'V' if ($elements[$n] ne '');
4152 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004153 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004154 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4155 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004156 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004157
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004158 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004159
4160 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004161 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004162 $c = 'V' if ($elements[$n + 2] ne '');
4163 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004164 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004165 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4166 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004167 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004168 } else {
4169 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004170 }
4171
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004172 my $ctx = "${a}x${c}";
4173
4174 my $at = "(ctx:$ctx)";
4175
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004176 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004177 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004178
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004179 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004180 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004181
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004182 # Get the full operator variant.
4183 my $opv = $op . substr($curr_vars, $off, 1);
4184
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004185 # Ignore operators passed as parameters.
4186 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004187 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004188
Andy Whitcroftcf655042008-03-04 14:28:20 -08004189# # Ignore comments
4190# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004191
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004192 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004193 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004194 if ($ctx !~ /.x[WEBC]/ &&
4195 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004196 if (ERROR("SPACING",
4197 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004198 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004199 $line_fixed = 1;
4200 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004201 }
4202
4203 # // is a comment
4204 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004205
Joe Perchesb00e4812014-04-03 14:49:33 -07004206 # : when part of a bitfield
4207 } elsif ($opv eq ':B') {
4208 # skip the bitfield test for now
4209
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004210 # No spaces for:
4211 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004212 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004213 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004214 if (ERROR("SPACING",
4215 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004216 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004217 if (defined $fix_elements[$n + 2]) {
4218 $fix_elements[$n + 2] =~ s/^\s+//;
4219 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004220 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004221 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004222 }
4223
Joe Perches23810972014-12-10 15:51:32 -08004224 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004225 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004226 my $rtrim_before = 0;
4227 my $space_after = 0;
4228 if ($ctx =~ /Wx./) {
4229 if (ERROR("SPACING",
4230 "space prohibited before that '$op' $at\n" . $hereptr)) {
4231 $line_fixed = 1;
4232 $rtrim_before = 1;
4233 }
4234 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004235 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004236 if (ERROR("SPACING",
4237 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004238 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004239 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004240 $space_after = 1;
4241 }
4242 }
4243 if ($rtrim_before || $space_after) {
4244 if ($rtrim_before) {
4245 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4246 } else {
4247 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4248 }
4249 if ($space_after) {
4250 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004251 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004252 }
4253
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004254 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004255 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004256 #warn "'*' is part of type\n";
4257
4258 # unary operators should have a space before and
4259 # none after. May be left adjacent to another
4260 # unary operator, or a cast
4261 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004262 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004263 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004264 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004265 if (ERROR("SPACING",
4266 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004267 if ($n != $last_after + 2) {
4268 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4269 $line_fixed = 1;
4270 }
Joe Perches3705ce52013-07-03 15:05:31 -07004271 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004272 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004273 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004274 # A unary '*' may be const
4275
4276 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004277 if (ERROR("SPACING",
4278 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004279 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004280 if (defined $fix_elements[$n + 2]) {
4281 $fix_elements[$n + 2] =~ s/^\s+//;
4282 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004283 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004284 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004285 }
4286
4287 # unary ++ and unary -- are allowed no space on one side.
4288 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004289 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004290 if (ERROR("SPACING",
4291 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004292 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004293 $line_fixed = 1;
4294 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004295 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004296 if ($ctx =~ /Wx[BE]/ ||
4297 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004298 if (ERROR("SPACING",
4299 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004300 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004301 $line_fixed = 1;
4302 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004303 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004304 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004305 if (ERROR("SPACING",
4306 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004307 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004308 if (defined $fix_elements[$n + 2]) {
4309 $fix_elements[$n + 2] =~ s/^\s+//;
4310 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004311 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004312 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004313 }
4314
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004315 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004316 } elsif ($op eq '<<' or $op eq '>>' or
4317 $op eq '&' or $op eq '^' or $op eq '|' or
4318 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004319 $op eq '*' or $op eq '/' or
4320 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004321 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004322 if ($check) {
4323 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4324 if (CHK("SPACING",
4325 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4326 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4327 $fix_elements[$n + 2] =~ s/^\s+//;
4328 $line_fixed = 1;
4329 }
4330 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4331 if (CHK("SPACING",
4332 "space preferred before that '$op' $at\n" . $hereptr)) {
4333 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4334 $line_fixed = 1;
4335 }
4336 }
4337 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004338 if (ERROR("SPACING",
4339 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004340 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4341 if (defined $fix_elements[$n + 2]) {
4342 $fix_elements[$n + 2] =~ s/^\s+//;
4343 }
Joe Perches3705ce52013-07-03 15:05:31 -07004344 $line_fixed = 1;
4345 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004346 }
4347
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004348 # A colon needs no spaces before when it is
4349 # terminating a case value or a label.
4350 } elsif ($opv eq ':C' || $opv eq ':L') {
4351 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004352 if (ERROR("SPACING",
4353 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004354 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004355 $line_fixed = 1;
4356 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004357 }
4358
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004359 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004360 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004361 my $ok = 0;
4362
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004363 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004364 if (($op eq '<' &&
4365 $cc =~ /^\S+\@\S+>/) ||
4366 ($op eq '>' &&
4367 $ca =~ /<\S+\@\S+$/))
4368 {
4369 $ok = 1;
4370 }
4371
Joe Perchese0df7e12015-04-16 12:44:53 -07004372 # for asm volatile statements
4373 # ignore a colon with another
4374 # colon immediately before or after
4375 if (($op eq ':') &&
4376 ($ca =~ /:$/ || $cc =~ /^:/)) {
4377 $ok = 1;
4378 }
4379
Joe Perches84731622013-11-12 15:10:05 -08004380 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004381 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004382 my $msg_level = \&ERROR;
4383 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004384
Jean Delvare0675a8f2017-09-08 16:16:07 -07004385 if (&{$msg_level}("SPACING",
4386 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004387 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4388 if (defined $fix_elements[$n + 2]) {
4389 $fix_elements[$n + 2] =~ s/^\s+//;
4390 }
Joe Perches3705ce52013-07-03 15:05:31 -07004391 $line_fixed = 1;
4392 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004393 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004394 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004395 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004396
4397## print("n: <$n> GOOD: <$good>\n");
4398
4399 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004400 }
Joe Perches3705ce52013-07-03 15:05:31 -07004401
4402 if (($#elements % 2) == 0) {
4403 $fixed_line = $fixed_line . $fix_elements[$#elements];
4404 }
4405
Joe Perches194f66f2014-08-06 16:11:03 -07004406 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4407 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004408 }
4409
4410
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004411 }
4412
Joe Perches786b6322013-07-03 15:05:32 -07004413# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004414 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004415 if (WARN("SPACING",
4416 "space prohibited before semicolon\n" . $herecurr) &&
4417 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004418 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004419 s/^(\+.*\S)\s+;/$1;/;
4420 }
4421 }
4422
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004423# check for multiple assignments
4424 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004425 CHK("MULTIPLE_ASSIGNMENTS",
4426 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004427 }
4428
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004429## # check for multiple declarations, allowing for a function declaration
4430## # continuation.
4431## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4432## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4433##
4434## # Remove any bracketed sections to ensure we do not
4435## # falsly report the parameters of functions.
4436## my $ln = $line;
4437## while ($ln =~ s/\([^\(\)]*\)//g) {
4438## }
4439## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004440## WARN("MULTIPLE_DECLARATION",
4441## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004442## }
4443## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004444
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004445#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004446 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004447 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004448 if (ERROR("SPACING",
4449 "space required before the open brace '{'\n" . $herecurr) &&
4450 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004451 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004452 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004453 }
4454
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004455## # check for blank lines before declarations
4456## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4457## $prevrawline =~ /^.\s*$/) {
4458## WARN("SPACING",
4459## "No blank lines before declarations\n" . $hereprev);
4460## }
4461##
4462
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004463# closing brace should have a space following it when it has anything
4464# on the line
4465 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004466 if (ERROR("SPACING",
4467 "space required after that close brace '}'\n" . $herecurr) &&
4468 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004469 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004470 s/}((?!(?:,|;|\)))\S)/} $1/;
4471 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004472 }
4473
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004474# check spacing on square brackets
4475 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004476 if (ERROR("SPACING",
4477 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4478 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004479 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004480 s/\[\s+/\[/;
4481 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004482 }
4483 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004484 if (ERROR("SPACING",
4485 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4486 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004487 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004488 s/\s+\]/\]/;
4489 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004490 }
4491
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004492# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004493 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4494 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004495 if (ERROR("SPACING",
4496 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4497 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004498 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004499 s/\(\s+/\(/;
4500 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004501 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004502 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004503 $line !~ /for\s*\(.*;\s+\)/ &&
4504 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004505 if (ERROR("SPACING",
4506 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4507 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004508 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004509 s/\s+\)/\)/;
4510 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004511 }
4512
Joe Perchese2826fd2014-08-06 16:10:48 -07004513# check unnecessary parentheses around addressof/dereference single $Lvals
4514# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4515
4516 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004517 my $var = $1;
4518 if (CHK("UNNECESSARY_PARENTHESES",
4519 "Unnecessary parentheses around $var\n" . $herecurr) &&
4520 $fix) {
4521 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4522 }
4523 }
4524
4525# check for unnecessary parentheses around function pointer uses
4526# ie: (foo->bar)(); should be foo->bar();
4527# but not "if (foo->bar) (" to avoid some false positives
4528 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4529 my $var = $2;
4530 if (CHK("UNNECESSARY_PARENTHESES",
4531 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4532 $fix) {
4533 my $var2 = deparenthesize($var);
4534 $var2 =~ s/\s//g;
4535 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4536 }
4537 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004538
Joe Perches63b7c732017-09-08 16:16:01 -07004539# check for unnecessary parentheses around comparisons in if uses
Joe Perchesa032aa42018-02-06 15:39:03 -08004540# when !drivers/staging or command-line uses --strict
4541 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) &&
4542 $^V && $^V ge 5.10.0 && defined($stat) &&
Joe Perches63b7c732017-09-08 16:16:01 -07004543 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4544 my $if_stat = $1;
4545 my $test = substr($2, 1, -1);
4546 my $herectx;
4547 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4548 my $match = $1;
4549 # avoid parentheses around potential macro args
4550 next if ($match =~ /^\s*\w+\s*$/);
4551 if (!defined($herectx)) {
4552 $herectx = $here . "\n";
4553 my $cnt = statement_rawlines($if_stat);
4554 for (my $n = 0; $n < $cnt; $n++) {
4555 my $rl = raw_line($linenr, $n);
4556 $herectx .= $rl . "\n";
4557 last if $rl =~ /^[ \+].*\{/;
4558 }
4559 }
4560 CHK("UNNECESSARY_PARENTHESES",
4561 "Unnecessary parentheses around '$match'\n" . $herectx);
4562 }
4563 }
4564
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004565#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004566 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004567 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004568 if (WARN("INDENTED_LABEL",
4569 "labels should not be indented\n" . $herecurr) &&
4570 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004571 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004572 s/^(.)\s+/$1/;
4573 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004574 }
4575
Joe Perches5b9553a2014-04-03 14:49:21 -07004576# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004577 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004578 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004579 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004580 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4581 my $value = $1;
4582 $value = deparenthesize($value);
4583 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4584 ERROR("RETURN_PARENTHESES",
4585 "return is not a function, parentheses are not required\n" . $herecurr);
4586 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004587 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004588 ERROR("SPACING",
4589 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004590 }
4591 }
Joe Perches507e5142013-11-12 15:10:13 -08004592
Joe Perchesb43ae212014-06-23 13:22:07 -07004593# unnecessary return in a void function
4594# at end-of-function, with the previous line a single leading tab, then return;
4595# and the line before that not a goto label target like "out:"
4596 if ($sline =~ /^[ \+]}\s*$/ &&
4597 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4598 $linenr >= 3 &&
4599 $lines[$linenr - 3] =~ /^[ +]/ &&
4600 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004601 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004602 "void function return statements are not generally useful\n" . $hereprev);
4603 }
Joe Perches9819cf22014-06-04 16:12:09 -07004604
Joe Perches189248d2014-01-23 15:54:47 -08004605# if statements using unnecessary parentheses - ie: if ((foo == bar))
4606 if ($^V && $^V ge 5.10.0 &&
4607 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4608 my $openparens = $1;
4609 my $count = $openparens =~ tr@\(@\(@;
4610 my $msg = "";
4611 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4612 my $comp = $4; #Not $1 because of $LvalOrFunc
4613 $msg = " - maybe == should be = ?" if ($comp eq "==");
4614 WARN("UNNECESSARY_PARENTHESES",
4615 "Unnecessary parentheses$msg\n" . $herecurr);
4616 }
4617 }
4618
Joe Perchesc5595fa2015-09-09 15:37:58 -07004619# comparisons with a constant or upper case identifier on the left
4620# avoid cases like "foo + BAR < baz"
4621# only fix matches surrounded by parentheses to avoid incorrect
4622# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4623 if ($^V && $^V ge 5.10.0 &&
4624 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4625 my $lead = $1;
4626 my $const = $2;
4627 my $comp = $3;
4628 my $to = $4;
4629 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004630 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004631 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4632 WARN("CONSTANT_COMPARISON",
4633 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4634 $fix) {
4635 if ($comp eq "<") {
4636 $newcomp = ">";
4637 } elsif ($comp eq "<=") {
4638 $newcomp = ">=";
4639 } elsif ($comp eq ">") {
4640 $newcomp = "<";
4641 } elsif ($comp eq ">=") {
4642 $newcomp = "<=";
4643 }
4644 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4645 }
4646 }
4647
Joe Perchesf34e4a42015-04-16 12:44:19 -07004648# Return of what appears to be an errno should normally be negative
4649 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004650 my $name = $1;
4651 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004652 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004653 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004654 }
4655 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004656
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004657# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004658 if ($line =~ /\b(if|while|for|switch)\(/) {
4659 if (ERROR("SPACING",
4660 "space required before the open parenthesis '('\n" . $herecurr) &&
4661 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004662 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004663 s/\b(if|while|for|switch)\(/$1 \(/;
4664 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004665 }
4666
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004667# Check for illegal assignment in if conditional -- and check for trailing
4668# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004669 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004670 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4671 ctx_statement_block($linenr, $realcnt, 0)
4672 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004673 my ($stat_next) = ctx_statement_block($line_nr_next,
4674 $remain_next, $off_next);
4675 $stat_next =~ s/\n./\n /g;
4676 ##print "stat<$stat> stat_next<$stat_next>\n";
4677
4678 if ($stat_next =~ /^\s*while\b/) {
4679 # If the statement carries leading newlines,
4680 # then count those as offsets.
4681 my ($whitespace) =
4682 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4683 my $offset =
4684 statement_rawlines($whitespace) - 1;
4685
4686 $suppress_whiletrailers{$line_nr_next +
4687 $offset} = 1;
4688 }
4689 }
4690 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004691 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004692 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004693 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004694
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004695 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004696 ERROR("ASSIGN_IN_IF",
4697 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004698 }
4699
4700 # Find out what is on the end of the line after the
4701 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004702 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004703 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004704 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004705 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4706 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004707 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004708 # Find out how long the conditional actually is.
4709 my @newlines = ($c =~ /\n/gs);
4710 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004711 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004712
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004713 $stat_real = raw_line($linenr, $cond_lines)
4714 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004715 if (defined($stat_real) && $cond_lines > 1) {
4716 $stat_real = "[...]\n$stat_real";
4717 }
4718
Joe Perches000d1cc12011-07-25 17:13:25 -07004719 ERROR("TRAILING_STATEMENTS",
4720 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004721 }
4722 }
4723
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004724# Check for bitwise tests written as boolean
4725 if ($line =~ /
4726 (?:
4727 (?:\[|\(|\&\&|\|\|)
4728 \s*0[xX][0-9]+\s*
4729 (?:\&\&|\|\|)
4730 |
4731 (?:\&\&|\|\|)
4732 \s*0[xX][0-9]+\s*
4733 (?:\&\&|\|\||\)|\])
4734 )/x)
4735 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004736 WARN("HEXADECIMAL_BOOLEAN_TEST",
4737 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004738 }
4739
Andy Whitcroft8905a672007-11-28 16:21:06 -08004740# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004741 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4742 my $s = $1;
4743 $s =~ s/$;//g; # Remove any comments
4744 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004745 ERROR("TRAILING_STATEMENTS",
4746 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004747 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004748 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004749# if should not continue a brace
4750 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004751 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004752 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004753 $herecurr);
4754 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004755# case and default should not have general statements after them
4756 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4757 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004758 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004759 \s*return\s+
4760 )/xg)
4761 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004762 ERROR("TRAILING_STATEMENTS",
4763 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004764 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004765
4766 # Check for }<nl>else {, these must be at the same
4767 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004768 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4769 $previndent == $indent) {
4770 if (ERROR("ELSE_AFTER_BRACE",
4771 "else should follow close brace '}'\n" . $hereprev) &&
4772 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4773 fix_delete_line($fixlinenr - 1, $prevrawline);
4774 fix_delete_line($fixlinenr, $rawline);
4775 my $fixedline = $prevrawline;
4776 $fixedline =~ s/}\s*$//;
4777 if ($fixedline !~ /^\+\s*$/) {
4778 fix_insert_line($fixlinenr, $fixedline);
4779 }
4780 $fixedline = $rawline;
4781 $fixedline =~ s/^(.\s*)else/$1} else/;
4782 fix_insert_line($fixlinenr, $fixedline);
4783 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004784 }
4785
Joe Perches8b8856f2014-08-06 16:11:14 -07004786 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4787 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004788 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4789
4790 # Find out what is on the end of the line after the
4791 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004792 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004793 $s =~ s/\n.*//g;
4794
4795 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004796 if (ERROR("WHILE_AFTER_BRACE",
4797 "while should follow close brace '}'\n" . $hereprev) &&
4798 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4799 fix_delete_line($fixlinenr - 1, $prevrawline);
4800 fix_delete_line($fixlinenr, $rawline);
4801 my $fixedline = $prevrawline;
4802 my $trailing = $rawline;
4803 $trailing =~ s/^\+//;
4804 $trailing = trim($trailing);
4805 $fixedline =~ s/}\s*$/} $trailing/;
4806 fix_insert_line($fixlinenr, $fixedline);
4807 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004808 }
4809 }
4810
Joe Perches95e2c602013-07-03 15:05:20 -07004811#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004812 while ($line =~ m{($Constant|$Lval)}g) {
4813 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004814
4815#gcc binary extension
4816 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004817 if (WARN("GCC_BINARY_CONSTANT",
4818 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4819 $fix) {
4820 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004821 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004822 s/\b$var\b/$hexval/;
4823 }
Joe Perches95e2c602013-07-03 15:05:20 -07004824 }
4825
4826#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004827 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004828 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004829#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004830 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004831#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004832 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4833#Ignore some three character SI units explicitly, like MiB and KHz
4834 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004835 while ($var =~ m{($Ident)}g) {
4836 my $word = $1;
4837 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004838 if ($check) {
4839 seed_camelcase_includes();
4840 if (!$file && !$camelcase_file_seeded) {
4841 seed_camelcase_file($realfile);
4842 $camelcase_file_seeded = 1;
4843 }
4844 }
Joe Perches7e781f62013-09-11 14:23:55 -07004845 if (!defined $camelcase{$word}) {
4846 $camelcase{$word} = 1;
4847 CHK("CAMELCASE",
4848 "Avoid CamelCase: <$word>\n" . $herecurr);
4849 }
Joe Perches34456862013-07-03 15:05:34 -07004850 }
Joe Perches323c1262012-12-17 16:02:07 -08004851 }
4852 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004853
4854#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004855 if ($line =~ /\#\s*define.*\\\s+$/) {
4856 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4857 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4858 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004859 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004860 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004861 }
4862
Fabian Frederick0e212e02015-04-16 12:44:25 -07004863# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4864# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004865 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004866 my $file = "$1.h";
4867 my $checkfile = "include/linux/$file";
4868 if (-f "$root/$checkfile" &&
4869 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004870 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004871 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004872 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4873 if ($asminclude > 0) {
4874 if ($realfile =~ m{^arch/}) {
4875 CHK("ARCH_INCLUDE_LINUX",
4876 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4877 } else {
4878 WARN("INCLUDE_LINUX",
4879 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4880 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004881 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004882 }
4883 }
4884
Andy Whitcroft653d4872007-06-23 17:16:34 -07004885# multi-statement macros should be enclosed in a do while loop, grab the
4886# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004887# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004888 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4889 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004890 my $ln = $linenr;
4891 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004892 my ($off, $dstat, $dcond, $rest);
4893 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004894 my $has_flow_statement = 0;
4895 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004896 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004897 ctx_statement_block($linenr, $realcnt, 0);
4898 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004899 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004900 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004901
Joe Perches08a28432014-10-13 15:51:55 -07004902 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004903 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004904
Joe Perchesf59b64b2016-10-11 13:52:08 -07004905 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4906 my $define_args = $1;
4907 my $define_stmt = $dstat;
4908 my @def_args = ();
4909
4910 if (defined $define_args && $define_args ne "") {
4911 $define_args = substr($define_args, 1, length($define_args) - 2);
4912 $define_args =~ s/\s*//g;
4913 @def_args = split(",", $define_args);
4914 }
4915
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004916 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004917 $dstat =~ s/\\\n.//g;
4918 $dstat =~ s/^\s*//s;
4919 $dstat =~ s/\s*$//s;
4920
4921 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004922 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4923 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004924 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004925 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004926 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004927
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004928 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004929 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4930 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004931 {
4932 }
4933
Joe Perches42e15292016-03-15 14:58:01 -07004934 # Make asm volatile uses seem like a generic function
4935 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4936
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004937 my $exceptions = qr{
4938 $Declare|
4939 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004940 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004941 DECLARE_PER_CPU|
4942 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004943 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004944 union|
4945 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004946 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004947 ^\"|\"$|
4948 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004949 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004950 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004951
4952 $ctx =~ s/\n*$//;
4953 my $herectx = $here . "\n";
4954 my $stmt_cnt = statement_rawlines($ctx);
4955
4956 for (my $n = 0; $n < $stmt_cnt; $n++) {
4957 $herectx .= raw_line($linenr, $n) . "\n";
4958 }
4959
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004960 if ($dstat ne '' &&
4961 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4962 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004963 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004964 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004965 $dstat !~ /$exceptions/ &&
4966 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004967 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004968 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004969 $dstat !~ /^for\s*$Constant$/ && # for (...)
4970 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4971 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004972 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004973 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004974 {
Joe Perchese7955562017-05-08 15:55:48 -07004975 if ($dstat =~ /^\s*if\b/) {
4976 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4977 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4978 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004979 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4980 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4981 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004982 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004983 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004984 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004985
4986 }
Joe Perches52076492016-10-11 13:52:14 -07004987
4988 # Make $define_stmt single line, comment-free, etc
4989 my @stmt_array = split('\n', $define_stmt);
4990 my $first = 1;
4991 $define_stmt = "";
4992 foreach my $l (@stmt_array) {
4993 $l =~ s/\\$//;
4994 if ($first) {
4995 $define_stmt = $l;
4996 $first = 0;
4997 } elsif ($l =~ /^[\+ ]/) {
4998 $define_stmt .= substr($l, 1);
4999 }
5000 }
5001 $define_stmt =~ s/$;//g;
5002 $define_stmt =~ s/\s+/ /g;
5003 $define_stmt = trim($define_stmt);
5004
Joe Perchesf59b64b2016-10-11 13:52:08 -07005005# check if any macro arguments are reused (ignore '...' and 'type')
5006 foreach my $arg (@def_args) {
5007 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07005008 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07005009 my $tmp_stmt = $define_stmt;
5010 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5011 $tmp_stmt =~ s/\#+\s*$arg\b//g;
5012 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
5013 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07005014 if ($use_cnt > 1) {
5015 CHK("MACRO_ARG_REUSE",
5016 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07005017 }
5018# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07005019 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07005020 ((defined($1) && $1 ne ',') ||
5021 (defined($2) && $2 ne ','))) {
5022 CHK("MACRO_ARG_PRECEDENCE",
5023 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07005024 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005025 }
Joe Perches5023d342012-12-17 16:01:47 -08005026
Joe Perches08a28432014-10-13 15:51:55 -07005027# check for macros with flow control, but without ## concatenation
5028# ## concatenation is commonly a macro that defines a function so ignore those
5029 if ($has_flow_statement && !$has_arg_concat) {
5030 my $herectx = $here . "\n";
5031 my $cnt = statement_rawlines($ctx);
5032
5033 for (my $n = 0; $n < $cnt; $n++) {
5034 $herectx .= raw_line($linenr, $n) . "\n";
5035 }
5036 WARN("MACRO_WITH_FLOW_CONTROL",
5037 "Macros with flow control statements should be avoided\n" . "$herectx");
5038 }
5039
Joe Perches481eb482012-12-17 16:01:56 -08005040# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005041
5042 } else {
5043 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005044 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5045 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005046 $line =~ /^\+.*\\$/) {
5047 WARN("LINE_CONTINUATIONS",
5048 "Avoid unnecessary line continuations\n" . $herecurr);
5049 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005050 }
5051
Joe Perchesb13edf72012-07-30 14:41:24 -07005052# do {} while (0) macro tests:
5053# single-statement macros do not need to be enclosed in do while (0) loop,
5054# macro should not end with a semicolon
5055 if ($^V && $^V ge 5.10.0 &&
5056 $realfile !~ m@/vmlinux.lds.h$@ &&
5057 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5058 my $ln = $linenr;
5059 my $cnt = $realcnt;
5060 my ($off, $dstat, $dcond, $rest);
5061 my $ctx = '';
5062 ($dstat, $dcond, $ln, $cnt, $off) =
5063 ctx_statement_block($linenr, $realcnt, 0);
5064 $ctx = $dstat;
5065
5066 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005067 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005068
5069 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5070 my $stmts = $2;
5071 my $semis = $3;
5072
5073 $ctx =~ s/\n*$//;
5074 my $cnt = statement_rawlines($ctx);
5075 my $herectx = $here . "\n";
5076
5077 for (my $n = 0; $n < $cnt; $n++) {
5078 $herectx .= raw_line($linenr, $n) . "\n";
5079 }
5080
Joe Perchesac8e97f2012-08-21 16:15:53 -07005081 if (($stmts =~ tr/;/;/) == 1 &&
5082 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005083 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5084 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5085 }
5086 if (defined $semis && $semis ne "") {
5087 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5088 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5089 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005090 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5091 $ctx =~ s/\n*$//;
5092 my $cnt = statement_rawlines($ctx);
5093 my $herectx = $here . "\n";
5094
5095 for (my $n = 0; $n < $cnt; $n++) {
5096 $herectx .= raw_line($linenr, $n) . "\n";
5097 }
5098
5099 WARN("TRAILING_SEMICOLON",
5100 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005101 }
5102 }
5103
Mike Frysinger080ba922009-01-06 14:41:25 -08005104# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5105# all assignments may have only one of the following with an assignment:
5106# .
5107# ALIGN(...)
5108# VMLINUX_SYMBOL(...)
5109 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005110 WARN("MISSING_VMLINUX_SYMBOL",
5111 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005112 }
5113
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005114# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005115 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5116 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005117 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005118 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005119 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5120 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005121 my @allowed = ();
5122 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005123 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005124 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005125 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005126 for my $chunk (@chunks) {
5127 my ($cond, $block) = @{$chunk};
5128
Andy Whitcroft773647a2008-03-28 14:15:58 -07005129 # If the condition carries leading newlines, then count those as offsets.
5130 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5131 my $offset = statement_rawlines($whitespace) - 1;
5132
Joe Perchesaad4f612012-03-23 15:02:19 -07005133 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005134 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5135
5136 # We have looked at and allowed this specific line.
5137 $suppress_ifbraces{$ln + $offset} = 1;
5138
5139 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005140 $ln += statement_rawlines($block) - 1;
5141
Andy Whitcroft773647a2008-03-28 14:15:58 -07005142 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005143
5144 $seen++ if ($block =~ /^\s*{/);
5145
Joe Perchesaad4f612012-03-23 15:02:19 -07005146 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005147 if (statement_lines($cond) > 1) {
5148 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005149 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005150 }
5151 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005152 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005153 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005154 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005155 if (statement_block_size($block) > 1) {
5156 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005157 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005158 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005159 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005160 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005161 if ($seen) {
5162 my $sum_allowed = 0;
5163 foreach (@allowed) {
5164 $sum_allowed += $_;
5165 }
5166 if ($sum_allowed == 0) {
5167 WARN("BRACES",
5168 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5169 } elsif ($sum_allowed != $allow &&
5170 $seen != $allow) {
5171 CHK("BRACES",
5172 "braces {} should be used on all arms of this statement\n" . $herectx);
5173 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005174 }
5175 }
5176 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005177 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005178 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005179 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005180
Andy Whitcroftcf655042008-03-04 14:28:20 -08005181 # Check the pre-context.
5182 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5183 #print "APW: ALLOWED: pre<$1>\n";
5184 $allowed = 1;
5185 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005186
5187 my ($level, $endln, @chunks) =
5188 ctx_statement_full($linenr, $realcnt, $-[0]);
5189
Andy Whitcroftcf655042008-03-04 14:28:20 -08005190 # Check the condition.
5191 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005192 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005193 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005194 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005195 }
5196 if (statement_lines($cond) > 1) {
5197 #print "APW: ALLOWED: cond<$cond>\n";
5198 $allowed = 1;
5199 }
5200 if ($block =~/\b(?:if|for|while)\b/) {
5201 #print "APW: ALLOWED: block<$block>\n";
5202 $allowed = 1;
5203 }
5204 if (statement_block_size($block) > 1) {
5205 #print "APW: ALLOWED: lines block<$block>\n";
5206 $allowed = 1;
5207 }
5208 # Check the post-context.
5209 if (defined $chunks[1]) {
5210 my ($cond, $block) = @{$chunks[1]};
5211 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005212 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005213 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005214 if ($block =~ /^\s*\{/) {
5215 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5216 $allowed = 1;
5217 }
5218 }
5219 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005220 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005221 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005222
Andy Whitcroftf0556632008-10-15 22:02:23 -07005223 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005224 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005225 }
5226
Joe Perches000d1cc12011-07-25 17:13:25 -07005227 WARN("BRACES",
5228 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005229 }
5230 }
5231
Joe Perchese4c5bab2017-02-24 15:01:41 -08005232# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005233 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5234 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005235 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5236 }
5237
Joe Perches0979ae62012-12-17 16:01:59 -08005238# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005239 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005240 if (CHK("BRACES",
5241 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5242 $fix && $prevrawline =~ /^\+/) {
5243 fix_delete_line($fixlinenr - 1, $prevrawline);
5244 }
Joe Perches0979ae62012-12-17 16:01:59 -08005245 }
Joe Perches77b9a532013-07-03 15:05:29 -07005246 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005247 if (CHK("BRACES",
5248 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5249 $fix) {
5250 fix_delete_line($fixlinenr, $rawline);
5251 }
Joe Perches0979ae62012-12-17 16:01:59 -08005252 }
5253
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005254# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005255 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5256 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005257 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005258 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005259 }
5260
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005261# Check for user-visible strings broken across lines, which breaks the ability
5262# to grep for the string. Make exceptions when the previous string ends in a
5263# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5264# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005265 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005266 $prevline =~ /"\s*$/ &&
5267 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5268 if (WARN("SPLIT_STRING",
5269 "quoted string split across lines\n" . $hereprev) &&
5270 $fix &&
5271 $prevrawline =~ /^\+.*"\s*$/ &&
5272 $last_coalesced_string_linenr != $linenr - 1) {
5273 my $extracted_string = get_quoted_string($line, $rawline);
5274 my $comma_close = "";
5275 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5276 $comma_close = $1;
5277 }
5278
5279 fix_delete_line($fixlinenr - 1, $prevrawline);
5280 fix_delete_line($fixlinenr, $rawline);
5281 my $fixedline = $prevrawline;
5282 $fixedline =~ s/"\s*$//;
5283 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5284 fix_insert_line($fixlinenr - 1, $fixedline);
5285 $fixedline = $rawline;
5286 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5287 if ($fixedline !~ /\+\s*$/) {
5288 fix_insert_line($fixlinenr, $fixedline);
5289 }
5290 $last_coalesced_string_linenr = $linenr;
5291 }
5292 }
5293
5294# check for missing a space in a string concatenation
5295 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5296 WARN('MISSING_SPACE',
5297 "break quoted strings at a space character\n" . $hereprev);
5298 }
5299
Joe Perchese4b7d302017-05-08 15:55:51 -07005300# check for an embedded function name in a string when the function is known
5301# This does not work very well for -f --file checking as it depends on patch
5302# context providing the function name or a single line form for in-file
5303# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005304 if ($line =~ /^\+.*$String/ &&
5305 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005306 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5307 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005308 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005309 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005310 }
5311
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005312# check for spaces before a quoted newline
5313 if ($rawline =~ /^.*\".*\s\\n/) {
5314 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5315 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5316 $fix) {
5317 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5318 }
5319
5320 }
5321
Joe Perchesf17dba42014-10-13 15:51:51 -07005322# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005323 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005324 CHK("CONCATENATED_STRING",
5325 "Concatenated strings should use spaces between elements\n" . $herecurr);
5326 }
5327
Joe Perches90ad30e2014-12-10 15:51:59 -08005328# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005329 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005330 WARN("STRING_FRAGMENTS",
5331 "Consecutive strings are generally better as a single string\n" . $herecurr);
5332 }
5333
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005334# check for non-standard and hex prefixed decimal printf formats
5335 my $show_L = 1; #don't show the same defect twice
5336 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005337 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005338 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005339 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005340 # check for %L
5341 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005342 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005343 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5344 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005345 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005346 # check for %Z
5347 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5348 WARN("PRINTF_Z",
5349 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5350 $show_Z = 0;
5351 }
5352 # check for 0x<decimal>
5353 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5354 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005355 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5356 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005357 }
5358
5359# check for line continuations in quoted strings with odd counts of "
Joe Perches3f7f3352018-02-06 15:38:52 -08005360 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005361 WARN("LINE_CONTINUATIONS",
5362 "Avoid line continuations in quoted strings\n" . $herecurr);
5363 }
5364
Andy Whitcroft00df3442007-06-08 13:47:06 -07005365# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005366 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005367 CHK("REDUNDANT_CODE",
5368 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005369 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005370 }
5371
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005372# check for needless "if (<foo>) fn(<foo>)" uses
5373 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005374 my $tested = quotemeta($1);
5375 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5376 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5377 my $func = $1;
5378 if (WARN('NEEDLESS_IF',
5379 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5380 $fix) {
5381 my $do_fix = 1;
5382 my $leading_tabs = "";
5383 my $new_leading_tabs = "";
5384 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5385 $leading_tabs = $1;
5386 } else {
5387 $do_fix = 0;
5388 }
5389 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5390 $new_leading_tabs = $1;
5391 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5392 $do_fix = 0;
5393 }
5394 } else {
5395 $do_fix = 0;
5396 }
5397 if ($do_fix) {
5398 fix_delete_line($fixlinenr - 1, $prevrawline);
5399 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5400 }
5401 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005402 }
5403 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005404
Joe Perchesebfdc402014-08-06 16:10:27 -07005405# check for unnecessary "Out of Memory" messages
5406 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5407 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5408 (defined $1 || defined $3) &&
5409 $linenr > 3) {
5410 my $testval = $2;
5411 my $testline = $lines[$linenr - 3];
5412
5413 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5414# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5415
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005416 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 -07005417 WARN("OOM_MESSAGE",
5418 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5419 }
5420 }
5421
Joe Perchesf78d98f2014-10-13 15:52:01 -07005422# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005423 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005424 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5425 my $level = $1;
5426 if (WARN("UNNECESSARY_KERN_LEVEL",
5427 "Possible unnecessary $level\n" . $herecurr) &&
5428 $fix) {
5429 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5430 }
5431 }
5432
Joe Perches45c55e92017-02-24 15:01:31 -08005433# check for logging continuations
5434 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5435 WARN("LOGGING_CONTINUATION",
5436 "Avoid logging continuation uses where feasible\n" . $herecurr);
5437 }
5438
Joe Perchesabb08a52014-12-10 15:51:46 -08005439# check for mask then right shift without a parentheses
5440 if ($^V && $^V ge 5.10.0 &&
5441 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5442 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5443 WARN("MASK_THEN_SHIFT",
5444 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5445 }
5446
Joe Perchesb75ac612014-12-10 15:52:02 -08005447# check for pointer comparisons to NULL
5448 if ($^V && $^V ge 5.10.0) {
5449 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5450 my $val = $1;
5451 my $equal = "!";
5452 $equal = "" if ($4 eq "!=");
5453 if (CHK("COMPARISON_TO_NULL",
5454 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5455 $fix) {
5456 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5457 }
5458 }
5459 }
5460
Joe Perches8716de32013-09-11 14:24:05 -07005461# check for bad placement of section $InitAttribute (e.g.: __initdata)
5462 if ($line =~ /(\b$InitAttribute\b)/) {
5463 my $attr = $1;
5464 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5465 my $ptr = $1;
5466 my $var = $2;
5467 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5468 ERROR("MISPLACED_INIT",
5469 "$attr should be placed after $var\n" . $herecurr)) ||
5470 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5471 WARN("MISPLACED_INIT",
5472 "$attr should be placed after $var\n" . $herecurr))) &&
5473 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005474 $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 -07005475 }
5476 }
5477 }
5478
Joe Perchese970b8842013-11-12 15:10:10 -08005479# check for $InitAttributeData (ie: __initdata) with const
5480 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5481 my $attr = $1;
5482 $attr =~ /($InitAttributePrefix)(.*)/;
5483 my $attr_prefix = $1;
5484 my $attr_type = $2;
5485 if (ERROR("INIT_ATTRIBUTE",
5486 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5487 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005488 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005489 s/$InitAttributeData/${attr_prefix}initconst/;
5490 }
5491 }
5492
5493# check for $InitAttributeConst (ie: __initconst) without const
5494 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5495 my $attr = $1;
5496 if (ERROR("INIT_ATTRIBUTE",
5497 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5498 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005499 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005500 /(^\+\s*(?:static\s+))/;
5501 $lead = rtrim($1);
5502 $lead = "$lead " if ($lead !~ /^\+$/);
5503 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005504 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005505 }
5506 }
5507
Joe Perchesc17893c2015-04-16 12:44:42 -07005508# check for __read_mostly with const non-pointer (should just be const)
5509 if ($line =~ /\b__read_mostly\b/ &&
5510 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5511 if (ERROR("CONST_READ_MOSTLY",
5512 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5513 $fix) {
5514 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5515 }
5516 }
5517
Joe Perchesfbdb8132014-04-03 14:49:14 -07005518# don't use __constant_<foo> functions outside of include/uapi/
5519 if ($realfile !~ m@^include/uapi/@ &&
5520 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5521 my $constant_func = $1;
5522 my $func = $constant_func;
5523 $func =~ s/^__constant_//;
5524 if (WARN("CONSTANT_CONVERSION",
5525 "$constant_func should be $func\n" . $herecurr) &&
5526 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005527 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005528 }
5529 }
5530
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005531# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005532 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005533 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005534 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005535 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005536 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005537 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5538 }
5539 if ($delay > 2000) {
5540 WARN("LONG_UDELAY",
5541 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005542 }
5543 }
5544
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005545# warn about unexpectedly long msleep's
5546 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5547 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005548 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005549 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005550 }
5551 }
5552
Joe Perches36ec1932013-07-03 15:05:25 -07005553# check for comparisons of jiffies
5554 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5555 WARN("JIFFIES_COMPARISON",
5556 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5557 }
5558
Joe Perches9d7a34a2013-07-03 15:05:26 -07005559# check for comparisons of get_jiffies_64()
5560 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5561 WARN("JIFFIES_COMPARISON",
5562 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5563 }
5564
Andy Whitcroft00df3442007-06-08 13:47:06 -07005565# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005566# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005567# print "#ifdef in C files should be avoided\n";
5568# print "$herecurr";
5569# $clean = 0;
5570# }
5571
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005572# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005573 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005574 if (ERROR("SPACING",
5575 "exactly one space required after that #$1\n" . $herecurr) &&
5576 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005577 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005578 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5579 }
5580
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005581 }
5582
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005583# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005584 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5585 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005586 my $which = $1;
5587 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005588 CHK("UNCOMMENTED_DEFINITION",
5589 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005590 }
5591 }
5592# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005593
5594 my $barriers = qr{
5595 mb|
5596 rmb|
5597 wmb|
5598 read_barrier_depends
5599 }x;
5600 my $barrier_stems = qr{
5601 mb__before_atomic|
5602 mb__after_atomic|
5603 store_release|
5604 load_acquire|
5605 store_mb|
5606 (?:$barriers)
5607 }x;
5608 my $all_barriers = qr{
5609 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005610 smp_(?:$barrier_stems)|
5611 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005612 }x;
5613
5614 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005615 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005616 WARN("MEMORY_BARRIER",
5617 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005618 }
5619 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005620
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005621 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5622
5623 if ($realfile !~ m@^include/asm-generic/@ &&
5624 $realfile !~ m@/barrier\.h$@ &&
5625 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5626 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5627 WARN("MEMORY_BARRIER",
5628 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5629 }
5630
Joe Perchescb426e92015-06-25 15:02:46 -07005631# check for waitqueue_active without a comment.
5632 if ($line =~ /\bwaitqueue_active\s*\(/) {
5633 if (!ctx_has_comment($first_line, $linenr)) {
5634 WARN("WAITQUEUE_ACTIVE",
5635 "waitqueue_active without comment\n" . $herecurr);
5636 }
5637 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005638
Paul E. McKenney91db2592017-11-27 09:37:35 -08005639# check for smp_read_barrier_depends and read_barrier_depends
5640 if (!$file && $line =~ /\b(smp_|)read_barrier_depends\s*\(/) {
5641 WARN("READ_BARRIER_DEPENDS",
5642 "$1read_barrier_depends should only be used in READ_ONCE or DEC Alpha code\n" . $herecurr);
5643 }
5644
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005645# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005646 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005647 CHK("ARCH_DEFINES",
5648 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005649 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005650
Joe Perches596ed452017-07-12 14:37:02 -07005651# check that the storage class is not after a type
5652 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005653 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005654 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5655 }
5656# Check that the storage class is at the beginning of a declaration
5657 if ($line =~ /\b$Storage\b/ &&
5658 $line !~ /^.\s*$Storage/ &&
5659 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5660 $1 !~ /[\,\)]\s*$/) {
5661 WARN("STORAGE_CLASS",
5662 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005663 }
5664
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005665# check the location of the inline attribute, that it is between
5666# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005667 if ($line =~ /\b$Type\s+$Inline\b/ ||
5668 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005669 ERROR("INLINE_LOCATION",
5670 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005671 }
5672
Andy Whitcroft8905a672007-11-28 16:21:06 -08005673# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005674 if ($realfile !~ m@\binclude/uapi/@ &&
5675 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005676 if (WARN("INLINE",
5677 "plain inline is preferred over $1\n" . $herecurr) &&
5678 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005679 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005680
5681 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005682 }
5683
Joe Perches3d130fd2011-01-12 17:00:00 -08005684# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005685 if ($realfile !~ m@\binclude/uapi/@ &&
5686 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005687 WARN("PREFER_PACKED",
5688 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005689 }
5690
Joe Perches39b7e282011-07-25 17:13:24 -07005691# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005692 if ($realfile !~ m@\binclude/uapi/@ &&
5693 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005694 WARN("PREFER_ALIGNED",
5695 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005696 }
5697
Joe Perches5f14d3b2012-01-10 15:09:52 -08005698# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005699 if ($realfile !~ m@\binclude/uapi/@ &&
5700 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005701 if (WARN("PREFER_PRINTF",
5702 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5703 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005704 $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 -07005705
5706 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005707 }
5708
Joe Perches6061d942012-03-23 15:02:16 -07005709# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005710 if ($realfile !~ m@\binclude/uapi/@ &&
5711 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005712 if (WARN("PREFER_SCANF",
5713 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5714 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005715 $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 -07005716 }
Joe Perches6061d942012-03-23 15:02:16 -07005717 }
5718
Joe Perches619a9082014-12-10 15:51:35 -08005719# Check for __attribute__ weak, or __weak declarations (may have link issues)
5720 if ($^V && $^V ge 5.10.0 &&
5721 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5722 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5723 $line =~ /\b__weak\b/)) {
5724 ERROR("WEAK_DECLARATION",
5725 "Using weak declarations can have unintended link defects\n" . $herecurr);
5726 }
5727
Tomas Winklerfd39f902016-12-12 16:46:34 -08005728# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005729 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005730 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005731 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5732 my $type = $1;
5733 if ($type =~ /\b($typeC99Typedefs)\b/) {
5734 $type = $1;
5735 my $kernel_type = 'u';
5736 $kernel_type = 's' if ($type =~ /^_*[si]/);
5737 $type =~ /(\d+)/;
5738 $kernel_type .= $1;
5739 if (CHK("PREFER_KERNEL_TYPES",
5740 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5741 $fix) {
5742 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5743 }
5744 }
5745 }
5746
Joe Perches938224b2016-01-20 14:59:15 -08005747# check for cast of C90 native int or longer types constants
5748 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5749 my $cast = $1;
5750 my $const = $2;
5751 if (WARN("TYPECAST_INT_CONSTANT",
5752 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5753 $fix) {
5754 my $suffix = "";
5755 my $newconst = $const;
5756 $newconst =~ s/${Int_type}$//;
5757 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5758 if ($cast =~ /\blong\s+long\b/) {
5759 $suffix .= 'LL';
5760 } elsif ($cast =~ /\blong\b/) {
5761 $suffix .= 'L';
5762 }
5763 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5764 }
5765 }
5766
Joe Perches8f53a9b2010-03-05 13:43:48 -08005767# check for sizeof(&)
5768 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005769 WARN("SIZEOF_ADDRESS",
5770 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005771 }
5772
Joe Perches66c80b62012-07-30 14:41:22 -07005773# check for sizeof without parenthesis
5774 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005775 if (WARN("SIZEOF_PARENTHESIS",
5776 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5777 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005778 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005779 }
Joe Perches66c80b62012-07-30 14:41:22 -07005780 }
5781
Joe Perches88982fe2012-12-17 16:02:00 -08005782# check for struct spinlock declarations
5783 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5784 WARN("USE_SPINLOCK_T",
5785 "struct spinlock should be spinlock_t\n" . $herecurr);
5786 }
5787
Joe Perchesa6962d72013-04-29 16:18:13 -07005788# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005789 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005790 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005791 $fmt =~ s/%%//g;
5792 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005793 if (WARN("PREFER_SEQ_PUTS",
5794 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5795 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005796 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005797 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005798 }
5799 }
5800
Joe Perches0b523762017-05-08 15:55:36 -07005801 # check for vsprintf extension %p<foo> misuses
5802 if ($^V && $^V ge 5.10.0 &&
5803 defined $stat &&
5804 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5805 $1 !~ /^_*volatile_*$/) {
5806 my $bad_extension = "";
5807 my $lc = $stat =~ tr@\n@@;
5808 $lc = $lc + $linenr;
5809 for (my $count = $linenr; $count <= $lc; $count++) {
5810 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5811 $fmt =~ s/%%//g;
Linus Torvaldsab486bc2018-02-01 13:36:15 -08005812 if ($fmt =~ /(\%[\*\d\.]*p(?![\WSsBKRraEhMmIiUDdgVCbGNOx]).)/) {
Joe Perches0b523762017-05-08 15:55:36 -07005813 $bad_extension = $1;
5814 last;
5815 }
5816 }
5817 if ($bad_extension ne "") {
5818 my $stat_real = raw_line($linenr, 0);
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005819 my $ext_type = "Invalid";
5820 my $use = "";
Joe Perches0b523762017-05-08 15:55:36 -07005821 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5822 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5823 }
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005824 if ($bad_extension =~ /p[Ff]/) {
5825 $ext_type = "Deprecated";
5826 $use = " - use %pS instead";
5827 $use =~ s/pS/ps/ if ($bad_extension =~ /pf/);
5828 }
Joe Perches0b523762017-05-08 15:55:36 -07005829 WARN("VSPRINTF_POINTER_EXTENSION",
Sergey Senozhatsky1df73382017-11-10 08:48:30 +09005830 "$ext_type vsprintf pointer extension '$bad_extension'$use\n" . "$here\n$stat_real\n");
Joe Perches0b523762017-05-08 15:55:36 -07005831 }
5832 }
5833
Andy Whitcroft554e1652012-01-10 15:09:57 -08005834# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005835 if ($^V && $^V ge 5.10.0 &&
5836 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005837 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005838
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005839 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005840 my $ms_val = $7;
5841 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005842
Andy Whitcroft554e1652012-01-10 15:09:57 -08005843 if ($ms_size =~ /^(0x|)0$/i) {
5844 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005845 "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 -08005846 } elsif ($ms_size =~ /^(0x|)1$/i) {
5847 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005848 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5849 }
5850 }
5851
Joe Perches98a9bba2014-01-23 15:54:52 -08005852# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005853# if ($^V && $^V ge 5.10.0 &&
5854# defined $stat &&
5855# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5856# if (WARN("PREFER_ETHER_ADDR_COPY",
5857# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5858# $fix) {
5859# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5860# }
5861# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005862
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005863# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005864# if ($^V && $^V ge 5.10.0 &&
5865# defined $stat &&
5866# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5867# WARN("PREFER_ETHER_ADDR_EQUAL",
5868# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5869# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005870
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005871# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5872# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf333195d2016-10-11 13:51:53 -07005873# if ($^V && $^V ge 5.10.0 &&
5874# defined $stat &&
5875# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5876#
5877# my $ms_val = $7;
5878#
5879# if ($ms_val =~ /^(?:0x|)0+$/i) {
5880# if (WARN("PREFER_ETH_ZERO_ADDR",
5881# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5882# $fix) {
5883# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5884# }
5885# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5886# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5887# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5888# $fix) {
5889# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5890# }
5891# }
5892# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005893
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005894# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005895 if ($^V && $^V ge 5.10.0 &&
5896 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005897 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005898 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005899 my $call = $1;
5900 my $cast1 = deparenthesize($2);
5901 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005902 my $cast2 = deparenthesize($7);
5903 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005904 my $cast;
5905
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005906 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005907 $cast = "$cast1 or $cast2";
5908 } elsif ($cast1 ne "") {
5909 $cast = $cast1;
5910 } else {
5911 $cast = $cast2;
5912 }
5913 WARN("MINMAX",
5914 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005915 }
5916 }
5917
Joe Perches4a273192012-07-30 14:41:20 -07005918# check usleep_range arguments
5919 if ($^V && $^V ge 5.10.0 &&
5920 defined $stat &&
5921 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5922 my $min = $1;
5923 my $max = $7;
5924 if ($min eq $max) {
5925 WARN("USLEEP_RANGE",
5926 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5927 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5928 $min > $max) {
5929 WARN("USLEEP_RANGE",
5930 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5931 }
5932 }
5933
Joe Perches823b7942013-11-12 15:10:15 -08005934# check for naked sscanf
5935 if ($^V && $^V ge 5.10.0 &&
5936 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005937 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005938 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5939 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5940 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5941 my $lc = $stat =~ tr@\n@@;
5942 $lc = $lc + $linenr;
5943 my $stat_real = raw_line($linenr, 0);
5944 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5945 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5946 }
5947 WARN("NAKED_SSCANF",
5948 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5949 }
5950
Joe Perchesafc819a2014-06-04 16:12:08 -07005951# check for simple sscanf that should be kstrto<foo>
5952 if ($^V && $^V ge 5.10.0 &&
5953 defined $stat &&
5954 $line =~ /\bsscanf\b/) {
5955 my $lc = $stat =~ tr@\n@@;
5956 $lc = $lc + $linenr;
5957 my $stat_real = raw_line($linenr, 0);
5958 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5959 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5960 }
5961 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5962 my $format = $6;
5963 my $count = $format =~ tr@%@%@;
5964 if ($count == 1 &&
5965 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5966 WARN("SSCANF_TO_KSTRTO",
5967 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5968 }
5969 }
5970 }
5971
Joe Perches70dc8a42013-09-11 14:23:58 -07005972# check for new externs in .h files.
5973 if ($realfile =~ /\.h$/ &&
5974 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005975 if (CHK("AVOID_EXTERNS",
5976 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005977 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005978 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005979 }
5980 }
5981
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005982# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005983 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005984 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005985 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005986 my $function_name = $1;
5987 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005988
5989 my $s = $stat;
5990 if (defined $cond) {
5991 substr($s, 0, length($cond), '');
5992 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005993 if ($s =~ /^\s*;/ &&
5994 $function_name ne 'uninitialized_var')
5995 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005996 WARN("AVOID_EXTERNS",
5997 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005998 }
5999
6000 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006001 WARN("FUNCTION_ARGUMENTS",
6002 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006003 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006004
6005 } elsif ($realfile =~ /\.c$/ && defined $stat &&
6006 $stat =~ /^.\s*extern\s+/)
6007 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006008 WARN("AVOID_EXTERNS",
6009 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006010 }
6011
Joe Perchesa0ad7592017-07-10 15:52:19 -07006012# check for function declarations that have arguments without identifier names
6013 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08006014 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07006015 $1 ne "void") {
6016 my $args = trim($1);
6017 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
6018 my $arg = trim($1);
6019 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
6020 WARN("FUNCTION_ARGUMENTS",
6021 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
6022 }
6023 }
6024 }
6025
Joe Perchesa0ad7592017-07-10 15:52:19 -07006026# check for function definitions
6027 if ($^V && $^V ge 5.10.0 &&
6028 defined $stat &&
6029 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
6030 $context_function = $1;
6031
6032# check for multiline function definition with misplaced open brace
6033 my $ok = 0;
6034 my $cnt = statement_rawlines($stat);
6035 my $herectx = $here . "\n";
6036 for (my $n = 0; $n < $cnt; $n++) {
6037 my $rl = raw_line($linenr, $n);
6038 $herectx .= $rl . "\n";
6039 $ok = 1 if ($rl =~ /^[ \+]\{/);
6040 $ok = 1 if ($rl =~ /\{/ && $n == 0);
6041 last if $rl =~ /^[ \+].*\{/;
6042 }
6043 if (!$ok) {
6044 ERROR("OPEN_BRACE",
6045 "open brace '{' following function definitions go on the next line\n" . $herectx);
6046 }
6047 }
6048
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006049# checks for new __setup's
6050 if ($rawline =~ /\b__setup\("([^"]*)"/) {
6051 my $name = $1;
6052
6053 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006054 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006055 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006056 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006057 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006058
6059# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08006060 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006061 WARN("UNNECESSARY_CASTS",
6062 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006063 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006064
Joe Perchesa640d252013-07-03 15:05:21 -07006065# alloc style
6066# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6067 if ($^V && $^V ge 5.10.0 &&
6068 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6069 CHK("ALLOC_SIZEOF_STRUCT",
6070 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6071 }
6072
Joe Perches60a55362014-06-04 16:12:07 -07006073# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6074 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006075 defined $stat &&
6076 $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 -07006077 my $oldfunc = $3;
6078 my $a1 = $4;
6079 my $a2 = $10;
6080 my $newfunc = "kmalloc_array";
6081 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006082 my $r1 = $a1;
6083 my $r2 = $a2;
6084 if ($a1 =~ /^sizeof\s*\S/) {
6085 $r1 = $a2;
6086 $r2 = $a1;
6087 }
6088 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6089 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006090 my $ctx = '';
6091 my $herectx = $here . "\n";
6092 my $cnt = statement_rawlines($stat);
6093 for (my $n = 0; $n < $cnt; $n++) {
6094 $herectx .= raw_line($linenr, $n) . "\n";
6095 }
Joe Perches60a55362014-06-04 16:12:07 -07006096 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006097 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6098 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006099 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006100 $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 -07006101 }
6102 }
6103 }
6104
Joe Perches972fdea2013-04-29 16:18:12 -07006105# check for krealloc arg reuse
6106 if ($^V && $^V ge 5.10.0 &&
6107 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6108 WARN("KREALLOC_ARG_REUSE",
6109 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6110 }
6111
Joe Perches5ce59ae2013-02-21 16:44:18 -08006112# check for alloc argument mismatch
6113 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6114 WARN("ALLOC_ARRAY_ARGS",
6115 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6116 }
6117
Joe Perchescaf2a542011-01-12 16:59:56 -08006118# check for multiple semicolons
6119 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006120 if (WARN("ONE_SEMICOLON",
6121 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6122 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006123 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006124 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006125 }
6126
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006127# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6128 if ($realfile !~ m@^include/uapi/@ &&
6129 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006130 my $ull = "";
6131 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6132 if (CHK("BIT_MACRO",
6133 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6134 $fix) {
6135 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6136 }
6137 }
6138
Joe Perches2d632742016-05-20 17:04:00 -07006139# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6140 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6141 my $config = $1;
6142 if (WARN("PREFER_IS_ENABLED",
6143 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6144 $fix) {
6145 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6146 }
6147 }
6148
Joe Perchese81f2392014-08-06 16:11:25 -07006149# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006150 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6151 my $has_break = 0;
6152 my $has_statement = 0;
6153 my $count = 0;
6154 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006155 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006156 $prevline--;
6157 my $rline = $rawlines[$prevline - 1];
6158 my $fline = $lines[$prevline - 1];
6159 last if ($fline =~ /^\@\@/);
6160 next if ($fline =~ /^\-/);
6161 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6162 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6163 next if ($fline =~ /^.[\s$;]*$/);
6164 $has_statement = 1;
6165 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006166 $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 -08006167 }
6168 if (!$has_break && $has_statement) {
6169 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006170 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006171 }
6172 }
6173
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006174# check for switch/default statements without a break;
6175 if ($^V && $^V ge 5.10.0 &&
6176 defined $stat &&
6177 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6178 my $ctx = '';
6179 my $herectx = $here . "\n";
6180 my $cnt = statement_rawlines($stat);
6181 for (my $n = 0; $n < $cnt; $n++) {
6182 $herectx .= raw_line($linenr, $n) . "\n";
6183 }
6184 WARN("DEFAULT_NO_BREAK",
6185 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006186 }
6187
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006188# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006189 if ($line =~ /\b__FUNCTION__\b/) {
6190 if (WARN("USE_FUNC",
6191 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6192 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006193 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006194 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006195 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006196
Joe Perches62ec8182015-02-13 14:38:18 -08006197# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6198 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6199 ERROR("DATE_TIME",
6200 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6201 }
6202
Joe Perches2c924882012-03-23 15:02:20 -07006203# check for use of yield()
6204 if ($line =~ /\byield\s*\(\s*\)/) {
6205 WARN("YIELD",
6206 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6207 }
6208
Joe Perches179f8f42013-07-03 15:05:30 -07006209# check for comparisons against true and false
6210 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6211 my $lead = $1;
6212 my $arg = $2;
6213 my $test = $3;
6214 my $otype = $4;
6215 my $trail = $5;
6216 my $op = "!";
6217
6218 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6219
6220 my $type = lc($otype);
6221 if ($type =~ /^(?:true|false)$/) {
6222 if (("$test" eq "==" && "$type" eq "true") ||
6223 ("$test" eq "!=" && "$type" eq "false")) {
6224 $op = "";
6225 }
6226
6227 CHK("BOOL_COMPARISON",
6228 "Using comparison to $otype is error prone\n" . $herecurr);
6229
6230## maybe suggesting a correct construct would better
6231## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6232
6233 }
6234 }
6235
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006236# check for semaphores initialized locked
6237 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006238 WARN("CONSIDER_COMPLETION",
6239 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006240 }
Joe Perches6712d852012-03-23 15:02:20 -07006241
Joe Perches67d0a072011-10-31 17:13:10 -07006242# recommend kstrto* over simple_strto* and strict_strto*
6243 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006244 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006245 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006246 }
Joe Perches6712d852012-03-23 15:02:20 -07006247
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006248# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006249 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006250 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006251 "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 -07006252 }
Joe Perches6712d852012-03-23 15:02:20 -07006253
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006254# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006255# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006256 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006257 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006258 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006259 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006260 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006261
6262# use of NR_CPUS is usually wrong
6263# ignore definitions of NR_CPUS and usage to define arrays as likely right
6264 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006265 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6266 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006267 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6268 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6269 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006270 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006271 WARN("NR_CPUS",
6272 "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 -07006273 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006274
Joe Perches52ea8502013-11-12 15:10:09 -08006275# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6276 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6277 ERROR("DEFINE_ARCH_HAS",
6278 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6279 }
6280
Joe Perchesacd93622015-02-13 14:38:38 -08006281# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6282 if ($^V && $^V ge 5.10.0 &&
6283 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6284 WARN("LIKELY_MISUSE",
6285 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6286 }
6287
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006288# whine mightly about in_atomic
6289 if ($line =~ /\bin_atomic\s*\(/) {
6290 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006291 ERROR("IN_ATOMIC",
6292 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006293 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006294 WARN("IN_ATOMIC",
6295 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006296 }
6297 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006298
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006299# check for mutex_trylock_recursive usage
6300 if ($line =~ /mutex_trylock_recursive/) {
6301 ERROR("LOCKING",
6302 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6303 }
6304
Peter Zijlstra1704f472010-03-19 01:37:42 +01006305# check for lockdep_set_novalidate_class
6306 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6307 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6308 if ($realfile !~ m@^kernel/lockdep@ &&
6309 $realfile !~ m@^include/linux/lockdep@ &&
6310 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006311 ERROR("LOCKDEP",
6312 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006313 }
6314 }
Dave Jones88f88312011-01-12 16:59:59 -08006315
Joe Perchesb392c642015-04-16 12:44:16 -07006316 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6317 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006318 WARN("EXPORTED_WORLD_WRITABLE",
6319 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006320 }
Joe Perches24358802014-04-03 14:49:13 -07006321
Joe Perches00180462018-02-06 15:38:55 -08006322# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6323# and whether or not function naming is typical and if
6324# DEVICE_ATTR permissions uses are unusual too
6325 if ($^V && $^V ge 5.10.0 &&
6326 defined $stat &&
6327 $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*\)/) {
6328 my $var = $1;
6329 my $perms = $2;
6330 my $show = $3;
6331 my $store = $4;
6332 my $octal_perms = perms_to_octal($perms);
6333 if ($show =~ /^${var}_show$/ &&
6334 $store =~ /^${var}_store$/ &&
6335 $octal_perms eq "0644") {
6336 if (WARN("DEVICE_ATTR_RW",
6337 "Use DEVICE_ATTR_RW\n" . $herecurr) &&
6338 $fix) {
6339 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6340 }
6341 } elsif ($show =~ /^${var}_show$/ &&
6342 $store =~ /^NULL$/ &&
6343 $octal_perms eq "0444") {
6344 if (WARN("DEVICE_ATTR_RO",
6345 "Use DEVICE_ATTR_RO\n" . $herecurr) &&
6346 $fix) {
6347 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6348 }
6349 } elsif ($show =~ /^NULL$/ &&
6350 $store =~ /^${var}_store$/ &&
6351 $octal_perms eq "0200") {
6352 if (WARN("DEVICE_ATTR_WO",
6353 "Use DEVICE_ATTR_WO\n" . $herecurr) &&
6354 $fix) {
6355 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6356 }
6357 } elsif ($octal_perms eq "0644" ||
6358 $octal_perms eq "0444" ||
6359 $octal_perms eq "0200") {
6360 my $newshow = "$show";
6361 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show");
6362 my $newstore = $store;
6363 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store");
6364 my $rename = "";
6365 if ($show ne $newshow) {
6366 $rename .= " '$show' to '$newshow'";
6367 }
6368 if ($store ne $newstore) {
6369 $rename .= " '$store' to '$newstore'";
6370 }
6371 WARN("DEVICE_ATTR_FUNCTIONS",
6372 "Consider renaming function(s)$rename\n" . $herecurr);
6373 } else {
6374 WARN("DEVICE_ATTR_PERMS",
6375 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr);
6376 }
6377 }
6378
Joe Perches515a2352014-04-03 14:49:24 -07006379# Mode permission misuses where it seems decimal should be octal
6380# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
Joe Perches73121532018-02-06 15:38:49 -08006381# o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6382# specific definition of not visible in sysfs.
6383# o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6384# use the default permissions
Joe Perches515a2352014-04-03 14:49:24 -07006385 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006386 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006387 $line =~ /$mode_perms_search/) {
6388 foreach my $entry (@mode_permission_funcs) {
6389 my $func = $entry->[0];
6390 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006391
Joe Perches459cf0a2016-10-11 13:52:19 -07006392 my $lc = $stat =~ tr@\n@@;
6393 $lc = $lc + $linenr;
6394 my $stat_real = raw_line($linenr, 0);
6395 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6396 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6397 }
6398
Joe Perches515a2352014-04-03 14:49:24 -07006399 my $skip_args = "";
6400 if ($arg_pos > 1) {
6401 $arg_pos--;
6402 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6403 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006404 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006405 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006406 my $val = $1;
6407 $val = $6 if ($skip_args ne "");
Joe Perches73121532018-02-06 15:38:49 -08006408 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") &&
6409 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6410 ($val =~ /^$Octal$/ && length($val) ne 4))) {
Joe Perches515a2352014-04-03 14:49:24 -07006411 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006412 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006413 }
6414 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006415 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006416 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006417 }
Joe Perches24358802014-04-03 14:49:13 -07006418 }
6419 }
6420 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006421
Joe Perches459cf0a2016-10-11 13:52:19 -07006422# check for uses of S_<PERMS> that could be octal for readability
Joe Perches00180462018-02-06 15:38:55 -08006423 if ($line =~ /\b($multi_mode_perms_string_search)\b/) {
6424 my $oval = $1;
6425 my $octal = perms_to_octal($oval);
Joe Perches459cf0a2016-10-11 13:52:19 -07006426 if (WARN("SYMBOLIC_PERMS",
6427 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6428 $fix) {
Joe Perches00180462018-02-06 15:38:55 -08006429 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/;
Joe Perches459cf0a2016-10-11 13:52:19 -07006430 }
6431 }
6432
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006433# validate content of MODULE_LICENSE against list from include/linux/module.h
6434 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6435 my $extracted_string = get_quoted_string($line, $rawline);
6436 my $valid_licenses = qr{
6437 GPL|
6438 GPL\ v2|
6439 GPL\ and\ additional\ rights|
6440 Dual\ BSD/GPL|
6441 Dual\ MIT/GPL|
6442 Dual\ MPL/GPL|
6443 Proprietary
6444 }x;
6445 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6446 WARN("MODULE_LICENSE",
6447 "unknown module license " . $extracted_string . "\n" . $herecurr);
6448 }
6449 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006450 }
6451
6452 # If we have no input at all, then there is nothing to report on
6453 # so just keep quiet.
6454 if ($#rawlines == -1) {
6455 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006456 }
6457
Andy Whitcroft8905a672007-11-28 16:21:06 -08006458 # In mailback mode only produce a report in the negative, for
6459 # things that appear to be patches.
6460 if ($mailback && ($clean == 1 || !$is_patch)) {
6461 exit(0);
6462 }
6463
6464 # This is not a patch, and we are are in 'no-patch' mode so
6465 # just keep quiet.
6466 if (!$chk_patch && !$is_patch) {
6467 exit(0);
6468 }
6469
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006470 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006471 ERROR("NOT_UNIFIED_DIFF",
6472 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006473 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006474 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006475 ERROR("MISSING_SIGN_OFF",
6476 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006477 }
6478
Andy Whitcroft8905a672007-11-28 16:21:06 -08006479 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006480 if ($summary && !($clean == 1 && $quiet == 1)) {
6481 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006482 print "total: $cnt_error errors, $cnt_warn warnings, " .
6483 (($check)? "$cnt_chk checks, " : "") .
6484 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006485 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006486
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006487 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006488 # If there were any defects found and not already fixing them
6489 if (!$clean and !$fix) {
6490 print << "EOM"
6491
6492NOTE: For some of the reported defects, checkpatch may be able to
6493 mechanically convert to the typical style using --fix or --fix-inplace.
6494EOM
6495 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006496 # If there were whitespace errors which cleanpatch can fix
6497 # then suggest that.
6498 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006499 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006500 print << "EOM"
6501
6502NOTE: Whitespace errors detected.
6503 You may wish to use scripts/cleanpatch or scripts/cleanfile
6504EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006505 }
6506 }
6507
Joe Perchesd752fcc2014-08-06 16:11:05 -07006508 if ($clean == 0 && $fix &&
6509 ("@rawlines" ne "@fixed" ||
6510 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006511 my $newfile = $filename;
6512 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006513 my $linecount = 0;
6514 my $f;
6515
Joe Perchesd752fcc2014-08-06 16:11:05 -07006516 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6517
Joe Perches3705ce52013-07-03 15:05:31 -07006518 open($f, '>', $newfile)
6519 or die "$P: Can't open $newfile for write\n";
6520 foreach my $fixed_line (@fixed) {
6521 $linecount++;
6522 if ($file) {
6523 if ($linecount > 3) {
6524 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006525 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006526 }
6527 } else {
6528 print $f $fixed_line . "\n";
6529 }
6530 }
6531 close($f);
6532
6533 if (!$quiet) {
6534 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006535
Joe Perches3705ce52013-07-03 15:05:31 -07006536Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6537
6538Do _NOT_ trust the results written to this file.
6539Do _NOT_ submit these changes without inspecting them for correctness.
6540
6541This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6542No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006543EOM
6544 }
6545 }
6546
Joe Perchesd8469f12015-06-25 15:03:00 -07006547 if ($quiet == 0) {
6548 print "\n";
6549 if ($clean == 1) {
6550 print "$vname has no obvious style problems and is ready for submission.\n";
6551 } else {
6552 print "$vname has style problems, please review.\n";
6553 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006554 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006555 return $clean;
6556}