blob: 95cda3ecc66b859ec1c86762810bfbd200687ef0 [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}
569
Joe Perchesb392c642015-04-16 12:44:16 -0700570our $mode_perms_world_writable = qr{
571 S_IWUGO |
572 S_IWOTH |
573 S_IRWXUGO |
574 S_IALLUGO |
575 0[0-7][0-7][2367]
576}x;
577
Joe Perchesf90774e2016-10-11 13:51:47 -0700578our %mode_permission_string_types = (
579 "S_IRWXU" => 0700,
580 "S_IRUSR" => 0400,
581 "S_IWUSR" => 0200,
582 "S_IXUSR" => 0100,
583 "S_IRWXG" => 0070,
584 "S_IRGRP" => 0040,
585 "S_IWGRP" => 0020,
586 "S_IXGRP" => 0010,
587 "S_IRWXO" => 0007,
588 "S_IROTH" => 0004,
589 "S_IWOTH" => 0002,
590 "S_IXOTH" => 0001,
591 "S_IRWXUGO" => 0777,
592 "S_IRUGO" => 0444,
593 "S_IWUGO" => 0222,
594 "S_IXUGO" => 0111,
595);
596
597#Create a search pattern for all these strings to speed up a loop below
598our $mode_perms_string_search = "";
599foreach my $entry (keys %mode_permission_string_types) {
600 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
601 $mode_perms_string_search .= $entry;
602}
603
Wolfram Sang7840a942010-08-09 17:20:57 -0700604our $allowed_asm_includes = qr{(?x:
605 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700606 memory|
607 time|
608 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700609)};
610# memory.h: ARM has a custom one
611
Kees Cook66b47b42014-10-13 15:51:57 -0700612# Load common spelling mistakes and build regular expression list.
613my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700614my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700615
Joe Perches36061e32014-12-10 15:51:43 -0800616if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800617 while (<$spelling>) {
618 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700619
Joe Perches36061e32014-12-10 15:51:43 -0800620 $line =~ s/\s*\n?$//g;
621 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700622
Joe Perches36061e32014-12-10 15:51:43 -0800623 next if ($line =~ m/^\s*#/);
624 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700625
Joe Perches36061e32014-12-10 15:51:43 -0800626 my ($suspect, $fix) = split(/\|\|/, $line);
627
Joe Perches36061e32014-12-10 15:51:43 -0800628 $spelling_fix{$suspect} = $fix;
629 }
630 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800631} else {
632 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700633}
Kees Cook66b47b42014-10-13 15:51:57 -0700634
Joe Perchesebfd7d62015-04-16 12:44:14 -0700635if ($codespell) {
636 if (open(my $spelling, '<', $codespellfile)) {
637 while (<$spelling>) {
638 my $line = $_;
639
640 $line =~ s/\s*\n?$//g;
641 $line =~ s/^\s*//g;
642
643 next if ($line =~ m/^\s*#/);
644 next if ($line =~ m/^\s*$/);
645 next if ($line =~ m/, disabled/i);
646
647 $line =~ s/,.*$//;
648
649 my ($suspect, $fix) = split(/->/, $line);
650
651 $spelling_fix{$suspect} = $fix;
652 }
653 close($spelling);
654 } else {
655 warn "No codespell typos will be found - file '$codespellfile': $!\n";
656 }
657}
658
659$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
660
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700661sub read_words {
662 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700663
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700664 if (open(my $words, '<', $file)) {
665 while (<$words>) {
666 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700667
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700668 $line =~ s/\s*\n?$//g;
669 $line =~ s/^\s*//g;
670
671 next if ($line =~ m/^\s*#/);
672 next if ($line =~ m/^\s*$/);
673 if ($line =~ /\s/) {
674 print("$file: '$line' invalid - ignored\n");
675 next;
676 }
677
678 $$wordsRef .= '|' if ($$wordsRef ne "");
679 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700680 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700681 close($file);
682 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700683 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700684
685 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700686}
687
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700688my $const_structs = "";
689read_words(\$const_structs, $conststructsfile)
690 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
691
692my $typeOtherTypedefs = "";
693if (length($typedefsfile)) {
694 read_words(\$typeOtherTypedefs, $typedefsfile)
695 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
696}
697$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
698
Andy Whitcroft8905a672007-11-28 16:21:06 -0800699sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700700 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
701 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700702 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700703 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700704 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700705 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700706 (?:$typeTypedefs\b)|
707 (?:${all}\b)
708 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800709 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700710 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800711 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800712 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700713 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700714 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800715 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700716 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800717 }x;
Joe Perches18130872014-08-06 16:11:22 -0700718 $NonptrTypeMisordered = qr{
719 (?:$Modifier\s+|const\s+)*
720 (?:
721 (?:${Misordered}\b)
722 )
723 (?:\s+$Modifier|\s+const)*
724 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700725 $NonptrTypeWithAttr = qr{
726 (?:$Modifier\s+|const\s+)*
727 (?:
728 (?:typeof|__typeof__)\s*\([^\)]*\)|
729 (?:$typeTypedefs\b)|
730 (?:${allWithAttr}\b)
731 )
732 (?:\s+$Modifier|\s+const)*
733 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800734 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700735 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700736 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700737 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800738 }x;
Joe Perches18130872014-08-06 16:11:22 -0700739 $TypeMisordered = qr{
740 $NonptrTypeMisordered
741 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
742 (?:\s+$Inline|\s+$Modifier)*
743 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700744 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700745 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800746}
747build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700748
Joe Perches7d2367a2011-07-25 17:13:22 -0700749our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700750
751# Using $balanced_parens, $LvalOrFunc, or $FuncArg
752# requires at least perl version v5.10.0
753# Any use must be runtime checked with $^V
754
755our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700756our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800757our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700758
Joe Perchesf8422302014-08-06 16:11:31 -0700759our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700760 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700761 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700762 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
763)};
764
Joe Perches7d2367a2011-07-25 17:13:22 -0700765sub deparenthesize {
766 my ($string) = @_;
767 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700768
769 while ($string =~ /^\s*\(.*\)\s*$/) {
770 $string =~ s@^\s*\(\s*@@;
771 $string =~ s@\s*\)\s*$@@;
772 }
773
Joe Perches7d2367a2011-07-25 17:13:22 -0700774 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700775
Joe Perches7d2367a2011-07-25 17:13:22 -0700776 return $string;
777}
778
Joe Perches34456862013-07-03 15:05:34 -0700779sub seed_camelcase_file {
780 my ($file) = @_;
781
782 return if (!(-f $file));
783
784 local $/;
785
786 open(my $include_file, '<', "$file")
787 or warn "$P: Can't read '$file' $!\n";
788 my $text = <$include_file>;
789 close($include_file);
790
791 my @lines = split('\n', $text);
792
793 foreach my $line (@lines) {
794 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
795 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
796 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800797 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
798 $camelcase{$1} = 1;
799 } 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 -0700800 $camelcase{$1} = 1;
801 }
802 }
803}
804
Joe Perches85b0ee12016-10-11 13:51:44 -0700805sub is_maintained_obsolete {
806 my ($filename) = @_;
807
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800808 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700809
Joe Perches0616efa2016-10-11 13:52:02 -0700810 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 -0700811
812 return $status =~ /obsolete/i;
813}
814
Joe Perches34456862013-07-03 15:05:34 -0700815my $camelcase_seeded = 0;
816sub seed_camelcase_includes {
817 return if ($camelcase_seeded);
818
819 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700820 my $camelcase_cache = "";
821 my @include_files = ();
822
823 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700824
Richard Genoud3645e322014-02-10 14:25:32 -0800825 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700826 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
827 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700828 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700829 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700830 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700831 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700832 @include_files = split('\n', $files);
833 foreach my $file (@include_files) {
834 my $date = POSIX::strftime("%Y%m%d%H%M",
835 localtime((stat $file)[9]));
836 $last_mod_date = $date if ($last_mod_date < $date);
837 }
838 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700839 }
Joe Perchesc707a812013-07-08 16:00:43 -0700840
841 if ($camelcase_cache ne "" && -f $camelcase_cache) {
842 open(my $camelcase_file, '<', "$camelcase_cache")
843 or warn "$P: Can't read '$camelcase_cache' $!\n";
844 while (<$camelcase_file>) {
845 chomp;
846 $camelcase{$_} = 1;
847 }
848 close($camelcase_file);
849
850 return;
851 }
852
Richard Genoud3645e322014-02-10 14:25:32 -0800853 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700854 $files = `git ls-files "include/*.h"`;
855 @include_files = split('\n', $files);
856 }
857
Joe Perches34456862013-07-03 15:05:34 -0700858 foreach my $file (@include_files) {
859 seed_camelcase_file($file);
860 }
Joe Perches351b2a12013-07-03 15:05:36 -0700861
Joe Perchesc707a812013-07-08 16:00:43 -0700862 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700863 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700864 open(my $camelcase_file, '>', "$camelcase_cache")
865 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700866 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
867 print $camelcase_file ("$_\n");
868 }
869 close($camelcase_file);
870 }
Joe Perches34456862013-07-03 15:05:34 -0700871}
872
Joe Perchesd311cd42014-08-06 16:10:57 -0700873sub git_commit_info {
874 my ($commit, $id, $desc) = @_;
875
876 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
877
878 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
879 $output =~ s/^\s*//gm;
880 my @lines = split("\n", $output);
881
Joe Perches0d7835f2015-02-13 14:38:35 -0800882 return ($id, $desc) if ($#lines < 0);
883
Joe Perchesd311cd42014-08-06 16:10:57 -0700884 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
885# Maybe one day convert this block of bash into something that returns
886# all matching commit ids, but it's very slow...
887#
888# echo "checking commits $1..."
889# git rev-list --remotes | grep -i "^$1" |
890# while read line ; do
891# git log --format='%H %s' -1 $line |
892# echo "commit $(cut -c 1-12,41-)"
893# done
894 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700895 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700896 } else {
897 $id = substr($lines[0], 0, 12);
898 $desc = substr($lines[0], 41);
899 }
900
901 return ($id, $desc);
902}
903
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904$chk_signoff = 0 if ($file);
905
Andy Whitcroft00df3442007-06-08 13:47:06 -0700906my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800907my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700908my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700909my @fixed_inserted = ();
910my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700911my $fixlinenr = -1;
912
Du, Changbin4a593c32016-05-20 17:04:16 -0700913# If input is git commits, extract all commits from the commit expressions.
914# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
915die "$P: No git repository found\n" if ($git && !-e ".git");
916
917if ($git) {
918 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700919 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700920 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700921 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
922 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700923 } elsif ($commit_expr =~ m/\.\./) {
924 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700925 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700926 $git_range = "-1 $commit_expr";
927 }
928 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
929 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700930 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
931 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700932 my $sha1 = $1;
933 my $subject = $2;
934 unshift(@commits, $sha1);
935 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700936 }
937 }
938 die "$P: no git commits after extraction!\n" if (@commits == 0);
939 @ARGV = @commits;
940}
941
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800942my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700943for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800944 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700945 if ($git) {
946 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
947 die "$P: $filename: git format-patch failed - $!\n";
948 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800949 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700950 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800951 } elsif ($filename eq '-') {
952 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700953 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800954 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700955 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700956 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800957 if ($filename eq '-') {
958 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700959 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700960 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800961 } else {
962 $vname = $filename;
963 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800964 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700965 chomp;
966 push(@rawlines, $_);
967 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800968 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700969
970 if ($#ARGV > 0 && $quiet == 0) {
971 print '-' x length($vname) . "\n";
972 print "$vname\n";
973 print '-' x length($vname) . "\n";
974 }
975
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800976 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700977 $exit = 1;
978 }
979 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800980 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700981 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700982 @fixed_inserted = ();
983 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700984 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700985 @modifierListFile = ();
986 @typeListFile = ();
987 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700988}
989
Joe Perchesd8469f12015-06-25 15:03:00 -0700990if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700991 hash_show_words(\%use_type, "Used");
992 hash_show_words(\%ignore_type, "Ignored");
993
Joe Perchesd8469f12015-06-25 15:03:00 -0700994 if ($^V lt 5.10.0) {
995 print << "EOM"
996
997NOTE: perl $^V is not modern enough to detect all possible issues.
998 An upgrade to at least perl v5.10.0 is suggested.
999EOM
1000 }
1001 if ($exit) {
1002 print << "EOM"
1003
1004NOTE: If any of the errors are false positives, please report
1005 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1006EOM
1007 }
1008}
1009
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001010exit($exit);
1011
1012sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001013 my ($root) = @_;
1014
1015 my @tree_check = (
1016 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1017 "README", "Documentation", "arch", "include", "drivers",
1018 "fs", "init", "ipc", "kernel", "lib", "scripts",
1019 );
1020
1021 foreach my $check (@tree_check) {
1022 if (! -e $root . '/' . $check) {
1023 return 0;
1024 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001025 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001026 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001027}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001028
Joe Perches20112472011-07-25 17:13:23 -07001029sub parse_email {
1030 my ($formatted_email) = @_;
1031
1032 my $name = "";
1033 my $address = "";
1034 my $comment = "";
1035
1036 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1037 $name = $1;
1038 $address = $2;
1039 $comment = $3 if defined $3;
1040 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1041 $address = $1;
1042 $comment = $2 if defined $2;
1043 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1044 $address = $1;
1045 $comment = $2 if defined $2;
1046 $formatted_email =~ s/$address.*$//;
1047 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001048 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001049 $name =~ s/^\"|\"$//g;
1050 # If there's a name left after stripping spaces and
1051 # leading quotes, and the address doesn't have both
1052 # leading and trailing angle brackets, the address
1053 # is invalid. ie:
1054 # "joe smith joe@smith.com" bad
1055 # "joe smith <joe@smith.com" bad
1056 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1057 $name = "";
1058 $address = "";
1059 $comment = "";
1060 }
1061 }
1062
Joe Perches3705ce52013-07-03 15:05:31 -07001063 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001064 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001065 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001066 $address =~ s/^\<|\>$//g;
1067
1068 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1069 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1070 $name = "\"$name\"";
1071 }
1072
1073 return ($name, $address, $comment);
1074}
1075
1076sub format_email {
1077 my ($name, $address) = @_;
1078
1079 my $formatted_email;
1080
Joe Perches3705ce52013-07-03 15:05:31 -07001081 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001082 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001083 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001084
1085 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1086 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1087 $name = "\"$name\"";
1088 }
1089
1090 if ("$name" eq "") {
1091 $formatted_email = "$address";
1092 } else {
1093 $formatted_email = "$name <$address>";
1094 }
1095
1096 return $formatted_email;
1097}
1098
Joe Perchesd311cd42014-08-06 16:10:57 -07001099sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001100 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001101
Joe Perchesbd474ca2014-08-06 16:11:10 -07001102 foreach my $path (split(/:/, $ENV{PATH})) {
1103 if (-e "$path/$bin") {
1104 return "$path/$bin";
1105 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001106 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001107
Joe Perchesbd474ca2014-08-06 16:11:10 -07001108 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001109}
1110
Joe Perches000d1cc12011-07-25 17:13:25 -07001111sub which_conf {
1112 my ($conf) = @_;
1113
1114 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1115 if (-e "$path/$conf") {
1116 return "$path/$conf";
1117 }
1118 }
1119
1120 return "";
1121}
1122
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001123sub expand_tabs {
1124 my ($str) = @_;
1125
1126 my $res = '';
1127 my $n = 0;
1128 for my $c (split(//, $str)) {
1129 if ($c eq "\t") {
1130 $res .= ' ';
1131 $n++;
1132 for (; ($n % 8) != 0; $n++) {
1133 $res .= ' ';
1134 }
1135 next;
1136 }
1137 $res .= $c;
1138 $n++;
1139 }
1140
1141 return $res;
1142}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001143sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001144 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001145 return $res;
1146}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001147
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001148sub line_stats {
1149 my ($line) = @_;
1150
1151 # Drop the diff line leader and expand tabs
1152 $line =~ s/^.//;
1153 $line = expand_tabs($line);
1154
1155 # Pick the indent from the front of the line.
1156 my ($white) = ($line =~ /^(\s*)/);
1157
1158 return (length($line), length($white));
1159}
1160
Andy Whitcroft773647a2008-03-28 14:15:58 -07001161my $sanitise_quote = '';
1162
1163sub sanitise_line_reset {
1164 my ($in_comment) = @_;
1165
1166 if ($in_comment) {
1167 $sanitise_quote = '*/';
1168 } else {
1169 $sanitise_quote = '';
1170 }
1171}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001172sub sanitise_line {
1173 my ($line) = @_;
1174
1175 my $res = '';
1176 my $l = '';
1177
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001178 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001179 my $off = 0;
1180 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001181
Andy Whitcroft773647a2008-03-28 14:15:58 -07001182 # Always copy over the diff marker.
1183 $res = substr($line, 0, 1);
1184
1185 for ($off = 1; $off < length($line); $off++) {
1186 $c = substr($line, $off, 1);
1187
1188 # Comments we are wacking completly including the begin
1189 # and end, all to $;.
1190 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1191 $sanitise_quote = '*/';
1192
1193 substr($res, $off, 2, "$;$;");
1194 $off++;
1195 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001196 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001197 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001198 $sanitise_quote = '';
1199 substr($res, $off, 2, "$;$;");
1200 $off++;
1201 next;
1202 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001203 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1204 $sanitise_quote = '//';
1205
1206 substr($res, $off, 2, $sanitise_quote);
1207 $off++;
1208 next;
1209 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001210
1211 # A \ in a string means ignore the next character.
1212 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1213 $c eq "\\") {
1214 substr($res, $off, 2, 'XX');
1215 $off++;
1216 next;
1217 }
1218 # Regular quotes.
1219 if ($c eq "'" || $c eq '"') {
1220 if ($sanitise_quote eq '') {
1221 $sanitise_quote = $c;
1222
1223 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001224 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001225 } elsif ($sanitise_quote eq $c) {
1226 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001227 }
1228 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001229
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001230 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001231 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1232 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001233 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1234 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001235 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1236 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001237 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001238 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001239 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001240 }
1241
Daniel Walker113f04a2009-09-21 17:04:35 -07001242 if ($sanitise_quote eq '//') {
1243 $sanitise_quote = '';
1244 }
1245
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001246 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001247 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001248 my $clean = 'X' x length($1);
1249 $res =~ s@\<.*\>@<$clean>@;
1250
1251 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001252 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001253 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001254 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001255 }
1256
Joe Perchesdadf6802016-08-02 14:04:33 -07001257 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1258 my $match = $1;
1259 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1260 }
1261
Andy Whitcroft00df3442007-06-08 13:47:06 -07001262 return $res;
1263}
1264
Joe Perchesa6962d72013-04-29 16:18:13 -07001265sub get_quoted_string {
1266 my ($line, $rawline) = @_;
1267
Joe Perches33acb542015-06-25 15:02:54 -07001268 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001269 return substr($rawline, $-[0], $+[0] - $-[0]);
1270}
1271
Andy Whitcroft8905a672007-11-28 16:21:06 -08001272sub ctx_statement_block {
1273 my ($linenr, $remain, $off) = @_;
1274 my $line = $linenr - 1;
1275 my $blk = '';
1276 my $soff = $off;
1277 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001278 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001279
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001280 my $loff = 0;
1281
Andy Whitcroft8905a672007-11-28 16:21:06 -08001282 my $type = '';
1283 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001284 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001285 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001286 my $c;
1287 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001288
1289 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001290 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001291 @stack = (['', 0]) if ($#stack == -1);
1292
Andy Whitcroft773647a2008-03-28 14:15:58 -07001293 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001294 # If we are about to drop off the end, pull in more
1295 # context.
1296 if ($off >= $len) {
1297 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001298 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001299 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001300 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001301 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001303 $len = length($blk);
1304 $line++;
1305 last;
1306 }
1307 # Bail if there is no further context.
1308 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001309 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001310 last;
1311 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001312 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1313 $level++;
1314 $type = '#';
1315 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001316 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001317 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001318 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001319 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001320
Andy Whitcroft773647a2008-03-28 14:15:58 -07001321 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001322
1323 # Handle nested #if/#else.
1324 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1325 push(@stack, [ $type, $level ]);
1326 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1327 ($type, $level) = @{$stack[$#stack - 1]};
1328 } elsif ($remainder =~ /^#\s*endif\b/) {
1329 ($type, $level) = @{pop(@stack)};
1330 }
1331
Andy Whitcroft8905a672007-11-28 16:21:06 -08001332 # Statement ends at the ';' or a close '}' at the
1333 # outermost level.
1334 if ($level == 0 && $c eq ';') {
1335 last;
1336 }
1337
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001338 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001339 if ($level == 0 && $coff_set == 0 &&
1340 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1341 $remainder =~ /^(else)(?:\s|{)/ &&
1342 $remainder !~ /^else\s+if\b/) {
1343 $coff = $off + length($1) - 1;
1344 $coff_set = 1;
1345 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1346 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001347 }
1348
Andy Whitcroft8905a672007-11-28 16:21:06 -08001349 if (($type eq '' || $type eq '(') && $c eq '(') {
1350 $level++;
1351 $type = '(';
1352 }
1353 if ($type eq '(' && $c eq ')') {
1354 $level--;
1355 $type = ($level != 0)? '(' : '';
1356
1357 if ($level == 0 && $coff < $soff) {
1358 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001359 $coff_set = 1;
1360 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001361 }
1362 }
1363 if (($type eq '' || $type eq '{') && $c eq '{') {
1364 $level++;
1365 $type = '{';
1366 }
1367 if ($type eq '{' && $c eq '}') {
1368 $level--;
1369 $type = ($level != 0)? '{' : '';
1370
1371 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001372 if (substr($blk, $off + 1, 1) eq ';') {
1373 $off++;
1374 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001375 last;
1376 }
1377 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001378 # Preprocessor commands end at the newline unless escaped.
1379 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1380 $level--;
1381 $type = '';
1382 $off++;
1383 last;
1384 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001385 $off++;
1386 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001387 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001388 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001389 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001390 $line++;
1391 $remain--;
1392 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001393
1394 my $statement = substr($blk, $soff, $off - $soff + 1);
1395 my $condition = substr($blk, $soff, $coff - $soff + 1);
1396
1397 #warn "STATEMENT<$statement>\n";
1398 #warn "CONDITION<$condition>\n";
1399
Andy Whitcroft773647a2008-03-28 14:15:58 -07001400 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001401
1402 return ($statement, $condition,
1403 $line, $remain + 1, $off - $loff + 1, $level);
1404}
1405
Andy Whitcroftcf655042008-03-04 14:28:20 -08001406sub statement_lines {
1407 my ($stmt) = @_;
1408
1409 # Strip the diff line prefixes and rip blank lines at start and end.
1410 $stmt =~ s/(^|\n)./$1/g;
1411 $stmt =~ s/^\s*//;
1412 $stmt =~ s/\s*$//;
1413
1414 my @stmt_lines = ($stmt =~ /\n/g);
1415
1416 return $#stmt_lines + 2;
1417}
1418
1419sub statement_rawlines {
1420 my ($stmt) = @_;
1421
1422 my @stmt_lines = ($stmt =~ /\n/g);
1423
1424 return $#stmt_lines + 2;
1425}
1426
1427sub statement_block_size {
1428 my ($stmt) = @_;
1429
1430 $stmt =~ s/(^|\n)./$1/g;
1431 $stmt =~ s/^\s*{//;
1432 $stmt =~ s/}\s*$//;
1433 $stmt =~ s/^\s*//;
1434 $stmt =~ s/\s*$//;
1435
1436 my @stmt_lines = ($stmt =~ /\n/g);
1437 my @stmt_statements = ($stmt =~ /;/g);
1438
1439 my $stmt_lines = $#stmt_lines + 2;
1440 my $stmt_statements = $#stmt_statements + 1;
1441
1442 if ($stmt_lines > $stmt_statements) {
1443 return $stmt_lines;
1444 } else {
1445 return $stmt_statements;
1446 }
1447}
1448
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001449sub ctx_statement_full {
1450 my ($linenr, $remain, $off) = @_;
1451 my ($statement, $condition, $level);
1452
1453 my (@chunks);
1454
Andy Whitcroftcf655042008-03-04 14:28:20 -08001455 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001456 ($statement, $condition, $linenr, $remain, $off, $level) =
1457 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001458 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001459 push(@chunks, [ $condition, $statement ]);
1460 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1461 return ($level, $linenr, @chunks);
1462 }
1463
1464 # Pull in the following conditional/block pairs and see if they
1465 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001466 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001467 ($statement, $condition, $linenr, $remain, $off, $level) =
1468 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001469 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001470 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001471 #print "C: push\n";
1472 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001473 }
1474
1475 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001476}
1477
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001478sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001479 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001480 my $line;
1481 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001482 my $blk = '';
1483 my @o;
1484 my @c;
1485 my @res = ();
1486
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001487 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001488 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001489 for ($line = $start; $remain > 0; $line++) {
1490 next if ($rawlines[$line] =~ /^-/);
1491 $remain--;
1492
1493 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001494
1495 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001496 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001497 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001498 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001499 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001500 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001501 $level = pop(@stack);
1502 }
1503
Andy Whitcroft01464f32010-10-26 14:23:19 -07001504 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001505 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1506 if ($off > 0) {
1507 $off--;
1508 next;
1509 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001510
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001511 if ($c eq $close && $level > 0) {
1512 $level--;
1513 last if ($level == 0);
1514 } elsif ($c eq $open) {
1515 $level++;
1516 }
1517 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001518
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001519 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001520 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001521 }
1522
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001523 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001524 }
1525
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001526 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001527}
1528sub ctx_block_outer {
1529 my ($linenr, $remain) = @_;
1530
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001531 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1532 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001533}
1534sub ctx_block {
1535 my ($linenr, $remain) = @_;
1536
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001537 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1538 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001539}
1540sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001541 my ($linenr, $remain, $off) = @_;
1542
1543 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1544 return @r;
1545}
1546sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001547 my ($linenr, $remain) = @_;
1548
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001549 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001550}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001551sub ctx_statement_level {
1552 my ($linenr, $remain, $off) = @_;
1553
1554 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1555}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001556
1557sub ctx_locate_comment {
1558 my ($first_line, $end_line) = @_;
1559
1560 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001561 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001562 return $current_comment if (defined $current_comment);
1563
1564 # Look through the context and try and figure out if there is a
1565 # comment.
1566 my $in_comment = 0;
1567 $current_comment = '';
1568 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001569 my $line = $rawlines[$linenr - 1];
1570 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001571 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1572 $in_comment = 1;
1573 }
1574 if ($line =~ m@/\*@) {
1575 $in_comment = 1;
1576 }
1577 if (!$in_comment && $current_comment ne '') {
1578 $current_comment = '';
1579 }
1580 $current_comment .= $line . "\n" if ($in_comment);
1581 if ($line =~ m@\*/@) {
1582 $in_comment = 0;
1583 }
1584 }
1585
1586 chomp($current_comment);
1587 return($current_comment);
1588}
1589sub ctx_has_comment {
1590 my ($first_line, $end_line) = @_;
1591 my $cmt = ctx_locate_comment($first_line, $end_line);
1592
Andy Whitcroft00df3442007-06-08 13:47:06 -07001593 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001594 ##print "CMMT: $cmt\n";
1595
1596 return ($cmt ne '');
1597}
1598
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001599sub raw_line {
1600 my ($linenr, $cnt) = @_;
1601
1602 my $offset = $linenr - 1;
1603 $cnt++;
1604
1605 my $line;
1606 while ($cnt) {
1607 $line = $rawlines[$offset++];
1608 next if (defined($line) && $line =~ /^-/);
1609 $cnt--;
1610 }
1611
1612 return $line;
1613}
1614
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001615sub cat_vet {
1616 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001617 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001618
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001619 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001620 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1621 $res .= $1;
1622 if ($2 ne '') {
1623 $coded = sprintf("^%c", unpack('C', $2) + 64);
1624 $res .= $coded;
1625 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001626 }
1627 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001628
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001629 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001630}
1631
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001632my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001633my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001634my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001635my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001636
1637sub annotate_reset {
1638 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001639 $av_pending = '_';
1640 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001641 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001642}
1643
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001644sub annotate_values {
1645 my ($stream, $type) = @_;
1646
1647 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001648 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001649 my $cur = $stream;
1650
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001651 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001653 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001654 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001655 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001656 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001657 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001658 print "WS($1)\n" if ($dbg_values > 1);
1659 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001660 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001661 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001662 }
1663
Florian Micklerc023e4732011-01-12 16:59:58 -08001664 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001665 print "CAST($1)\n" if ($dbg_values > 1);
1666 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001667 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001668
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001669 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001670 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001671 $type = 'T';
1672
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001673 } elsif ($cur =~ /^($Modifier)\s*/) {
1674 print "MODIFIER($1)\n" if ($dbg_values > 1);
1675 $type = 'T';
1676
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001677 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001678 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001679 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001680 push(@av_paren_type, $type);
1681 if ($2 ne '') {
1682 $av_pending = 'N';
1683 }
1684 $type = 'E';
1685
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001686 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001687 print "UNDEF($1)\n" if ($dbg_values > 1);
1688 $av_preprocessor = 1;
1689 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001690
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001691 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001692 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001693 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001694
1695 push(@av_paren_type, $type);
1696 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001697 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001698
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001699 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001700 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1701 $av_preprocessor = 1;
1702
1703 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1704
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001705 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001706
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001707 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001708 print "PRE_END($1)\n" if ($dbg_values > 1);
1709
1710 $av_preprocessor = 1;
1711
1712 # Assume all arms of the conditional end as this
1713 # one does, and continue as if the #endif was not here.
1714 pop(@av_paren_type);
1715 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001716 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001717
1718 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001719 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001720
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001721 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1722 print "ATTR($1)\n" if ($dbg_values > 1);
1723 $av_pending = $type;
1724 $type = 'N';
1725
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001726 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001727 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001728 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001729 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001730 }
1731 $type = 'N';
1732
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001733 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001734 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001735 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001736 $type = 'N';
1737
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001738 } elsif ($cur =~/^(case)/o) {
1739 print "CASE($1)\n" if ($dbg_values > 1);
1740 $av_pend_colon = 'C';
1741 $type = 'N';
1742
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001743 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001744 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001745 $type = 'N';
1746
1747 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001748 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001749 push(@av_paren_type, $av_pending);
1750 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001751 $type = 'N';
1752
1753 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001754 my $new_type = pop(@av_paren_type);
1755 if ($new_type ne '_') {
1756 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001757 print "PAREN('$1') -> $type\n"
1758 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001759 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001760 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761 }
1762
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001763 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001764 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001765 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001766 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001767
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001768 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1769 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001770 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001771 } elsif ($type eq 'E') {
1772 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001773 }
1774 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1775 $type = 'V';
1776
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001777 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001778 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001779 $type = 'V';
1780
1781 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001782 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001783 $type = 'N';
1784
Andy Whitcroftcf655042008-03-04 14:28:20 -08001785 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001786 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001787 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001788 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001789
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001790 } elsif ($cur =~/^(,)/) {
1791 print "COMMA($1)\n" if ($dbg_values > 1);
1792 $type = 'C';
1793
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001794 } elsif ($cur =~ /^(\?)/o) {
1795 print "QUESTION($1)\n" if ($dbg_values > 1);
1796 $type = 'N';
1797
1798 } elsif ($cur =~ /^(:)/o) {
1799 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1800
1801 substr($var, length($res), 1, $av_pend_colon);
1802 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1803 $type = 'E';
1804 } else {
1805 $type = 'N';
1806 }
1807 $av_pend_colon = 'O';
1808
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001809 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001810 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001811 $type = 'N';
1812
Andy Whitcroft0d413862008-10-15 22:02:16 -07001813 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001814 my $variant;
1815
1816 print "OPV($1)\n" if ($dbg_values > 1);
1817 if ($type eq 'V') {
1818 $variant = 'B';
1819 } else {
1820 $variant = 'U';
1821 }
1822
1823 substr($var, length($res), 1, $variant);
1824 $type = 'N';
1825
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001826 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001827 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001828 if ($1 ne '++' && $1 ne '--') {
1829 $type = 'N';
1830 }
1831
1832 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001833 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001834 }
1835 if (defined $1) {
1836 $cur = substr($cur, length($1));
1837 $res .= $type x length($1);
1838 }
1839 }
1840
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001841 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001842}
1843
Andy Whitcroft8905a672007-11-28 16:21:06 -08001844sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001845 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001846 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001847 ^(?:
1848 $Modifier|
1849 $Storage|
1850 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001851 DEFINE_\S+
1852 )$|
1853 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001854 goto|
1855 return|
1856 case|
1857 else|
1858 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001859 do|
1860 \#|
1861 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001862 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001863 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001864 )}x;
1865 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1866 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001867 # Check for modifiers.
1868 $possible =~ s/\s*$Storage\s*//g;
1869 $possible =~ s/\s*$Sparse\s*//g;
1870 if ($possible =~ /^\s*$/) {
1871
1872 } elsif ($possible =~ /\s/) {
1873 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001874 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001875 if ($modifier !~ $notPermitted) {
1876 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001877 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001878 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001879 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001880
1881 } else {
1882 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001883 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001884 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001885 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001886 } else {
1887 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001888 }
1889}
1890
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001891my $prefix = '';
1892
Joe Perches000d1cc12011-07-25 17:13:25 -07001893sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001894 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001895
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001896 $type =~ tr/[a-z]/[A-Z]/;
1897
Joe Perchescbec18a2014-04-03 14:49:19 -07001898 return defined $use_type{$type} if (scalar keys %use_type > 0);
1899
1900 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001901}
1902
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001903sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001904 my ($level, $type, $msg) = @_;
1905
1906 if (!show_type($type) ||
1907 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001908 return 0;
1909 }
Joe Perches57230292015-06-25 15:03:03 -07001910 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001911 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001912 if ($level eq 'ERROR') {
1913 $output .= RED;
1914 } elsif ($level eq 'WARNING') {
1915 $output .= YELLOW;
1916 } else {
1917 $output .= GREEN;
1918 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001919 }
Joe Perches57230292015-06-25 15:03:03 -07001920 $output .= $prefix . $level . ':';
1921 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001922 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001923 $output .= "$type:";
1924 }
John Brooks737c0762017-07-10 15:52:24 -07001925 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001926 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001927
1928 if ($showfile) {
1929 my @lines = split("\n", $output, -1);
1930 splice(@lines, 1, 1);
1931 $output = join("\n", @lines);
1932 }
Joe Perches57230292015-06-25 15:03:03 -07001933 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001934
Joe Perches57230292015-06-25 15:03:03 -07001935 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001936
1937 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001938}
Joe Perchescbec18a2014-04-03 14:49:19 -07001939
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001940sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001941 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001942}
Joe Perches000d1cc12011-07-25 17:13:25 -07001943
Joe Perchesd752fcc2014-08-06 16:11:05 -07001944sub fixup_current_range {
1945 my ($lineRef, $offset, $length) = @_;
1946
1947 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1948 my $o = $1;
1949 my $l = $2;
1950 my $no = $o + $offset;
1951 my $nl = $l + $length;
1952 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1953 }
1954}
1955
1956sub fix_inserted_deleted_lines {
1957 my ($linesRef, $insertedRef, $deletedRef) = @_;
1958
1959 my $range_last_linenr = 0;
1960 my $delta_offset = 0;
1961
1962 my $old_linenr = 0;
1963 my $new_linenr = 0;
1964
1965 my $next_insert = 0;
1966 my $next_delete = 0;
1967
1968 my @lines = ();
1969
1970 my $inserted = @{$insertedRef}[$next_insert++];
1971 my $deleted = @{$deletedRef}[$next_delete++];
1972
1973 foreach my $old_line (@{$linesRef}) {
1974 my $save_line = 1;
1975 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001976 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001977 $delta_offset = 0;
1978 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1979 $range_last_linenr = $new_linenr;
1980 fixup_current_range(\$line, $delta_offset, 0);
1981 }
1982
1983 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1984 $deleted = @{$deletedRef}[$next_delete++];
1985 $save_line = 0;
1986 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1987 }
1988
1989 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1990 push(@lines, ${$inserted}{'LINE'});
1991 $inserted = @{$insertedRef}[$next_insert++];
1992 $new_linenr++;
1993 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1994 }
1995
1996 if ($save_line) {
1997 push(@lines, $line);
1998 $new_linenr++;
1999 }
2000
2001 $old_linenr++;
2002 }
2003
2004 return @lines;
2005}
2006
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002007sub fix_insert_line {
2008 my ($linenr, $line) = @_;
2009
2010 my $inserted = {
2011 LINENR => $linenr,
2012 LINE => $line,
2013 };
2014 push(@fixed_inserted, $inserted);
2015}
2016
2017sub fix_delete_line {
2018 my ($linenr, $line) = @_;
2019
2020 my $deleted = {
2021 LINENR => $linenr,
2022 LINE => $line,
2023 };
2024
2025 push(@fixed_deleted, $deleted);
2026}
2027
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002028sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002029 my ($type, $msg) = @_;
2030
2031 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002032 our $clean = 0;
2033 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002034 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002035 }
Joe Perches3705ce52013-07-03 15:05:31 -07002036 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002037}
2038sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002039 my ($type, $msg) = @_;
2040
2041 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002042 our $clean = 0;
2043 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002044 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002045 }
Joe Perches3705ce52013-07-03 15:05:31 -07002046 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002047}
2048sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002049 my ($type, $msg) = @_;
2050
2051 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002052 our $clean = 0;
2053 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002054 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002055 }
Joe Perches3705ce52013-07-03 15:05:31 -07002056 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002057}
2058
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002059sub check_absolute_file {
2060 my ($absolute, $herecurr) = @_;
2061 my $file = $absolute;
2062
2063 ##print "absolute<$absolute>\n";
2064
2065 # See if any suffix of this path is a path within the tree.
2066 while ($file =~ s@^[^/]*/@@) {
2067 if (-f "$root/$file") {
2068 ##print "file<$file>\n";
2069 last;
2070 }
2071 }
2072 if (! -f _) {
2073 return 0;
2074 }
2075
2076 # It is, so see if the prefix is acceptable.
2077 my $prefix = $absolute;
2078 substr($prefix, -length($file)) = '';
2079
2080 ##print "prefix<$prefix>\n";
2081 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002082 WARN("USE_RELATIVE_PATH",
2083 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002084 }
2085}
2086
Joe Perches3705ce52013-07-03 15:05:31 -07002087sub trim {
2088 my ($string) = @_;
2089
Joe Perchesb34c6482013-09-11 14:24:01 -07002090 $string =~ s/^\s+|\s+$//g;
2091
2092 return $string;
2093}
2094
2095sub ltrim {
2096 my ($string) = @_;
2097
2098 $string =~ s/^\s+//;
2099
2100 return $string;
2101}
2102
2103sub rtrim {
2104 my ($string) = @_;
2105
2106 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002107
2108 return $string;
2109}
2110
Joe Perches52ea8502013-11-12 15:10:09 -08002111sub string_find_replace {
2112 my ($string, $find, $replace) = @_;
2113
2114 $string =~ s/$find/$replace/g;
2115
2116 return $string;
2117}
2118
Joe Perches3705ce52013-07-03 15:05:31 -07002119sub tabify {
2120 my ($leading) = @_;
2121
2122 my $source_indent = 8;
2123 my $max_spaces_before_tab = $source_indent - 1;
2124 my $spaces_to_tab = " " x $source_indent;
2125
2126 #convert leading spaces to tabs
2127 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2128 #Remove spaces before a tab
2129 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2130
2131 return "$leading";
2132}
2133
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002134sub pos_last_openparen {
2135 my ($line) = @_;
2136
2137 my $pos = 0;
2138
2139 my $opens = $line =~ tr/\(/\(/;
2140 my $closes = $line =~ tr/\)/\)/;
2141
2142 my $last_openparen = 0;
2143
2144 if (($opens == 0) || ($closes >= $opens)) {
2145 return -1;
2146 }
2147
2148 my $len = length($line);
2149
2150 for ($pos = 0; $pos < $len; $pos++) {
2151 my $string = substr($line, $pos);
2152 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2153 $pos += length($1) - 1;
2154 } elsif (substr($line, $pos, 1) eq '(') {
2155 $last_openparen = $pos;
2156 } elsif (index($string, '(') == -1) {
2157 last;
2158 }
2159 }
2160
Joe Perches91cb5192014-04-03 14:49:32 -07002161 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002162}
2163
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002164sub process {
2165 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002166
2167 my $linenr=0;
2168 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002169 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002170 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002171 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002172
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002173 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002174 my $indent;
2175 my $previndent=0;
2176 my $stashindent=0;
2177
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002178 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002179 my $signoff = 0;
2180 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002181 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002182 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002183 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002184 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002185 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002186 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002187 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002188 my $non_utf8_charset = 0;
2189
Joe Perches365dd4e2014-08-06 16:10:42 -07002190 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002191 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002192
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002193 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002194 our $cnt_lines = 0;
2195 our $cnt_error = 0;
2196 our $cnt_warn = 0;
2197 our $cnt_chk = 0;
2198
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002199 # Trace the real file/line as we go.
2200 my $realfile = '';
2201 my $realline = 0;
2202 my $realcnt = 0;
2203 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002204 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002205 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002206 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002207 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002208 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002209
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002210 my $prev_values = 'E';
2211
2212 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002213 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002214 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002215 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002216 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002217
Joe Perches7e51f192013-09-11 14:23:57 -07002218 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002219
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002220 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002221 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002222 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002223 my @setup_docs = ();
2224 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002225
Joe Perchesd8b07712013-11-12 15:10:06 -08002226 my $camelcase_file_seeded = 0;
2227
Andy Whitcroft773647a2008-03-28 14:15:58 -07002228 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002229 my $line;
2230 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002231 $linenr++;
2232 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002233
Joe Perches3705ce52013-07-03 15:05:31 -07002234 push(@fixed, $rawline) if ($fix);
2235
Andy Whitcroft773647a2008-03-28 14:15:58 -07002236 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002237 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002238 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002239 $setup_docs = 1;
2240 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002241 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002242 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002243 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002244 $realline=$1-1;
2245 if (defined $2) {
2246 $realcnt=$3+1;
2247 } else {
2248 $realcnt=1+1;
2249 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002250 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002251
2252 # Guestimate if this is a continuing comment. Run
2253 # the context looking for a comment "edge". If this
2254 # edge is a close comment then we must be in a comment
2255 # at context start.
2256 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002257 my $cnt = $realcnt;
2258 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2259 next if (defined $rawlines[$ln - 1] &&
2260 $rawlines[$ln - 1] =~ /^-/);
2261 $cnt--;
2262 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002263 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002264 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2265 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2266 ($edge) = $1;
2267 last;
2268 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002269 }
2270 if (defined $edge && $edge eq '*/') {
2271 $in_comment = 1;
2272 }
2273
2274 # Guestimate if this is a continuing comment. If this
2275 # is the start of a diff block and this line starts
2276 # ' *' then it is very likely a comment.
2277 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002278 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002279 {
2280 $in_comment = 1;
2281 }
2282
2283 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2284 sanitise_line_reset($in_comment);
2285
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002286 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002287 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002288 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002289 $line = sanitise_line($rawline);
2290 }
2291 push(@lines, $line);
2292
2293 if ($realcnt > 1) {
2294 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2295 } else {
2296 $realcnt = 0;
2297 }
2298
2299 #print "==>$rawline\n";
2300 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002301
2302 if ($setup_docs && $line =~ /^\+/) {
2303 push(@setup_docs, $line);
2304 }
2305 }
2306
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002307 $prefix = '';
2308
Andy Whitcroft773647a2008-03-28 14:15:58 -07002309 $realcnt = 0;
2310 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002311 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002312 foreach my $line (@lines) {
2313 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002314 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002315 my $sline = $line; #copy of $line
2316 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002317
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002318 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002319
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002320#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002321 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002322 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2323 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002324 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002325 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002326 $realline=$1-1;
2327 if (defined $2) {
2328 $realcnt=$3+1;
2329 } else {
2330 $realcnt=1+1;
2331 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002332 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002333 $prev_values = 'E';
2334
Andy Whitcroft773647a2008-03-28 14:15:58 -07002335 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002336 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002337 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002338 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002339 if ($context =~ /\b(\w+)\s*\(/) {
2340 $context_function = $1;
2341 } else {
2342 undef $context_function;
2343 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002344 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002345
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002346# track the line number as we move through the hunk, note that
2347# new versions of GNU diff omit the leading space on completely
2348# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002349 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002350 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002351 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002352
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002353 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002354 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002355
2356 # Track the previous line.
2357 ($prevline, $stashline) = ($stashline, $line);
2358 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002359 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2360
Andy Whitcroft773647a2008-03-28 14:15:58 -07002361 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002362
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002363 } elsif ($realcnt == 1) {
2364 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002365 }
2366
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002367 my $hunk_line = ($realcnt != 0);
2368
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002369 $here = "#$linenr: " if (!$file);
2370 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002371
Joe Perches2ac73b42014-06-04 16:12:05 -07002372 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002373 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002374 if ($line =~ /^diff --git.*?(\S+)$/) {
2375 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002376 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002377 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002378 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002379 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002380 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002381 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002382 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002383
2384 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002385 if (!$file && $tree && $p1_prefix ne '' &&
2386 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002387 WARN("PATCH_PREFIX",
2388 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002389 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002390
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002391 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002392 ERROR("MODIFIED_INCLUDE_ASM",
2393 "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 -07002394 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002395 $found_file = 1;
2396 }
2397
Joe Perches34d88152015-06-25 15:03:05 -07002398#make up the handle for any error we report on this line
2399 if ($showfile) {
2400 $prefix = "$realfile:$realline: "
2401 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002402 if ($file) {
2403 $prefix = "$filename:$realline: ";
2404 } else {
2405 $prefix = "$filename:$linenr: ";
2406 }
Joe Perches34d88152015-06-25 15:03:05 -07002407 }
2408
Joe Perches2ac73b42014-06-04 16:12:05 -07002409 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002410 if (is_maintained_obsolete($realfile)) {
2411 WARN("OBSOLETE",
2412 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2413 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002414 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002415 $check = 1;
2416 } else {
2417 $check = $check_orig;
2418 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419 next;
2420 }
2421
Randy Dunlap389834b2007-06-08 13:47:03 -07002422 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002423
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002424 my $hereline = "$here\n$rawline\n";
2425 my $herecurr = "$here\n$rawline\n";
2426 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002427
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002428 $cnt_lines++ if ($realcnt != 0);
2429
Joe Perchese518e9a2015-06-25 15:03:27 -07002430# Check if the commit log has what seems like a diff which can confuse patch
2431 if ($in_commit_log && !$commit_log_has_diff &&
2432 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2433 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2434 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2435 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2436 ERROR("DIFF_IN_COMMIT_MSG",
2437 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2438 $commit_log_has_diff = 1;
2439 }
2440
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002441# Check for incorrect file permissions
2442 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2443 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002444 if ($realfile !~ m@scripts/@ &&
2445 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002446 ERROR("EXECUTE_PERMISSIONS",
2447 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002448 }
2449 }
2450
Joe Perches20112472011-07-25 17:13:23 -07002451# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002452 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002453 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002454 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002455 }
2456
Joe Perchese0d975b2014-12-10 15:51:49 -08002457# Check if MAINTAINERS is being updated. If so, there's probably no need to
2458# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2459 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2460 $reported_maintainer_file = 1;
2461 }
2462
Joe Perches20112472011-07-25 17:13:23 -07002463# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002464 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002465 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002466 my $space_before = $1;
2467 my $sign_off = $2;
2468 my $space_after = $3;
2469 my $email = $4;
2470 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2471
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002472 if ($sign_off !~ /$signature_tags/) {
2473 WARN("BAD_SIGN_OFF",
2474 "Non-standard signature: $sign_off\n" . $herecurr);
2475 }
Joe Perches20112472011-07-25 17:13:23 -07002476 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002477 if (WARN("BAD_SIGN_OFF",
2478 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2479 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002480 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002481 "$ucfirst_sign_off $email";
2482 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002483 }
Joe Perches20112472011-07-25 17:13:23 -07002484 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002485 if (WARN("BAD_SIGN_OFF",
2486 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2487 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002488 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002489 "$ucfirst_sign_off $email";
2490 }
2491
Joe Perches20112472011-07-25 17:13:23 -07002492 }
2493 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002494 if (WARN("BAD_SIGN_OFF",
2495 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2496 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002497 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002498 "$ucfirst_sign_off $email";
2499 }
Joe Perches20112472011-07-25 17:13:23 -07002500 }
2501
2502 my ($email_name, $email_address, $comment) = parse_email($email);
2503 my $suggested_email = format_email(($email_name, $email_address));
2504 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002505 ERROR("BAD_SIGN_OFF",
2506 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002507 } else {
2508 my $dequoted = $suggested_email;
2509 $dequoted =~ s/^"//;
2510 $dequoted =~ s/" </ </;
2511 # Don't force email to have quotes
2512 # Allow just an angle bracketed address
2513 if ("$dequoted$comment" ne $email &&
2514 "<$email_address>$comment" ne $email &&
2515 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002516 WARN("BAD_SIGN_OFF",
2517 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002518 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002519 }
Joe Perches7e51f192013-09-11 14:23:57 -07002520
2521# Check for duplicate signatures
2522 my $sig_nospace = $line;
2523 $sig_nospace =~ s/\s//g;
2524 $sig_nospace = lc($sig_nospace);
2525 if (defined $signatures{$sig_nospace}) {
2526 WARN("BAD_SIGN_OFF",
2527 "Duplicate signature\n" . $herecurr);
2528 } else {
2529 $signatures{$sig_nospace} = 1;
2530 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002531 }
2532
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002533# Check email subject for common tools that don't need to be mentioned
2534 if ($in_header_lines &&
2535 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2536 WARN("EMAIL_SUBJECT",
2537 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2538 }
2539
Joe Perches9b3189e2014-06-04 16:12:10 -07002540# Check for old stable address
2541 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2542 ERROR("STABLE_ADDRESS",
2543 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2544 }
2545
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002546# Check for unwanted Gerrit info
2547 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2548 ERROR("GERRIT_CHANGE_ID",
2549 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2550 }
2551
Joe Perches369c8dd2015-11-06 16:31:34 -08002552# Check if the commit log is in a possible stack dump
2553 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2554 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2555 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2556 # timestamp
2557 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2558 # stack dump address
2559 $commit_log_possible_stack_dump = 1;
2560 }
2561
Joe Perches2a076f42015-04-16 12:44:28 -07002562# Check for line lengths > 75 in commit log, warn once
2563 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002564 length($line) > 75 &&
2565 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2566 # file delta changes
2567 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2568 # filename then :
2569 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2570 # A Fixes: or Link: line
2571 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002572 WARN("COMMIT_LOG_LONG_LINE",
2573 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2574 $commit_log_long_line = 1;
2575 }
2576
Joe Perchesbf4daf12015-09-09 15:37:50 -07002577# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002578 if ($in_commit_log && $commit_log_possible_stack_dump &&
2579 $line =~ /^\s*$/) {
2580 $commit_log_possible_stack_dump = 0;
2581 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002582
Joe Perches0d7835f2015-02-13 14:38:35 -08002583# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002584 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002585 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002586 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002587 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002588 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002589 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2590 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002591 my $init_char = "c";
2592 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002593 my $short = 1;
2594 my $long = 0;
2595 my $case = 1;
2596 my $space = 1;
2597 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002598 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002599 my $id = '0123456789ab';
2600 my $orig_desc = "commit description";
2601 my $description = "";
2602
Joe Perchesfe043ea2015-09-09 15:37:25 -07002603 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2604 $init_char = $1;
2605 $orig_commit = lc($2);
2606 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2607 $orig_commit = lc($1);
2608 }
2609
Joe Perches0d7835f2015-02-13 14:38:35 -08002610 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2611 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2612 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2613 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2614 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2615 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002616 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002617 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2618 defined $rawlines[$linenr] &&
2619 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2620 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002621 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002622 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2623 defined $rawlines[$linenr] &&
2624 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2625 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2626 $orig_desc = $1;
2627 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2628 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002629 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002630 }
2631
2632 ($id, $description) = git_commit_info($orig_commit,
2633 $id, $orig_desc);
2634
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002635 if (defined($id) &&
2636 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002637 ERROR("GIT_COMMIT_ID",
2638 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2639 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002640 }
2641
Joe Perches13f19372014-08-06 16:10:59 -07002642# Check for added, moved or deleted files
2643 if (!$reported_maintainer_file && !$in_commit_log &&
2644 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2645 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2646 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2647 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002648 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002649 $reported_maintainer_file = 1;
2650 WARN("FILE_PATH_CHANGES",
2651 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2652 }
2653
Andy Whitcroft00df3442007-06-08 13:47:06 -07002654# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002655 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002656 ERROR("CORRUPTED_PATCH",
2657 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002658 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002659 }
2660
2661# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2662 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002663 $rawline !~ m/^$UTF8*$/) {
2664 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2665
2666 my $blank = copy_spacing($rawline);
2667 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2668 my $hereptr = "$hereline$ptr\n";
2669
Joe Perches34d99212011-07-25 17:13:26 -07002670 CHK("INVALID_UTF8",
2671 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002672 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002673
Joe Perches15662b32011-10-31 17:13:12 -07002674# Check if it's the start of a commit log
2675# (not a header line and we haven't seen the patch filename)
2676 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002677 !($rawline =~ /^\s+(?:\S|$)/ ||
2678 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002679 $in_header_lines = 0;
2680 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002681 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002682 }
2683
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002684# Check if there is UTF-8 in a commit log when a mail header has explicitly
2685# declined it, i.e defined some charset where it is missing.
2686 if ($in_header_lines &&
2687 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2688 $1 !~ /utf-8/i) {
2689 $non_utf8_charset = 1;
2690 }
2691
2692 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002693 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002694 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002695 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2696 }
2697
Joe Perchesd6430f72016-12-12 16:46:28 -08002698# Check for absolute kernel paths in commit message
2699 if ($tree && $in_commit_log) {
2700 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2701 my $file = $1;
2702
2703 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2704 check_absolute_file($1, $herecurr)) {
2705 #
2706 } else {
2707 check_absolute_file($file, $herecurr);
2708 }
2709 }
2710 }
2711
Kees Cook66b47b42014-10-13 15:51:57 -07002712# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002713 if (defined($misspellings) &&
2714 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002715 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002716 my $typo = $1;
2717 my $typo_fix = $spelling_fix{lc($typo)};
2718 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2719 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002720 my $msg_level = \&WARN;
2721 $msg_level = \&CHK if ($file);
2722 if (&{$msg_level}("TYPO_SPELLING",
2723 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002724 $fix) {
2725 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2726 }
2727 }
2728 }
2729
Andy Whitcroft306708542008-10-15 22:02:28 -07002730# ignore non-hunk lines and lines being removed
2731 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002732
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002733#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002734 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002735 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002736 if (ERROR("DOS_LINE_ENDINGS",
2737 "DOS line endings\n" . $herevet) &&
2738 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002739 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002740 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002741 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2742 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002743 if (ERROR("TRAILING_WHITESPACE",
2744 "trailing whitespace\n" . $herevet) &&
2745 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002746 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002747 }
2748
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002749 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002750 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002751
Josh Triplett4783f892013-11-12 15:10:12 -08002752# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002753 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002754 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002755 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2756 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002757 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002758 my $msg_level = \&ERROR;
2759 $msg_level = \&CHK if ($file);
2760 &{$msg_level}("FSF_MAILING_ADDRESS",
2761 "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 -08002762 }
2763
Andi Kleen33549572010-05-24 14:33:29 -07002764# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002765# Only applies when adding the entry originally, after that we do not have
2766# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002767 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002768 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002769 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002770 my $cnt = $realcnt;
2771 my $ln = $linenr + 1;
2772 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002773 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002774 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002775 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002776 $f = $lines[$ln - 1];
2777 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2778 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002779
2780 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002781 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002782
Joe Perches8d73e0e2014-08-06 16:10:46 -07002783 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002784 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002785 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002786 $length = -1;
2787 }
2788
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002789 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002790 $f =~ s/#.*//;
2791 $f =~ s/^\s+//;
2792 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002793 if ($f =~ /^\s*config\s/) {
2794 $is_end = 1;
2795 last;
2796 }
Andi Kleen33549572010-05-24 14:33:29 -07002797 $length++;
2798 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002799 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2800 WARN("CONFIG_DESCRIPTION",
2801 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2802 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002803 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002804 }
2805
Joe Perches628f91a2017-07-10 15:52:07 -07002806# check for MAINTAINERS entries that don't have the right form
2807 if ($realfile =~ /^MAINTAINERS$/ &&
2808 $rawline =~ /^\+[A-Z]:/ &&
2809 $rawline !~ /^\+[A-Z]:\t\S/) {
2810 if (WARN("MAINTAINERS_STYLE",
2811 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2812 $fix) {
2813 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2814 }
2815 }
2816
Christoph Jaeger327953e2015-02-13 14:38:29 -08002817# discourage the use of boolean for type definition attributes of Kconfig options
2818 if ($realfile =~ /Kconfig/ &&
2819 $line =~ /^\+\s*\bboolean\b/) {
2820 WARN("CONFIG_TYPE_BOOLEAN",
2821 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2822 }
2823
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002824 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2825 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2826 my $flag = $1;
2827 my $replacement = {
2828 'EXTRA_AFLAGS' => 'asflags-y',
2829 'EXTRA_CFLAGS' => 'ccflags-y',
2830 'EXTRA_CPPFLAGS' => 'cppflags-y',
2831 'EXTRA_LDFLAGS' => 'ldflags-y',
2832 };
2833
2834 WARN("DEPRECATED_VARIABLE",
2835 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2836 }
2837
Rob Herringbff5da42014-01-23 15:54:51 -08002838# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002839 if (defined $root &&
2840 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2841 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2842
Rob Herringbff5da42014-01-23 15:54:51 -08002843 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2844
Florian Vaussardcc933192014-04-03 14:49:27 -07002845 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2846 my $vp_file = $dt_path . "vendor-prefixes.txt";
2847
Rob Herringbff5da42014-01-23 15:54:51 -08002848 foreach my $compat (@compats) {
2849 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002850 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2851 my $compat3 = $compat;
2852 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2853 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002854 if ( $? >> 8 ) {
2855 WARN("UNDOCUMENTED_DT_STRING",
2856 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2857 }
2858
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002859 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2860 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002861 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002862 if ( $? >> 8 ) {
2863 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002864 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002865 }
2866 }
2867 }
2868
Andy Whitcroft5368df202008-10-15 22:02:27 -07002869# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002870 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002871
Joe Perches47e0c882015-06-25 15:02:57 -07002872# line length limit (with some exclusions)
2873#
2874# There are a few types of lines that may extend beyond $max_line_length:
2875# logging functions like pr_info that end in a string
2876# lines with a single string
2877# #defines that are a single string
2878#
2879# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002880# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002881# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2882# LONG_LINE all other lines longer than $max_line_length
2883#
2884# if LONG_LINE is ignored, the other 2 types are also ignored
2885#
2886
Joe Perchesb4749e92015-07-17 16:24:01 -07002887 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002888 my $msg_type = "LONG_LINE";
2889
2890 # Check the allowed long line types first
2891
2892 # logging functions that end in a string that starts
2893 # before $max_line_length
2894 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2895 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2896 $msg_type = "";
2897
2898 # lines with only strings (w/ possible termination)
2899 # #defines with only strings
2900 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2901 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2902 $msg_type = "";
2903
Joe Perchescc147502017-11-17 15:28:44 -08002904 # More special cases
2905 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
2906 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07002907 $msg_type = "";
2908
Joe Perches47e0c882015-06-25 15:02:57 -07002909 # Otherwise set the alternate message types
2910
2911 # a comment starts before $max_line_length
2912 } elsif ($line =~ /($;[\s$;]*)$/ &&
2913 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2914 $msg_type = "LONG_LINE_COMMENT"
2915
2916 # a quoted string starts before $max_line_length
2917 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2918 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2919 $msg_type = "LONG_LINE_STRING"
2920 }
2921
2922 if ($msg_type ne "" &&
2923 (show_type("LONG_LINE") || show_type($msg_type))) {
2924 WARN($msg_type,
2925 "line over $max_line_length characters\n" . $herecurr);
2926 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002927 }
2928
Andy Whitcroft8905a672007-11-28 16:21:06 -08002929# check for adding lines without a newline.
2930 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002931 WARN("MISSING_EOF_NEWLINE",
2932 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002933 }
2934
Mike Frysinger42e41c52009-09-21 17:04:40 -07002935# Blackfin: use hi/lo macros
2936 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2937 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2938 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002939 ERROR("LO_MACRO",
2940 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002941 }
2942 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2943 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002944 ERROR("HI_MACRO",
2945 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002946 }
2947 }
2948
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002949# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002950 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002951
2952# at the beginning of a line any tabs must come first and anything
2953# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002954 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2955 $rawline =~ /^\+\s* \s*/) {
2956 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002957 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002958 if (ERROR("CODE_INDENT",
2959 "code indent should use tabs where possible\n" . $herevet) &&
2960 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002961 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002962 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002963 }
2964
Alberto Panizzo08e44362010-03-05 13:43:54 -08002965# check for space before tabs.
2966 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2967 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002968 if (WARN("SPACE_BEFORE_TAB",
2969 "please, no space before tabs\n" . $herevet) &&
2970 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002971 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002972 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002973 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002974 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002975 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002976 }
2977
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002978# check for && or || at the start of a line
2979 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2980 CHK("LOGICAL_CONTINUATIONS",
2981 "Logical continuations should be on the previous line\n" . $hereprev);
2982 }
2983
Joe Perchesa91e8992016-05-20 17:04:05 -07002984# check indentation starts on a tab stop
2985 if ($^V && $^V ge 5.10.0 &&
2986 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2987 my $indent = length($1);
2988 if ($indent % 8) {
2989 if (WARN("TABSTOP",
2990 "Statements should start on a tabstop\n" . $herecurr) &&
2991 $fix) {
2992 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2993 }
2994 }
2995 }
2996
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002997# check multi-line statement indentation matches previous line
2998 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07002999 $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 -07003000 $prevline =~ /^\+(\t*)(.*)$/;
3001 my $oldindent = $1;
3002 my $rest = $2;
3003
3004 my $pos = pos_last_openparen($rest);
3005 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003006 $line =~ /^(\+| )([ \t]*)/;
3007 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003008
3009 my $goodtabindent = $oldindent .
3010 "\t" x ($pos / 8) .
3011 " " x ($pos % 8);
3012 my $goodspaceindent = $oldindent . " " x $pos;
3013
3014 if ($newindent ne $goodtabindent &&
3015 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003016
3017 if (CHK("PARENTHESIS_ALIGNMENT",
3018 "Alignment should match open parenthesis\n" . $hereprev) &&
3019 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003020 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003021 s/^\+[ \t]*/\+$goodtabindent/;
3022 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003023 }
3024 }
3025 }
3026
Joe Perches6ab3a972015-04-16 12:44:05 -07003027# check for space after cast like "(int) foo" or "(struct foo) bar"
3028# avoid checking a few false positives:
3029# "sizeof(<type>)" or "__alignof__(<type>)"
3030# function pointer declarations like "(*foo)(int) = bar;"
3031# structure definitions like "(struct foo) { 0 };"
3032# multiline macros that define functions
3033# known attributes or the __attribute__ keyword
3034 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3035 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003036 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003037 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003038 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003039 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003040 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003041 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003042 }
3043
Joe Perches86406b12015-09-09 15:37:41 -07003044# Block comment styles
3045# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003046 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003047 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003048 $rawline =~ /^\+[ \t]*\*/ &&
3049 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003050 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3051 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3052 }
3053
Joe Perches86406b12015-09-09 15:37:41 -07003054# Block comments use * on subsequent lines
3055 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3056 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003057 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003058 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003059 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003060 WARN("BLOCK_COMMENT_STYLE",
3061 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003062 }
3063
Joe Perches86406b12015-09-09 15:37:41 -07003064# Block comments use */ on trailing lines
3065 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003066 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3067 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3068 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003069 WARN("BLOCK_COMMENT_STYLE",
3070 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003071 }
3072
Joe Perches08eb9b82016-10-11 13:51:50 -07003073# Block comment * alignment
3074 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003075 $line =~ /^\+[ \t]*$;/ && #leading comment
3076 $rawline =~ /^\+[ \t]*\*/ && #leading *
3077 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003078 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003079 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3080 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003081 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003082 if (defined($1)) {
3083 $oldindent = expand_tabs($1);
3084 } else {
3085 $prevrawline =~ m@^\+(.*/?)\*@;
3086 $oldindent = expand_tabs($1);
3087 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003088 $rawline =~ m@^\+([ \t]*)\*@;
3089 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003090 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003091 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003092 WARN("BLOCK_COMMENT_STYLE",
3093 "Block comments should align the * on each line\n" . $hereprev);
3094 }
3095 }
3096
Joe Perches7f619192014-08-06 16:10:39 -07003097# check for missing blank lines after struct/union declarations
3098# with exceptions for various attributes and macros
3099 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3100 $line =~ /^\+/ &&
3101 !($line =~ /^\+\s*$/ ||
3102 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3103 $line =~ /^\+\s*MODULE_/i ||
3104 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3105 $line =~ /^\+[a-z_]*init/ ||
3106 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3107 $line =~ /^\+\s*DECLARE/ ||
Masahiro Yamada0bc989f2017-11-17 15:28:55 -08003108 $line =~ /^\+\s*builtin_[\w_]*driver/ ||
Joe Perches7f619192014-08-06 16:10:39 -07003109 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003110 if (CHK("LINE_SPACING",
3111 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3112 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003113 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003114 }
Joe Perches7f619192014-08-06 16:10:39 -07003115 }
3116
Joe Perches365dd4e2014-08-06 16:10:42 -07003117# check for multiple consecutive blank lines
3118 if ($prevline =~ /^[\+ ]\s*$/ &&
3119 $line =~ /^\+\s*$/ &&
3120 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003121 if (CHK("LINE_SPACING",
3122 "Please don't use multiple blank lines\n" . $hereprev) &&
3123 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003124 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003125 }
3126
Joe Perches365dd4e2014-08-06 16:10:42 -07003127 $last_blank_line = $linenr;
3128 }
3129
Joe Perches3b617e32014-04-03 14:49:28 -07003130# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003131 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3132 # actual declarations
3133 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003134 # function pointer declarations
3135 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003136 # foo bar; where foo is some local typedef or #define
3137 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3138 # known declaration macros
3139 $prevline =~ /^\+\s+$declaration_macros/) &&
3140 # for "else if" which can look like "$Ident $Ident"
3141 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3142 # other possible extensions of declaration lines
3143 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3144 # not starting a section or a macro "\" extended line
3145 $prevline =~ /(?:\{\s*|\\)$/) &&
3146 # looks like a declaration
3147 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003148 # function pointer declarations
3149 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003150 # foo bar; where foo is some local typedef or #define
3151 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3152 # known declaration macros
3153 $sline =~ /^\+\s+$declaration_macros/ ||
3154 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003155 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003156 # start or end of block or continuation of declaration
3157 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3158 # bitfield continuation
3159 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3160 # other possible extensions of declaration lines
3161 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3162 # indentation of previous and current line are the same
3163 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003164 if (WARN("LINE_SPACING",
3165 "Missing a blank line after declarations\n" . $hereprev) &&
3166 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003167 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003168 }
Joe Perches3b617e32014-04-03 14:49:28 -07003169 }
3170
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003171# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003172# Exceptions:
3173# 1) within comments
3174# 2) indented preprocessor commands
3175# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003176 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003177 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003178 if (WARN("LEADING_SPACE",
3179 "please, no spaces at the start of a line\n" . $herevet) &&
3180 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003181 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003182 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003183 }
3184
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003185# check we are in a valid C source file if not then ignore this hunk
3186 next if ($realfile !~ /\.(h|c)$/);
3187
Joe Perches5751a242017-11-17 15:28:52 -08003188# check for unusual line ending [ or (
3189 if ($line =~ /^\+.*([\[\(])\s*$/) {
3190 CHK("OPEN_ENDED_LINE",
3191 "Lines should not end with a '$1'\n" . $herecurr);
3192 }
3193
Joe Perches4dbed762017-05-08 15:55:39 -07003194# check if this appears to be the start function declaration, save the name
3195 if ($sline =~ /^\+\{\s*$/ &&
3196 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3197 $context_function = $1;
3198 }
3199
3200# check if this appears to be the end of function declaration
3201 if ($sline =~ /^\+\}\s*$/) {
3202 undef $context_function;
3203 }
3204
Joe Perches032a4c02014-08-06 16:10:29 -07003205# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003206# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003207# if the previous line is a break or return and is indented 1 tab more...
3208 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3209 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003210 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3211 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3212 defined $lines[$linenr] &&
3213 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003214 WARN("UNNECESSARY_ELSE",
3215 "else is not generally useful after a break or return\n" . $hereprev);
3216 }
3217 }
3218
Joe Perchesc00df192014-08-06 16:11:01 -07003219# check indentation of a line with a break;
3220# if the previous line is a goto or return and is indented the same # of tabs
3221 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3222 my $tabs = $1;
3223 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3224 WARN("UNNECESSARY_BREAK",
3225 "break is not useful after a goto or return\n" . $hereprev);
3226 }
3227 }
3228
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003229# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003230 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003231 WARN("CVS_KEYWORD",
3232 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003233 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003234
Mike Frysinger42e41c52009-09-21 17:04:40 -07003235# Blackfin: don't use __builtin_bfin_[cs]sync
3236 if ($line =~ /__builtin_bfin_csync/) {
3237 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003238 ERROR("CSYNC",
3239 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003240 }
3241 if ($line =~ /__builtin_bfin_ssync/) {
3242 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003243 ERROR("SSYNC",
3244 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003245 }
3246
Joe Perches56e77d72013-02-21 16:44:14 -08003247# check for old HOTPLUG __dev<foo> section markings
3248 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3249 WARN("HOTPLUG_SECTION",
3250 "Using $1 is unnecessary\n" . $herecurr);
3251 }
3252
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003253# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003254 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3255 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003256#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003257 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003258 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003259 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003260 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003261 $stat =~ s/\n./\n /g;
3262 $cond =~ s/\n./\n /g;
3263
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003264#print "linenr<$linenr> <$stat>\n";
3265 # If this statement has no statement boundaries within
3266 # it there is no point in retrying a statement scan
3267 # until we hit end of it.
3268 my $frag = $stat; $frag =~ s/;+\s*$//;
3269 if ($frag !~ /(?:{|;)/) {
3270#print "skip<$line_nr_next>\n";
3271 $suppress_statement = $line_nr_next;
3272 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003273
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003274 # Find the real next line.
3275 $realline_next = $line_nr_next;
3276 if (defined $realline_next &&
3277 (!defined $lines[$realline_next - 1] ||
3278 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3279 $realline_next++;
3280 }
3281
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003282 my $s = $stat;
3283 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003284
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003285 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003286 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003287
3288 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003289 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003290
Andy Whitcroft463f2862009-09-21 17:04:34 -07003291 } elsif ($s =~ /^.\s*else\b/s) {
3292
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003293 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003294 } 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 -07003295 my $type = $1;
3296 $type =~ s/\s+/ /g;
3297 possible($type, "A:" . $s);
3298
Andy Whitcroft8905a672007-11-28 16:21:06 -08003299 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003300 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003301 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003302 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003303
3304 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003305 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003306 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003307 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003308
3309 # Check for any sort of function declaration.
3310 # int foo(something bar, other baz);
3311 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003312 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 -08003313 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003314
Andy Whitcroftcf655042008-03-04 14:28:20 -08003315 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003316 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003317 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003318
Andy Whitcroft8905a672007-11-28 16:21:06 -08003319 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003320 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003321
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003322 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003323 }
3324 }
3325 }
3326
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003327 }
3328
Andy Whitcroft653d4872007-06-23 17:16:34 -07003329#
3330# Checks which may be anchored in the context.
3331#
3332
3333# Check for switch () and associated case and default
3334# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003335 if ($line=~/\bswitch\s*\(.*\)/) {
3336 my $err = '';
3337 my $sep = '';
3338 my @ctx = ctx_block_outer($linenr, $realcnt);
3339 shift(@ctx);
3340 for my $ctx (@ctx) {
3341 my ($clen, $cindent) = line_stats($ctx);
3342 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3343 $indent != $cindent) {
3344 $err .= "$sep$ctx\n";
3345 $sep = '';
3346 } else {
3347 $sep = "[...]\n";
3348 }
3349 }
3350 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003351 ERROR("SWITCH_CASE_INDENT_LEVEL",
3352 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003353 }
3354 }
3355
3356# if/while/etc brace do not go on next line, unless defining a do while loop,
3357# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003358 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 -07003359 my $pre_ctx = "$1$2";
3360
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003361 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003362
3363 if ($line =~ /^\+\t{6,}/) {
3364 WARN("DEEP_INDENTATION",
3365 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3366 }
3367
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003368 my $ctx_cnt = $realcnt - $#ctx - 1;
3369 my $ctx = join("\n", @ctx);
3370
Andy Whitcroft548596d2008-07-23 21:29:01 -07003371 my $ctx_ln = $linenr;
3372 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003373
Andy Whitcroft548596d2008-07-23 21:29:01 -07003374 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3375 defined $lines[$ctx_ln - 1] &&
3376 $lines[$ctx_ln - 1] =~ /^-/)) {
3377 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3378 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003379 $ctx_ln++;
3380 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003381
Andy Whitcroft53210162008-07-23 21:29:03 -07003382 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3383 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003384
Joe Perchesd752fcc2014-08-06 16:11:05 -07003385 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003386 ERROR("OPEN_BRACE",
3387 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003388 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003389 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003390 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3391 $ctx =~ /\)\s*\;\s*$/ &&
3392 defined $lines[$ctx_ln - 1])
3393 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003394 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3395 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003396 WARN("TRAILING_SEMICOLON",
3397 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003398 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003399 }
3400 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003401 }
3402
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003403# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003404 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 -08003405 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3406 ctx_statement_block($linenr, $realcnt, 0)
3407 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003408 my ($s, $c) = ($stat, $cond);
3409
3410 substr($s, 0, length($c), '');
3411
Joe Perches9f5af482015-09-09 15:37:30 -07003412 # remove inline comments
3413 $s =~ s/$;/ /g;
3414 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003415
3416 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003417 my @newlines = ($c =~ /\n/gs);
3418 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003419
Joe Perches9f5af482015-09-09 15:37:30 -07003420 # Make sure we remove the line prefixes as we have
3421 # none on the first line, and are going to readd them
3422 # where necessary.
3423 $s =~ s/\n./\n/gs;
3424 while ($s =~ /\n\s+\\\n/) {
3425 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3426 }
3427
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003428 # We want to check the first line inside the block
3429 # starting at the end of the conditional, so remove:
3430 # 1) any blank line termination
3431 # 2) any opening brace { on end of the line
3432 # 3) any do (...) {
3433 my $continuation = 0;
3434 my $check = 0;
3435 $s =~ s/^.*\bdo\b//;
3436 $s =~ s/^\s*{//;
3437 if ($s =~ s/^\s*\\//) {
3438 $continuation = 1;
3439 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003440 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003441 $check = 1;
3442 $cond_lines++;
3443 }
3444
3445 # Also ignore a loop construct at the end of a
3446 # preprocessor statement.
3447 if (($prevline =~ /^.\s*#\s*define\s/ ||
3448 $prevline =~ /\\\s*$/) && $continuation == 0) {
3449 $check = 0;
3450 }
3451
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003452 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003453 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003454 while ($cond_ptr != $cond_lines) {
3455 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003456
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003457 # If we see an #else/#elif then the code
3458 # is not linear.
3459 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3460 $check = 0;
3461 }
3462
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003463 # Ignore:
3464 # 1) blank lines, they should be at 0,
3465 # 2) preprocessor lines, and
3466 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003467 if ($continuation ||
3468 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003469 $s =~ /^\s*#\s*?/ ||
3470 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003471 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003472 if ($s =~ s/^.*?\n//) {
3473 $cond_lines++;
3474 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003475 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003476 }
3477
3478 my (undef, $sindent) = line_stats("+" . $s);
3479 my $stat_real = raw_line($linenr, $cond_lines);
3480
3481 # Check if either of these lines are modified, else
3482 # this is not this patch's fault.
3483 if (!defined($stat_real) ||
3484 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3485 $check = 0;
3486 }
3487 if (defined($stat_real) && $cond_lines > 1) {
3488 $stat_real = "[...]\n$stat_real";
3489 }
3490
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003491 #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 -07003492
Joe Perches9f5af482015-09-09 15:37:30 -07003493 if ($check && $s ne '' &&
3494 (($sindent % 8) != 0 ||
3495 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003496 ($sindent == $indent &&
3497 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003498 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003499 WARN("SUSPECT_CODE_INDENT",
3500 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003501 }
3502 }
3503
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003504 # Track the 'values' across context and added lines.
3505 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003506 my ($curr_values, $curr_vars) =
3507 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003508 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003509 if ($dbg_values) {
3510 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003511 print "$linenr > .$outline\n";
3512 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003513 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003514 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003515 $prev_values = substr($curr_values, -1);
3516
Andy Whitcroft00df3442007-06-08 13:47:06 -07003517#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003518 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003519
Joe Perches11ca40a2016-12-12 16:46:31 -08003520# check for dereferences that span multiple lines
3521 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3522 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3523 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3524 my $ref = $1;
3525 $line =~ /^.\s*($Lval)/;
3526 $ref .= $1;
3527 $ref =~ s/\s//g;
3528 WARN("MULTILINE_DEREFERENCE",
3529 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3530 }
3531
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003532# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003533 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 -07003534 my $type = $1;
3535 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003536 $var = "" if (!defined $var);
3537 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003538 my $sign = $1;
3539 my $pointer = $2;
3540
3541 $pointer = "" if (!defined $pointer);
3542
3543 if (WARN("UNSPECIFIED_INT",
3544 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3545 $fix) {
3546 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003547 my $comp_pointer = $pointer;
3548 $comp_pointer =~ s/\s//g;
3549 $decl .= $comp_pointer;
3550 $decl = rtrim($decl) if ($var eq "");
3551 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003552 }
3553 }
3554 }
3555
Andy Whitcroft653d4872007-06-23 17:16:34 -07003556# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003557 if ($dbg_type) {
3558 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003559 ERROR("TEST_TYPE",
3560 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003561 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003562 ERROR("TEST_NOT_TYPE",
3563 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003564 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003565 next;
3566 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003567# TEST: allow direct testing of the attribute matcher.
3568 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003569 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003570 ERROR("TEST_ATTR",
3571 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003572 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003573 ERROR("TEST_NOT_ATTR",
3574 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003575 }
3576 next;
3577 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003578
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003579# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003580 if ($line =~ /^.\s*{/ &&
3581 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003582 if (ERROR("OPEN_BRACE",
3583 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003584 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3585 fix_delete_line($fixlinenr - 1, $prevrawline);
3586 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003587 my $fixedline = $prevrawline;
3588 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003589 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003590 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003591 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003592 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003593 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003594 }
3595
Andy Whitcroft653d4872007-06-23 17:16:34 -07003596#
3597# Checks which are anchored on the added line.
3598#
3599
3600# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003601 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003602 my $path = $1;
3603 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003604 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003605 "malformed #include filename\n" . $herecurr);
3606 }
3607 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3608 ERROR("UAPI_INCLUDE",
3609 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003610 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003611 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003612
3613# no C99 // comments
3614 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003615 if (ERROR("C99_COMMENTS",
3616 "do not use C99 // comments\n" . $herecurr) &&
3617 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003618 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003619 if ($line =~ /\/\/(.*)$/) {
3620 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003621 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003622 }
3623 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003624 }
3625 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003626 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003627 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003628
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003629# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3630# the whole statement.
3631#print "APW <$lines[$realline_next - 1]>\n";
3632 if (defined $realline_next &&
3633 exists $lines[$realline_next - 1] &&
3634 !defined $suppress_export{$realline_next} &&
3635 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3636 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003637 # Handle definitions which produce identifiers with
3638 # a prefix:
3639 # XXX(foo);
3640 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003641 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003642 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003643 $name =~ /^${Ident}_$2/) {
3644#print "FOO C name<$name>\n";
3645 $suppress_export{$realline_next} = 1;
3646
3647 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003648 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003649 ^.DEFINE_$Ident\(\Q$name\E\)|
3650 ^.DECLARE_$Ident\(\Q$name\E\)|
3651 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003652 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3653 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003654 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003655#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3656 $suppress_export{$realline_next} = 2;
3657 } else {
3658 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003659 }
3660 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003661 if (!defined $suppress_export{$linenr} &&
3662 $prevline =~ /^.\s*$/ &&
3663 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3664 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3665#print "FOO B <$lines[$linenr - 1]>\n";
3666 $suppress_export{$linenr} = 2;
3667 }
3668 if (defined $suppress_export{$linenr} &&
3669 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003670 WARN("EXPORT_SYMBOL",
3671 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003672 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003673
Joe Eloff5150bda2010-08-09 17:21:00 -07003674# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003675 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003676 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003677 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003678 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003679 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003680 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003681 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003682# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003683 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003684 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003685 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003686 $herecurr) &&
3687 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003688 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003689 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003690 }
3691
Joe Perches18130872014-08-06 16:11:22 -07003692# check for misordered declarations of char/short/int/long with signed/unsigned
3693 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3694 my $tmp = trim($1);
3695 WARN("MISORDERED_TYPE",
3696 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3697 }
3698
Joe Perchescb710ec2010-10-26 14:23:20 -07003699# check for static const char * arrays.
3700 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003701 WARN("STATIC_CONST_CHAR_ARRAY",
3702 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003703 $herecurr);
3704 }
3705
3706# check for static char foo[] = "bar" declarations.
3707 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003708 WARN("STATIC_CONST_CHAR_ARRAY",
3709 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003710 $herecurr);
3711 }
3712
Joe Perchesab7e23f2015-04-16 12:44:22 -07003713# check for const <foo> const where <foo> is not a pointer or array type
3714 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3715 my $found = $1;
3716 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3717 WARN("CONST_CONST",
3718 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3719 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3720 WARN("CONST_CONST",
3721 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3722 }
3723 }
3724
Joe Perches9b0fa602014-04-03 14:49:18 -07003725# check for non-global char *foo[] = {"bar", ...} declarations.
3726 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3727 WARN("STATIC_CONST_CHAR_ARRAY",
3728 "char * array declaration might be better as static const\n" .
3729 $herecurr);
3730 }
3731
Joe Perchesb598b672015-04-16 12:44:36 -07003732# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3733 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3734 my $array = $1;
3735 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3736 my $array_div = $1;
3737 if (WARN("ARRAY_SIZE",
3738 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3739 $fix) {
3740 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3741 }
3742 }
3743 }
3744
Joe Perchesb36190c2014-01-27 17:07:18 -08003745# check for function declarations without arguments like "int foo()"
3746 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3747 if (ERROR("FUNCTION_WITHOUT_ARGS",
3748 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3749 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003750 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003751 }
3752 }
3753
Andy Whitcroft653d4872007-06-23 17:16:34 -07003754# check for new typedefs, only function parameters and sparse annotations
3755# make sense.
3756 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003757 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003758 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003759 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003760 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003761 WARN("NEW_TYPEDEFS",
3762 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003763 }
3764
3765# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003766 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003767 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3768 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003769 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003770
Andy Whitcroft65863862009-01-06 14:41:21 -08003771 # Should start with a space.
3772 $to =~ s/^(\S)/ $1/;
3773 # Should not end with a space.
3774 $to =~ s/\s+$//;
3775 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003776 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003777 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003778
Joe Perches3705ce52013-07-03 15:05:31 -07003779## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003780 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003781 if (ERROR("POINTER_LOCATION",
3782 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3783 $fix) {
3784 my $sub_from = $ident;
3785 my $sub_to = $ident;
3786 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003787 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003788 s@\Q$sub_from\E@$sub_to@;
3789 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003790 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003791 }
3792 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3793 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003794 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003795
Andy Whitcroft65863862009-01-06 14:41:21 -08003796 # Should start with a space.
3797 $to =~ s/^(\S)/ $1/;
3798 # Should not end with a space.
3799 $to =~ s/\s+$//;
3800 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003801 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003802 }
3803 # Modifiers should have spaces.
3804 $to =~ s/(\b$Modifier$)/$1 /;
3805
Joe Perches3705ce52013-07-03 15:05:31 -07003806## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003807 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003808 if (ERROR("POINTER_LOCATION",
3809 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3810 $fix) {
3811
3812 my $sub_from = $match;
3813 my $sub_to = $match;
3814 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003815 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003816 s@\Q$sub_from\E@$sub_to@;
3817 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003818 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003819 }
3820
Joe Perches9d3e3c72015-09-09 15:37:27 -07003821# avoid BUG() or BUG_ON()
3822 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003823 my $msg_level = \&WARN;
3824 $msg_level = \&CHK if ($file);
3825 &{$msg_level}("AVOID_BUG",
3826 "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 -07003827 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003828
Joe Perches9d3e3c72015-09-09 15:37:27 -07003829# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003830 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003831 WARN("LINUX_VERSION_CODE",
3832 "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 -08003833 }
3834
Joe Perches17441222011-06-15 15:08:17 -07003835# check for uses of printk_ratelimit
3836 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003837 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003838 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003839 }
3840
Joe Percheseeef5732017-11-17 15:28:41 -08003841# printk should use KERN_* levels
3842 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3843 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3844 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003845 }
3846
Joe Perches243f3802012-05-31 16:26:09 -07003847 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3848 my $orig = $1;
3849 my $level = lc($orig);
3850 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003851 my $level2 = $level;
3852 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003853 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003854 "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 -07003855 }
3856
3857 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003858 if (WARN("PREFER_PR_LEVEL",
3859 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3860 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003861 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003862 s/\bpr_warning\b/pr_warn/;
3863 }
Joe Perches243f3802012-05-31 16:26:09 -07003864 }
3865
Joe Perchesdc139312013-02-21 16:44:13 -08003866 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3867 my $orig = $1;
3868 my $level = lc($orig);
3869 $level = "warn" if ($level eq "warning");
3870 $level = "dbg" if ($level eq "debug");
3871 WARN("PREFER_DEV_LEVEL",
3872 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3873 }
3874
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003875# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3876# number of false positives, but assembly files are not checked, so at
3877# least the arch entry code will not trigger this warning.
3878 if ($line =~ /\bENOSYS\b/) {
3879 WARN("ENOSYS",
3880 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3881 }
3882
Andy Whitcroft653d4872007-06-23 17:16:34 -07003883# function brace can't be on same line, except for #defines of do while,
3884# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003885 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003886 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003887 if (ERROR("OPEN_BRACE",
3888 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3889 $fix) {
3890 fix_delete_line($fixlinenr, $rawline);
3891 my $fixed_line = $rawline;
3892 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3893 my $line1 = $1;
3894 my $line2 = $2;
3895 fix_insert_line($fixlinenr, ltrim($line1));
3896 fix_insert_line($fixlinenr, "\+{");
3897 if ($line2 !~ /^\s*$/) {
3898 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3899 }
3900 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003901 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003902
Andy Whitcroft8905a672007-11-28 16:21:06 -08003903# open braces for enum, union and struct go on the same line.
3904 if ($line =~ /^.\s*{/ &&
3905 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003906 if (ERROR("OPEN_BRACE",
3907 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3908 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3909 fix_delete_line($fixlinenr - 1, $prevrawline);
3910 fix_delete_line($fixlinenr, $rawline);
3911 my $fixedline = rtrim($prevrawline) . " {";
3912 fix_insert_line($fixlinenr, $fixedline);
3913 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003914 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003915 if ($fixedline !~ /^\+\s*$/) {
3916 fix_insert_line($fixlinenr, $fixedline);
3917 }
3918 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003919 }
3920
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003921# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003922 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3923 if (WARN("SPACING",
3924 "missing space after $1 definition\n" . $herecurr) &&
3925 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003926 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003927 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3928 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003929 }
3930
Joe Perches31070b52014-01-23 15:54:49 -08003931# Function pointer declarations
3932# check spacing between type, funcptr, and args
3933# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003934 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003935 my $declare = $1;
3936 my $pre_pointer_space = $2;
3937 my $post_pointer_space = $3;
3938 my $funcname = $4;
3939 my $post_funcname_space = $5;
3940 my $pre_args_space = $6;
3941
Joe Perches91f72e92014-04-03 14:49:12 -07003942# the $Declare variable will capture all spaces after the type
3943# so check it for a missing trailing missing space but pointer return types
3944# don't need a space so don't warn for those.
3945 my $post_declare_space = "";
3946 if ($declare =~ /(\s+)$/) {
3947 $post_declare_space = $1;
3948 $declare = rtrim($declare);
3949 }
3950 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003951 WARN("SPACING",
3952 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003953 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003954 }
3955
3956# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003957# This test is not currently implemented because these declarations are
3958# equivalent to
3959# int foo(int bar, ...)
3960# and this is form shouldn't/doesn't generate a checkpatch warning.
3961#
3962# elsif ($declare =~ /\s{2,}$/) {
3963# WARN("SPACING",
3964# "Multiple spaces after return type\n" . $herecurr);
3965# }
Joe Perches31070b52014-01-23 15:54:49 -08003966
3967# unnecessary space "type ( *funcptr)(args...)"
3968 if (defined $pre_pointer_space &&
3969 $pre_pointer_space =~ /^\s/) {
3970 WARN("SPACING",
3971 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3972 }
3973
3974# unnecessary space "type (* funcptr)(args...)"
3975 if (defined $post_pointer_space &&
3976 $post_pointer_space =~ /^\s/) {
3977 WARN("SPACING",
3978 "Unnecessary space before function pointer name\n" . $herecurr);
3979 }
3980
3981# unnecessary space "type (*funcptr )(args...)"
3982 if (defined $post_funcname_space &&
3983 $post_funcname_space =~ /^\s/) {
3984 WARN("SPACING",
3985 "Unnecessary space after function pointer name\n" . $herecurr);
3986 }
3987
3988# unnecessary space "type (*funcptr) (args...)"
3989 if (defined $pre_args_space &&
3990 $pre_args_space =~ /^\s/) {
3991 WARN("SPACING",
3992 "Unnecessary space before function pointer arguments\n" . $herecurr);
3993 }
3994
3995 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003996 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003997 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003998 }
3999 }
4000
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004001# check for spacing round square brackets; allowed:
4002# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004003# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4004# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004005 while ($line =~ /(.*?\s)\[/g) {
4006 my ($where, $prefix) = ($-[1], $1);
4007 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004008 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004009 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004010 if (ERROR("BRACKET_SPACE",
4011 "space prohibited before open square bracket '['\n" . $herecurr) &&
4012 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004013 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004014 s/^(\+.*?)\s+\[/$1\[/;
4015 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004016 }
4017 }
4018
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004019# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004020 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004021 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004022 my $ctx_before = substr($line, 0, $-[1]);
4023 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004024
4025 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004026 if ($name =~ /^(?:
4027 if|for|while|switch|return|case|
4028 volatile|__volatile__|
4029 __attribute__|format|__extension__|
4030 asm|__asm__)$/x)
4031 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004032 # cpp #define statements have non-optional spaces, ie
4033 # if there is a space between the name and the open
4034 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004035 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004036
4037 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004038 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004039
4040 # If this whole things ends with a type its most
4041 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004042 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004043
4044 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004045 if (WARN("SPACING",
4046 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4047 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004048 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004049 s/\b$name\s+\(/$name\(/;
4050 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004051 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004052 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004053
Andy Whitcroft653d4872007-06-23 17:16:34 -07004054# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004055 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004056 my $fixed_line = "";
4057 my $line_fixed = 0;
4058
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004059 my $ops = qr{
4060 <<=|>>=|<=|>=|==|!=|
4061 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4062 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004063 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004064 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004065 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004066 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004067
4068## print("element count: <" . $#elements . ">\n");
4069## foreach my $el (@elements) {
4070## print("el: <$el>\n");
4071## }
4072
4073 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004074 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004075
Joe Perches3705ce52013-07-03 15:05:31 -07004076 foreach my $el (@elements) {
4077 push(@fix_elements, substr($rawline, $off, length($el)));
4078 $off += length($el);
4079 }
4080
4081 $off = 0;
4082
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004083 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004084 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004085
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004086 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004087
4088 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4089
4090## print("n: <$n> good: <$good>\n");
4091
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004092 $off += length($elements[$n]);
4093
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004094 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004095 my $ca = substr($opline, 0, $off);
4096 my $cc = '';
4097 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4098 $cc = substr($opline, $off + length($elements[$n + 1]));
4099 }
4100 my $cb = "$ca$;$cc";
4101
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004102 my $a = '';
4103 $a = 'V' if ($elements[$n] ne '');
4104 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004105 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004106 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4107 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004108 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004109
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004110 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004111
4112 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004113 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004114 $c = 'V' if ($elements[$n + 2] ne '');
4115 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004116 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004117 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4118 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004119 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004120 } else {
4121 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004122 }
4123
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004124 my $ctx = "${a}x${c}";
4125
4126 my $at = "(ctx:$ctx)";
4127
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004128 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004129 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004130
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004131 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004132 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004133
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004134 # Get the full operator variant.
4135 my $opv = $op . substr($curr_vars, $off, 1);
4136
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004137 # Ignore operators passed as parameters.
4138 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004139 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004140
Andy Whitcroftcf655042008-03-04 14:28:20 -08004141# # Ignore comments
4142# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004143
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004144 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004145 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004146 if ($ctx !~ /.x[WEBC]/ &&
4147 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004148 if (ERROR("SPACING",
4149 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004150 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004151 $line_fixed = 1;
4152 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004153 }
4154
4155 # // is a comment
4156 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004157
Joe Perchesb00e4812014-04-03 14:49:33 -07004158 # : when part of a bitfield
4159 } elsif ($opv eq ':B') {
4160 # skip the bitfield test for now
4161
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004162 # No spaces for:
4163 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004164 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004165 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004166 if (ERROR("SPACING",
4167 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004168 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004169 if (defined $fix_elements[$n + 2]) {
4170 $fix_elements[$n + 2] =~ s/^\s+//;
4171 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004172 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004173 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004174 }
4175
Joe Perches23810972014-12-10 15:51:32 -08004176 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004177 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004178 my $rtrim_before = 0;
4179 my $space_after = 0;
4180 if ($ctx =~ /Wx./) {
4181 if (ERROR("SPACING",
4182 "space prohibited before that '$op' $at\n" . $hereptr)) {
4183 $line_fixed = 1;
4184 $rtrim_before = 1;
4185 }
4186 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004187 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004188 if (ERROR("SPACING",
4189 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004190 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004191 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004192 $space_after = 1;
4193 }
4194 }
4195 if ($rtrim_before || $space_after) {
4196 if ($rtrim_before) {
4197 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4198 } else {
4199 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4200 }
4201 if ($space_after) {
4202 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004203 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004204 }
4205
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004206 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004207 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004208 #warn "'*' is part of type\n";
4209
4210 # unary operators should have a space before and
4211 # none after. May be left adjacent to another
4212 # unary operator, or a cast
4213 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004214 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004215 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004216 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004217 if (ERROR("SPACING",
4218 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004219 if ($n != $last_after + 2) {
4220 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4221 $line_fixed = 1;
4222 }
Joe Perches3705ce52013-07-03 15:05:31 -07004223 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004224 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004225 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004226 # A unary '*' may be const
4227
4228 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004229 if (ERROR("SPACING",
4230 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004231 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004232 if (defined $fix_elements[$n + 2]) {
4233 $fix_elements[$n + 2] =~ s/^\s+//;
4234 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004235 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004236 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004237 }
4238
4239 # unary ++ and unary -- are allowed no space on one side.
4240 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004241 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004242 if (ERROR("SPACING",
4243 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004244 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004245 $line_fixed = 1;
4246 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004247 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004248 if ($ctx =~ /Wx[BE]/ ||
4249 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004250 if (ERROR("SPACING",
4251 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004252 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004253 $line_fixed = 1;
4254 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004255 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004256 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004257 if (ERROR("SPACING",
4258 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004259 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004260 if (defined $fix_elements[$n + 2]) {
4261 $fix_elements[$n + 2] =~ s/^\s+//;
4262 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004263 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004264 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004265 }
4266
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004267 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004268 } elsif ($op eq '<<' or $op eq '>>' or
4269 $op eq '&' or $op eq '^' or $op eq '|' or
4270 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004271 $op eq '*' or $op eq '/' or
4272 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004273 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004274 if ($check) {
4275 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4276 if (CHK("SPACING",
4277 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4278 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4279 $fix_elements[$n + 2] =~ s/^\s+//;
4280 $line_fixed = 1;
4281 }
4282 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4283 if (CHK("SPACING",
4284 "space preferred before that '$op' $at\n" . $hereptr)) {
4285 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4286 $line_fixed = 1;
4287 }
4288 }
4289 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004290 if (ERROR("SPACING",
4291 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004292 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4293 if (defined $fix_elements[$n + 2]) {
4294 $fix_elements[$n + 2] =~ s/^\s+//;
4295 }
Joe Perches3705ce52013-07-03 15:05:31 -07004296 $line_fixed = 1;
4297 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004298 }
4299
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004300 # A colon needs no spaces before when it is
4301 # terminating a case value or a label.
4302 } elsif ($opv eq ':C' || $opv eq ':L') {
4303 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004304 if (ERROR("SPACING",
4305 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004306 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004307 $line_fixed = 1;
4308 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004309 }
4310
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004311 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004312 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004313 my $ok = 0;
4314
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004315 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004316 if (($op eq '<' &&
4317 $cc =~ /^\S+\@\S+>/) ||
4318 ($op eq '>' &&
4319 $ca =~ /<\S+\@\S+$/))
4320 {
4321 $ok = 1;
4322 }
4323
Joe Perchese0df7e12015-04-16 12:44:53 -07004324 # for asm volatile statements
4325 # ignore a colon with another
4326 # colon immediately before or after
4327 if (($op eq ':') &&
4328 ($ca =~ /:$/ || $cc =~ /^:/)) {
4329 $ok = 1;
4330 }
4331
Joe Perches84731622013-11-12 15:10:05 -08004332 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004333 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004334 my $msg_level = \&ERROR;
4335 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004336
Jean Delvare0675a8f2017-09-08 16:16:07 -07004337 if (&{$msg_level}("SPACING",
4338 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004339 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4340 if (defined $fix_elements[$n + 2]) {
4341 $fix_elements[$n + 2] =~ s/^\s+//;
4342 }
Joe Perches3705ce52013-07-03 15:05:31 -07004343 $line_fixed = 1;
4344 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004345 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004346 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004347 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004348
4349## print("n: <$n> GOOD: <$good>\n");
4350
4351 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004352 }
Joe Perches3705ce52013-07-03 15:05:31 -07004353
4354 if (($#elements % 2) == 0) {
4355 $fixed_line = $fixed_line . $fix_elements[$#elements];
4356 }
4357
Joe Perches194f66f2014-08-06 16:11:03 -07004358 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4359 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004360 }
4361
4362
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004363 }
4364
Joe Perches786b6322013-07-03 15:05:32 -07004365# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004366 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004367 if (WARN("SPACING",
4368 "space prohibited before semicolon\n" . $herecurr) &&
4369 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004370 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004371 s/^(\+.*\S)\s+;/$1;/;
4372 }
4373 }
4374
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004375# check for multiple assignments
4376 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004377 CHK("MULTIPLE_ASSIGNMENTS",
4378 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004379 }
4380
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004381## # check for multiple declarations, allowing for a function declaration
4382## # continuation.
4383## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4384## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4385##
4386## # Remove any bracketed sections to ensure we do not
4387## # falsly report the parameters of functions.
4388## my $ln = $line;
4389## while ($ln =~ s/\([^\(\)]*\)//g) {
4390## }
4391## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004392## WARN("MULTIPLE_DECLARATION",
4393## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004394## }
4395## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004396
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004397#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004398 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004399 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004400 if (ERROR("SPACING",
4401 "space required before the open brace '{'\n" . $herecurr) &&
4402 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004403 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004404 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004405 }
4406
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004407## # check for blank lines before declarations
4408## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4409## $prevrawline =~ /^.\s*$/) {
4410## WARN("SPACING",
4411## "No blank lines before declarations\n" . $hereprev);
4412## }
4413##
4414
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004415# closing brace should have a space following it when it has anything
4416# on the line
4417 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004418 if (ERROR("SPACING",
4419 "space required after that close brace '}'\n" . $herecurr) &&
4420 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004421 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004422 s/}((?!(?:,|;|\)))\S)/} $1/;
4423 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004424 }
4425
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004426# check spacing on square brackets
4427 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004428 if (ERROR("SPACING",
4429 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4430 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004431 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004432 s/\[\s+/\[/;
4433 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004434 }
4435 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004436 if (ERROR("SPACING",
4437 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4438 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004439 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004440 s/\s+\]/\]/;
4441 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004442 }
4443
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004444# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004445 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4446 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004447 if (ERROR("SPACING",
4448 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4449 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004450 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004451 s/\(\s+/\(/;
4452 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004453 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004454 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004455 $line !~ /for\s*\(.*;\s+\)/ &&
4456 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004457 if (ERROR("SPACING",
4458 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4459 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004460 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004461 s/\s+\)/\)/;
4462 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004463 }
4464
Joe Perchese2826fd2014-08-06 16:10:48 -07004465# check unnecessary parentheses around addressof/dereference single $Lvals
4466# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4467
4468 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004469 my $var = $1;
4470 if (CHK("UNNECESSARY_PARENTHESES",
4471 "Unnecessary parentheses around $var\n" . $herecurr) &&
4472 $fix) {
4473 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4474 }
4475 }
4476
4477# check for unnecessary parentheses around function pointer uses
4478# ie: (foo->bar)(); should be foo->bar();
4479# but not "if (foo->bar) (" to avoid some false positives
4480 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4481 my $var = $2;
4482 if (CHK("UNNECESSARY_PARENTHESES",
4483 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4484 $fix) {
4485 my $var2 = deparenthesize($var);
4486 $var2 =~ s/\s//g;
4487 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4488 }
4489 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004490
Joe Perches63b7c732017-09-08 16:16:01 -07004491# check for unnecessary parentheses around comparisons in if uses
4492 if ($^V && $^V ge 5.10.0 && defined($stat) &&
4493 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4494 my $if_stat = $1;
4495 my $test = substr($2, 1, -1);
4496 my $herectx;
4497 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4498 my $match = $1;
4499 # avoid parentheses around potential macro args
4500 next if ($match =~ /^\s*\w+\s*$/);
4501 if (!defined($herectx)) {
4502 $herectx = $here . "\n";
4503 my $cnt = statement_rawlines($if_stat);
4504 for (my $n = 0; $n < $cnt; $n++) {
4505 my $rl = raw_line($linenr, $n);
4506 $herectx .= $rl . "\n";
4507 last if $rl =~ /^[ \+].*\{/;
4508 }
4509 }
4510 CHK("UNNECESSARY_PARENTHESES",
4511 "Unnecessary parentheses around '$match'\n" . $herectx);
4512 }
4513 }
4514
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004515#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004516 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004517 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004518 if (WARN("INDENTED_LABEL",
4519 "labels should not be indented\n" . $herecurr) &&
4520 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004521 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004522 s/^(.)\s+/$1/;
4523 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004524 }
4525
Joe Perches5b9553a2014-04-03 14:49:21 -07004526# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004527 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004528 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004529 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004530 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4531 my $value = $1;
4532 $value = deparenthesize($value);
4533 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4534 ERROR("RETURN_PARENTHESES",
4535 "return is not a function, parentheses are not required\n" . $herecurr);
4536 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004537 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004538 ERROR("SPACING",
4539 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004540 }
4541 }
Joe Perches507e5142013-11-12 15:10:13 -08004542
Joe Perchesb43ae212014-06-23 13:22:07 -07004543# unnecessary return in a void function
4544# at end-of-function, with the previous line a single leading tab, then return;
4545# and the line before that not a goto label target like "out:"
4546 if ($sline =~ /^[ \+]}\s*$/ &&
4547 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4548 $linenr >= 3 &&
4549 $lines[$linenr - 3] =~ /^[ +]/ &&
4550 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004551 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004552 "void function return statements are not generally useful\n" . $hereprev);
4553 }
Joe Perches9819cf22014-06-04 16:12:09 -07004554
Joe Perches189248d2014-01-23 15:54:47 -08004555# if statements using unnecessary parentheses - ie: if ((foo == bar))
4556 if ($^V && $^V ge 5.10.0 &&
4557 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4558 my $openparens = $1;
4559 my $count = $openparens =~ tr@\(@\(@;
4560 my $msg = "";
4561 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4562 my $comp = $4; #Not $1 because of $LvalOrFunc
4563 $msg = " - maybe == should be = ?" if ($comp eq "==");
4564 WARN("UNNECESSARY_PARENTHESES",
4565 "Unnecessary parentheses$msg\n" . $herecurr);
4566 }
4567 }
4568
Joe Perchesc5595fa2015-09-09 15:37:58 -07004569# comparisons with a constant or upper case identifier on the left
4570# avoid cases like "foo + BAR < baz"
4571# only fix matches surrounded by parentheses to avoid incorrect
4572# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4573 if ($^V && $^V ge 5.10.0 &&
4574 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4575 my $lead = $1;
4576 my $const = $2;
4577 my $comp = $3;
4578 my $to = $4;
4579 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004580 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004581 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4582 WARN("CONSTANT_COMPARISON",
4583 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4584 $fix) {
4585 if ($comp eq "<") {
4586 $newcomp = ">";
4587 } elsif ($comp eq "<=") {
4588 $newcomp = ">=";
4589 } elsif ($comp eq ">") {
4590 $newcomp = "<";
4591 } elsif ($comp eq ">=") {
4592 $newcomp = "<=";
4593 }
4594 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4595 }
4596 }
4597
Joe Perchesf34e4a42015-04-16 12:44:19 -07004598# Return of what appears to be an errno should normally be negative
4599 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004600 my $name = $1;
4601 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004602 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004603 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004604 }
4605 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004606
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004607# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004608 if ($line =~ /\b(if|while|for|switch)\(/) {
4609 if (ERROR("SPACING",
4610 "space required before the open parenthesis '('\n" . $herecurr) &&
4611 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004612 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004613 s/\b(if|while|for|switch)\(/$1 \(/;
4614 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004615 }
4616
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004617# Check for illegal assignment in if conditional -- and check for trailing
4618# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004619 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004620 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4621 ctx_statement_block($linenr, $realcnt, 0)
4622 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004623 my ($stat_next) = ctx_statement_block($line_nr_next,
4624 $remain_next, $off_next);
4625 $stat_next =~ s/\n./\n /g;
4626 ##print "stat<$stat> stat_next<$stat_next>\n";
4627
4628 if ($stat_next =~ /^\s*while\b/) {
4629 # If the statement carries leading newlines,
4630 # then count those as offsets.
4631 my ($whitespace) =
4632 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4633 my $offset =
4634 statement_rawlines($whitespace) - 1;
4635
4636 $suppress_whiletrailers{$line_nr_next +
4637 $offset} = 1;
4638 }
4639 }
4640 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004641 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004642 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004643 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004644
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004645 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004646 ERROR("ASSIGN_IN_IF",
4647 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004648 }
4649
4650 # Find out what is on the end of the line after the
4651 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004652 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004653 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004654 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004655 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4656 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004657 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004658 # Find out how long the conditional actually is.
4659 my @newlines = ($c =~ /\n/gs);
4660 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004661 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004662
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004663 $stat_real = raw_line($linenr, $cond_lines)
4664 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004665 if (defined($stat_real) && $cond_lines > 1) {
4666 $stat_real = "[...]\n$stat_real";
4667 }
4668
Joe Perches000d1cc12011-07-25 17:13:25 -07004669 ERROR("TRAILING_STATEMENTS",
4670 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004671 }
4672 }
4673
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004674# Check for bitwise tests written as boolean
4675 if ($line =~ /
4676 (?:
4677 (?:\[|\(|\&\&|\|\|)
4678 \s*0[xX][0-9]+\s*
4679 (?:\&\&|\|\|)
4680 |
4681 (?:\&\&|\|\|)
4682 \s*0[xX][0-9]+\s*
4683 (?:\&\&|\|\||\)|\])
4684 )/x)
4685 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004686 WARN("HEXADECIMAL_BOOLEAN_TEST",
4687 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004688 }
4689
Andy Whitcroft8905a672007-11-28 16:21:06 -08004690# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004691 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4692 my $s = $1;
4693 $s =~ s/$;//g; # Remove any comments
4694 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004695 ERROR("TRAILING_STATEMENTS",
4696 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004697 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004698 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004699# if should not continue a brace
4700 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004701 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004702 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004703 $herecurr);
4704 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004705# case and default should not have general statements after them
4706 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4707 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004708 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004709 \s*return\s+
4710 )/xg)
4711 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004712 ERROR("TRAILING_STATEMENTS",
4713 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004714 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004715
4716 # Check for }<nl>else {, these must be at the same
4717 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004718 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4719 $previndent == $indent) {
4720 if (ERROR("ELSE_AFTER_BRACE",
4721 "else should follow close brace '}'\n" . $hereprev) &&
4722 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4723 fix_delete_line($fixlinenr - 1, $prevrawline);
4724 fix_delete_line($fixlinenr, $rawline);
4725 my $fixedline = $prevrawline;
4726 $fixedline =~ s/}\s*$//;
4727 if ($fixedline !~ /^\+\s*$/) {
4728 fix_insert_line($fixlinenr, $fixedline);
4729 }
4730 $fixedline = $rawline;
4731 $fixedline =~ s/^(.\s*)else/$1} else/;
4732 fix_insert_line($fixlinenr, $fixedline);
4733 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004734 }
4735
Joe Perches8b8856f2014-08-06 16:11:14 -07004736 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4737 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004738 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4739
4740 # Find out what is on the end of the line after the
4741 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004742 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004743 $s =~ s/\n.*//g;
4744
4745 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004746 if (ERROR("WHILE_AFTER_BRACE",
4747 "while should follow close brace '}'\n" . $hereprev) &&
4748 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4749 fix_delete_line($fixlinenr - 1, $prevrawline);
4750 fix_delete_line($fixlinenr, $rawline);
4751 my $fixedline = $prevrawline;
4752 my $trailing = $rawline;
4753 $trailing =~ s/^\+//;
4754 $trailing = trim($trailing);
4755 $fixedline =~ s/}\s*$/} $trailing/;
4756 fix_insert_line($fixlinenr, $fixedline);
4757 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004758 }
4759 }
4760
Joe Perches95e2c602013-07-03 15:05:20 -07004761#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004762 while ($line =~ m{($Constant|$Lval)}g) {
4763 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004764
4765#gcc binary extension
4766 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004767 if (WARN("GCC_BINARY_CONSTANT",
4768 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4769 $fix) {
4770 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004771 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004772 s/\b$var\b/$hexval/;
4773 }
Joe Perches95e2c602013-07-03 15:05:20 -07004774 }
4775
4776#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004777 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004778 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004779#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004780 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004781#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004782 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4783#Ignore some three character SI units explicitly, like MiB and KHz
4784 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004785 while ($var =~ m{($Ident)}g) {
4786 my $word = $1;
4787 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004788 if ($check) {
4789 seed_camelcase_includes();
4790 if (!$file && !$camelcase_file_seeded) {
4791 seed_camelcase_file($realfile);
4792 $camelcase_file_seeded = 1;
4793 }
4794 }
Joe Perches7e781f62013-09-11 14:23:55 -07004795 if (!defined $camelcase{$word}) {
4796 $camelcase{$word} = 1;
4797 CHK("CAMELCASE",
4798 "Avoid CamelCase: <$word>\n" . $herecurr);
4799 }
Joe Perches34456862013-07-03 15:05:34 -07004800 }
Joe Perches323c1262012-12-17 16:02:07 -08004801 }
4802 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004803
4804#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004805 if ($line =~ /\#\s*define.*\\\s+$/) {
4806 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4807 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4808 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004809 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004810 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004811 }
4812
Fabian Frederick0e212e02015-04-16 12:44:25 -07004813# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4814# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004815 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004816 my $file = "$1.h";
4817 my $checkfile = "include/linux/$file";
4818 if (-f "$root/$checkfile" &&
4819 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004820 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004821 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004822 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4823 if ($asminclude > 0) {
4824 if ($realfile =~ m{^arch/}) {
4825 CHK("ARCH_INCLUDE_LINUX",
4826 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4827 } else {
4828 WARN("INCLUDE_LINUX",
4829 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4830 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004831 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004832 }
4833 }
4834
Andy Whitcroft653d4872007-06-23 17:16:34 -07004835# multi-statement macros should be enclosed in a do while loop, grab the
4836# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004837# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004838 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4839 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004840 my $ln = $linenr;
4841 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004842 my ($off, $dstat, $dcond, $rest);
4843 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004844 my $has_flow_statement = 0;
4845 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004846 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004847 ctx_statement_block($linenr, $realcnt, 0);
4848 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004849 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004850 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004851
Joe Perches08a28432014-10-13 15:51:55 -07004852 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004853 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004854
Joe Perchesf59b64b2016-10-11 13:52:08 -07004855 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4856 my $define_args = $1;
4857 my $define_stmt = $dstat;
4858 my @def_args = ();
4859
4860 if (defined $define_args && $define_args ne "") {
4861 $define_args = substr($define_args, 1, length($define_args) - 2);
4862 $define_args =~ s/\s*//g;
4863 @def_args = split(",", $define_args);
4864 }
4865
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004866 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004867 $dstat =~ s/\\\n.//g;
4868 $dstat =~ s/^\s*//s;
4869 $dstat =~ s/\s*$//s;
4870
4871 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004872 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4873 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004874 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004875 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004876 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004877
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004878 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004879 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4880 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004881 {
4882 }
4883
Joe Perches42e15292016-03-15 14:58:01 -07004884 # Make asm volatile uses seem like a generic function
4885 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4886
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004887 my $exceptions = qr{
4888 $Declare|
4889 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004890 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004891 DECLARE_PER_CPU|
4892 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004893 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004894 union|
4895 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004896 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004897 ^\"|\"$|
4898 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004899 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004900 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004901
4902 $ctx =~ s/\n*$//;
4903 my $herectx = $here . "\n";
4904 my $stmt_cnt = statement_rawlines($ctx);
4905
4906 for (my $n = 0; $n < $stmt_cnt; $n++) {
4907 $herectx .= raw_line($linenr, $n) . "\n";
4908 }
4909
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004910 if ($dstat ne '' &&
4911 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4912 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004913 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004914 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004915 $dstat !~ /$exceptions/ &&
4916 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004917 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004918 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004919 $dstat !~ /^for\s*$Constant$/ && # for (...)
4920 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4921 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004922 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004923 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004924 {
Joe Perchese7955562017-05-08 15:55:48 -07004925 if ($dstat =~ /^\s*if\b/) {
4926 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4927 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4928 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004929 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4930 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4931 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004932 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004933 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004934 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004935
4936 }
Joe Perches52076492016-10-11 13:52:14 -07004937
4938 # Make $define_stmt single line, comment-free, etc
4939 my @stmt_array = split('\n', $define_stmt);
4940 my $first = 1;
4941 $define_stmt = "";
4942 foreach my $l (@stmt_array) {
4943 $l =~ s/\\$//;
4944 if ($first) {
4945 $define_stmt = $l;
4946 $first = 0;
4947 } elsif ($l =~ /^[\+ ]/) {
4948 $define_stmt .= substr($l, 1);
4949 }
4950 }
4951 $define_stmt =~ s/$;//g;
4952 $define_stmt =~ s/\s+/ /g;
4953 $define_stmt = trim($define_stmt);
4954
Joe Perchesf59b64b2016-10-11 13:52:08 -07004955# check if any macro arguments are reused (ignore '...' and 'type')
4956 foreach my $arg (@def_args) {
4957 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07004958 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07004959 my $tmp_stmt = $define_stmt;
4960 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4961 $tmp_stmt =~ s/\#+\s*$arg\b//g;
4962 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
4963 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004964 if ($use_cnt > 1) {
4965 CHK("MACRO_ARG_REUSE",
4966 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07004967 }
4968# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07004969 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07004970 ((defined($1) && $1 ne ',') ||
4971 (defined($2) && $2 ne ','))) {
4972 CHK("MACRO_ARG_PRECEDENCE",
4973 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07004974 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004975 }
Joe Perches5023d342012-12-17 16:01:47 -08004976
Joe Perches08a28432014-10-13 15:51:55 -07004977# check for macros with flow control, but without ## concatenation
4978# ## concatenation is commonly a macro that defines a function so ignore those
4979 if ($has_flow_statement && !$has_arg_concat) {
4980 my $herectx = $here . "\n";
4981 my $cnt = statement_rawlines($ctx);
4982
4983 for (my $n = 0; $n < $cnt; $n++) {
4984 $herectx .= raw_line($linenr, $n) . "\n";
4985 }
4986 WARN("MACRO_WITH_FLOW_CONTROL",
4987 "Macros with flow control statements should be avoided\n" . "$herectx");
4988 }
4989
Joe Perches481eb482012-12-17 16:01:56 -08004990# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004991
4992 } else {
4993 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004994 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4995 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004996 $line =~ /^\+.*\\$/) {
4997 WARN("LINE_CONTINUATIONS",
4998 "Avoid unnecessary line continuations\n" . $herecurr);
4999 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005000 }
5001
Joe Perchesb13edf72012-07-30 14:41:24 -07005002# do {} while (0) macro tests:
5003# single-statement macros do not need to be enclosed in do while (0) loop,
5004# macro should not end with a semicolon
5005 if ($^V && $^V ge 5.10.0 &&
5006 $realfile !~ m@/vmlinux.lds.h$@ &&
5007 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5008 my $ln = $linenr;
5009 my $cnt = $realcnt;
5010 my ($off, $dstat, $dcond, $rest);
5011 my $ctx = '';
5012 ($dstat, $dcond, $ln, $cnt, $off) =
5013 ctx_statement_block($linenr, $realcnt, 0);
5014 $ctx = $dstat;
5015
5016 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005017 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005018
5019 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5020 my $stmts = $2;
5021 my $semis = $3;
5022
5023 $ctx =~ s/\n*$//;
5024 my $cnt = statement_rawlines($ctx);
5025 my $herectx = $here . "\n";
5026
5027 for (my $n = 0; $n < $cnt; $n++) {
5028 $herectx .= raw_line($linenr, $n) . "\n";
5029 }
5030
Joe Perchesac8e97f2012-08-21 16:15:53 -07005031 if (($stmts =~ tr/;/;/) == 1 &&
5032 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005033 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5034 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5035 }
5036 if (defined $semis && $semis ne "") {
5037 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5038 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5039 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005040 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5041 $ctx =~ s/\n*$//;
5042 my $cnt = statement_rawlines($ctx);
5043 my $herectx = $here . "\n";
5044
5045 for (my $n = 0; $n < $cnt; $n++) {
5046 $herectx .= raw_line($linenr, $n) . "\n";
5047 }
5048
5049 WARN("TRAILING_SEMICOLON",
5050 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005051 }
5052 }
5053
Mike Frysinger080ba922009-01-06 14:41:25 -08005054# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5055# all assignments may have only one of the following with an assignment:
5056# .
5057# ALIGN(...)
5058# VMLINUX_SYMBOL(...)
5059 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005060 WARN("MISSING_VMLINUX_SYMBOL",
5061 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005062 }
5063
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005064# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005065 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5066 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005067 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005068 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005069 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5070 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005071 my @allowed = ();
5072 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005073 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005074 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005075 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005076 for my $chunk (@chunks) {
5077 my ($cond, $block) = @{$chunk};
5078
Andy Whitcroft773647a2008-03-28 14:15:58 -07005079 # If the condition carries leading newlines, then count those as offsets.
5080 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5081 my $offset = statement_rawlines($whitespace) - 1;
5082
Joe Perchesaad4f612012-03-23 15:02:19 -07005083 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005084 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5085
5086 # We have looked at and allowed this specific line.
5087 $suppress_ifbraces{$ln + $offset} = 1;
5088
5089 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005090 $ln += statement_rawlines($block) - 1;
5091
Andy Whitcroft773647a2008-03-28 14:15:58 -07005092 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005093
5094 $seen++ if ($block =~ /^\s*{/);
5095
Joe Perchesaad4f612012-03-23 15:02:19 -07005096 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005097 if (statement_lines($cond) > 1) {
5098 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005099 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005100 }
5101 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005102 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005103 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005104 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005105 if (statement_block_size($block) > 1) {
5106 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005107 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005108 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005109 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005110 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005111 if ($seen) {
5112 my $sum_allowed = 0;
5113 foreach (@allowed) {
5114 $sum_allowed += $_;
5115 }
5116 if ($sum_allowed == 0) {
5117 WARN("BRACES",
5118 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5119 } elsif ($sum_allowed != $allow &&
5120 $seen != $allow) {
5121 CHK("BRACES",
5122 "braces {} should be used on all arms of this statement\n" . $herectx);
5123 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005124 }
5125 }
5126 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005127 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005128 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005129 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005130
Andy Whitcroftcf655042008-03-04 14:28:20 -08005131 # Check the pre-context.
5132 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5133 #print "APW: ALLOWED: pre<$1>\n";
5134 $allowed = 1;
5135 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005136
5137 my ($level, $endln, @chunks) =
5138 ctx_statement_full($linenr, $realcnt, $-[0]);
5139
Andy Whitcroftcf655042008-03-04 14:28:20 -08005140 # Check the condition.
5141 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005142 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005143 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005144 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005145 }
5146 if (statement_lines($cond) > 1) {
5147 #print "APW: ALLOWED: cond<$cond>\n";
5148 $allowed = 1;
5149 }
5150 if ($block =~/\b(?:if|for|while)\b/) {
5151 #print "APW: ALLOWED: block<$block>\n";
5152 $allowed = 1;
5153 }
5154 if (statement_block_size($block) > 1) {
5155 #print "APW: ALLOWED: lines block<$block>\n";
5156 $allowed = 1;
5157 }
5158 # Check the post-context.
5159 if (defined $chunks[1]) {
5160 my ($cond, $block) = @{$chunks[1]};
5161 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005162 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005163 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005164 if ($block =~ /^\s*\{/) {
5165 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5166 $allowed = 1;
5167 }
5168 }
5169 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005170 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005171 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005172
Andy Whitcroftf0556632008-10-15 22:02:23 -07005173 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005174 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005175 }
5176
Joe Perches000d1cc12011-07-25 17:13:25 -07005177 WARN("BRACES",
5178 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005179 }
5180 }
5181
Joe Perchese4c5bab2017-02-24 15:01:41 -08005182# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005183 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5184 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005185 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5186 }
5187
Joe Perches0979ae62012-12-17 16:01:59 -08005188# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005189 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005190 if (CHK("BRACES",
5191 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5192 $fix && $prevrawline =~ /^\+/) {
5193 fix_delete_line($fixlinenr - 1, $prevrawline);
5194 }
Joe Perches0979ae62012-12-17 16:01:59 -08005195 }
Joe Perches77b9a532013-07-03 15:05:29 -07005196 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005197 if (CHK("BRACES",
5198 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5199 $fix) {
5200 fix_delete_line($fixlinenr, $rawline);
5201 }
Joe Perches0979ae62012-12-17 16:01:59 -08005202 }
5203
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005204# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005205 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5206 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005207 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005208 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005209 }
5210
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005211# Check for user-visible strings broken across lines, which breaks the ability
5212# to grep for the string. Make exceptions when the previous string ends in a
5213# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5214# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005215 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005216 $prevline =~ /"\s*$/ &&
5217 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5218 if (WARN("SPLIT_STRING",
5219 "quoted string split across lines\n" . $hereprev) &&
5220 $fix &&
5221 $prevrawline =~ /^\+.*"\s*$/ &&
5222 $last_coalesced_string_linenr != $linenr - 1) {
5223 my $extracted_string = get_quoted_string($line, $rawline);
5224 my $comma_close = "";
5225 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5226 $comma_close = $1;
5227 }
5228
5229 fix_delete_line($fixlinenr - 1, $prevrawline);
5230 fix_delete_line($fixlinenr, $rawline);
5231 my $fixedline = $prevrawline;
5232 $fixedline =~ s/"\s*$//;
5233 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5234 fix_insert_line($fixlinenr - 1, $fixedline);
5235 $fixedline = $rawline;
5236 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5237 if ($fixedline !~ /\+\s*$/) {
5238 fix_insert_line($fixlinenr, $fixedline);
5239 }
5240 $last_coalesced_string_linenr = $linenr;
5241 }
5242 }
5243
5244# check for missing a space in a string concatenation
5245 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5246 WARN('MISSING_SPACE',
5247 "break quoted strings at a space character\n" . $hereprev);
5248 }
5249
Joe Perchese4b7d302017-05-08 15:55:51 -07005250# check for an embedded function name in a string when the function is known
5251# This does not work very well for -f --file checking as it depends on patch
5252# context providing the function name or a single line form for in-file
5253# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005254 if ($line =~ /^\+.*$String/ &&
5255 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005256 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5257 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005258 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005259 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005260 }
5261
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005262# check for spaces before a quoted newline
5263 if ($rawline =~ /^.*\".*\s\\n/) {
5264 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5265 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5266 $fix) {
5267 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5268 }
5269
5270 }
5271
Joe Perchesf17dba42014-10-13 15:51:51 -07005272# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005273 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005274 CHK("CONCATENATED_STRING",
5275 "Concatenated strings should use spaces between elements\n" . $herecurr);
5276 }
5277
Joe Perches90ad30e2014-12-10 15:51:59 -08005278# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005279 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005280 WARN("STRING_FRAGMENTS",
5281 "Consecutive strings are generally better as a single string\n" . $herecurr);
5282 }
5283
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005284# check for non-standard and hex prefixed decimal printf formats
5285 my $show_L = 1; #don't show the same defect twice
5286 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005287 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005288 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005289 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005290 # check for %L
5291 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005292 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005293 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5294 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005295 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005296 # check for %Z
5297 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5298 WARN("PRINTF_Z",
5299 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5300 $show_Z = 0;
5301 }
5302 # check for 0x<decimal>
5303 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5304 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005305 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5306 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005307 }
5308
5309# check for line continuations in quoted strings with odd counts of "
5310 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5311 WARN("LINE_CONTINUATIONS",
5312 "Avoid line continuations in quoted strings\n" . $herecurr);
5313 }
5314
Andy Whitcroft00df3442007-06-08 13:47:06 -07005315# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005316 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005317 CHK("REDUNDANT_CODE",
5318 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005319 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005320 }
5321
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005322# check for needless "if (<foo>) fn(<foo>)" uses
5323 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005324 my $tested = quotemeta($1);
5325 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5326 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5327 my $func = $1;
5328 if (WARN('NEEDLESS_IF',
5329 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5330 $fix) {
5331 my $do_fix = 1;
5332 my $leading_tabs = "";
5333 my $new_leading_tabs = "";
5334 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5335 $leading_tabs = $1;
5336 } else {
5337 $do_fix = 0;
5338 }
5339 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5340 $new_leading_tabs = $1;
5341 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5342 $do_fix = 0;
5343 }
5344 } else {
5345 $do_fix = 0;
5346 }
5347 if ($do_fix) {
5348 fix_delete_line($fixlinenr - 1, $prevrawline);
5349 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5350 }
5351 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005352 }
5353 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005354
Joe Perchesebfdc402014-08-06 16:10:27 -07005355# check for unnecessary "Out of Memory" messages
5356 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5357 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5358 (defined $1 || defined $3) &&
5359 $linenr > 3) {
5360 my $testval = $2;
5361 my $testline = $lines[$linenr - 3];
5362
5363 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5364# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5365
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005366 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 -07005367 WARN("OOM_MESSAGE",
5368 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5369 }
5370 }
5371
Joe Perchesf78d98f2014-10-13 15:52:01 -07005372# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005373 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005374 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5375 my $level = $1;
5376 if (WARN("UNNECESSARY_KERN_LEVEL",
5377 "Possible unnecessary $level\n" . $herecurr) &&
5378 $fix) {
5379 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5380 }
5381 }
5382
Joe Perches45c55e92017-02-24 15:01:31 -08005383# check for logging continuations
5384 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5385 WARN("LOGGING_CONTINUATION",
5386 "Avoid logging continuation uses where feasible\n" . $herecurr);
5387 }
5388
Joe Perchesabb08a52014-12-10 15:51:46 -08005389# check for mask then right shift without a parentheses
5390 if ($^V && $^V ge 5.10.0 &&
5391 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5392 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5393 WARN("MASK_THEN_SHIFT",
5394 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5395 }
5396
Joe Perchesb75ac612014-12-10 15:52:02 -08005397# check for pointer comparisons to NULL
5398 if ($^V && $^V ge 5.10.0) {
5399 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5400 my $val = $1;
5401 my $equal = "!";
5402 $equal = "" if ($4 eq "!=");
5403 if (CHK("COMPARISON_TO_NULL",
5404 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5405 $fix) {
5406 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5407 }
5408 }
5409 }
5410
Joe Perches8716de32013-09-11 14:24:05 -07005411# check for bad placement of section $InitAttribute (e.g.: __initdata)
5412 if ($line =~ /(\b$InitAttribute\b)/) {
5413 my $attr = $1;
5414 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5415 my $ptr = $1;
5416 my $var = $2;
5417 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5418 ERROR("MISPLACED_INIT",
5419 "$attr should be placed after $var\n" . $herecurr)) ||
5420 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5421 WARN("MISPLACED_INIT",
5422 "$attr should be placed after $var\n" . $herecurr))) &&
5423 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005424 $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 -07005425 }
5426 }
5427 }
5428
Joe Perchese970b8842013-11-12 15:10:10 -08005429# check for $InitAttributeData (ie: __initdata) with const
5430 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5431 my $attr = $1;
5432 $attr =~ /($InitAttributePrefix)(.*)/;
5433 my $attr_prefix = $1;
5434 my $attr_type = $2;
5435 if (ERROR("INIT_ATTRIBUTE",
5436 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5437 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005438 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005439 s/$InitAttributeData/${attr_prefix}initconst/;
5440 }
5441 }
5442
5443# check for $InitAttributeConst (ie: __initconst) without const
5444 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5445 my $attr = $1;
5446 if (ERROR("INIT_ATTRIBUTE",
5447 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5448 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005449 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005450 /(^\+\s*(?:static\s+))/;
5451 $lead = rtrim($1);
5452 $lead = "$lead " if ($lead !~ /^\+$/);
5453 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005454 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005455 }
5456 }
5457
Joe Perchesc17893c2015-04-16 12:44:42 -07005458# check for __read_mostly with const non-pointer (should just be const)
5459 if ($line =~ /\b__read_mostly\b/ &&
5460 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5461 if (ERROR("CONST_READ_MOSTLY",
5462 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5463 $fix) {
5464 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5465 }
5466 }
5467
Joe Perchesfbdb8132014-04-03 14:49:14 -07005468# don't use __constant_<foo> functions outside of include/uapi/
5469 if ($realfile !~ m@^include/uapi/@ &&
5470 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5471 my $constant_func = $1;
5472 my $func = $constant_func;
5473 $func =~ s/^__constant_//;
5474 if (WARN("CONSTANT_CONVERSION",
5475 "$constant_func should be $func\n" . $herecurr) &&
5476 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005477 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005478 }
5479 }
5480
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005481# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005482 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005483 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005484 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005485 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005486 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005487 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5488 }
5489 if ($delay > 2000) {
5490 WARN("LONG_UDELAY",
5491 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005492 }
5493 }
5494
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005495# warn about unexpectedly long msleep's
5496 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5497 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005498 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005499 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005500 }
5501 }
5502
Joe Perches36ec1932013-07-03 15:05:25 -07005503# check for comparisons of jiffies
5504 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5505 WARN("JIFFIES_COMPARISON",
5506 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5507 }
5508
Joe Perches9d7a34a2013-07-03 15:05:26 -07005509# check for comparisons of get_jiffies_64()
5510 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5511 WARN("JIFFIES_COMPARISON",
5512 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5513 }
5514
Andy Whitcroft00df3442007-06-08 13:47:06 -07005515# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005516# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005517# print "#ifdef in C files should be avoided\n";
5518# print "$herecurr";
5519# $clean = 0;
5520# }
5521
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005522# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005523 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005524 if (ERROR("SPACING",
5525 "exactly one space required after that #$1\n" . $herecurr) &&
5526 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005527 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005528 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5529 }
5530
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005531 }
5532
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005533# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005534 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5535 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005536 my $which = $1;
5537 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005538 CHK("UNCOMMENTED_DEFINITION",
5539 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005540 }
5541 }
5542# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005543
5544 my $barriers = qr{
5545 mb|
5546 rmb|
5547 wmb|
5548 read_barrier_depends
5549 }x;
5550 my $barrier_stems = qr{
5551 mb__before_atomic|
5552 mb__after_atomic|
5553 store_release|
5554 load_acquire|
5555 store_mb|
5556 (?:$barriers)
5557 }x;
5558 my $all_barriers = qr{
5559 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005560 smp_(?:$barrier_stems)|
5561 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005562 }x;
5563
5564 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005565 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005566 WARN("MEMORY_BARRIER",
5567 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005568 }
5569 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005570
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005571 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5572
5573 if ($realfile !~ m@^include/asm-generic/@ &&
5574 $realfile !~ m@/barrier\.h$@ &&
5575 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5576 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5577 WARN("MEMORY_BARRIER",
5578 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5579 }
5580
Joe Perchescb426e92015-06-25 15:02:46 -07005581# check for waitqueue_active without a comment.
5582 if ($line =~ /\bwaitqueue_active\s*\(/) {
5583 if (!ctx_has_comment($first_line, $linenr)) {
5584 WARN("WAITQUEUE_ACTIVE",
5585 "waitqueue_active without comment\n" . $herecurr);
5586 }
5587 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005588
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005589# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005590 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005591 CHK("ARCH_DEFINES",
5592 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005593 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005594
Joe Perches596ed452017-07-12 14:37:02 -07005595# check that the storage class is not after a type
5596 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005597 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005598 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5599 }
5600# Check that the storage class is at the beginning of a declaration
5601 if ($line =~ /\b$Storage\b/ &&
5602 $line !~ /^.\s*$Storage/ &&
5603 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5604 $1 !~ /[\,\)]\s*$/) {
5605 WARN("STORAGE_CLASS",
5606 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005607 }
5608
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005609# check the location of the inline attribute, that it is between
5610# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005611 if ($line =~ /\b$Type\s+$Inline\b/ ||
5612 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005613 ERROR("INLINE_LOCATION",
5614 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005615 }
5616
Andy Whitcroft8905a672007-11-28 16:21:06 -08005617# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005618 if ($realfile !~ m@\binclude/uapi/@ &&
5619 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005620 if (WARN("INLINE",
5621 "plain inline is preferred over $1\n" . $herecurr) &&
5622 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005623 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005624
5625 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005626 }
5627
Joe Perches3d130fd2011-01-12 17:00:00 -08005628# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005629 if ($realfile !~ m@\binclude/uapi/@ &&
5630 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005631 WARN("PREFER_PACKED",
5632 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005633 }
5634
Joe Perches39b7e282011-07-25 17:13:24 -07005635# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005636 if ($realfile !~ m@\binclude/uapi/@ &&
5637 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005638 WARN("PREFER_ALIGNED",
5639 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005640 }
5641
Joe Perches5f14d3b2012-01-10 15:09:52 -08005642# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005643 if ($realfile !~ m@\binclude/uapi/@ &&
5644 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005645 if (WARN("PREFER_PRINTF",
5646 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5647 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005648 $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 -07005649
5650 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005651 }
5652
Joe Perches6061d942012-03-23 15:02:16 -07005653# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005654 if ($realfile !~ m@\binclude/uapi/@ &&
5655 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005656 if (WARN("PREFER_SCANF",
5657 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5658 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005659 $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 -07005660 }
Joe Perches6061d942012-03-23 15:02:16 -07005661 }
5662
Joe Perches619a9082014-12-10 15:51:35 -08005663# Check for __attribute__ weak, or __weak declarations (may have link issues)
5664 if ($^V && $^V ge 5.10.0 &&
5665 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5666 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5667 $line =~ /\b__weak\b/)) {
5668 ERROR("WEAK_DECLARATION",
5669 "Using weak declarations can have unintended link defects\n" . $herecurr);
5670 }
5671
Tomas Winklerfd39f902016-12-12 16:46:34 -08005672# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005673 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005674 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005675 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5676 my $type = $1;
5677 if ($type =~ /\b($typeC99Typedefs)\b/) {
5678 $type = $1;
5679 my $kernel_type = 'u';
5680 $kernel_type = 's' if ($type =~ /^_*[si]/);
5681 $type =~ /(\d+)/;
5682 $kernel_type .= $1;
5683 if (CHK("PREFER_KERNEL_TYPES",
5684 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5685 $fix) {
5686 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5687 }
5688 }
5689 }
5690
Joe Perches938224b2016-01-20 14:59:15 -08005691# check for cast of C90 native int or longer types constants
5692 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5693 my $cast = $1;
5694 my $const = $2;
5695 if (WARN("TYPECAST_INT_CONSTANT",
5696 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5697 $fix) {
5698 my $suffix = "";
5699 my $newconst = $const;
5700 $newconst =~ s/${Int_type}$//;
5701 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5702 if ($cast =~ /\blong\s+long\b/) {
5703 $suffix .= 'LL';
5704 } elsif ($cast =~ /\blong\b/) {
5705 $suffix .= 'L';
5706 }
5707 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5708 }
5709 }
5710
Joe Perches8f53a9b2010-03-05 13:43:48 -08005711# check for sizeof(&)
5712 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005713 WARN("SIZEOF_ADDRESS",
5714 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005715 }
5716
Joe Perches66c80b62012-07-30 14:41:22 -07005717# check for sizeof without parenthesis
5718 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005719 if (WARN("SIZEOF_PARENTHESIS",
5720 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5721 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005722 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005723 }
Joe Perches66c80b62012-07-30 14:41:22 -07005724 }
5725
Joe Perches88982fe2012-12-17 16:02:00 -08005726# check for struct spinlock declarations
5727 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5728 WARN("USE_SPINLOCK_T",
5729 "struct spinlock should be spinlock_t\n" . $herecurr);
5730 }
5731
Joe Perchesa6962d72013-04-29 16:18:13 -07005732# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005733 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005734 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005735 $fmt =~ s/%%//g;
5736 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005737 if (WARN("PREFER_SEQ_PUTS",
5738 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5739 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005740 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005741 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005742 }
5743 }
5744
Joe Perches0b523762017-05-08 15:55:36 -07005745 # check for vsprintf extension %p<foo> misuses
5746 if ($^V && $^V ge 5.10.0 &&
5747 defined $stat &&
5748 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5749 $1 !~ /^_*volatile_*$/) {
5750 my $bad_extension = "";
5751 my $lc = $stat =~ tr@\n@@;
5752 $lc = $lc + $linenr;
5753 for (my $count = $linenr; $count <= $lc; $count++) {
5754 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5755 $fmt =~ s/%%//g;
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02005756 if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNO]).)/) {
Joe Perches0b523762017-05-08 15:55:36 -07005757 $bad_extension = $1;
5758 last;
5759 }
5760 }
5761 if ($bad_extension ne "") {
5762 my $stat_real = raw_line($linenr, 0);
5763 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5764 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5765 }
5766 WARN("VSPRINTF_POINTER_EXTENSION",
5767 "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
5768 }
5769 }
5770
Andy Whitcroft554e1652012-01-10 15:09:57 -08005771# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005772 if ($^V && $^V ge 5.10.0 &&
5773 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005774 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005775
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005776 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005777 my $ms_val = $7;
5778 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005779
Andy Whitcroft554e1652012-01-10 15:09:57 -08005780 if ($ms_size =~ /^(0x|)0$/i) {
5781 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005782 "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 -08005783 } elsif ($ms_size =~ /^(0x|)1$/i) {
5784 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005785 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5786 }
5787 }
5788
Joe Perches98a9bba2014-01-23 15:54:52 -08005789# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005790# if ($^V && $^V ge 5.10.0 &&
5791# defined $stat &&
5792# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5793# if (WARN("PREFER_ETHER_ADDR_COPY",
5794# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5795# $fix) {
5796# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5797# }
5798# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005799
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005800# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005801# if ($^V && $^V ge 5.10.0 &&
5802# defined $stat &&
5803# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5804# WARN("PREFER_ETHER_ADDR_EQUAL",
5805# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5806# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005807
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005808# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5809# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf3331952016-10-11 13:51:53 -07005810# if ($^V && $^V ge 5.10.0 &&
5811# defined $stat &&
5812# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5813#
5814# my $ms_val = $7;
5815#
5816# if ($ms_val =~ /^(?:0x|)0+$/i) {
5817# if (WARN("PREFER_ETH_ZERO_ADDR",
5818# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5819# $fix) {
5820# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5821# }
5822# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5823# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5824# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5825# $fix) {
5826# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5827# }
5828# }
5829# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005830
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005831# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005832 if ($^V && $^V ge 5.10.0 &&
5833 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005834 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005835 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005836 my $call = $1;
5837 my $cast1 = deparenthesize($2);
5838 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005839 my $cast2 = deparenthesize($7);
5840 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005841 my $cast;
5842
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005843 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005844 $cast = "$cast1 or $cast2";
5845 } elsif ($cast1 ne "") {
5846 $cast = $cast1;
5847 } else {
5848 $cast = $cast2;
5849 }
5850 WARN("MINMAX",
5851 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005852 }
5853 }
5854
Joe Perches4a273192012-07-30 14:41:20 -07005855# check usleep_range arguments
5856 if ($^V && $^V ge 5.10.0 &&
5857 defined $stat &&
5858 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5859 my $min = $1;
5860 my $max = $7;
5861 if ($min eq $max) {
5862 WARN("USLEEP_RANGE",
5863 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5864 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5865 $min > $max) {
5866 WARN("USLEEP_RANGE",
5867 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5868 }
5869 }
5870
Joe Perches823b7942013-11-12 15:10:15 -08005871# check for naked sscanf
5872 if ($^V && $^V ge 5.10.0 &&
5873 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005874 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005875 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5876 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5877 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5878 my $lc = $stat =~ tr@\n@@;
5879 $lc = $lc + $linenr;
5880 my $stat_real = raw_line($linenr, 0);
5881 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5882 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5883 }
5884 WARN("NAKED_SSCANF",
5885 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5886 }
5887
Joe Perchesafc819a2014-06-04 16:12:08 -07005888# check for simple sscanf that should be kstrto<foo>
5889 if ($^V && $^V ge 5.10.0 &&
5890 defined $stat &&
5891 $line =~ /\bsscanf\b/) {
5892 my $lc = $stat =~ tr@\n@@;
5893 $lc = $lc + $linenr;
5894 my $stat_real = raw_line($linenr, 0);
5895 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5896 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5897 }
5898 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5899 my $format = $6;
5900 my $count = $format =~ tr@%@%@;
5901 if ($count == 1 &&
5902 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5903 WARN("SSCANF_TO_KSTRTO",
5904 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5905 }
5906 }
5907 }
5908
Joe Perches70dc8a42013-09-11 14:23:58 -07005909# check for new externs in .h files.
5910 if ($realfile =~ /\.h$/ &&
5911 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005912 if (CHK("AVOID_EXTERNS",
5913 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005914 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005915 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005916 }
5917 }
5918
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005919# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005920 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005921 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005922 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005923 my $function_name = $1;
5924 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005925
5926 my $s = $stat;
5927 if (defined $cond) {
5928 substr($s, 0, length($cond), '');
5929 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005930 if ($s =~ /^\s*;/ &&
5931 $function_name ne 'uninitialized_var')
5932 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005933 WARN("AVOID_EXTERNS",
5934 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005935 }
5936
5937 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005938 WARN("FUNCTION_ARGUMENTS",
5939 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005940 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005941
5942 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5943 $stat =~ /^.\s*extern\s+/)
5944 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005945 WARN("AVOID_EXTERNS",
5946 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005947 }
5948
Joe Perchesa0ad7592017-07-10 15:52:19 -07005949# check for function declarations that have arguments without identifier names
5950 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08005951 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07005952 $1 ne "void") {
5953 my $args = trim($1);
5954 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5955 my $arg = trim($1);
5956 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5957 WARN("FUNCTION_ARGUMENTS",
5958 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5959 }
5960 }
5961 }
5962
Joe Perchesa0ad7592017-07-10 15:52:19 -07005963# check for function definitions
5964 if ($^V && $^V ge 5.10.0 &&
5965 defined $stat &&
5966 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
5967 $context_function = $1;
5968
5969# check for multiline function definition with misplaced open brace
5970 my $ok = 0;
5971 my $cnt = statement_rawlines($stat);
5972 my $herectx = $here . "\n";
5973 for (my $n = 0; $n < $cnt; $n++) {
5974 my $rl = raw_line($linenr, $n);
5975 $herectx .= $rl . "\n";
5976 $ok = 1 if ($rl =~ /^[ \+]\{/);
5977 $ok = 1 if ($rl =~ /\{/ && $n == 0);
5978 last if $rl =~ /^[ \+].*\{/;
5979 }
5980 if (!$ok) {
5981 ERROR("OPEN_BRACE",
5982 "open brace '{' following function definitions go on the next line\n" . $herectx);
5983 }
5984 }
5985
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005986# checks for new __setup's
5987 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5988 my $name = $1;
5989
5990 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005991 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005992 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005993 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005994 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005995
5996# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005997 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005998 WARN("UNNECESSARY_CASTS",
5999 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006000 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006001
Joe Perchesa640d252013-07-03 15:05:21 -07006002# alloc style
6003# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6004 if ($^V && $^V ge 5.10.0 &&
6005 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6006 CHK("ALLOC_SIZEOF_STRUCT",
6007 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6008 }
6009
Joe Perches60a55362014-06-04 16:12:07 -07006010# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6011 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006012 defined $stat &&
6013 $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 -07006014 my $oldfunc = $3;
6015 my $a1 = $4;
6016 my $a2 = $10;
6017 my $newfunc = "kmalloc_array";
6018 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006019 my $r1 = $a1;
6020 my $r2 = $a2;
6021 if ($a1 =~ /^sizeof\s*\S/) {
6022 $r1 = $a2;
6023 $r2 = $a1;
6024 }
6025 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6026 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006027 my $ctx = '';
6028 my $herectx = $here . "\n";
6029 my $cnt = statement_rawlines($stat);
6030 for (my $n = 0; $n < $cnt; $n++) {
6031 $herectx .= raw_line($linenr, $n) . "\n";
6032 }
Joe Perches60a55362014-06-04 16:12:07 -07006033 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006034 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6035 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006036 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006037 $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 -07006038 }
6039 }
6040 }
6041
Joe Perches972fdea2013-04-29 16:18:12 -07006042# check for krealloc arg reuse
6043 if ($^V && $^V ge 5.10.0 &&
6044 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6045 WARN("KREALLOC_ARG_REUSE",
6046 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6047 }
6048
Joe Perches5ce59ae2013-02-21 16:44:18 -08006049# check for alloc argument mismatch
6050 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6051 WARN("ALLOC_ARRAY_ARGS",
6052 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6053 }
6054
Joe Perchescaf2a542011-01-12 16:59:56 -08006055# check for multiple semicolons
6056 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006057 if (WARN("ONE_SEMICOLON",
6058 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6059 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006060 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006061 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006062 }
6063
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006064# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6065 if ($realfile !~ m@^include/uapi/@ &&
6066 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006067 my $ull = "";
6068 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6069 if (CHK("BIT_MACRO",
6070 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6071 $fix) {
6072 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6073 }
6074 }
6075
Joe Perches2d632742016-05-20 17:04:00 -07006076# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6077 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6078 my $config = $1;
6079 if (WARN("PREFER_IS_ENABLED",
6080 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6081 $fix) {
6082 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6083 }
6084 }
6085
Joe Perchese81f2392014-08-06 16:11:25 -07006086# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006087 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6088 my $has_break = 0;
6089 my $has_statement = 0;
6090 my $count = 0;
6091 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006092 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006093 $prevline--;
6094 my $rline = $rawlines[$prevline - 1];
6095 my $fline = $lines[$prevline - 1];
6096 last if ($fline =~ /^\@\@/);
6097 next if ($fline =~ /^\-/);
6098 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6099 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6100 next if ($fline =~ /^.[\s$;]*$/);
6101 $has_statement = 1;
6102 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006103 $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 -08006104 }
6105 if (!$has_break && $has_statement) {
6106 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006107 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006108 }
6109 }
6110
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006111# check for switch/default statements without a break;
6112 if ($^V && $^V ge 5.10.0 &&
6113 defined $stat &&
6114 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6115 my $ctx = '';
6116 my $herectx = $here . "\n";
6117 my $cnt = statement_rawlines($stat);
6118 for (my $n = 0; $n < $cnt; $n++) {
6119 $herectx .= raw_line($linenr, $n) . "\n";
6120 }
6121 WARN("DEFAULT_NO_BREAK",
6122 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006123 }
6124
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006125# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006126 if ($line =~ /\b__FUNCTION__\b/) {
6127 if (WARN("USE_FUNC",
6128 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6129 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006130 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006131 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006132 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006133
Joe Perches62ec8182015-02-13 14:38:18 -08006134# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6135 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6136 ERROR("DATE_TIME",
6137 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6138 }
6139
Joe Perches2c924882012-03-23 15:02:20 -07006140# check for use of yield()
6141 if ($line =~ /\byield\s*\(\s*\)/) {
6142 WARN("YIELD",
6143 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6144 }
6145
Joe Perches179f8f42013-07-03 15:05:30 -07006146# check for comparisons against true and false
6147 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6148 my $lead = $1;
6149 my $arg = $2;
6150 my $test = $3;
6151 my $otype = $4;
6152 my $trail = $5;
6153 my $op = "!";
6154
6155 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6156
6157 my $type = lc($otype);
6158 if ($type =~ /^(?:true|false)$/) {
6159 if (("$test" eq "==" && "$type" eq "true") ||
6160 ("$test" eq "!=" && "$type" eq "false")) {
6161 $op = "";
6162 }
6163
6164 CHK("BOOL_COMPARISON",
6165 "Using comparison to $otype is error prone\n" . $herecurr);
6166
6167## maybe suggesting a correct construct would better
6168## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6169
6170 }
6171 }
6172
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006173# check for semaphores initialized locked
6174 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006175 WARN("CONSIDER_COMPLETION",
6176 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006177 }
Joe Perches6712d852012-03-23 15:02:20 -07006178
Joe Perches67d0a072011-10-31 17:13:10 -07006179# recommend kstrto* over simple_strto* and strict_strto*
6180 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006181 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006182 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006183 }
Joe Perches6712d852012-03-23 15:02:20 -07006184
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006185# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006186 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006187 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006188 "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 -07006189 }
Joe Perches6712d852012-03-23 15:02:20 -07006190
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006191# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006192# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006193 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006194 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006195 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006196 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006197 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006198
6199# use of NR_CPUS is usually wrong
6200# ignore definitions of NR_CPUS and usage to define arrays as likely right
6201 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006202 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6203 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006204 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6205 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6206 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006207 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006208 WARN("NR_CPUS",
6209 "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 -07006210 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006211
Joe Perches52ea8502013-11-12 15:10:09 -08006212# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6213 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6214 ERROR("DEFINE_ARCH_HAS",
6215 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6216 }
6217
Joe Perchesacd93622015-02-13 14:38:38 -08006218# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6219 if ($^V && $^V ge 5.10.0 &&
6220 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6221 WARN("LIKELY_MISUSE",
6222 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6223 }
6224
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006225# whine mightly about in_atomic
6226 if ($line =~ /\bin_atomic\s*\(/) {
6227 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006228 ERROR("IN_ATOMIC",
6229 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006230 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006231 WARN("IN_ATOMIC",
6232 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006233 }
6234 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006235
Joe Perches481aea52016-05-20 17:04:08 -07006236# whine about ACCESS_ONCE
6237 if ($^V && $^V ge 5.10.0 &&
6238 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6239 my $par = $1;
6240 my $eq = $2;
6241 my $fun = $3;
6242 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6243 if (defined($eq)) {
6244 if (WARN("PREFER_WRITE_ONCE",
6245 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6246 $fix) {
6247 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6248 }
6249 } else {
6250 if (WARN("PREFER_READ_ONCE",
6251 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6252 $fix) {
6253 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6254 }
6255 }
6256 }
6257
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006258# check for mutex_trylock_recursive usage
6259 if ($line =~ /mutex_trylock_recursive/) {
6260 ERROR("LOCKING",
6261 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6262 }
6263
Peter Zijlstra1704f472010-03-19 01:37:42 +01006264# check for lockdep_set_novalidate_class
6265 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6266 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6267 if ($realfile !~ m@^kernel/lockdep@ &&
6268 $realfile !~ m@^include/linux/lockdep@ &&
6269 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006270 ERROR("LOCKDEP",
6271 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006272 }
6273 }
Dave Jones88f88312011-01-12 16:59:59 -08006274
Joe Perchesb392c642015-04-16 12:44:16 -07006275 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6276 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006277 WARN("EXPORTED_WORLD_WRITABLE",
6278 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006279 }
Joe Perches24358802014-04-03 14:49:13 -07006280
Joe Perches515a2352014-04-03 14:49:24 -07006281# Mode permission misuses where it seems decimal should be octal
6282# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6283 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006284 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006285 $line =~ /$mode_perms_search/) {
6286 foreach my $entry (@mode_permission_funcs) {
6287 my $func = $entry->[0];
6288 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006289
Joe Perches459cf0a2016-10-11 13:52:19 -07006290 my $lc = $stat =~ tr@\n@@;
6291 $lc = $lc + $linenr;
6292 my $stat_real = raw_line($linenr, 0);
6293 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6294 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6295 }
6296
Joe Perches515a2352014-04-03 14:49:24 -07006297 my $skip_args = "";
6298 if ($arg_pos > 1) {
6299 $arg_pos--;
6300 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6301 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006302 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006303 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006304 my $val = $1;
6305 $val = $6 if ($skip_args ne "");
Joe Perchesf90774e2016-10-11 13:51:47 -07006306 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6307 ($val =~ /^$Octal$/ && length($val) ne 4)) {
Joe Perches515a2352014-04-03 14:49:24 -07006308 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006309 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006310 }
6311 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006312 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006313 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006314 }
Joe Perches24358802014-04-03 14:49:13 -07006315 }
6316 }
6317 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006318
Joe Perches459cf0a2016-10-11 13:52:19 -07006319# check for uses of S_<PERMS> that could be octal for readability
6320 if ($line =~ /\b$mode_perms_string_search\b/) {
6321 my $val = "";
6322 my $oval = "";
6323 my $to = 0;
6324 my $curpos = 0;
6325 my $lastpos = 0;
6326 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6327 $curpos = pos($line);
6328 my $match = $2;
6329 my $omatch = $1;
6330 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6331 $lastpos = $curpos;
6332 $to |= $mode_permission_string_types{$match};
6333 $val .= '\s*\|\s*' if ($val ne "");
6334 $val .= $match;
6335 $oval .= $omatch;
6336 }
6337 $oval =~ s/^\s*\|\s*//;
6338 $oval =~ s/\s*\|\s*$//;
6339 my $octal = sprintf("%04o", $to);
6340 if (WARN("SYMBOLIC_PERMS",
6341 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6342 $fix) {
6343 $fixed[$fixlinenr] =~ s/$val/$octal/;
6344 }
6345 }
6346
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006347# validate content of MODULE_LICENSE against list from include/linux/module.h
6348 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6349 my $extracted_string = get_quoted_string($line, $rawline);
6350 my $valid_licenses = qr{
6351 GPL|
6352 GPL\ v2|
6353 GPL\ and\ additional\ rights|
6354 Dual\ BSD/GPL|
6355 Dual\ MIT/GPL|
6356 Dual\ MPL/GPL|
6357 Proprietary
6358 }x;
6359 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6360 WARN("MODULE_LICENSE",
6361 "unknown module license " . $extracted_string . "\n" . $herecurr);
6362 }
6363 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006364 }
6365
6366 # If we have no input at all, then there is nothing to report on
6367 # so just keep quiet.
6368 if ($#rawlines == -1) {
6369 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006370 }
6371
Andy Whitcroft8905a672007-11-28 16:21:06 -08006372 # In mailback mode only produce a report in the negative, for
6373 # things that appear to be patches.
6374 if ($mailback && ($clean == 1 || !$is_patch)) {
6375 exit(0);
6376 }
6377
6378 # This is not a patch, and we are are in 'no-patch' mode so
6379 # just keep quiet.
6380 if (!$chk_patch && !$is_patch) {
6381 exit(0);
6382 }
6383
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006384 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006385 ERROR("NOT_UNIFIED_DIFF",
6386 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006387 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006388 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006389 ERROR("MISSING_SIGN_OFF",
6390 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006391 }
6392
Andy Whitcroft8905a672007-11-28 16:21:06 -08006393 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006394 if ($summary && !($clean == 1 && $quiet == 1)) {
6395 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006396 print "total: $cnt_error errors, $cnt_warn warnings, " .
6397 (($check)? "$cnt_chk checks, " : "") .
6398 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006399 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006400
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006401 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006402 # If there were any defects found and not already fixing them
6403 if (!$clean and !$fix) {
6404 print << "EOM"
6405
6406NOTE: For some of the reported defects, checkpatch may be able to
6407 mechanically convert to the typical style using --fix or --fix-inplace.
6408EOM
6409 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006410 # If there were whitespace errors which cleanpatch can fix
6411 # then suggest that.
6412 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006413 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006414 print << "EOM"
6415
6416NOTE: Whitespace errors detected.
6417 You may wish to use scripts/cleanpatch or scripts/cleanfile
6418EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006419 }
6420 }
6421
Joe Perchesd752fcc2014-08-06 16:11:05 -07006422 if ($clean == 0 && $fix &&
6423 ("@rawlines" ne "@fixed" ||
6424 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006425 my $newfile = $filename;
6426 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006427 my $linecount = 0;
6428 my $f;
6429
Joe Perchesd752fcc2014-08-06 16:11:05 -07006430 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6431
Joe Perches3705ce52013-07-03 15:05:31 -07006432 open($f, '>', $newfile)
6433 or die "$P: Can't open $newfile for write\n";
6434 foreach my $fixed_line (@fixed) {
6435 $linecount++;
6436 if ($file) {
6437 if ($linecount > 3) {
6438 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006439 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006440 }
6441 } else {
6442 print $f $fixed_line . "\n";
6443 }
6444 }
6445 close($f);
6446
6447 if (!$quiet) {
6448 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006449
Joe Perches3705ce52013-07-03 15:05:31 -07006450Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6451
6452Do _NOT_ trust the results written to this file.
6453Do _NOT_ submit these changes without inspecting them for correctness.
6454
6455This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6456No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006457EOM
6458 }
6459 }
6460
Joe Perchesd8469f12015-06-25 15:03:00 -07006461 if ($quiet == 0) {
6462 print "\n";
6463 if ($clean == 1) {
6464 print "$vname has no obvious style problems and is ready for submission.\n";
6465 } else {
6466 print "$vname has style problems, please review.\n";
6467 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006468 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006469 return $clean;
6470}