blob: dd2c262aebbf2a43283f38badcf445702c59c9e9 [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 Perches6e60c022011-07-25 17:13:27 -0700457 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700458 panic|
Joe Perches06668722013-11-12 15:10:07 -0800459 MODULE_[A-Z_]+|
460 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800461)};
462
Joe Perches20112472011-07-25 17:13:23 -0700463our $signature_tags = qr{(?xi:
464 Signed-off-by:|
465 Acked-by:|
466 Tested-by:|
467 Reviewed-by:|
468 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700469 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700470 To:|
471 Cc:
472)};
473
Joe Perches18130872014-08-06 16:11:22 -0700474our @typeListMisordered = (
475 qr{char\s+(?:un)?signed},
476 qr{int\s+(?:(?:un)?signed\s+)?short\s},
477 qr{int\s+short(?:\s+(?:un)?signed)},
478 qr{short\s+int(?:\s+(?:un)?signed)},
479 qr{(?:un)?signed\s+int\s+short},
480 qr{short\s+(?:un)?signed},
481 qr{long\s+int\s+(?:un)?signed},
482 qr{int\s+long\s+(?:un)?signed},
483 qr{long\s+(?:un)?signed\s+int},
484 qr{int\s+(?:un)?signed\s+long},
485 qr{int\s+(?:un)?signed},
486 qr{int\s+long\s+long\s+(?:un)?signed},
487 qr{long\s+long\s+int\s+(?:un)?signed},
488 qr{long\s+long\s+(?:un)?signed\s+int},
489 qr{long\s+long\s+(?:un)?signed},
490 qr{long\s+(?:un)?signed},
491);
492
Andy Whitcroft8905a672007-11-28 16:21:06 -0800493our @typeList = (
494 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700495 qr{(?:(?:un)?signed\s+)?char},
496 qr{(?:(?:un)?signed\s+)?short\s+int},
497 qr{(?:(?:un)?signed\s+)?short},
498 qr{(?:(?:un)?signed\s+)?int},
499 qr{(?:(?:un)?signed\s+)?long\s+int},
500 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
501 qr{(?:(?:un)?signed\s+)?long\s+long},
502 qr{(?:(?:un)?signed\s+)?long},
503 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800504 qr{float},
505 qr{double},
506 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800507 qr{struct\s+$Ident},
508 qr{union\s+$Ident},
509 qr{enum\s+$Ident},
510 qr{${Ident}_t},
511 qr{${Ident}_handler},
512 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700513 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800514);
Joe Perches938224b2016-01-20 14:59:15 -0800515
516our $C90_int_types = qr{(?x:
517 long\s+long\s+int\s+(?:un)?signed|
518 long\s+long\s+(?:un)?signed\s+int|
519 long\s+long\s+(?:un)?signed|
520 (?:(?:un)?signed\s+)?long\s+long\s+int|
521 (?:(?:un)?signed\s+)?long\s+long|
522 int\s+long\s+long\s+(?:un)?signed|
523 int\s+(?:(?:un)?signed\s+)?long\s+long|
524
525 long\s+int\s+(?:un)?signed|
526 long\s+(?:un)?signed\s+int|
527 long\s+(?:un)?signed|
528 (?:(?:un)?signed\s+)?long\s+int|
529 (?:(?:un)?signed\s+)?long|
530 int\s+long\s+(?:un)?signed|
531 int\s+(?:(?:un)?signed\s+)?long|
532
533 int\s+(?:un)?signed|
534 (?:(?:un)?signed\s+)?int
535)};
536
Alex Dowad485ff232015-06-25 15:02:52 -0700537our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700538our @typeListWithAttr = (
539 @typeList,
540 qr{struct\s+$InitAttribute\s+$Ident},
541 qr{union\s+$InitAttribute\s+$Ident},
542);
543
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700544our @modifierList = (
545 qr{fastcall},
546);
Alex Dowad485ff232015-06-25 15:02:52 -0700547our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800548
Joe Perches24358802014-04-03 14:49:13 -0700549our @mode_permission_funcs = (
550 ["module_param", 3],
551 ["module_param_(?:array|named|string)", 4],
552 ["module_param_array_named", 5],
553 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
554 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700555 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
556 ["IIO_DEV_ATTR_[A-Z_]+", 1],
557 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
558 ["SENSOR_TEMPLATE(?:_2|)", 3],
559 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700560);
561
Joe Perches515a2352014-04-03 14:49:24 -0700562#Create a search pattern for all these functions to speed up a loop below
563our $mode_perms_search = "";
564foreach my $entry (@mode_permission_funcs) {
565 $mode_perms_search .= '|' if ($mode_perms_search ne "");
566 $mode_perms_search .= $entry->[0];
567}
568
Joe Perchesb392c642015-04-16 12:44:16 -0700569our $mode_perms_world_writable = qr{
570 S_IWUGO |
571 S_IWOTH |
572 S_IRWXUGO |
573 S_IALLUGO |
574 0[0-7][0-7][2367]
575}x;
576
Joe Perchesf90774e2016-10-11 13:51:47 -0700577our %mode_permission_string_types = (
578 "S_IRWXU" => 0700,
579 "S_IRUSR" => 0400,
580 "S_IWUSR" => 0200,
581 "S_IXUSR" => 0100,
582 "S_IRWXG" => 0070,
583 "S_IRGRP" => 0040,
584 "S_IWGRP" => 0020,
585 "S_IXGRP" => 0010,
586 "S_IRWXO" => 0007,
587 "S_IROTH" => 0004,
588 "S_IWOTH" => 0002,
589 "S_IXOTH" => 0001,
590 "S_IRWXUGO" => 0777,
591 "S_IRUGO" => 0444,
592 "S_IWUGO" => 0222,
593 "S_IXUGO" => 0111,
594);
595
596#Create a search pattern for all these strings to speed up a loop below
597our $mode_perms_string_search = "";
598foreach my $entry (keys %mode_permission_string_types) {
599 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
600 $mode_perms_string_search .= $entry;
601}
602
Wolfram Sang7840a942010-08-09 17:20:57 -0700603our $allowed_asm_includes = qr{(?x:
604 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700605 memory|
606 time|
607 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700608)};
609# memory.h: ARM has a custom one
610
Kees Cook66b47b42014-10-13 15:51:57 -0700611# Load common spelling mistakes and build regular expression list.
612my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700613my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700614
Joe Perches36061e32014-12-10 15:51:43 -0800615if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800616 while (<$spelling>) {
617 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700618
Joe Perches36061e32014-12-10 15:51:43 -0800619 $line =~ s/\s*\n?$//g;
620 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700621
Joe Perches36061e32014-12-10 15:51:43 -0800622 next if ($line =~ m/^\s*#/);
623 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700624
Joe Perches36061e32014-12-10 15:51:43 -0800625 my ($suspect, $fix) = split(/\|\|/, $line);
626
Joe Perches36061e32014-12-10 15:51:43 -0800627 $spelling_fix{$suspect} = $fix;
628 }
629 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800630} else {
631 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700632}
Kees Cook66b47b42014-10-13 15:51:57 -0700633
Joe Perchesebfd7d62015-04-16 12:44:14 -0700634if ($codespell) {
635 if (open(my $spelling, '<', $codespellfile)) {
636 while (<$spelling>) {
637 my $line = $_;
638
639 $line =~ s/\s*\n?$//g;
640 $line =~ s/^\s*//g;
641
642 next if ($line =~ m/^\s*#/);
643 next if ($line =~ m/^\s*$/);
644 next if ($line =~ m/, disabled/i);
645
646 $line =~ s/,.*$//;
647
648 my ($suspect, $fix) = split(/->/, $line);
649
650 $spelling_fix{$suspect} = $fix;
651 }
652 close($spelling);
653 } else {
654 warn "No codespell typos will be found - file '$codespellfile': $!\n";
655 }
656}
657
658$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
659
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700660sub read_words {
661 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700662
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700663 if (open(my $words, '<', $file)) {
664 while (<$words>) {
665 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700666
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700667 $line =~ s/\s*\n?$//g;
668 $line =~ s/^\s*//g;
669
670 next if ($line =~ m/^\s*#/);
671 next if ($line =~ m/^\s*$/);
672 if ($line =~ /\s/) {
673 print("$file: '$line' invalid - ignored\n");
674 next;
675 }
676
677 $$wordsRef .= '|' if ($$wordsRef ne "");
678 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700679 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700680 close($file);
681 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700682 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700683
684 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700685}
686
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700687my $const_structs = "";
688read_words(\$const_structs, $conststructsfile)
689 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
690
691my $typeOtherTypedefs = "";
692if (length($typedefsfile)) {
693 read_words(\$typeOtherTypedefs, $typedefsfile)
694 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
695}
696$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
697
Andy Whitcroft8905a672007-11-28 16:21:06 -0800698sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700699 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
700 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700701 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700702 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700703 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700704 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700705 (?:$typeTypedefs\b)|
706 (?:${all}\b)
707 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800708 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700709 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800710 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800711 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700712 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700713 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800714 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700715 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800716 }x;
Joe Perches18130872014-08-06 16:11:22 -0700717 $NonptrTypeMisordered = qr{
718 (?:$Modifier\s+|const\s+)*
719 (?:
720 (?:${Misordered}\b)
721 )
722 (?:\s+$Modifier|\s+const)*
723 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700724 $NonptrTypeWithAttr = qr{
725 (?:$Modifier\s+|const\s+)*
726 (?:
727 (?:typeof|__typeof__)\s*\([^\)]*\)|
728 (?:$typeTypedefs\b)|
729 (?:${allWithAttr}\b)
730 )
731 (?:\s+$Modifier|\s+const)*
732 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800733 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700734 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700735 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700736 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800737 }x;
Joe Perches18130872014-08-06 16:11:22 -0700738 $TypeMisordered = qr{
739 $NonptrTypeMisordered
740 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
741 (?:\s+$Inline|\s+$Modifier)*
742 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700743 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700744 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800745}
746build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700747
Joe Perches7d2367a2011-07-25 17:13:22 -0700748our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700749
750# Using $balanced_parens, $LvalOrFunc, or $FuncArg
751# requires at least perl version v5.10.0
752# Any use must be runtime checked with $^V
753
754our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700755our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800756our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700757
Joe Perchesf8422302014-08-06 16:11:31 -0700758our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700759 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700760 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700761 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
762)};
763
Joe Perches7d2367a2011-07-25 17:13:22 -0700764sub deparenthesize {
765 my ($string) = @_;
766 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700767
768 while ($string =~ /^\s*\(.*\)\s*$/) {
769 $string =~ s@^\s*\(\s*@@;
770 $string =~ s@\s*\)\s*$@@;
771 }
772
Joe Perches7d2367a2011-07-25 17:13:22 -0700773 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700774
Joe Perches7d2367a2011-07-25 17:13:22 -0700775 return $string;
776}
777
Joe Perches34456862013-07-03 15:05:34 -0700778sub seed_camelcase_file {
779 my ($file) = @_;
780
781 return if (!(-f $file));
782
783 local $/;
784
785 open(my $include_file, '<', "$file")
786 or warn "$P: Can't read '$file' $!\n";
787 my $text = <$include_file>;
788 close($include_file);
789
790 my @lines = split('\n', $text);
791
792 foreach my $line (@lines) {
793 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
794 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
795 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800796 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
797 $camelcase{$1} = 1;
798 } 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 -0700799 $camelcase{$1} = 1;
800 }
801 }
802}
803
Joe Perches85b0ee12016-10-11 13:51:44 -0700804sub is_maintained_obsolete {
805 my ($filename) = @_;
806
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800807 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700808
Joe Perches0616efa2016-10-11 13:52:02 -0700809 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 -0700810
811 return $status =~ /obsolete/i;
812}
813
Joe Perches34456862013-07-03 15:05:34 -0700814my $camelcase_seeded = 0;
815sub seed_camelcase_includes {
816 return if ($camelcase_seeded);
817
818 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700819 my $camelcase_cache = "";
820 my @include_files = ();
821
822 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700823
Richard Genoud3645e322014-02-10 14:25:32 -0800824 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700825 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
826 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700827 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700828 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700829 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700830 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700831 @include_files = split('\n', $files);
832 foreach my $file (@include_files) {
833 my $date = POSIX::strftime("%Y%m%d%H%M",
834 localtime((stat $file)[9]));
835 $last_mod_date = $date if ($last_mod_date < $date);
836 }
837 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700838 }
Joe Perchesc707a812013-07-08 16:00:43 -0700839
840 if ($camelcase_cache ne "" && -f $camelcase_cache) {
841 open(my $camelcase_file, '<', "$camelcase_cache")
842 or warn "$P: Can't read '$camelcase_cache' $!\n";
843 while (<$camelcase_file>) {
844 chomp;
845 $camelcase{$_} = 1;
846 }
847 close($camelcase_file);
848
849 return;
850 }
851
Richard Genoud3645e322014-02-10 14:25:32 -0800852 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700853 $files = `git ls-files "include/*.h"`;
854 @include_files = split('\n', $files);
855 }
856
Joe Perches34456862013-07-03 15:05:34 -0700857 foreach my $file (@include_files) {
858 seed_camelcase_file($file);
859 }
Joe Perches351b2a12013-07-03 15:05:36 -0700860
Joe Perchesc707a812013-07-08 16:00:43 -0700861 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700862 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700863 open(my $camelcase_file, '>', "$camelcase_cache")
864 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700865 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
866 print $camelcase_file ("$_\n");
867 }
868 close($camelcase_file);
869 }
Joe Perches34456862013-07-03 15:05:34 -0700870}
871
Joe Perchesd311cd42014-08-06 16:10:57 -0700872sub git_commit_info {
873 my ($commit, $id, $desc) = @_;
874
875 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
876
877 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
878 $output =~ s/^\s*//gm;
879 my @lines = split("\n", $output);
880
Joe Perches0d7835f2015-02-13 14:38:35 -0800881 return ($id, $desc) if ($#lines < 0);
882
Joe Perchesd311cd42014-08-06 16:10:57 -0700883 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
884# Maybe one day convert this block of bash into something that returns
885# all matching commit ids, but it's very slow...
886#
887# echo "checking commits $1..."
888# git rev-list --remotes | grep -i "^$1" |
889# while read line ; do
890# git log --format='%H %s' -1 $line |
891# echo "commit $(cut -c 1-12,41-)"
892# done
893 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700894 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700895 } else {
896 $id = substr($lines[0], 0, 12);
897 $desc = substr($lines[0], 41);
898 }
899
900 return ($id, $desc);
901}
902
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700903$chk_signoff = 0 if ($file);
904
Andy Whitcroft00df3442007-06-08 13:47:06 -0700905my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800906my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700907my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700908my @fixed_inserted = ();
909my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700910my $fixlinenr = -1;
911
Du, Changbin4a593c32016-05-20 17:04:16 -0700912# If input is git commits, extract all commits from the commit expressions.
913# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
914die "$P: No git repository found\n" if ($git && !-e ".git");
915
916if ($git) {
917 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700918 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700919 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700920 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
921 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700922 } elsif ($commit_expr =~ m/\.\./) {
923 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700924 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700925 $git_range = "-1 $commit_expr";
926 }
927 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
928 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700929 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
930 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700931 my $sha1 = $1;
932 my $subject = $2;
933 unshift(@commits, $sha1);
934 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700935 }
936 }
937 die "$P: no git commits after extraction!\n" if (@commits == 0);
938 @ARGV = @commits;
939}
940
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800941my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700942for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800943 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700944 if ($git) {
945 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
946 die "$P: $filename: git format-patch failed - $!\n";
947 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800948 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700949 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800950 } elsif ($filename eq '-') {
951 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700952 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800953 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700954 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700955 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800956 if ($filename eq '-') {
957 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700958 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700959 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800960 } else {
961 $vname = $filename;
962 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800963 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700964 chomp;
965 push(@rawlines, $_);
966 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800967 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700968
969 if ($#ARGV > 0 && $quiet == 0) {
970 print '-' x length($vname) . "\n";
971 print "$vname\n";
972 print '-' x length($vname) . "\n";
973 }
974
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800975 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700976 $exit = 1;
977 }
978 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800979 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700980 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700981 @fixed_inserted = ();
982 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700983 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700984 @modifierListFile = ();
985 @typeListFile = ();
986 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700987}
988
Joe Perchesd8469f12015-06-25 15:03:00 -0700989if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700990 hash_show_words(\%use_type, "Used");
991 hash_show_words(\%ignore_type, "Ignored");
992
Joe Perchesd8469f12015-06-25 15:03:00 -0700993 if ($^V lt 5.10.0) {
994 print << "EOM"
995
996NOTE: perl $^V is not modern enough to detect all possible issues.
997 An upgrade to at least perl v5.10.0 is suggested.
998EOM
999 }
1000 if ($exit) {
1001 print << "EOM"
1002
1003NOTE: If any of the errors are false positives, please report
1004 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1005EOM
1006 }
1007}
1008
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001009exit($exit);
1010
1011sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001012 my ($root) = @_;
1013
1014 my @tree_check = (
1015 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1016 "README", "Documentation", "arch", "include", "drivers",
1017 "fs", "init", "ipc", "kernel", "lib", "scripts",
1018 );
1019
1020 foreach my $check (@tree_check) {
1021 if (! -e $root . '/' . $check) {
1022 return 0;
1023 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001024 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001025 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001026}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001027
Joe Perches20112472011-07-25 17:13:23 -07001028sub parse_email {
1029 my ($formatted_email) = @_;
1030
1031 my $name = "";
1032 my $address = "";
1033 my $comment = "";
1034
1035 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1036 $name = $1;
1037 $address = $2;
1038 $comment = $3 if defined $3;
1039 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1040 $address = $1;
1041 $comment = $2 if defined $2;
1042 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1043 $address = $1;
1044 $comment = $2 if defined $2;
1045 $formatted_email =~ s/$address.*$//;
1046 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001047 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001048 $name =~ s/^\"|\"$//g;
1049 # If there's a name left after stripping spaces and
1050 # leading quotes, and the address doesn't have both
1051 # leading and trailing angle brackets, the address
1052 # is invalid. ie:
1053 # "joe smith joe@smith.com" bad
1054 # "joe smith <joe@smith.com" bad
1055 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1056 $name = "";
1057 $address = "";
1058 $comment = "";
1059 }
1060 }
1061
Joe Perches3705ce52013-07-03 15:05:31 -07001062 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001063 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001064 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001065 $address =~ s/^\<|\>$//g;
1066
1067 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1068 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1069 $name = "\"$name\"";
1070 }
1071
1072 return ($name, $address, $comment);
1073}
1074
1075sub format_email {
1076 my ($name, $address) = @_;
1077
1078 my $formatted_email;
1079
Joe Perches3705ce52013-07-03 15:05:31 -07001080 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001081 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001082 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001083
1084 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1085 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1086 $name = "\"$name\"";
1087 }
1088
1089 if ("$name" eq "") {
1090 $formatted_email = "$address";
1091 } else {
1092 $formatted_email = "$name <$address>";
1093 }
1094
1095 return $formatted_email;
1096}
1097
Joe Perchesd311cd42014-08-06 16:10:57 -07001098sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001099 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001100
Joe Perchesbd474ca2014-08-06 16:11:10 -07001101 foreach my $path (split(/:/, $ENV{PATH})) {
1102 if (-e "$path/$bin") {
1103 return "$path/$bin";
1104 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001105 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001106
Joe Perchesbd474ca2014-08-06 16:11:10 -07001107 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001108}
1109
Joe Perches000d1cc12011-07-25 17:13:25 -07001110sub which_conf {
1111 my ($conf) = @_;
1112
1113 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1114 if (-e "$path/$conf") {
1115 return "$path/$conf";
1116 }
1117 }
1118
1119 return "";
1120}
1121
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001122sub expand_tabs {
1123 my ($str) = @_;
1124
1125 my $res = '';
1126 my $n = 0;
1127 for my $c (split(//, $str)) {
1128 if ($c eq "\t") {
1129 $res .= ' ';
1130 $n++;
1131 for (; ($n % 8) != 0; $n++) {
1132 $res .= ' ';
1133 }
1134 next;
1135 }
1136 $res .= $c;
1137 $n++;
1138 }
1139
1140 return $res;
1141}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001142sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001143 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001144 return $res;
1145}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001146
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001147sub line_stats {
1148 my ($line) = @_;
1149
1150 # Drop the diff line leader and expand tabs
1151 $line =~ s/^.//;
1152 $line = expand_tabs($line);
1153
1154 # Pick the indent from the front of the line.
1155 my ($white) = ($line =~ /^(\s*)/);
1156
1157 return (length($line), length($white));
1158}
1159
Andy Whitcroft773647a2008-03-28 14:15:58 -07001160my $sanitise_quote = '';
1161
1162sub sanitise_line_reset {
1163 my ($in_comment) = @_;
1164
1165 if ($in_comment) {
1166 $sanitise_quote = '*/';
1167 } else {
1168 $sanitise_quote = '';
1169 }
1170}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001171sub sanitise_line {
1172 my ($line) = @_;
1173
1174 my $res = '';
1175 my $l = '';
1176
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001177 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001178 my $off = 0;
1179 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001180
Andy Whitcroft773647a2008-03-28 14:15:58 -07001181 # Always copy over the diff marker.
1182 $res = substr($line, 0, 1);
1183
1184 for ($off = 1; $off < length($line); $off++) {
1185 $c = substr($line, $off, 1);
1186
1187 # Comments we are wacking completly including the begin
1188 # and end, all to $;.
1189 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1190 $sanitise_quote = '*/';
1191
1192 substr($res, $off, 2, "$;$;");
1193 $off++;
1194 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001195 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001196 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001197 $sanitise_quote = '';
1198 substr($res, $off, 2, "$;$;");
1199 $off++;
1200 next;
1201 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001202 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1203 $sanitise_quote = '//';
1204
1205 substr($res, $off, 2, $sanitise_quote);
1206 $off++;
1207 next;
1208 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001209
1210 # A \ in a string means ignore the next character.
1211 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1212 $c eq "\\") {
1213 substr($res, $off, 2, 'XX');
1214 $off++;
1215 next;
1216 }
1217 # Regular quotes.
1218 if ($c eq "'" || $c eq '"') {
1219 if ($sanitise_quote eq '') {
1220 $sanitise_quote = $c;
1221
1222 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001223 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001224 } elsif ($sanitise_quote eq $c) {
1225 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001226 }
1227 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001228
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001229 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001230 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1231 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001232 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1233 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001234 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1235 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001236 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001237 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001238 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001239 }
1240
Daniel Walker113f04a2009-09-21 17:04:35 -07001241 if ($sanitise_quote eq '//') {
1242 $sanitise_quote = '';
1243 }
1244
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001245 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001246 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001247 my $clean = 'X' x length($1);
1248 $res =~ s@\<.*\>@<$clean>@;
1249
1250 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001251 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001252 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001253 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001254 }
1255
Joe Perchesdadf6802016-08-02 14:04:33 -07001256 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1257 my $match = $1;
1258 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1259 }
1260
Andy Whitcroft00df3442007-06-08 13:47:06 -07001261 return $res;
1262}
1263
Joe Perchesa6962d72013-04-29 16:18:13 -07001264sub get_quoted_string {
1265 my ($line, $rawline) = @_;
1266
Joe Perches33acb542015-06-25 15:02:54 -07001267 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001268 return substr($rawline, $-[0], $+[0] - $-[0]);
1269}
1270
Andy Whitcroft8905a672007-11-28 16:21:06 -08001271sub ctx_statement_block {
1272 my ($linenr, $remain, $off) = @_;
1273 my $line = $linenr - 1;
1274 my $blk = '';
1275 my $soff = $off;
1276 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001277 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001278
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001279 my $loff = 0;
1280
Andy Whitcroft8905a672007-11-28 16:21:06 -08001281 my $type = '';
1282 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001283 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001284 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001285 my $c;
1286 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001287
1288 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001289 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001290 @stack = (['', 0]) if ($#stack == -1);
1291
Andy Whitcroft773647a2008-03-28 14:15:58 -07001292 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001293 # If we are about to drop off the end, pull in more
1294 # context.
1295 if ($off >= $len) {
1296 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001297 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001298 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001299 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001300 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001301 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001302 $len = length($blk);
1303 $line++;
1304 last;
1305 }
1306 # Bail if there is no further context.
1307 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001308 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001309 last;
1310 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001311 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1312 $level++;
1313 $type = '#';
1314 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001315 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001316 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001317 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001318 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001319
Andy Whitcroft773647a2008-03-28 14:15:58 -07001320 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001321
1322 # Handle nested #if/#else.
1323 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1324 push(@stack, [ $type, $level ]);
1325 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1326 ($type, $level) = @{$stack[$#stack - 1]};
1327 } elsif ($remainder =~ /^#\s*endif\b/) {
1328 ($type, $level) = @{pop(@stack)};
1329 }
1330
Andy Whitcroft8905a672007-11-28 16:21:06 -08001331 # Statement ends at the ';' or a close '}' at the
1332 # outermost level.
1333 if ($level == 0 && $c eq ';') {
1334 last;
1335 }
1336
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001337 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001338 if ($level == 0 && $coff_set == 0 &&
1339 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1340 $remainder =~ /^(else)(?:\s|{)/ &&
1341 $remainder !~ /^else\s+if\b/) {
1342 $coff = $off + length($1) - 1;
1343 $coff_set = 1;
1344 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1345 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001346 }
1347
Andy Whitcroft8905a672007-11-28 16:21:06 -08001348 if (($type eq '' || $type eq '(') && $c eq '(') {
1349 $level++;
1350 $type = '(';
1351 }
1352 if ($type eq '(' && $c eq ')') {
1353 $level--;
1354 $type = ($level != 0)? '(' : '';
1355
1356 if ($level == 0 && $coff < $soff) {
1357 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001358 $coff_set = 1;
1359 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001360 }
1361 }
1362 if (($type eq '' || $type eq '{') && $c eq '{') {
1363 $level++;
1364 $type = '{';
1365 }
1366 if ($type eq '{' && $c eq '}') {
1367 $level--;
1368 $type = ($level != 0)? '{' : '';
1369
1370 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001371 if (substr($blk, $off + 1, 1) eq ';') {
1372 $off++;
1373 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001374 last;
1375 }
1376 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001377 # Preprocessor commands end at the newline unless escaped.
1378 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1379 $level--;
1380 $type = '';
1381 $off++;
1382 last;
1383 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001384 $off++;
1385 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001386 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001387 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001388 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001389 $line++;
1390 $remain--;
1391 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001392
1393 my $statement = substr($blk, $soff, $off - $soff + 1);
1394 my $condition = substr($blk, $soff, $coff - $soff + 1);
1395
1396 #warn "STATEMENT<$statement>\n";
1397 #warn "CONDITION<$condition>\n";
1398
Andy Whitcroft773647a2008-03-28 14:15:58 -07001399 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001400
1401 return ($statement, $condition,
1402 $line, $remain + 1, $off - $loff + 1, $level);
1403}
1404
Andy Whitcroftcf655042008-03-04 14:28:20 -08001405sub statement_lines {
1406 my ($stmt) = @_;
1407
1408 # Strip the diff line prefixes and rip blank lines at start and end.
1409 $stmt =~ s/(^|\n)./$1/g;
1410 $stmt =~ s/^\s*//;
1411 $stmt =~ s/\s*$//;
1412
1413 my @stmt_lines = ($stmt =~ /\n/g);
1414
1415 return $#stmt_lines + 2;
1416}
1417
1418sub statement_rawlines {
1419 my ($stmt) = @_;
1420
1421 my @stmt_lines = ($stmt =~ /\n/g);
1422
1423 return $#stmt_lines + 2;
1424}
1425
1426sub statement_block_size {
1427 my ($stmt) = @_;
1428
1429 $stmt =~ s/(^|\n)./$1/g;
1430 $stmt =~ s/^\s*{//;
1431 $stmt =~ s/}\s*$//;
1432 $stmt =~ s/^\s*//;
1433 $stmt =~ s/\s*$//;
1434
1435 my @stmt_lines = ($stmt =~ /\n/g);
1436 my @stmt_statements = ($stmt =~ /;/g);
1437
1438 my $stmt_lines = $#stmt_lines + 2;
1439 my $stmt_statements = $#stmt_statements + 1;
1440
1441 if ($stmt_lines > $stmt_statements) {
1442 return $stmt_lines;
1443 } else {
1444 return $stmt_statements;
1445 }
1446}
1447
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001448sub ctx_statement_full {
1449 my ($linenr, $remain, $off) = @_;
1450 my ($statement, $condition, $level);
1451
1452 my (@chunks);
1453
Andy Whitcroftcf655042008-03-04 14:28:20 -08001454 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001455 ($statement, $condition, $linenr, $remain, $off, $level) =
1456 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001457 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001458 push(@chunks, [ $condition, $statement ]);
1459 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1460 return ($level, $linenr, @chunks);
1461 }
1462
1463 # Pull in the following conditional/block pairs and see if they
1464 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001465 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001466 ($statement, $condition, $linenr, $remain, $off, $level) =
1467 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001468 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001469 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001470 #print "C: push\n";
1471 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001472 }
1473
1474 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001475}
1476
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001477sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001478 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001479 my $line;
1480 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001481 my $blk = '';
1482 my @o;
1483 my @c;
1484 my @res = ();
1485
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001486 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001487 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001488 for ($line = $start; $remain > 0; $line++) {
1489 next if ($rawlines[$line] =~ /^-/);
1490 $remain--;
1491
1492 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001493
1494 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001495 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001496 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001497 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001498 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001499 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001500 $level = pop(@stack);
1501 }
1502
Andy Whitcroft01464f32010-10-26 14:23:19 -07001503 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001504 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1505 if ($off > 0) {
1506 $off--;
1507 next;
1508 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001509
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001510 if ($c eq $close && $level > 0) {
1511 $level--;
1512 last if ($level == 0);
1513 } elsif ($c eq $open) {
1514 $level++;
1515 }
1516 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001517
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001518 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001519 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001520 }
1521
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001522 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001523 }
1524
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001525 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001526}
1527sub ctx_block_outer {
1528 my ($linenr, $remain) = @_;
1529
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001530 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1531 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001532}
1533sub ctx_block {
1534 my ($linenr, $remain) = @_;
1535
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001536 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1537 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001538}
1539sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001540 my ($linenr, $remain, $off) = @_;
1541
1542 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1543 return @r;
1544}
1545sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001546 my ($linenr, $remain) = @_;
1547
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001548 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001549}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001550sub ctx_statement_level {
1551 my ($linenr, $remain, $off) = @_;
1552
1553 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1554}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001555
1556sub ctx_locate_comment {
1557 my ($first_line, $end_line) = @_;
1558
1559 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001560 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001561 return $current_comment if (defined $current_comment);
1562
1563 # Look through the context and try and figure out if there is a
1564 # comment.
1565 my $in_comment = 0;
1566 $current_comment = '';
1567 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001568 my $line = $rawlines[$linenr - 1];
1569 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001570 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1571 $in_comment = 1;
1572 }
1573 if ($line =~ m@/\*@) {
1574 $in_comment = 1;
1575 }
1576 if (!$in_comment && $current_comment ne '') {
1577 $current_comment = '';
1578 }
1579 $current_comment .= $line . "\n" if ($in_comment);
1580 if ($line =~ m@\*/@) {
1581 $in_comment = 0;
1582 }
1583 }
1584
1585 chomp($current_comment);
1586 return($current_comment);
1587}
1588sub ctx_has_comment {
1589 my ($first_line, $end_line) = @_;
1590 my $cmt = ctx_locate_comment($first_line, $end_line);
1591
Andy Whitcroft00df3442007-06-08 13:47:06 -07001592 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001593 ##print "CMMT: $cmt\n";
1594
1595 return ($cmt ne '');
1596}
1597
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001598sub raw_line {
1599 my ($linenr, $cnt) = @_;
1600
1601 my $offset = $linenr - 1;
1602 $cnt++;
1603
1604 my $line;
1605 while ($cnt) {
1606 $line = $rawlines[$offset++];
1607 next if (defined($line) && $line =~ /^-/);
1608 $cnt--;
1609 }
1610
1611 return $line;
1612}
1613
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001614sub cat_vet {
1615 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001616 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001617
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001618 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001619 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1620 $res .= $1;
1621 if ($2 ne '') {
1622 $coded = sprintf("^%c", unpack('C', $2) + 64);
1623 $res .= $coded;
1624 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001625 }
1626 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001627
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001628 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001629}
1630
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001631my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001632my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001633my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001634my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001635
1636sub annotate_reset {
1637 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001638 $av_pending = '_';
1639 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001640 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001641}
1642
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001643sub annotate_values {
1644 my ($stream, $type) = @_;
1645
1646 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001647 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001648 my $cur = $stream;
1649
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001650 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001651
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001653 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001654 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001655 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001656 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001657 print "WS($1)\n" if ($dbg_values > 1);
1658 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001659 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001660 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001661 }
1662
Florian Micklerc023e4732011-01-12 16:59:58 -08001663 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001664 print "CAST($1)\n" if ($dbg_values > 1);
1665 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001666 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001667
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001668 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001669 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001670 $type = 'T';
1671
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001672 } elsif ($cur =~ /^($Modifier)\s*/) {
1673 print "MODIFIER($1)\n" if ($dbg_values > 1);
1674 $type = 'T';
1675
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001676 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001677 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001678 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001679 push(@av_paren_type, $type);
1680 if ($2 ne '') {
1681 $av_pending = 'N';
1682 }
1683 $type = 'E';
1684
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001685 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001686 print "UNDEF($1)\n" if ($dbg_values > 1);
1687 $av_preprocessor = 1;
1688 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001689
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001690 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001691 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001692 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001693
1694 push(@av_paren_type, $type);
1695 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001696 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001697
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001698 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001699 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1700 $av_preprocessor = 1;
1701
1702 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1703
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001704 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001705
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001706 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001707 print "PRE_END($1)\n" if ($dbg_values > 1);
1708
1709 $av_preprocessor = 1;
1710
1711 # Assume all arms of the conditional end as this
1712 # one does, and continue as if the #endif was not here.
1713 pop(@av_paren_type);
1714 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001715 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001716
1717 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001719
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001720 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1721 print "ATTR($1)\n" if ($dbg_values > 1);
1722 $av_pending = $type;
1723 $type = 'N';
1724
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001725 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001726 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001727 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001728 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001729 }
1730 $type = 'N';
1731
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001732 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001733 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001734 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001735 $type = 'N';
1736
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001737 } elsif ($cur =~/^(case)/o) {
1738 print "CASE($1)\n" if ($dbg_values > 1);
1739 $av_pend_colon = 'C';
1740 $type = 'N';
1741
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001742 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001743 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001744 $type = 'N';
1745
1746 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001747 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001748 push(@av_paren_type, $av_pending);
1749 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001750 $type = 'N';
1751
1752 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001753 my $new_type = pop(@av_paren_type);
1754 if ($new_type ne '_') {
1755 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001756 print "PAREN('$1') -> $type\n"
1757 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001758 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001759 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001760 }
1761
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001762 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001763 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001764 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001765 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001766
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001767 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1768 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001769 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001770 } elsif ($type eq 'E') {
1771 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001772 }
1773 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1774 $type = 'V';
1775
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001776 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001777 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001778 $type = 'V';
1779
1780 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001781 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001782 $type = 'N';
1783
Andy Whitcroftcf655042008-03-04 14:28:20 -08001784 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001785 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001786 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001787 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001788
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001789 } elsif ($cur =~/^(,)/) {
1790 print "COMMA($1)\n" if ($dbg_values > 1);
1791 $type = 'C';
1792
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001793 } elsif ($cur =~ /^(\?)/o) {
1794 print "QUESTION($1)\n" if ($dbg_values > 1);
1795 $type = 'N';
1796
1797 } elsif ($cur =~ /^(:)/o) {
1798 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1799
1800 substr($var, length($res), 1, $av_pend_colon);
1801 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1802 $type = 'E';
1803 } else {
1804 $type = 'N';
1805 }
1806 $av_pend_colon = 'O';
1807
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001808 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001809 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001810 $type = 'N';
1811
Andy Whitcroft0d413862008-10-15 22:02:16 -07001812 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001813 my $variant;
1814
1815 print "OPV($1)\n" if ($dbg_values > 1);
1816 if ($type eq 'V') {
1817 $variant = 'B';
1818 } else {
1819 $variant = 'U';
1820 }
1821
1822 substr($var, length($res), 1, $variant);
1823 $type = 'N';
1824
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001825 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001826 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001827 if ($1 ne '++' && $1 ne '--') {
1828 $type = 'N';
1829 }
1830
1831 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001832 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001833 }
1834 if (defined $1) {
1835 $cur = substr($cur, length($1));
1836 $res .= $type x length($1);
1837 }
1838 }
1839
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001840 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001841}
1842
Andy Whitcroft8905a672007-11-28 16:21:06 -08001843sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001844 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001845 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001846 ^(?:
1847 $Modifier|
1848 $Storage|
1849 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001850 DEFINE_\S+
1851 )$|
1852 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001853 goto|
1854 return|
1855 case|
1856 else|
1857 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001858 do|
1859 \#|
1860 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001861 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001862 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001863 )}x;
1864 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1865 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001866 # Check for modifiers.
1867 $possible =~ s/\s*$Storage\s*//g;
1868 $possible =~ s/\s*$Sparse\s*//g;
1869 if ($possible =~ /^\s*$/) {
1870
1871 } elsif ($possible =~ /\s/) {
1872 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001873 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001874 if ($modifier !~ $notPermitted) {
1875 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001876 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001877 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001878 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001879
1880 } else {
1881 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001882 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001883 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001884 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001885 } else {
1886 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001887 }
1888}
1889
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001890my $prefix = '';
1891
Joe Perches000d1cc12011-07-25 17:13:25 -07001892sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001893 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001894
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001895 $type =~ tr/[a-z]/[A-Z]/;
1896
Joe Perchescbec18a2014-04-03 14:49:19 -07001897 return defined $use_type{$type} if (scalar keys %use_type > 0);
1898
1899 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001900}
1901
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001902sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001903 my ($level, $type, $msg) = @_;
1904
1905 if (!show_type($type) ||
1906 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001907 return 0;
1908 }
Joe Perches57230292015-06-25 15:03:03 -07001909 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001910 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001911 if ($level eq 'ERROR') {
1912 $output .= RED;
1913 } elsif ($level eq 'WARNING') {
1914 $output .= YELLOW;
1915 } else {
1916 $output .= GREEN;
1917 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001918 }
Joe Perches57230292015-06-25 15:03:03 -07001919 $output .= $prefix . $level . ':';
1920 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001921 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001922 $output .= "$type:";
1923 }
John Brooks737c0762017-07-10 15:52:24 -07001924 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001925 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001926
1927 if ($showfile) {
1928 my @lines = split("\n", $output, -1);
1929 splice(@lines, 1, 1);
1930 $output = join("\n", @lines);
1931 }
Joe Perches57230292015-06-25 15:03:03 -07001932 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001933
Joe Perches57230292015-06-25 15:03:03 -07001934 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001935
1936 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001937}
Joe Perchescbec18a2014-04-03 14:49:19 -07001938
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001939sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001940 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001941}
Joe Perches000d1cc12011-07-25 17:13:25 -07001942
Joe Perchesd752fcc2014-08-06 16:11:05 -07001943sub fixup_current_range {
1944 my ($lineRef, $offset, $length) = @_;
1945
1946 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1947 my $o = $1;
1948 my $l = $2;
1949 my $no = $o + $offset;
1950 my $nl = $l + $length;
1951 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1952 }
1953}
1954
1955sub fix_inserted_deleted_lines {
1956 my ($linesRef, $insertedRef, $deletedRef) = @_;
1957
1958 my $range_last_linenr = 0;
1959 my $delta_offset = 0;
1960
1961 my $old_linenr = 0;
1962 my $new_linenr = 0;
1963
1964 my $next_insert = 0;
1965 my $next_delete = 0;
1966
1967 my @lines = ();
1968
1969 my $inserted = @{$insertedRef}[$next_insert++];
1970 my $deleted = @{$deletedRef}[$next_delete++];
1971
1972 foreach my $old_line (@{$linesRef}) {
1973 my $save_line = 1;
1974 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001975 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001976 $delta_offset = 0;
1977 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1978 $range_last_linenr = $new_linenr;
1979 fixup_current_range(\$line, $delta_offset, 0);
1980 }
1981
1982 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1983 $deleted = @{$deletedRef}[$next_delete++];
1984 $save_line = 0;
1985 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1986 }
1987
1988 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1989 push(@lines, ${$inserted}{'LINE'});
1990 $inserted = @{$insertedRef}[$next_insert++];
1991 $new_linenr++;
1992 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1993 }
1994
1995 if ($save_line) {
1996 push(@lines, $line);
1997 $new_linenr++;
1998 }
1999
2000 $old_linenr++;
2001 }
2002
2003 return @lines;
2004}
2005
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002006sub fix_insert_line {
2007 my ($linenr, $line) = @_;
2008
2009 my $inserted = {
2010 LINENR => $linenr,
2011 LINE => $line,
2012 };
2013 push(@fixed_inserted, $inserted);
2014}
2015
2016sub fix_delete_line {
2017 my ($linenr, $line) = @_;
2018
2019 my $deleted = {
2020 LINENR => $linenr,
2021 LINE => $line,
2022 };
2023
2024 push(@fixed_deleted, $deleted);
2025}
2026
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002027sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002028 my ($type, $msg) = @_;
2029
2030 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002031 our $clean = 0;
2032 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002033 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002034 }
Joe Perches3705ce52013-07-03 15:05:31 -07002035 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002036}
2037sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002038 my ($type, $msg) = @_;
2039
2040 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002041 our $clean = 0;
2042 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002043 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002044 }
Joe Perches3705ce52013-07-03 15:05:31 -07002045 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002046}
2047sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002048 my ($type, $msg) = @_;
2049
2050 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002051 our $clean = 0;
2052 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002053 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002054 }
Joe Perches3705ce52013-07-03 15:05:31 -07002055 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002056}
2057
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002058sub check_absolute_file {
2059 my ($absolute, $herecurr) = @_;
2060 my $file = $absolute;
2061
2062 ##print "absolute<$absolute>\n";
2063
2064 # See if any suffix of this path is a path within the tree.
2065 while ($file =~ s@^[^/]*/@@) {
2066 if (-f "$root/$file") {
2067 ##print "file<$file>\n";
2068 last;
2069 }
2070 }
2071 if (! -f _) {
2072 return 0;
2073 }
2074
2075 # It is, so see if the prefix is acceptable.
2076 my $prefix = $absolute;
2077 substr($prefix, -length($file)) = '';
2078
2079 ##print "prefix<$prefix>\n";
2080 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002081 WARN("USE_RELATIVE_PATH",
2082 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002083 }
2084}
2085
Joe Perches3705ce52013-07-03 15:05:31 -07002086sub trim {
2087 my ($string) = @_;
2088
Joe Perchesb34c6482013-09-11 14:24:01 -07002089 $string =~ s/^\s+|\s+$//g;
2090
2091 return $string;
2092}
2093
2094sub ltrim {
2095 my ($string) = @_;
2096
2097 $string =~ s/^\s+//;
2098
2099 return $string;
2100}
2101
2102sub rtrim {
2103 my ($string) = @_;
2104
2105 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002106
2107 return $string;
2108}
2109
Joe Perches52ea8502013-11-12 15:10:09 -08002110sub string_find_replace {
2111 my ($string, $find, $replace) = @_;
2112
2113 $string =~ s/$find/$replace/g;
2114
2115 return $string;
2116}
2117
Joe Perches3705ce52013-07-03 15:05:31 -07002118sub tabify {
2119 my ($leading) = @_;
2120
2121 my $source_indent = 8;
2122 my $max_spaces_before_tab = $source_indent - 1;
2123 my $spaces_to_tab = " " x $source_indent;
2124
2125 #convert leading spaces to tabs
2126 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2127 #Remove spaces before a tab
2128 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2129
2130 return "$leading";
2131}
2132
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002133sub pos_last_openparen {
2134 my ($line) = @_;
2135
2136 my $pos = 0;
2137
2138 my $opens = $line =~ tr/\(/\(/;
2139 my $closes = $line =~ tr/\)/\)/;
2140
2141 my $last_openparen = 0;
2142
2143 if (($opens == 0) || ($closes >= $opens)) {
2144 return -1;
2145 }
2146
2147 my $len = length($line);
2148
2149 for ($pos = 0; $pos < $len; $pos++) {
2150 my $string = substr($line, $pos);
2151 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2152 $pos += length($1) - 1;
2153 } elsif (substr($line, $pos, 1) eq '(') {
2154 $last_openparen = $pos;
2155 } elsif (index($string, '(') == -1) {
2156 last;
2157 }
2158 }
2159
Joe Perches91cb5192014-04-03 14:49:32 -07002160 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002161}
2162
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002163sub process {
2164 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002165
2166 my $linenr=0;
2167 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002168 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002169 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002170 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002171
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002172 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002173 my $indent;
2174 my $previndent=0;
2175 my $stashindent=0;
2176
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002177 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002178 my $signoff = 0;
2179 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002180 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002181 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002182 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002183 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002184 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002185 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002186 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002187 my $non_utf8_charset = 0;
2188
Joe Perches365dd4e2014-08-06 16:10:42 -07002189 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002190 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002191
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002192 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002193 our $cnt_lines = 0;
2194 our $cnt_error = 0;
2195 our $cnt_warn = 0;
2196 our $cnt_chk = 0;
2197
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002198 # Trace the real file/line as we go.
2199 my $realfile = '';
2200 my $realline = 0;
2201 my $realcnt = 0;
2202 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002203 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002204 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002205 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002206 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002207 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002208
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002209 my $prev_values = 'E';
2210
2211 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002212 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002213 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002214 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002215 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002216
Joe Perches7e51f192013-09-11 14:23:57 -07002217 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002218
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002219 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002220 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002221 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002222 my @setup_docs = ();
2223 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002224
Joe Perchesd8b07712013-11-12 15:10:06 -08002225 my $camelcase_file_seeded = 0;
2226
Andy Whitcroft773647a2008-03-28 14:15:58 -07002227 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002228 my $line;
2229 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002230 $linenr++;
2231 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002232
Joe Perches3705ce52013-07-03 15:05:31 -07002233 push(@fixed, $rawline) if ($fix);
2234
Andy Whitcroft773647a2008-03-28 14:15:58 -07002235 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002236 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002237 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002238 $setup_docs = 1;
2239 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002240 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002241 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002242 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002243 $realline=$1-1;
2244 if (defined $2) {
2245 $realcnt=$3+1;
2246 } else {
2247 $realcnt=1+1;
2248 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002249 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002250
2251 # Guestimate if this is a continuing comment. Run
2252 # the context looking for a comment "edge". If this
2253 # edge is a close comment then we must be in a comment
2254 # at context start.
2255 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002256 my $cnt = $realcnt;
2257 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2258 next if (defined $rawlines[$ln - 1] &&
2259 $rawlines[$ln - 1] =~ /^-/);
2260 $cnt--;
2261 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002262 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002263 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2264 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2265 ($edge) = $1;
2266 last;
2267 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002268 }
2269 if (defined $edge && $edge eq '*/') {
2270 $in_comment = 1;
2271 }
2272
2273 # Guestimate if this is a continuing comment. If this
2274 # is the start of a diff block and this line starts
2275 # ' *' then it is very likely a comment.
2276 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002277 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002278 {
2279 $in_comment = 1;
2280 }
2281
2282 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2283 sanitise_line_reset($in_comment);
2284
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002285 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002286 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002287 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002288 $line = sanitise_line($rawline);
2289 }
2290 push(@lines, $line);
2291
2292 if ($realcnt > 1) {
2293 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2294 } else {
2295 $realcnt = 0;
2296 }
2297
2298 #print "==>$rawline\n";
2299 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002300
2301 if ($setup_docs && $line =~ /^\+/) {
2302 push(@setup_docs, $line);
2303 }
2304 }
2305
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002306 $prefix = '';
2307
Andy Whitcroft773647a2008-03-28 14:15:58 -07002308 $realcnt = 0;
2309 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002310 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002311 foreach my $line (@lines) {
2312 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002313 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002314 my $sline = $line; #copy of $line
2315 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002316
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002317 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002318
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002319#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002320 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002321 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2322 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002323 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002324 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002325 $realline=$1-1;
2326 if (defined $2) {
2327 $realcnt=$3+1;
2328 } else {
2329 $realcnt=1+1;
2330 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002331 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002332 $prev_values = 'E';
2333
Andy Whitcroft773647a2008-03-28 14:15:58 -07002334 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002335 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002336 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002337 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002338 if ($context =~ /\b(\w+)\s*\(/) {
2339 $context_function = $1;
2340 } else {
2341 undef $context_function;
2342 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002343 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002344
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002345# track the line number as we move through the hunk, note that
2346# new versions of GNU diff omit the leading space on completely
2347# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002348 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002349 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002350 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002351
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002352 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002353 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002354
2355 # Track the previous line.
2356 ($prevline, $stashline) = ($stashline, $line);
2357 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002358 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2359
Andy Whitcroft773647a2008-03-28 14:15:58 -07002360 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002361
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002362 } elsif ($realcnt == 1) {
2363 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002364 }
2365
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002366 my $hunk_line = ($realcnt != 0);
2367
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002368 $here = "#$linenr: " if (!$file);
2369 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002370
Joe Perches2ac73b42014-06-04 16:12:05 -07002371 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002372 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002373 if ($line =~ /^diff --git.*?(\S+)$/) {
2374 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002375 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002376 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002377 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002378 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002379 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002380 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002381 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002382
2383 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002384 if (!$file && $tree && $p1_prefix ne '' &&
2385 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002386 WARN("PATCH_PREFIX",
2387 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002388 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002389
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002390 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002391 ERROR("MODIFIED_INCLUDE_ASM",
2392 "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 -07002393 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002394 $found_file = 1;
2395 }
2396
Joe Perches34d88152015-06-25 15:03:05 -07002397#make up the handle for any error we report on this line
2398 if ($showfile) {
2399 $prefix = "$realfile:$realline: "
2400 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002401 if ($file) {
2402 $prefix = "$filename:$realline: ";
2403 } else {
2404 $prefix = "$filename:$linenr: ";
2405 }
Joe Perches34d88152015-06-25 15:03:05 -07002406 }
2407
Joe Perches2ac73b42014-06-04 16:12:05 -07002408 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002409 if (is_maintained_obsolete($realfile)) {
2410 WARN("OBSOLETE",
2411 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2412 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002413 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002414 $check = 1;
2415 } else {
2416 $check = $check_orig;
2417 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002418 next;
2419 }
2420
Randy Dunlap389834b2007-06-08 13:47:03 -07002421 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002422
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002423 my $hereline = "$here\n$rawline\n";
2424 my $herecurr = "$here\n$rawline\n";
2425 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002426
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002427 $cnt_lines++ if ($realcnt != 0);
2428
Joe Perchese518e9a2015-06-25 15:03:27 -07002429# Check if the commit log has what seems like a diff which can confuse patch
2430 if ($in_commit_log && !$commit_log_has_diff &&
2431 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2432 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2433 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2434 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2435 ERROR("DIFF_IN_COMMIT_MSG",
2436 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2437 $commit_log_has_diff = 1;
2438 }
2439
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002440# Check for incorrect file permissions
2441 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2442 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002443 if ($realfile !~ m@scripts/@ &&
2444 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002445 ERROR("EXECUTE_PERMISSIONS",
2446 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002447 }
2448 }
2449
Joe Perches20112472011-07-25 17:13:23 -07002450# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002451 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002452 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002453 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002454 }
2455
Joe Perchese0d975b2014-12-10 15:51:49 -08002456# Check if MAINTAINERS is being updated. If so, there's probably no need to
2457# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2458 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2459 $reported_maintainer_file = 1;
2460 }
2461
Joe Perches20112472011-07-25 17:13:23 -07002462# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002463 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002464 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002465 my $space_before = $1;
2466 my $sign_off = $2;
2467 my $space_after = $3;
2468 my $email = $4;
2469 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2470
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002471 if ($sign_off !~ /$signature_tags/) {
2472 WARN("BAD_SIGN_OFF",
2473 "Non-standard signature: $sign_off\n" . $herecurr);
2474 }
Joe Perches20112472011-07-25 17:13:23 -07002475 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002476 if (WARN("BAD_SIGN_OFF",
2477 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2478 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002479 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002480 "$ucfirst_sign_off $email";
2481 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002482 }
Joe Perches20112472011-07-25 17:13:23 -07002483 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002484 if (WARN("BAD_SIGN_OFF",
2485 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2486 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002487 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002488 "$ucfirst_sign_off $email";
2489 }
2490
Joe Perches20112472011-07-25 17:13:23 -07002491 }
2492 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002493 if (WARN("BAD_SIGN_OFF",
2494 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2495 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002496 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002497 "$ucfirst_sign_off $email";
2498 }
Joe Perches20112472011-07-25 17:13:23 -07002499 }
2500
2501 my ($email_name, $email_address, $comment) = parse_email($email);
2502 my $suggested_email = format_email(($email_name, $email_address));
2503 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002504 ERROR("BAD_SIGN_OFF",
2505 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002506 } else {
2507 my $dequoted = $suggested_email;
2508 $dequoted =~ s/^"//;
2509 $dequoted =~ s/" </ </;
2510 # Don't force email to have quotes
2511 # Allow just an angle bracketed address
2512 if ("$dequoted$comment" ne $email &&
2513 "<$email_address>$comment" ne $email &&
2514 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002515 WARN("BAD_SIGN_OFF",
2516 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002517 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002518 }
Joe Perches7e51f192013-09-11 14:23:57 -07002519
2520# Check for duplicate signatures
2521 my $sig_nospace = $line;
2522 $sig_nospace =~ s/\s//g;
2523 $sig_nospace = lc($sig_nospace);
2524 if (defined $signatures{$sig_nospace}) {
2525 WARN("BAD_SIGN_OFF",
2526 "Duplicate signature\n" . $herecurr);
2527 } else {
2528 $signatures{$sig_nospace} = 1;
2529 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002530 }
2531
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002532# Check email subject for common tools that don't need to be mentioned
2533 if ($in_header_lines &&
2534 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2535 WARN("EMAIL_SUBJECT",
2536 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2537 }
2538
Joe Perches9b3189e2014-06-04 16:12:10 -07002539# Check for old stable address
2540 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2541 ERROR("STABLE_ADDRESS",
2542 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2543 }
2544
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002545# Check for unwanted Gerrit info
2546 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2547 ERROR("GERRIT_CHANGE_ID",
2548 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2549 }
2550
Joe Perches369c8dd2015-11-06 16:31:34 -08002551# Check if the commit log is in a possible stack dump
2552 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2553 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2554 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2555 # timestamp
2556 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2557 # stack dump address
2558 $commit_log_possible_stack_dump = 1;
2559 }
2560
Joe Perches2a076f42015-04-16 12:44:28 -07002561# Check for line lengths > 75 in commit log, warn once
2562 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002563 length($line) > 75 &&
2564 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2565 # file delta changes
2566 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2567 # filename then :
2568 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2569 # A Fixes: or Link: line
2570 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002571 WARN("COMMIT_LOG_LONG_LINE",
2572 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2573 $commit_log_long_line = 1;
2574 }
2575
Joe Perchesbf4daf12015-09-09 15:37:50 -07002576# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002577 if ($in_commit_log && $commit_log_possible_stack_dump &&
2578 $line =~ /^\s*$/) {
2579 $commit_log_possible_stack_dump = 0;
2580 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002581
Joe Perches0d7835f2015-02-13 14:38:35 -08002582# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002583 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002584 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002585 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002586 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002587 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002588 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2589 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002590 my $init_char = "c";
2591 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002592 my $short = 1;
2593 my $long = 0;
2594 my $case = 1;
2595 my $space = 1;
2596 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002597 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002598 my $id = '0123456789ab';
2599 my $orig_desc = "commit description";
2600 my $description = "";
2601
Joe Perchesfe043ea2015-09-09 15:37:25 -07002602 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2603 $init_char = $1;
2604 $orig_commit = lc($2);
2605 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2606 $orig_commit = lc($1);
2607 }
2608
Joe Perches0d7835f2015-02-13 14:38:35 -08002609 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2610 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2611 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2612 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2613 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2614 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002615 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002616 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2617 defined $rawlines[$linenr] &&
2618 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2619 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002620 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002621 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2622 defined $rawlines[$linenr] &&
2623 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2624 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2625 $orig_desc = $1;
2626 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2627 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002628 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002629 }
2630
2631 ($id, $description) = git_commit_info($orig_commit,
2632 $id, $orig_desc);
2633
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002634 if (defined($id) &&
2635 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002636 ERROR("GIT_COMMIT_ID",
2637 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2638 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002639 }
2640
Joe Perches13f19372014-08-06 16:10:59 -07002641# Check for added, moved or deleted files
2642 if (!$reported_maintainer_file && !$in_commit_log &&
2643 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2644 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2645 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2646 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002647 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002648 $reported_maintainer_file = 1;
2649 WARN("FILE_PATH_CHANGES",
2650 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2651 }
2652
Andy Whitcroft00df3442007-06-08 13:47:06 -07002653# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002654 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002655 ERROR("CORRUPTED_PATCH",
2656 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002657 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002658 }
2659
2660# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2661 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002662 $rawline !~ m/^$UTF8*$/) {
2663 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2664
2665 my $blank = copy_spacing($rawline);
2666 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2667 my $hereptr = "$hereline$ptr\n";
2668
Joe Perches34d99212011-07-25 17:13:26 -07002669 CHK("INVALID_UTF8",
2670 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002671 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002672
Joe Perches15662b32011-10-31 17:13:12 -07002673# Check if it's the start of a commit log
2674# (not a header line and we haven't seen the patch filename)
2675 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002676 !($rawline =~ /^\s+(?:\S|$)/ ||
2677 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002678 $in_header_lines = 0;
2679 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002680 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002681 }
2682
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002683# Check if there is UTF-8 in a commit log when a mail header has explicitly
2684# declined it, i.e defined some charset where it is missing.
2685 if ($in_header_lines &&
2686 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2687 $1 !~ /utf-8/i) {
2688 $non_utf8_charset = 1;
2689 }
2690
2691 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002692 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002693 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002694 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2695 }
2696
Joe Perchesd6430f72016-12-12 16:46:28 -08002697# Check for absolute kernel paths in commit message
2698 if ($tree && $in_commit_log) {
2699 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2700 my $file = $1;
2701
2702 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2703 check_absolute_file($1, $herecurr)) {
2704 #
2705 } else {
2706 check_absolute_file($file, $herecurr);
2707 }
2708 }
2709 }
2710
Kees Cook66b47b42014-10-13 15:51:57 -07002711# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002712 if (defined($misspellings) &&
2713 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002714 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002715 my $typo = $1;
2716 my $typo_fix = $spelling_fix{lc($typo)};
2717 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2718 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002719 my $msg_level = \&WARN;
2720 $msg_level = \&CHK if ($file);
2721 if (&{$msg_level}("TYPO_SPELLING",
2722 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002723 $fix) {
2724 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2725 }
2726 }
2727 }
2728
Andy Whitcroft306708542008-10-15 22:02:28 -07002729# ignore non-hunk lines and lines being removed
2730 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002731
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002732#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002733 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002734 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002735 if (ERROR("DOS_LINE_ENDINGS",
2736 "DOS line endings\n" . $herevet) &&
2737 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002738 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002739 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002740 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2741 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002742 if (ERROR("TRAILING_WHITESPACE",
2743 "trailing whitespace\n" . $herevet) &&
2744 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002745 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002746 }
2747
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002748 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002749 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002750
Josh Triplett4783f892013-11-12 15:10:12 -08002751# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002752 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002753 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002754 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2755 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002756 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002757 my $msg_level = \&ERROR;
2758 $msg_level = \&CHK if ($file);
2759 &{$msg_level}("FSF_MAILING_ADDRESS",
2760 "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 -08002761 }
2762
Andi Kleen33549572010-05-24 14:33:29 -07002763# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002764# Only applies when adding the entry originally, after that we do not have
2765# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002766 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002767 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002768 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002769 my $cnt = $realcnt;
2770 my $ln = $linenr + 1;
2771 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002772 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002773 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002774 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002775 $f = $lines[$ln - 1];
2776 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2777 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002778
2779 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002780 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002781
Joe Perches8d73e0e2014-08-06 16:10:46 -07002782 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002783 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002784 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002785 $length = -1;
2786 }
2787
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002788 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002789 $f =~ s/#.*//;
2790 $f =~ s/^\s+//;
2791 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002792 if ($f =~ /^\s*config\s/) {
2793 $is_end = 1;
2794 last;
2795 }
Andi Kleen33549572010-05-24 14:33:29 -07002796 $length++;
2797 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002798 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2799 WARN("CONFIG_DESCRIPTION",
2800 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2801 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002802 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002803 }
2804
Joe Perches628f91a2017-07-10 15:52:07 -07002805# check for MAINTAINERS entries that don't have the right form
2806 if ($realfile =~ /^MAINTAINERS$/ &&
2807 $rawline =~ /^\+[A-Z]:/ &&
2808 $rawline !~ /^\+[A-Z]:\t\S/) {
2809 if (WARN("MAINTAINERS_STYLE",
2810 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2811 $fix) {
2812 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2813 }
2814 }
2815
Christoph Jaeger327953e2015-02-13 14:38:29 -08002816# discourage the use of boolean for type definition attributes of Kconfig options
2817 if ($realfile =~ /Kconfig/ &&
2818 $line =~ /^\+\s*\bboolean\b/) {
2819 WARN("CONFIG_TYPE_BOOLEAN",
2820 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2821 }
2822
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002823 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2824 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2825 my $flag = $1;
2826 my $replacement = {
2827 'EXTRA_AFLAGS' => 'asflags-y',
2828 'EXTRA_CFLAGS' => 'ccflags-y',
2829 'EXTRA_CPPFLAGS' => 'cppflags-y',
2830 'EXTRA_LDFLAGS' => 'ldflags-y',
2831 };
2832
2833 WARN("DEPRECATED_VARIABLE",
2834 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2835 }
2836
Rob Herringbff5da42014-01-23 15:54:51 -08002837# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002838 if (defined $root &&
2839 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2840 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2841
Rob Herringbff5da42014-01-23 15:54:51 -08002842 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2843
Florian Vaussardcc933192014-04-03 14:49:27 -07002844 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2845 my $vp_file = $dt_path . "vendor-prefixes.txt";
2846
Rob Herringbff5da42014-01-23 15:54:51 -08002847 foreach my $compat (@compats) {
2848 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002849 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2850 my $compat3 = $compat;
2851 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2852 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002853 if ( $? >> 8 ) {
2854 WARN("UNDOCUMENTED_DT_STRING",
2855 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2856 }
2857
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002858 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2859 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002860 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002861 if ( $? >> 8 ) {
2862 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002863 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002864 }
2865 }
2866 }
2867
Andy Whitcroft5368df202008-10-15 22:02:27 -07002868# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002869 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002870
Joe Perches47e0c882015-06-25 15:02:57 -07002871# line length limit (with some exclusions)
2872#
2873# There are a few types of lines that may extend beyond $max_line_length:
2874# logging functions like pr_info that end in a string
2875# lines with a single string
2876# #defines that are a single string
2877#
2878# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002879# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002880# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2881# LONG_LINE all other lines longer than $max_line_length
2882#
2883# if LONG_LINE is ignored, the other 2 types are also ignored
2884#
2885
Joe Perchesb4749e92015-07-17 16:24:01 -07002886 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002887 my $msg_type = "LONG_LINE";
2888
2889 # Check the allowed long line types first
2890
2891 # logging functions that end in a string that starts
2892 # before $max_line_length
2893 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2894 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2895 $msg_type = "";
2896
2897 # lines with only strings (w/ possible termination)
2898 # #defines with only strings
2899 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2900 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2901 $msg_type = "";
2902
Joe Perchesd560a5f2016-08-02 14:04:31 -07002903 # EFI_GUID is another special case
2904 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2905 $msg_type = "";
2906
Joe Perches47e0c882015-06-25 15:02:57 -07002907 # Otherwise set the alternate message types
2908
2909 # a comment starts before $max_line_length
2910 } elsif ($line =~ /($;[\s$;]*)$/ &&
2911 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2912 $msg_type = "LONG_LINE_COMMENT"
2913
2914 # a quoted string starts before $max_line_length
2915 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2916 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2917 $msg_type = "LONG_LINE_STRING"
2918 }
2919
2920 if ($msg_type ne "" &&
2921 (show_type("LONG_LINE") || show_type($msg_type))) {
2922 WARN($msg_type,
2923 "line over $max_line_length characters\n" . $herecurr);
2924 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002925 }
2926
Andy Whitcroft8905a672007-11-28 16:21:06 -08002927# check for adding lines without a newline.
2928 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002929 WARN("MISSING_EOF_NEWLINE",
2930 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002931 }
2932
Mike Frysinger42e41c52009-09-21 17:04:40 -07002933# Blackfin: use hi/lo macros
2934 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2935 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2936 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002937 ERROR("LO_MACRO",
2938 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002939 }
2940 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2941 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002942 ERROR("HI_MACRO",
2943 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002944 }
2945 }
2946
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002947# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002948 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002949
2950# at the beginning of a line any tabs must come first and anything
2951# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002952 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2953 $rawline =~ /^\+\s* \s*/) {
2954 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002955 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002956 if (ERROR("CODE_INDENT",
2957 "code indent should use tabs where possible\n" . $herevet) &&
2958 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002959 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002960 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002961 }
2962
Alberto Panizzo08e44362010-03-05 13:43:54 -08002963# check for space before tabs.
2964 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2965 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002966 if (WARN("SPACE_BEFORE_TAB",
2967 "please, no space before tabs\n" . $herevet) &&
2968 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002969 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002970 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002971 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002972 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002973 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002974 }
2975
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002976# check for && or || at the start of a line
2977 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2978 CHK("LOGICAL_CONTINUATIONS",
2979 "Logical continuations should be on the previous line\n" . $hereprev);
2980 }
2981
Joe Perchesa91e8992016-05-20 17:04:05 -07002982# check indentation starts on a tab stop
2983 if ($^V && $^V ge 5.10.0 &&
2984 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2985 my $indent = length($1);
2986 if ($indent % 8) {
2987 if (WARN("TABSTOP",
2988 "Statements should start on a tabstop\n" . $herecurr) &&
2989 $fix) {
2990 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2991 }
2992 }
2993 }
2994
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002995# check multi-line statement indentation matches previous line
2996 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07002997 $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 -07002998 $prevline =~ /^\+(\t*)(.*)$/;
2999 my $oldindent = $1;
3000 my $rest = $2;
3001
3002 my $pos = pos_last_openparen($rest);
3003 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003004 $line =~ /^(\+| )([ \t]*)/;
3005 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003006
3007 my $goodtabindent = $oldindent .
3008 "\t" x ($pos / 8) .
3009 " " x ($pos % 8);
3010 my $goodspaceindent = $oldindent . " " x $pos;
3011
3012 if ($newindent ne $goodtabindent &&
3013 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003014
3015 if (CHK("PARENTHESIS_ALIGNMENT",
3016 "Alignment should match open parenthesis\n" . $hereprev) &&
3017 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003018 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003019 s/^\+[ \t]*/\+$goodtabindent/;
3020 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003021 }
3022 }
3023 }
3024
Joe Perches6ab3a972015-04-16 12:44:05 -07003025# check for space after cast like "(int) foo" or "(struct foo) bar"
3026# avoid checking a few false positives:
3027# "sizeof(<type>)" or "__alignof__(<type>)"
3028# function pointer declarations like "(*foo)(int) = bar;"
3029# structure definitions like "(struct foo) { 0 };"
3030# multiline macros that define functions
3031# known attributes or the __attribute__ keyword
3032 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3033 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003034 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003035 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003036 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003037 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003038 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003039 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003040 }
3041
Joe Perches86406b12015-09-09 15:37:41 -07003042# Block comment styles
3043# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003044 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003045 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003046 $rawline =~ /^\+[ \t]*\*/ &&
3047 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003048 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3049 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3050 }
3051
Joe Perches86406b12015-09-09 15:37:41 -07003052# Block comments use * on subsequent lines
3053 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3054 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003055 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003056 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003057 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003058 WARN("BLOCK_COMMENT_STYLE",
3059 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003060 }
3061
Joe Perches86406b12015-09-09 15:37:41 -07003062# Block comments use */ on trailing lines
3063 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003064 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3065 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3066 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003067 WARN("BLOCK_COMMENT_STYLE",
3068 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003069 }
3070
Joe Perches08eb9b82016-10-11 13:51:50 -07003071# Block comment * alignment
3072 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003073 $line =~ /^\+[ \t]*$;/ && #leading comment
3074 $rawline =~ /^\+[ \t]*\*/ && #leading *
3075 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003076 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003077 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3078 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003079 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003080 if (defined($1)) {
3081 $oldindent = expand_tabs($1);
3082 } else {
3083 $prevrawline =~ m@^\+(.*/?)\*@;
3084 $oldindent = expand_tabs($1);
3085 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003086 $rawline =~ m@^\+([ \t]*)\*@;
3087 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003088 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003089 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003090 WARN("BLOCK_COMMENT_STYLE",
3091 "Block comments should align the * on each line\n" . $hereprev);
3092 }
3093 }
3094
Joe Perches7f619192014-08-06 16:10:39 -07003095# check for missing blank lines after struct/union declarations
3096# with exceptions for various attributes and macros
3097 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3098 $line =~ /^\+/ &&
3099 !($line =~ /^\+\s*$/ ||
3100 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3101 $line =~ /^\+\s*MODULE_/i ||
3102 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3103 $line =~ /^\+[a-z_]*init/ ||
3104 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3105 $line =~ /^\+\s*DECLARE/ ||
3106 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003107 if (CHK("LINE_SPACING",
3108 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3109 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003110 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003111 }
Joe Perches7f619192014-08-06 16:10:39 -07003112 }
3113
Joe Perches365dd4e2014-08-06 16:10:42 -07003114# check for multiple consecutive blank lines
3115 if ($prevline =~ /^[\+ ]\s*$/ &&
3116 $line =~ /^\+\s*$/ &&
3117 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003118 if (CHK("LINE_SPACING",
3119 "Please don't use multiple blank lines\n" . $hereprev) &&
3120 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003121 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003122 }
3123
Joe Perches365dd4e2014-08-06 16:10:42 -07003124 $last_blank_line = $linenr;
3125 }
3126
Joe Perches3b617e32014-04-03 14:49:28 -07003127# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003128 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3129 # actual declarations
3130 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003131 # function pointer declarations
3132 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003133 # foo bar; where foo is some local typedef or #define
3134 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3135 # known declaration macros
3136 $prevline =~ /^\+\s+$declaration_macros/) &&
3137 # for "else if" which can look like "$Ident $Ident"
3138 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3139 # other possible extensions of declaration lines
3140 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3141 # not starting a section or a macro "\" extended line
3142 $prevline =~ /(?:\{\s*|\\)$/) &&
3143 # looks like a declaration
3144 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003145 # function pointer declarations
3146 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003147 # foo bar; where foo is some local typedef or #define
3148 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3149 # known declaration macros
3150 $sline =~ /^\+\s+$declaration_macros/ ||
3151 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003152 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003153 # start or end of block or continuation of declaration
3154 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3155 # bitfield continuation
3156 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3157 # other possible extensions of declaration lines
3158 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3159 # indentation of previous and current line are the same
3160 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003161 if (WARN("LINE_SPACING",
3162 "Missing a blank line after declarations\n" . $hereprev) &&
3163 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003164 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003165 }
Joe Perches3b617e32014-04-03 14:49:28 -07003166 }
3167
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003168# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003169# Exceptions:
3170# 1) within comments
3171# 2) indented preprocessor commands
3172# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003173 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003174 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003175 if (WARN("LEADING_SPACE",
3176 "please, no spaces at the start of a line\n" . $herevet) &&
3177 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003178 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003179 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003180 }
3181
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003182# check we are in a valid C source file if not then ignore this hunk
3183 next if ($realfile !~ /\.(h|c)$/);
3184
Joe Perches4dbed762017-05-08 15:55:39 -07003185# check if this appears to be the start function declaration, save the name
3186 if ($sline =~ /^\+\{\s*$/ &&
3187 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3188 $context_function = $1;
3189 }
3190
3191# check if this appears to be the end of function declaration
3192 if ($sline =~ /^\+\}\s*$/) {
3193 undef $context_function;
3194 }
3195
Joe Perches032a4c02014-08-06 16:10:29 -07003196# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003197# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003198# if the previous line is a break or return and is indented 1 tab more...
3199 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3200 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003201 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3202 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3203 defined $lines[$linenr] &&
3204 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003205 WARN("UNNECESSARY_ELSE",
3206 "else is not generally useful after a break or return\n" . $hereprev);
3207 }
3208 }
3209
Joe Perchesc00df192014-08-06 16:11:01 -07003210# check indentation of a line with a break;
3211# if the previous line is a goto or return and is indented the same # of tabs
3212 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3213 my $tabs = $1;
3214 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3215 WARN("UNNECESSARY_BREAK",
3216 "break is not useful after a goto or return\n" . $hereprev);
3217 }
3218 }
3219
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003220# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003221 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003222 WARN("CVS_KEYWORD",
3223 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003224 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003225
Mike Frysinger42e41c52009-09-21 17:04:40 -07003226# Blackfin: don't use __builtin_bfin_[cs]sync
3227 if ($line =~ /__builtin_bfin_csync/) {
3228 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003229 ERROR("CSYNC",
3230 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003231 }
3232 if ($line =~ /__builtin_bfin_ssync/) {
3233 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003234 ERROR("SSYNC",
3235 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003236 }
3237
Joe Perches56e77d72013-02-21 16:44:14 -08003238# check for old HOTPLUG __dev<foo> section markings
3239 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3240 WARN("HOTPLUG_SECTION",
3241 "Using $1 is unnecessary\n" . $herecurr);
3242 }
3243
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003244# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003245 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3246 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003247#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003248 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003249 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003250 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003251 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003252 $stat =~ s/\n./\n /g;
3253 $cond =~ s/\n./\n /g;
3254
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003255#print "linenr<$linenr> <$stat>\n";
3256 # If this statement has no statement boundaries within
3257 # it there is no point in retrying a statement scan
3258 # until we hit end of it.
3259 my $frag = $stat; $frag =~ s/;+\s*$//;
3260 if ($frag !~ /(?:{|;)/) {
3261#print "skip<$line_nr_next>\n";
3262 $suppress_statement = $line_nr_next;
3263 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003264
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003265 # Find the real next line.
3266 $realline_next = $line_nr_next;
3267 if (defined $realline_next &&
3268 (!defined $lines[$realline_next - 1] ||
3269 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3270 $realline_next++;
3271 }
3272
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003273 my $s = $stat;
3274 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003275
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003276 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003277 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003278
3279 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003280 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003281
Andy Whitcroft463f2862009-09-21 17:04:34 -07003282 } elsif ($s =~ /^.\s*else\b/s) {
3283
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003284 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003285 } 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 -07003286 my $type = $1;
3287 $type =~ s/\s+/ /g;
3288 possible($type, "A:" . $s);
3289
Andy Whitcroft8905a672007-11-28 16:21:06 -08003290 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003291 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003292 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003293 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003294
3295 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003296 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003297 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003298 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003299
3300 # Check for any sort of function declaration.
3301 # int foo(something bar, other baz);
3302 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003303 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 -08003304 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003305
Andy Whitcroftcf655042008-03-04 14:28:20 -08003306 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003307 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003308 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003309
Andy Whitcroft8905a672007-11-28 16:21:06 -08003310 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003311 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003312
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003313 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003314 }
3315 }
3316 }
3317
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003318 }
3319
Andy Whitcroft653d4872007-06-23 17:16:34 -07003320#
3321# Checks which may be anchored in the context.
3322#
3323
3324# Check for switch () and associated case and default
3325# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003326 if ($line=~/\bswitch\s*\(.*\)/) {
3327 my $err = '';
3328 my $sep = '';
3329 my @ctx = ctx_block_outer($linenr, $realcnt);
3330 shift(@ctx);
3331 for my $ctx (@ctx) {
3332 my ($clen, $cindent) = line_stats($ctx);
3333 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3334 $indent != $cindent) {
3335 $err .= "$sep$ctx\n";
3336 $sep = '';
3337 } else {
3338 $sep = "[...]\n";
3339 }
3340 }
3341 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003342 ERROR("SWITCH_CASE_INDENT_LEVEL",
3343 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003344 }
3345 }
3346
3347# if/while/etc brace do not go on next line, unless defining a do while loop,
3348# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003349 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 -07003350 my $pre_ctx = "$1$2";
3351
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003352 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003353
3354 if ($line =~ /^\+\t{6,}/) {
3355 WARN("DEEP_INDENTATION",
3356 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3357 }
3358
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003359 my $ctx_cnt = $realcnt - $#ctx - 1;
3360 my $ctx = join("\n", @ctx);
3361
Andy Whitcroft548596d2008-07-23 21:29:01 -07003362 my $ctx_ln = $linenr;
3363 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003364
Andy Whitcroft548596d2008-07-23 21:29:01 -07003365 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3366 defined $lines[$ctx_ln - 1] &&
3367 $lines[$ctx_ln - 1] =~ /^-/)) {
3368 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3369 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003370 $ctx_ln++;
3371 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003372
Andy Whitcroft53210162008-07-23 21:29:03 -07003373 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3374 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003375
Joe Perchesd752fcc2014-08-06 16:11:05 -07003376 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003377 ERROR("OPEN_BRACE",
3378 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003379 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003380 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003381 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3382 $ctx =~ /\)\s*\;\s*$/ &&
3383 defined $lines[$ctx_ln - 1])
3384 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003385 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3386 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003387 WARN("TRAILING_SEMICOLON",
3388 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003389 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003390 }
3391 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003392 }
3393
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003394# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003395 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 -08003396 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3397 ctx_statement_block($linenr, $realcnt, 0)
3398 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003399 my ($s, $c) = ($stat, $cond);
3400
3401 substr($s, 0, length($c), '');
3402
Joe Perches9f5af482015-09-09 15:37:30 -07003403 # remove inline comments
3404 $s =~ s/$;/ /g;
3405 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003406
3407 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003408 my @newlines = ($c =~ /\n/gs);
3409 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003410
Joe Perches9f5af482015-09-09 15:37:30 -07003411 # Make sure we remove the line prefixes as we have
3412 # none on the first line, and are going to readd them
3413 # where necessary.
3414 $s =~ s/\n./\n/gs;
3415 while ($s =~ /\n\s+\\\n/) {
3416 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3417 }
3418
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003419 # We want to check the first line inside the block
3420 # starting at the end of the conditional, so remove:
3421 # 1) any blank line termination
3422 # 2) any opening brace { on end of the line
3423 # 3) any do (...) {
3424 my $continuation = 0;
3425 my $check = 0;
3426 $s =~ s/^.*\bdo\b//;
3427 $s =~ s/^\s*{//;
3428 if ($s =~ s/^\s*\\//) {
3429 $continuation = 1;
3430 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003431 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003432 $check = 1;
3433 $cond_lines++;
3434 }
3435
3436 # Also ignore a loop construct at the end of a
3437 # preprocessor statement.
3438 if (($prevline =~ /^.\s*#\s*define\s/ ||
3439 $prevline =~ /\\\s*$/) && $continuation == 0) {
3440 $check = 0;
3441 }
3442
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003443 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003444 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003445 while ($cond_ptr != $cond_lines) {
3446 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003447
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003448 # If we see an #else/#elif then the code
3449 # is not linear.
3450 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3451 $check = 0;
3452 }
3453
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003454 # Ignore:
3455 # 1) blank lines, they should be at 0,
3456 # 2) preprocessor lines, and
3457 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003458 if ($continuation ||
3459 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003460 $s =~ /^\s*#\s*?/ ||
3461 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003462 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003463 if ($s =~ s/^.*?\n//) {
3464 $cond_lines++;
3465 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003466 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003467 }
3468
3469 my (undef, $sindent) = line_stats("+" . $s);
3470 my $stat_real = raw_line($linenr, $cond_lines);
3471
3472 # Check if either of these lines are modified, else
3473 # this is not this patch's fault.
3474 if (!defined($stat_real) ||
3475 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3476 $check = 0;
3477 }
3478 if (defined($stat_real) && $cond_lines > 1) {
3479 $stat_real = "[...]\n$stat_real";
3480 }
3481
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003482 #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 -07003483
Joe Perches9f5af482015-09-09 15:37:30 -07003484 if ($check && $s ne '' &&
3485 (($sindent % 8) != 0 ||
3486 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003487 ($sindent == $indent &&
3488 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003489 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003490 WARN("SUSPECT_CODE_INDENT",
3491 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003492 }
3493 }
3494
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003495 # Track the 'values' across context and added lines.
3496 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003497 my ($curr_values, $curr_vars) =
3498 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003499 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003500 if ($dbg_values) {
3501 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003502 print "$linenr > .$outline\n";
3503 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003504 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003505 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003506 $prev_values = substr($curr_values, -1);
3507
Andy Whitcroft00df3442007-06-08 13:47:06 -07003508#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003509 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003510
Joe Perches11ca40a2016-12-12 16:46:31 -08003511# check for dereferences that span multiple lines
3512 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3513 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3514 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3515 my $ref = $1;
3516 $line =~ /^.\s*($Lval)/;
3517 $ref .= $1;
3518 $ref =~ s/\s//g;
3519 WARN("MULTILINE_DEREFERENCE",
3520 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3521 }
3522
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003523# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003524 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 -07003525 my $type = $1;
3526 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003527 $var = "" if (!defined $var);
3528 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003529 my $sign = $1;
3530 my $pointer = $2;
3531
3532 $pointer = "" if (!defined $pointer);
3533
3534 if (WARN("UNSPECIFIED_INT",
3535 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3536 $fix) {
3537 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003538 my $comp_pointer = $pointer;
3539 $comp_pointer =~ s/\s//g;
3540 $decl .= $comp_pointer;
3541 $decl = rtrim($decl) if ($var eq "");
3542 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003543 }
3544 }
3545 }
3546
Andy Whitcroft653d4872007-06-23 17:16:34 -07003547# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003548 if ($dbg_type) {
3549 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003550 ERROR("TEST_TYPE",
3551 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003552 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003553 ERROR("TEST_NOT_TYPE",
3554 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003555 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003556 next;
3557 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003558# TEST: allow direct testing of the attribute matcher.
3559 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003560 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003561 ERROR("TEST_ATTR",
3562 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003563 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003564 ERROR("TEST_NOT_ATTR",
3565 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003566 }
3567 next;
3568 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003569
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003570# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003571 if ($line =~ /^.\s*{/ &&
3572 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003573 if (ERROR("OPEN_BRACE",
3574 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003575 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3576 fix_delete_line($fixlinenr - 1, $prevrawline);
3577 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003578 my $fixedline = $prevrawline;
3579 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003580 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003581 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003582 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003583 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003584 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003585 }
3586
Andy Whitcroft653d4872007-06-23 17:16:34 -07003587#
3588# Checks which are anchored on the added line.
3589#
3590
3591# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003592 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003593 my $path = $1;
3594 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003595 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003596 "malformed #include filename\n" . $herecurr);
3597 }
3598 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3599 ERROR("UAPI_INCLUDE",
3600 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003601 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003602 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003603
3604# no C99 // comments
3605 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003606 if (ERROR("C99_COMMENTS",
3607 "do not use C99 // comments\n" . $herecurr) &&
3608 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003609 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003610 if ($line =~ /\/\/(.*)$/) {
3611 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003612 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003613 }
3614 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003615 }
3616 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003617 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003618 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003619
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003620# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3621# the whole statement.
3622#print "APW <$lines[$realline_next - 1]>\n";
3623 if (defined $realline_next &&
3624 exists $lines[$realline_next - 1] &&
3625 !defined $suppress_export{$realline_next} &&
3626 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3627 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003628 # Handle definitions which produce identifiers with
3629 # a prefix:
3630 # XXX(foo);
3631 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003632 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003633 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003634 $name =~ /^${Ident}_$2/) {
3635#print "FOO C name<$name>\n";
3636 $suppress_export{$realline_next} = 1;
3637
3638 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003639 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003640 ^.DEFINE_$Ident\(\Q$name\E\)|
3641 ^.DECLARE_$Ident\(\Q$name\E\)|
3642 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003643 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3644 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003645 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003646#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3647 $suppress_export{$realline_next} = 2;
3648 } else {
3649 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003650 }
3651 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003652 if (!defined $suppress_export{$linenr} &&
3653 $prevline =~ /^.\s*$/ &&
3654 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3655 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3656#print "FOO B <$lines[$linenr - 1]>\n";
3657 $suppress_export{$linenr} = 2;
3658 }
3659 if (defined $suppress_export{$linenr} &&
3660 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003661 WARN("EXPORT_SYMBOL",
3662 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003663 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003664
Joe Eloff5150bda2010-08-09 17:21:00 -07003665# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003666 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003667 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003668 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003669 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003670 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003671 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003672 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003673# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003674 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003675 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003676 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003677 $herecurr) &&
3678 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003679 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003680 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003681 }
3682
Joe Perches18130872014-08-06 16:11:22 -07003683# check for misordered declarations of char/short/int/long with signed/unsigned
3684 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3685 my $tmp = trim($1);
3686 WARN("MISORDERED_TYPE",
3687 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3688 }
3689
Joe Perchescb710ec2010-10-26 14:23:20 -07003690# check for static const char * arrays.
3691 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003692 WARN("STATIC_CONST_CHAR_ARRAY",
3693 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003694 $herecurr);
3695 }
3696
3697# check for static char foo[] = "bar" declarations.
3698 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003699 WARN("STATIC_CONST_CHAR_ARRAY",
3700 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003701 $herecurr);
3702 }
3703
Joe Perchesab7e23f2015-04-16 12:44:22 -07003704# check for const <foo> const where <foo> is not a pointer or array type
3705 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3706 my $found = $1;
3707 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3708 WARN("CONST_CONST",
3709 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3710 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3711 WARN("CONST_CONST",
3712 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3713 }
3714 }
3715
Joe Perches9b0fa602014-04-03 14:49:18 -07003716# check for non-global char *foo[] = {"bar", ...} declarations.
3717 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3718 WARN("STATIC_CONST_CHAR_ARRAY",
3719 "char * array declaration might be better as static const\n" .
3720 $herecurr);
3721 }
3722
Joe Perchesb598b672015-04-16 12:44:36 -07003723# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3724 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3725 my $array = $1;
3726 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3727 my $array_div = $1;
3728 if (WARN("ARRAY_SIZE",
3729 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3730 $fix) {
3731 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3732 }
3733 }
3734 }
3735
Joe Perchesb36190c2014-01-27 17:07:18 -08003736# check for function declarations without arguments like "int foo()"
3737 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3738 if (ERROR("FUNCTION_WITHOUT_ARGS",
3739 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3740 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003741 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003742 }
3743 }
3744
Andy Whitcroft653d4872007-06-23 17:16:34 -07003745# check for new typedefs, only function parameters and sparse annotations
3746# make sense.
3747 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003748 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003749 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003750 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003751 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003752 WARN("NEW_TYPEDEFS",
3753 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003754 }
3755
3756# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003757 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003758 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3759 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003760 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003761
Andy Whitcroft65863862009-01-06 14:41:21 -08003762 # Should start with a space.
3763 $to =~ s/^(\S)/ $1/;
3764 # Should not end with a space.
3765 $to =~ s/\s+$//;
3766 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003767 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003768 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003769
Joe Perches3705ce52013-07-03 15:05:31 -07003770## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003771 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003772 if (ERROR("POINTER_LOCATION",
3773 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3774 $fix) {
3775 my $sub_from = $ident;
3776 my $sub_to = $ident;
3777 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003778 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003779 s@\Q$sub_from\E@$sub_to@;
3780 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003781 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003782 }
3783 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3784 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003785 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003786
Andy Whitcroft65863862009-01-06 14:41:21 -08003787 # Should start with a space.
3788 $to =~ s/^(\S)/ $1/;
3789 # Should not end with a space.
3790 $to =~ s/\s+$//;
3791 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003792 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003793 }
3794 # Modifiers should have spaces.
3795 $to =~ s/(\b$Modifier$)/$1 /;
3796
Joe Perches3705ce52013-07-03 15:05:31 -07003797## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003798 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003799 if (ERROR("POINTER_LOCATION",
3800 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3801 $fix) {
3802
3803 my $sub_from = $match;
3804 my $sub_to = $match;
3805 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003806 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003807 s@\Q$sub_from\E@$sub_to@;
3808 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003809 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003810 }
3811
Joe Perches9d3e3c72015-09-09 15:37:27 -07003812# avoid BUG() or BUG_ON()
3813 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003814 my $msg_level = \&WARN;
3815 $msg_level = \&CHK if ($file);
3816 &{$msg_level}("AVOID_BUG",
3817 "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 -07003818 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003819
Joe Perches9d3e3c72015-09-09 15:37:27 -07003820# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003821 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003822 WARN("LINUX_VERSION_CODE",
3823 "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 -08003824 }
3825
Joe Perches17441222011-06-15 15:08:17 -07003826# check for uses of printk_ratelimit
3827 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003828 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003829 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003830 }
3831
Andy Whitcroft00df3442007-06-08 13:47:06 -07003832# printk should use KERN_* levels. Note that follow on printk's on the
3833# same line do not need a level, so we use the current block context
3834# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003835# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003836# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003837 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003838 my $ok = 0;
3839 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3840 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003841 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003842 # with "\n" ignore it, else it is to blame
3843 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3844 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3845 $ok = 1;
3846 }
3847 last;
3848 }
3849 }
3850 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003851 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3852 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003853 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003854 }
3855
Joe Perches243f3802012-05-31 16:26:09 -07003856 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3857 my $orig = $1;
3858 my $level = lc($orig);
3859 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003860 my $level2 = $level;
3861 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003862 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003863 "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 -07003864 }
3865
3866 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003867 if (WARN("PREFER_PR_LEVEL",
3868 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3869 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003870 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003871 s/\bpr_warning\b/pr_warn/;
3872 }
Joe Perches243f3802012-05-31 16:26:09 -07003873 }
3874
Joe Perchesdc139312013-02-21 16:44:13 -08003875 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3876 my $orig = $1;
3877 my $level = lc($orig);
3878 $level = "warn" if ($level eq "warning");
3879 $level = "dbg" if ($level eq "debug");
3880 WARN("PREFER_DEV_LEVEL",
3881 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3882 }
3883
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003884# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3885# number of false positives, but assembly files are not checked, so at
3886# least the arch entry code will not trigger this warning.
3887 if ($line =~ /\bENOSYS\b/) {
3888 WARN("ENOSYS",
3889 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3890 }
3891
Andy Whitcroft653d4872007-06-23 17:16:34 -07003892# function brace can't be on same line, except for #defines of do while,
3893# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003894 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003895 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003896 if (ERROR("OPEN_BRACE",
3897 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3898 $fix) {
3899 fix_delete_line($fixlinenr, $rawline);
3900 my $fixed_line = $rawline;
3901 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3902 my $line1 = $1;
3903 my $line2 = $2;
3904 fix_insert_line($fixlinenr, ltrim($line1));
3905 fix_insert_line($fixlinenr, "\+{");
3906 if ($line2 !~ /^\s*$/) {
3907 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3908 }
3909 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003910 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003911
Andy Whitcroft8905a672007-11-28 16:21:06 -08003912# open braces for enum, union and struct go on the same line.
3913 if ($line =~ /^.\s*{/ &&
3914 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003915 if (ERROR("OPEN_BRACE",
3916 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3917 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3918 fix_delete_line($fixlinenr - 1, $prevrawline);
3919 fix_delete_line($fixlinenr, $rawline);
3920 my $fixedline = rtrim($prevrawline) . " {";
3921 fix_insert_line($fixlinenr, $fixedline);
3922 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003923 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003924 if ($fixedline !~ /^\+\s*$/) {
3925 fix_insert_line($fixlinenr, $fixedline);
3926 }
3927 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003928 }
3929
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003930# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003931 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3932 if (WARN("SPACING",
3933 "missing space after $1 definition\n" . $herecurr) &&
3934 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003935 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003936 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3937 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003938 }
3939
Joe Perches31070b52014-01-23 15:54:49 -08003940# Function pointer declarations
3941# check spacing between type, funcptr, and args
3942# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003943 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003944 my $declare = $1;
3945 my $pre_pointer_space = $2;
3946 my $post_pointer_space = $3;
3947 my $funcname = $4;
3948 my $post_funcname_space = $5;
3949 my $pre_args_space = $6;
3950
Joe Perches91f72e92014-04-03 14:49:12 -07003951# the $Declare variable will capture all spaces after the type
3952# so check it for a missing trailing missing space but pointer return types
3953# don't need a space so don't warn for those.
3954 my $post_declare_space = "";
3955 if ($declare =~ /(\s+)$/) {
3956 $post_declare_space = $1;
3957 $declare = rtrim($declare);
3958 }
3959 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003960 WARN("SPACING",
3961 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003962 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003963 }
3964
3965# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003966# This test is not currently implemented because these declarations are
3967# equivalent to
3968# int foo(int bar, ...)
3969# and this is form shouldn't/doesn't generate a checkpatch warning.
3970#
3971# elsif ($declare =~ /\s{2,}$/) {
3972# WARN("SPACING",
3973# "Multiple spaces after return type\n" . $herecurr);
3974# }
Joe Perches31070b52014-01-23 15:54:49 -08003975
3976# unnecessary space "type ( *funcptr)(args...)"
3977 if (defined $pre_pointer_space &&
3978 $pre_pointer_space =~ /^\s/) {
3979 WARN("SPACING",
3980 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3981 }
3982
3983# unnecessary space "type (* funcptr)(args...)"
3984 if (defined $post_pointer_space &&
3985 $post_pointer_space =~ /^\s/) {
3986 WARN("SPACING",
3987 "Unnecessary space before function pointer name\n" . $herecurr);
3988 }
3989
3990# unnecessary space "type (*funcptr )(args...)"
3991 if (defined $post_funcname_space &&
3992 $post_funcname_space =~ /^\s/) {
3993 WARN("SPACING",
3994 "Unnecessary space after function pointer name\n" . $herecurr);
3995 }
3996
3997# unnecessary space "type (*funcptr) (args...)"
3998 if (defined $pre_args_space &&
3999 $pre_args_space =~ /^\s/) {
4000 WARN("SPACING",
4001 "Unnecessary space before function pointer arguments\n" . $herecurr);
4002 }
4003
4004 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004005 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07004006 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08004007 }
4008 }
4009
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004010# check for spacing round square brackets; allowed:
4011# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004012# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4013# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004014 while ($line =~ /(.*?\s)\[/g) {
4015 my ($where, $prefix) = ($-[1], $1);
4016 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004017 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004018 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004019 if (ERROR("BRACKET_SPACE",
4020 "space prohibited before open square bracket '['\n" . $herecurr) &&
4021 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004022 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004023 s/^(\+.*?)\s+\[/$1\[/;
4024 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004025 }
4026 }
4027
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004028# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004029 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004030 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004031 my $ctx_before = substr($line, 0, $-[1]);
4032 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004033
4034 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004035 if ($name =~ /^(?:
4036 if|for|while|switch|return|case|
4037 volatile|__volatile__|
4038 __attribute__|format|__extension__|
4039 asm|__asm__)$/x)
4040 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004041 # cpp #define statements have non-optional spaces, ie
4042 # if there is a space between the name and the open
4043 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004044 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004045
4046 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004047 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004048
4049 # If this whole things ends with a type its most
4050 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004051 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004052
4053 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004054 if (WARN("SPACING",
4055 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4056 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004057 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004058 s/\b$name\s+\(/$name\(/;
4059 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004060 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004061 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004062
Andy Whitcroft653d4872007-06-23 17:16:34 -07004063# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004064 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004065 my $fixed_line = "";
4066 my $line_fixed = 0;
4067
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004068 my $ops = qr{
4069 <<=|>>=|<=|>=|==|!=|
4070 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4071 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004072 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004073 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004074 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004075 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004076
4077## print("element count: <" . $#elements . ">\n");
4078## foreach my $el (@elements) {
4079## print("el: <$el>\n");
4080## }
4081
4082 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004083 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004084
Joe Perches3705ce52013-07-03 15:05:31 -07004085 foreach my $el (@elements) {
4086 push(@fix_elements, substr($rawline, $off, length($el)));
4087 $off += length($el);
4088 }
4089
4090 $off = 0;
4091
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004092 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004093 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004094
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004095 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004096
4097 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4098
4099## print("n: <$n> good: <$good>\n");
4100
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004101 $off += length($elements[$n]);
4102
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004103 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004104 my $ca = substr($opline, 0, $off);
4105 my $cc = '';
4106 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4107 $cc = substr($opline, $off + length($elements[$n + 1]));
4108 }
4109 my $cb = "$ca$;$cc";
4110
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004111 my $a = '';
4112 $a = 'V' if ($elements[$n] ne '');
4113 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004114 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004115 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4116 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004117 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004118
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004119 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004120
4121 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004122 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004123 $c = 'V' if ($elements[$n + 2] ne '');
4124 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004125 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004126 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4127 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004128 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004129 } else {
4130 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004131 }
4132
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004133 my $ctx = "${a}x${c}";
4134
4135 my $at = "(ctx:$ctx)";
4136
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004137 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004138 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004139
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004140 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004141 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004142
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004143 # Get the full operator variant.
4144 my $opv = $op . substr($curr_vars, $off, 1);
4145
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004146 # Ignore operators passed as parameters.
4147 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004148 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004149
Andy Whitcroftcf655042008-03-04 14:28:20 -08004150# # Ignore comments
4151# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004152
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004153 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004154 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004155 if ($ctx !~ /.x[WEBC]/ &&
4156 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004157 if (ERROR("SPACING",
4158 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004159 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004160 $line_fixed = 1;
4161 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004162 }
4163
4164 # // is a comment
4165 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004166
Joe Perchesb00e4812014-04-03 14:49:33 -07004167 # : when part of a bitfield
4168 } elsif ($opv eq ':B') {
4169 # skip the bitfield test for now
4170
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004171 # No spaces for:
4172 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004173 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004174 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004175 if (ERROR("SPACING",
4176 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004177 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004178 if (defined $fix_elements[$n + 2]) {
4179 $fix_elements[$n + 2] =~ s/^\s+//;
4180 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004181 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004182 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004183 }
4184
Joe Perches23810972014-12-10 15:51:32 -08004185 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004186 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004187 my $rtrim_before = 0;
4188 my $space_after = 0;
4189 if ($ctx =~ /Wx./) {
4190 if (ERROR("SPACING",
4191 "space prohibited before that '$op' $at\n" . $hereptr)) {
4192 $line_fixed = 1;
4193 $rtrim_before = 1;
4194 }
4195 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004196 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004197 if (ERROR("SPACING",
4198 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004199 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004200 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004201 $space_after = 1;
4202 }
4203 }
4204 if ($rtrim_before || $space_after) {
4205 if ($rtrim_before) {
4206 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4207 } else {
4208 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4209 }
4210 if ($space_after) {
4211 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004212 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004213 }
4214
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004215 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004216 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004217 #warn "'*' is part of type\n";
4218
4219 # unary operators should have a space before and
4220 # none after. May be left adjacent to another
4221 # unary operator, or a cast
4222 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004223 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004224 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004225 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004226 if (ERROR("SPACING",
4227 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004228 if ($n != $last_after + 2) {
4229 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4230 $line_fixed = 1;
4231 }
Joe Perches3705ce52013-07-03 15:05:31 -07004232 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004233 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004234 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004235 # A unary '*' may be const
4236
4237 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004238 if (ERROR("SPACING",
4239 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004240 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004241 if (defined $fix_elements[$n + 2]) {
4242 $fix_elements[$n + 2] =~ s/^\s+//;
4243 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004244 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004245 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004246 }
4247
4248 # unary ++ and unary -- are allowed no space on one side.
4249 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004250 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004251 if (ERROR("SPACING",
4252 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004253 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004254 $line_fixed = 1;
4255 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004256 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004257 if ($ctx =~ /Wx[BE]/ ||
4258 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004259 if (ERROR("SPACING",
4260 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004261 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004262 $line_fixed = 1;
4263 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004264 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004265 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004266 if (ERROR("SPACING",
4267 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004268 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004269 if (defined $fix_elements[$n + 2]) {
4270 $fix_elements[$n + 2] =~ s/^\s+//;
4271 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004272 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004273 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004274 }
4275
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004276 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004277 } elsif ($op eq '<<' or $op eq '>>' or
4278 $op eq '&' or $op eq '^' or $op eq '|' or
4279 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004280 $op eq '*' or $op eq '/' or
4281 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004282 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004283 if ($check) {
4284 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4285 if (CHK("SPACING",
4286 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4287 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4288 $fix_elements[$n + 2] =~ s/^\s+//;
4289 $line_fixed = 1;
4290 }
4291 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4292 if (CHK("SPACING",
4293 "space preferred before that '$op' $at\n" . $hereptr)) {
4294 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4295 $line_fixed = 1;
4296 }
4297 }
4298 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004299 if (ERROR("SPACING",
4300 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004301 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4302 if (defined $fix_elements[$n + 2]) {
4303 $fix_elements[$n + 2] =~ s/^\s+//;
4304 }
Joe Perches3705ce52013-07-03 15:05:31 -07004305 $line_fixed = 1;
4306 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004307 }
4308
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004309 # A colon needs no spaces before when it is
4310 # terminating a case value or a label.
4311 } elsif ($opv eq ':C' || $opv eq ':L') {
4312 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004313 if (ERROR("SPACING",
4314 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004315 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004316 $line_fixed = 1;
4317 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004318 }
4319
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004320 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004321 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004322 my $ok = 0;
4323
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004324 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004325 if (($op eq '<' &&
4326 $cc =~ /^\S+\@\S+>/) ||
4327 ($op eq '>' &&
4328 $ca =~ /<\S+\@\S+$/))
4329 {
4330 $ok = 1;
4331 }
4332
Joe Perchese0df7e12015-04-16 12:44:53 -07004333 # for asm volatile statements
4334 # ignore a colon with another
4335 # colon immediately before or after
4336 if (($op eq ':') &&
4337 ($ca =~ /:$/ || $cc =~ /^:/)) {
4338 $ok = 1;
4339 }
4340
Joe Perches84731622013-11-12 15:10:05 -08004341 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004342 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004343 my $msg_level = \&ERROR;
4344 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004345
Jean Delvare0675a8f2017-09-08 16:16:07 -07004346 if (&{$msg_level}("SPACING",
4347 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004348 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4349 if (defined $fix_elements[$n + 2]) {
4350 $fix_elements[$n + 2] =~ s/^\s+//;
4351 }
Joe Perches3705ce52013-07-03 15:05:31 -07004352 $line_fixed = 1;
4353 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004354 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004355 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004356 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004357
4358## print("n: <$n> GOOD: <$good>\n");
4359
4360 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004361 }
Joe Perches3705ce52013-07-03 15:05:31 -07004362
4363 if (($#elements % 2) == 0) {
4364 $fixed_line = $fixed_line . $fix_elements[$#elements];
4365 }
4366
Joe Perches194f66f2014-08-06 16:11:03 -07004367 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4368 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004369 }
4370
4371
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004372 }
4373
Joe Perches786b6322013-07-03 15:05:32 -07004374# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004375 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004376 if (WARN("SPACING",
4377 "space prohibited before semicolon\n" . $herecurr) &&
4378 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004379 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004380 s/^(\+.*\S)\s+;/$1;/;
4381 }
4382 }
4383
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004384# check for multiple assignments
4385 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004386 CHK("MULTIPLE_ASSIGNMENTS",
4387 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004388 }
4389
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004390## # check for multiple declarations, allowing for a function declaration
4391## # continuation.
4392## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4393## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4394##
4395## # Remove any bracketed sections to ensure we do not
4396## # falsly report the parameters of functions.
4397## my $ln = $line;
4398## while ($ln =~ s/\([^\(\)]*\)//g) {
4399## }
4400## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004401## WARN("MULTIPLE_DECLARATION",
4402## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004403## }
4404## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004405
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004406#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004407 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004408 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004409 if (ERROR("SPACING",
4410 "space required before the open brace '{'\n" . $herecurr) &&
4411 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004412 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004413 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004414 }
4415
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004416## # check for blank lines before declarations
4417## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4418## $prevrawline =~ /^.\s*$/) {
4419## WARN("SPACING",
4420## "No blank lines before declarations\n" . $hereprev);
4421## }
4422##
4423
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004424# closing brace should have a space following it when it has anything
4425# on the line
4426 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004427 if (ERROR("SPACING",
4428 "space required after that close brace '}'\n" . $herecurr) &&
4429 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004430 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004431 s/}((?!(?:,|;|\)))\S)/} $1/;
4432 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004433 }
4434
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004435# check spacing on square brackets
4436 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004437 if (ERROR("SPACING",
4438 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4439 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004440 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004441 s/\[\s+/\[/;
4442 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004443 }
4444 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004445 if (ERROR("SPACING",
4446 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4447 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004448 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004449 s/\s+\]/\]/;
4450 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004451 }
4452
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004453# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004454 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4455 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004456 if (ERROR("SPACING",
4457 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4458 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004459 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004460 s/\(\s+/\(/;
4461 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004462 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004463 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004464 $line !~ /for\s*\(.*;\s+\)/ &&
4465 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004466 if (ERROR("SPACING",
4467 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4468 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004469 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004470 s/\s+\)/\)/;
4471 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004472 }
4473
Joe Perchese2826fd2014-08-06 16:10:48 -07004474# check unnecessary parentheses around addressof/dereference single $Lvals
4475# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4476
4477 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004478 my $var = $1;
4479 if (CHK("UNNECESSARY_PARENTHESES",
4480 "Unnecessary parentheses around $var\n" . $herecurr) &&
4481 $fix) {
4482 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4483 }
4484 }
4485
4486# check for unnecessary parentheses around function pointer uses
4487# ie: (foo->bar)(); should be foo->bar();
4488# but not "if (foo->bar) (" to avoid some false positives
4489 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4490 my $var = $2;
4491 if (CHK("UNNECESSARY_PARENTHESES",
4492 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4493 $fix) {
4494 my $var2 = deparenthesize($var);
4495 $var2 =~ s/\s//g;
4496 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4497 }
4498 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004499
Joe Perches63b7c732017-09-08 16:16:01 -07004500# check for unnecessary parentheses around comparisons in if uses
4501 if ($^V && $^V ge 5.10.0 && defined($stat) &&
4502 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4503 my $if_stat = $1;
4504 my $test = substr($2, 1, -1);
4505 my $herectx;
4506 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4507 my $match = $1;
4508 # avoid parentheses around potential macro args
4509 next if ($match =~ /^\s*\w+\s*$/);
4510 if (!defined($herectx)) {
4511 $herectx = $here . "\n";
4512 my $cnt = statement_rawlines($if_stat);
4513 for (my $n = 0; $n < $cnt; $n++) {
4514 my $rl = raw_line($linenr, $n);
4515 $herectx .= $rl . "\n";
4516 last if $rl =~ /^[ \+].*\{/;
4517 }
4518 }
4519 CHK("UNNECESSARY_PARENTHESES",
4520 "Unnecessary parentheses around '$match'\n" . $herectx);
4521 }
4522 }
4523
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004524#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004525 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004526 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004527 if (WARN("INDENTED_LABEL",
4528 "labels should not be indented\n" . $herecurr) &&
4529 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004530 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004531 s/^(.)\s+/$1/;
4532 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004533 }
4534
Joe Perches5b9553a2014-04-03 14:49:21 -07004535# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004536 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004537 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004538 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004539 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4540 my $value = $1;
4541 $value = deparenthesize($value);
4542 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4543 ERROR("RETURN_PARENTHESES",
4544 "return is not a function, parentheses are not required\n" . $herecurr);
4545 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004546 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004547 ERROR("SPACING",
4548 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004549 }
4550 }
Joe Perches507e5142013-11-12 15:10:13 -08004551
Joe Perchesb43ae212014-06-23 13:22:07 -07004552# unnecessary return in a void function
4553# at end-of-function, with the previous line a single leading tab, then return;
4554# and the line before that not a goto label target like "out:"
4555 if ($sline =~ /^[ \+]}\s*$/ &&
4556 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4557 $linenr >= 3 &&
4558 $lines[$linenr - 3] =~ /^[ +]/ &&
4559 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004560 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004561 "void function return statements are not generally useful\n" . $hereprev);
4562 }
Joe Perches9819cf22014-06-04 16:12:09 -07004563
Joe Perches189248d2014-01-23 15:54:47 -08004564# if statements using unnecessary parentheses - ie: if ((foo == bar))
4565 if ($^V && $^V ge 5.10.0 &&
4566 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4567 my $openparens = $1;
4568 my $count = $openparens =~ tr@\(@\(@;
4569 my $msg = "";
4570 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4571 my $comp = $4; #Not $1 because of $LvalOrFunc
4572 $msg = " - maybe == should be = ?" if ($comp eq "==");
4573 WARN("UNNECESSARY_PARENTHESES",
4574 "Unnecessary parentheses$msg\n" . $herecurr);
4575 }
4576 }
4577
Joe Perchesc5595fa2015-09-09 15:37:58 -07004578# comparisons with a constant or upper case identifier on the left
4579# avoid cases like "foo + BAR < baz"
4580# only fix matches surrounded by parentheses to avoid incorrect
4581# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4582 if ($^V && $^V ge 5.10.0 &&
4583 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4584 my $lead = $1;
4585 my $const = $2;
4586 my $comp = $3;
4587 my $to = $4;
4588 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004589 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004590 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4591 WARN("CONSTANT_COMPARISON",
4592 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4593 $fix) {
4594 if ($comp eq "<") {
4595 $newcomp = ">";
4596 } elsif ($comp eq "<=") {
4597 $newcomp = ">=";
4598 } elsif ($comp eq ">") {
4599 $newcomp = "<";
4600 } elsif ($comp eq ">=") {
4601 $newcomp = "<=";
4602 }
4603 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4604 }
4605 }
4606
Joe Perchesf34e4a42015-04-16 12:44:19 -07004607# Return of what appears to be an errno should normally be negative
4608 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004609 my $name = $1;
4610 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004611 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004612 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004613 }
4614 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004615
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004616# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004617 if ($line =~ /\b(if|while|for|switch)\(/) {
4618 if (ERROR("SPACING",
4619 "space required before the open parenthesis '('\n" . $herecurr) &&
4620 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004621 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004622 s/\b(if|while|for|switch)\(/$1 \(/;
4623 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004624 }
4625
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004626# Check for illegal assignment in if conditional -- and check for trailing
4627# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004628 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004629 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4630 ctx_statement_block($linenr, $realcnt, 0)
4631 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004632 my ($stat_next) = ctx_statement_block($line_nr_next,
4633 $remain_next, $off_next);
4634 $stat_next =~ s/\n./\n /g;
4635 ##print "stat<$stat> stat_next<$stat_next>\n";
4636
4637 if ($stat_next =~ /^\s*while\b/) {
4638 # If the statement carries leading newlines,
4639 # then count those as offsets.
4640 my ($whitespace) =
4641 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4642 my $offset =
4643 statement_rawlines($whitespace) - 1;
4644
4645 $suppress_whiletrailers{$line_nr_next +
4646 $offset} = 1;
4647 }
4648 }
4649 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004650 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004651 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004652 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004653
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004654 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004655 ERROR("ASSIGN_IN_IF",
4656 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004657 }
4658
4659 # Find out what is on the end of the line after the
4660 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004661 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004662 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004663 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004664 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4665 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004666 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004667 # Find out how long the conditional actually is.
4668 my @newlines = ($c =~ /\n/gs);
4669 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004670 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004671
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004672 $stat_real = raw_line($linenr, $cond_lines)
4673 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004674 if (defined($stat_real) && $cond_lines > 1) {
4675 $stat_real = "[...]\n$stat_real";
4676 }
4677
Joe Perches000d1cc12011-07-25 17:13:25 -07004678 ERROR("TRAILING_STATEMENTS",
4679 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004680 }
4681 }
4682
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004683# Check for bitwise tests written as boolean
4684 if ($line =~ /
4685 (?:
4686 (?:\[|\(|\&\&|\|\|)
4687 \s*0[xX][0-9]+\s*
4688 (?:\&\&|\|\|)
4689 |
4690 (?:\&\&|\|\|)
4691 \s*0[xX][0-9]+\s*
4692 (?:\&\&|\|\||\)|\])
4693 )/x)
4694 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004695 WARN("HEXADECIMAL_BOOLEAN_TEST",
4696 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004697 }
4698
Andy Whitcroft8905a672007-11-28 16:21:06 -08004699# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004700 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4701 my $s = $1;
4702 $s =~ s/$;//g; # Remove any comments
4703 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004704 ERROR("TRAILING_STATEMENTS",
4705 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004706 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004707 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004708# if should not continue a brace
4709 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004710 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004711 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004712 $herecurr);
4713 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004714# case and default should not have general statements after them
4715 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4716 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004717 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004718 \s*return\s+
4719 )/xg)
4720 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004721 ERROR("TRAILING_STATEMENTS",
4722 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004723 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004724
4725 # Check for }<nl>else {, these must be at the same
4726 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004727 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4728 $previndent == $indent) {
4729 if (ERROR("ELSE_AFTER_BRACE",
4730 "else should follow close brace '}'\n" . $hereprev) &&
4731 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4732 fix_delete_line($fixlinenr - 1, $prevrawline);
4733 fix_delete_line($fixlinenr, $rawline);
4734 my $fixedline = $prevrawline;
4735 $fixedline =~ s/}\s*$//;
4736 if ($fixedline !~ /^\+\s*$/) {
4737 fix_insert_line($fixlinenr, $fixedline);
4738 }
4739 $fixedline = $rawline;
4740 $fixedline =~ s/^(.\s*)else/$1} else/;
4741 fix_insert_line($fixlinenr, $fixedline);
4742 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004743 }
4744
Joe Perches8b8856f2014-08-06 16:11:14 -07004745 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4746 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004747 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4748
4749 # Find out what is on the end of the line after the
4750 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004751 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004752 $s =~ s/\n.*//g;
4753
4754 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004755 if (ERROR("WHILE_AFTER_BRACE",
4756 "while should follow close brace '}'\n" . $hereprev) &&
4757 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4758 fix_delete_line($fixlinenr - 1, $prevrawline);
4759 fix_delete_line($fixlinenr, $rawline);
4760 my $fixedline = $prevrawline;
4761 my $trailing = $rawline;
4762 $trailing =~ s/^\+//;
4763 $trailing = trim($trailing);
4764 $fixedline =~ s/}\s*$/} $trailing/;
4765 fix_insert_line($fixlinenr, $fixedline);
4766 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004767 }
4768 }
4769
Joe Perches95e2c602013-07-03 15:05:20 -07004770#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004771 while ($line =~ m{($Constant|$Lval)}g) {
4772 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004773
4774#gcc binary extension
4775 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004776 if (WARN("GCC_BINARY_CONSTANT",
4777 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4778 $fix) {
4779 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004780 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004781 s/\b$var\b/$hexval/;
4782 }
Joe Perches95e2c602013-07-03 15:05:20 -07004783 }
4784
4785#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004786 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004787 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004788#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004789 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004790#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004791 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4792#Ignore some three character SI units explicitly, like MiB and KHz
4793 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004794 while ($var =~ m{($Ident)}g) {
4795 my $word = $1;
4796 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004797 if ($check) {
4798 seed_camelcase_includes();
4799 if (!$file && !$camelcase_file_seeded) {
4800 seed_camelcase_file($realfile);
4801 $camelcase_file_seeded = 1;
4802 }
4803 }
Joe Perches7e781f62013-09-11 14:23:55 -07004804 if (!defined $camelcase{$word}) {
4805 $camelcase{$word} = 1;
4806 CHK("CAMELCASE",
4807 "Avoid CamelCase: <$word>\n" . $herecurr);
4808 }
Joe Perches34456862013-07-03 15:05:34 -07004809 }
Joe Perches323c1262012-12-17 16:02:07 -08004810 }
4811 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004812
4813#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004814 if ($line =~ /\#\s*define.*\\\s+$/) {
4815 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4816 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4817 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004818 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004819 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004820 }
4821
Fabian Frederick0e212e02015-04-16 12:44:25 -07004822# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4823# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004824 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004825 my $file = "$1.h";
4826 my $checkfile = "include/linux/$file";
4827 if (-f "$root/$checkfile" &&
4828 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004829 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004830 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004831 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4832 if ($asminclude > 0) {
4833 if ($realfile =~ m{^arch/}) {
4834 CHK("ARCH_INCLUDE_LINUX",
4835 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4836 } else {
4837 WARN("INCLUDE_LINUX",
4838 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4839 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004840 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004841 }
4842 }
4843
Andy Whitcroft653d4872007-06-23 17:16:34 -07004844# multi-statement macros should be enclosed in a do while loop, grab the
4845# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004846# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004847 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4848 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004849 my $ln = $linenr;
4850 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004851 my ($off, $dstat, $dcond, $rest);
4852 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004853 my $has_flow_statement = 0;
4854 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004855 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004856 ctx_statement_block($linenr, $realcnt, 0);
4857 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004858 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004859 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004860
Joe Perches08a28432014-10-13 15:51:55 -07004861 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004862 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004863
Joe Perchesf59b64b2016-10-11 13:52:08 -07004864 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4865 my $define_args = $1;
4866 my $define_stmt = $dstat;
4867 my @def_args = ();
4868
4869 if (defined $define_args && $define_args ne "") {
4870 $define_args = substr($define_args, 1, length($define_args) - 2);
4871 $define_args =~ s/\s*//g;
4872 @def_args = split(",", $define_args);
4873 }
4874
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004875 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004876 $dstat =~ s/\\\n.//g;
4877 $dstat =~ s/^\s*//s;
4878 $dstat =~ s/\s*$//s;
4879
4880 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004881 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4882 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004883 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004884 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004885 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004886
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004887 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004888 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4889 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004890 {
4891 }
4892
Joe Perches42e15292016-03-15 14:58:01 -07004893 # Make asm volatile uses seem like a generic function
4894 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4895
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004896 my $exceptions = qr{
4897 $Declare|
4898 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004899 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004900 DECLARE_PER_CPU|
4901 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004902 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004903 union|
4904 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004905 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004906 ^\"|\"$|
4907 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004908 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004909 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004910
4911 $ctx =~ s/\n*$//;
4912 my $herectx = $here . "\n";
4913 my $stmt_cnt = statement_rawlines($ctx);
4914
4915 for (my $n = 0; $n < $stmt_cnt; $n++) {
4916 $herectx .= raw_line($linenr, $n) . "\n";
4917 }
4918
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004919 if ($dstat ne '' &&
4920 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4921 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004922 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004923 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004924 $dstat !~ /$exceptions/ &&
4925 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004926 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004927 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004928 $dstat !~ /^for\s*$Constant$/ && # for (...)
4929 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4930 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004931 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004932 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004933 {
Joe Perchese7955562017-05-08 15:55:48 -07004934 if ($dstat =~ /^\s*if\b/) {
4935 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4936 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4937 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004938 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4939 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4940 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004941 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004942 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004943 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004944
4945 }
Joe Perches52076492016-10-11 13:52:14 -07004946
4947 # Make $define_stmt single line, comment-free, etc
4948 my @stmt_array = split('\n', $define_stmt);
4949 my $first = 1;
4950 $define_stmt = "";
4951 foreach my $l (@stmt_array) {
4952 $l =~ s/\\$//;
4953 if ($first) {
4954 $define_stmt = $l;
4955 $first = 0;
4956 } elsif ($l =~ /^[\+ ]/) {
4957 $define_stmt .= substr($l, 1);
4958 }
4959 }
4960 $define_stmt =~ s/$;//g;
4961 $define_stmt =~ s/\s+/ /g;
4962 $define_stmt = trim($define_stmt);
4963
Joe Perchesf59b64b2016-10-11 13:52:08 -07004964# check if any macro arguments are reused (ignore '...' and 'type')
4965 foreach my $arg (@def_args) {
4966 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07004967 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07004968 my $tmp_stmt = $define_stmt;
4969 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4970 $tmp_stmt =~ s/\#+\s*$arg\b//g;
4971 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
4972 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004973 if ($use_cnt > 1) {
4974 CHK("MACRO_ARG_REUSE",
4975 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07004976 }
4977# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07004978 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07004979 ((defined($1) && $1 ne ',') ||
4980 (defined($2) && $2 ne ','))) {
4981 CHK("MACRO_ARG_PRECEDENCE",
4982 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07004983 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004984 }
Joe Perches5023d342012-12-17 16:01:47 -08004985
Joe Perches08a28432014-10-13 15:51:55 -07004986# check for macros with flow control, but without ## concatenation
4987# ## concatenation is commonly a macro that defines a function so ignore those
4988 if ($has_flow_statement && !$has_arg_concat) {
4989 my $herectx = $here . "\n";
4990 my $cnt = statement_rawlines($ctx);
4991
4992 for (my $n = 0; $n < $cnt; $n++) {
4993 $herectx .= raw_line($linenr, $n) . "\n";
4994 }
4995 WARN("MACRO_WITH_FLOW_CONTROL",
4996 "Macros with flow control statements should be avoided\n" . "$herectx");
4997 }
4998
Joe Perches481eb482012-12-17 16:01:56 -08004999# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08005000
5001 } else {
5002 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08005003 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
5004 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08005005 $line =~ /^\+.*\\$/) {
5006 WARN("LINE_CONTINUATIONS",
5007 "Avoid unnecessary line continuations\n" . $herecurr);
5008 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005009 }
5010
Joe Perchesb13edf72012-07-30 14:41:24 -07005011# do {} while (0) macro tests:
5012# single-statement macros do not need to be enclosed in do while (0) loop,
5013# macro should not end with a semicolon
5014 if ($^V && $^V ge 5.10.0 &&
5015 $realfile !~ m@/vmlinux.lds.h$@ &&
5016 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5017 my $ln = $linenr;
5018 my $cnt = $realcnt;
5019 my ($off, $dstat, $dcond, $rest);
5020 my $ctx = '';
5021 ($dstat, $dcond, $ln, $cnt, $off) =
5022 ctx_statement_block($linenr, $realcnt, 0);
5023 $ctx = $dstat;
5024
5025 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005026 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005027
5028 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5029 my $stmts = $2;
5030 my $semis = $3;
5031
5032 $ctx =~ s/\n*$//;
5033 my $cnt = statement_rawlines($ctx);
5034 my $herectx = $here . "\n";
5035
5036 for (my $n = 0; $n < $cnt; $n++) {
5037 $herectx .= raw_line($linenr, $n) . "\n";
5038 }
5039
Joe Perchesac8e97f2012-08-21 16:15:53 -07005040 if (($stmts =~ tr/;/;/) == 1 &&
5041 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005042 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5043 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5044 }
5045 if (defined $semis && $semis ne "") {
5046 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5047 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5048 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005049 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5050 $ctx =~ s/\n*$//;
5051 my $cnt = statement_rawlines($ctx);
5052 my $herectx = $here . "\n";
5053
5054 for (my $n = 0; $n < $cnt; $n++) {
5055 $herectx .= raw_line($linenr, $n) . "\n";
5056 }
5057
5058 WARN("TRAILING_SEMICOLON",
5059 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005060 }
5061 }
5062
Mike Frysinger080ba922009-01-06 14:41:25 -08005063# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5064# all assignments may have only one of the following with an assignment:
5065# .
5066# ALIGN(...)
5067# VMLINUX_SYMBOL(...)
5068 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005069 WARN("MISSING_VMLINUX_SYMBOL",
5070 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005071 }
5072
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005073# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005074 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5075 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005076 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005077 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005078 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5079 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005080 my @allowed = ();
5081 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005082 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005083 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005084 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005085 for my $chunk (@chunks) {
5086 my ($cond, $block) = @{$chunk};
5087
Andy Whitcroft773647a2008-03-28 14:15:58 -07005088 # If the condition carries leading newlines, then count those as offsets.
5089 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5090 my $offset = statement_rawlines($whitespace) - 1;
5091
Joe Perchesaad4f612012-03-23 15:02:19 -07005092 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005093 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5094
5095 # We have looked at and allowed this specific line.
5096 $suppress_ifbraces{$ln + $offset} = 1;
5097
5098 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005099 $ln += statement_rawlines($block) - 1;
5100
Andy Whitcroft773647a2008-03-28 14:15:58 -07005101 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005102
5103 $seen++ if ($block =~ /^\s*{/);
5104
Joe Perchesaad4f612012-03-23 15:02:19 -07005105 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005106 if (statement_lines($cond) > 1) {
5107 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005108 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005109 }
5110 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005111 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005112 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005113 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005114 if (statement_block_size($block) > 1) {
5115 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005116 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005117 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005118 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005119 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005120 if ($seen) {
5121 my $sum_allowed = 0;
5122 foreach (@allowed) {
5123 $sum_allowed += $_;
5124 }
5125 if ($sum_allowed == 0) {
5126 WARN("BRACES",
5127 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5128 } elsif ($sum_allowed != $allow &&
5129 $seen != $allow) {
5130 CHK("BRACES",
5131 "braces {} should be used on all arms of this statement\n" . $herectx);
5132 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005133 }
5134 }
5135 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005136 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005137 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005138 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005139
Andy Whitcroftcf655042008-03-04 14:28:20 -08005140 # Check the pre-context.
5141 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5142 #print "APW: ALLOWED: pre<$1>\n";
5143 $allowed = 1;
5144 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005145
5146 my ($level, $endln, @chunks) =
5147 ctx_statement_full($linenr, $realcnt, $-[0]);
5148
Andy Whitcroftcf655042008-03-04 14:28:20 -08005149 # Check the condition.
5150 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005151 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005152 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005153 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005154 }
5155 if (statement_lines($cond) > 1) {
5156 #print "APW: ALLOWED: cond<$cond>\n";
5157 $allowed = 1;
5158 }
5159 if ($block =~/\b(?:if|for|while)\b/) {
5160 #print "APW: ALLOWED: block<$block>\n";
5161 $allowed = 1;
5162 }
5163 if (statement_block_size($block) > 1) {
5164 #print "APW: ALLOWED: lines block<$block>\n";
5165 $allowed = 1;
5166 }
5167 # Check the post-context.
5168 if (defined $chunks[1]) {
5169 my ($cond, $block) = @{$chunks[1]};
5170 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005171 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005172 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005173 if ($block =~ /^\s*\{/) {
5174 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5175 $allowed = 1;
5176 }
5177 }
5178 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005179 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005180 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005181
Andy Whitcroftf0556632008-10-15 22:02:23 -07005182 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005183 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005184 }
5185
Joe Perches000d1cc12011-07-25 17:13:25 -07005186 WARN("BRACES",
5187 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005188 }
5189 }
5190
Joe Perchese4c5bab2017-02-24 15:01:41 -08005191# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005192 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5193 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005194 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5195 }
5196
Joe Perches0979ae62012-12-17 16:01:59 -08005197# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005198 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005199 if (CHK("BRACES",
5200 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5201 $fix && $prevrawline =~ /^\+/) {
5202 fix_delete_line($fixlinenr - 1, $prevrawline);
5203 }
Joe Perches0979ae62012-12-17 16:01:59 -08005204 }
Joe Perches77b9a532013-07-03 15:05:29 -07005205 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005206 if (CHK("BRACES",
5207 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5208 $fix) {
5209 fix_delete_line($fixlinenr, $rawline);
5210 }
Joe Perches0979ae62012-12-17 16:01:59 -08005211 }
5212
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005213# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005214 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5215 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005216 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005217 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005218 }
5219
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005220# Check for user-visible strings broken across lines, which breaks the ability
5221# to grep for the string. Make exceptions when the previous string ends in a
5222# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5223# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005224 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005225 $prevline =~ /"\s*$/ &&
5226 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5227 if (WARN("SPLIT_STRING",
5228 "quoted string split across lines\n" . $hereprev) &&
5229 $fix &&
5230 $prevrawline =~ /^\+.*"\s*$/ &&
5231 $last_coalesced_string_linenr != $linenr - 1) {
5232 my $extracted_string = get_quoted_string($line, $rawline);
5233 my $comma_close = "";
5234 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5235 $comma_close = $1;
5236 }
5237
5238 fix_delete_line($fixlinenr - 1, $prevrawline);
5239 fix_delete_line($fixlinenr, $rawline);
5240 my $fixedline = $prevrawline;
5241 $fixedline =~ s/"\s*$//;
5242 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5243 fix_insert_line($fixlinenr - 1, $fixedline);
5244 $fixedline = $rawline;
5245 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5246 if ($fixedline !~ /\+\s*$/) {
5247 fix_insert_line($fixlinenr, $fixedline);
5248 }
5249 $last_coalesced_string_linenr = $linenr;
5250 }
5251 }
5252
5253# check for missing a space in a string concatenation
5254 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5255 WARN('MISSING_SPACE',
5256 "break quoted strings at a space character\n" . $hereprev);
5257 }
5258
Joe Perchese4b7d302017-05-08 15:55:51 -07005259# check for an embedded function name in a string when the function is known
5260# This does not work very well for -f --file checking as it depends on patch
5261# context providing the function name or a single line form for in-file
5262# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005263 if ($line =~ /^\+.*$String/ &&
5264 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005265 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5266 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005267 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005268 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005269 }
5270
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005271# check for spaces before a quoted newline
5272 if ($rawline =~ /^.*\".*\s\\n/) {
5273 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5274 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5275 $fix) {
5276 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5277 }
5278
5279 }
5280
Joe Perchesf17dba42014-10-13 15:51:51 -07005281# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005282 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005283 CHK("CONCATENATED_STRING",
5284 "Concatenated strings should use spaces between elements\n" . $herecurr);
5285 }
5286
Joe Perches90ad30e2014-12-10 15:51:59 -08005287# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005288 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005289 WARN("STRING_FRAGMENTS",
5290 "Consecutive strings are generally better as a single string\n" . $herecurr);
5291 }
5292
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005293# check for non-standard and hex prefixed decimal printf formats
5294 my $show_L = 1; #don't show the same defect twice
5295 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005296 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005297 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005298 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005299 # check for %L
5300 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005301 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005302 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5303 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005304 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005305 # check for %Z
5306 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5307 WARN("PRINTF_Z",
5308 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5309 $show_Z = 0;
5310 }
5311 # check for 0x<decimal>
5312 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5313 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005314 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5315 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005316 }
5317
5318# check for line continuations in quoted strings with odd counts of "
5319 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5320 WARN("LINE_CONTINUATIONS",
5321 "Avoid line continuations in quoted strings\n" . $herecurr);
5322 }
5323
Andy Whitcroft00df3442007-06-08 13:47:06 -07005324# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005325 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005326 CHK("REDUNDANT_CODE",
5327 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005328 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005329 }
5330
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005331# check for needless "if (<foo>) fn(<foo>)" uses
5332 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005333 my $tested = quotemeta($1);
5334 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5335 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5336 my $func = $1;
5337 if (WARN('NEEDLESS_IF',
5338 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5339 $fix) {
5340 my $do_fix = 1;
5341 my $leading_tabs = "";
5342 my $new_leading_tabs = "";
5343 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5344 $leading_tabs = $1;
5345 } else {
5346 $do_fix = 0;
5347 }
5348 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5349 $new_leading_tabs = $1;
5350 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5351 $do_fix = 0;
5352 }
5353 } else {
5354 $do_fix = 0;
5355 }
5356 if ($do_fix) {
5357 fix_delete_line($fixlinenr - 1, $prevrawline);
5358 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5359 }
5360 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005361 }
5362 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005363
Joe Perchesebfdc402014-08-06 16:10:27 -07005364# check for unnecessary "Out of Memory" messages
5365 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5366 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5367 (defined $1 || defined $3) &&
5368 $linenr > 3) {
5369 my $testval = $2;
5370 my $testline = $lines[$linenr - 3];
5371
5372 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5373# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5374
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005375 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 -07005376 WARN("OOM_MESSAGE",
5377 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5378 }
5379 }
5380
Joe Perchesf78d98f2014-10-13 15:52:01 -07005381# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005382 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005383 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5384 my $level = $1;
5385 if (WARN("UNNECESSARY_KERN_LEVEL",
5386 "Possible unnecessary $level\n" . $herecurr) &&
5387 $fix) {
5388 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5389 }
5390 }
5391
Joe Perches45c55e92017-02-24 15:01:31 -08005392# check for logging continuations
5393 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5394 WARN("LOGGING_CONTINUATION",
5395 "Avoid logging continuation uses where feasible\n" . $herecurr);
5396 }
5397
Joe Perchesabb08a52014-12-10 15:51:46 -08005398# check for mask then right shift without a parentheses
5399 if ($^V && $^V ge 5.10.0 &&
5400 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5401 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5402 WARN("MASK_THEN_SHIFT",
5403 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5404 }
5405
Joe Perchesb75ac612014-12-10 15:52:02 -08005406# check for pointer comparisons to NULL
5407 if ($^V && $^V ge 5.10.0) {
5408 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5409 my $val = $1;
5410 my $equal = "!";
5411 $equal = "" if ($4 eq "!=");
5412 if (CHK("COMPARISON_TO_NULL",
5413 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5414 $fix) {
5415 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5416 }
5417 }
5418 }
5419
Joe Perches8716de32013-09-11 14:24:05 -07005420# check for bad placement of section $InitAttribute (e.g.: __initdata)
5421 if ($line =~ /(\b$InitAttribute\b)/) {
5422 my $attr = $1;
5423 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5424 my $ptr = $1;
5425 my $var = $2;
5426 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5427 ERROR("MISPLACED_INIT",
5428 "$attr should be placed after $var\n" . $herecurr)) ||
5429 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5430 WARN("MISPLACED_INIT",
5431 "$attr should be placed after $var\n" . $herecurr))) &&
5432 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005433 $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 -07005434 }
5435 }
5436 }
5437
Joe Perchese970b8842013-11-12 15:10:10 -08005438# check for $InitAttributeData (ie: __initdata) with const
5439 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5440 my $attr = $1;
5441 $attr =~ /($InitAttributePrefix)(.*)/;
5442 my $attr_prefix = $1;
5443 my $attr_type = $2;
5444 if (ERROR("INIT_ATTRIBUTE",
5445 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5446 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005447 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005448 s/$InitAttributeData/${attr_prefix}initconst/;
5449 }
5450 }
5451
5452# check for $InitAttributeConst (ie: __initconst) without const
5453 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5454 my $attr = $1;
5455 if (ERROR("INIT_ATTRIBUTE",
5456 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5457 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005458 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005459 /(^\+\s*(?:static\s+))/;
5460 $lead = rtrim($1);
5461 $lead = "$lead " if ($lead !~ /^\+$/);
5462 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005463 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005464 }
5465 }
5466
Joe Perchesc17893c2015-04-16 12:44:42 -07005467# check for __read_mostly with const non-pointer (should just be const)
5468 if ($line =~ /\b__read_mostly\b/ &&
5469 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5470 if (ERROR("CONST_READ_MOSTLY",
5471 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5472 $fix) {
5473 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5474 }
5475 }
5476
Joe Perchesfbdb8132014-04-03 14:49:14 -07005477# don't use __constant_<foo> functions outside of include/uapi/
5478 if ($realfile !~ m@^include/uapi/@ &&
5479 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5480 my $constant_func = $1;
5481 my $func = $constant_func;
5482 $func =~ s/^__constant_//;
5483 if (WARN("CONSTANT_CONVERSION",
5484 "$constant_func should be $func\n" . $herecurr) &&
5485 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005486 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005487 }
5488 }
5489
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005490# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005491 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005492 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005493 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005494 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005495 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005496 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5497 }
5498 if ($delay > 2000) {
5499 WARN("LONG_UDELAY",
5500 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005501 }
5502 }
5503
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005504# warn about unexpectedly long msleep's
5505 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5506 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005507 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005508 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005509 }
5510 }
5511
Joe Perches36ec1932013-07-03 15:05:25 -07005512# check for comparisons of jiffies
5513 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5514 WARN("JIFFIES_COMPARISON",
5515 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5516 }
5517
Joe Perches9d7a34a2013-07-03 15:05:26 -07005518# check for comparisons of get_jiffies_64()
5519 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5520 WARN("JIFFIES_COMPARISON",
5521 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5522 }
5523
Andy Whitcroft00df3442007-06-08 13:47:06 -07005524# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005525# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005526# print "#ifdef in C files should be avoided\n";
5527# print "$herecurr";
5528# $clean = 0;
5529# }
5530
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005531# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005532 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005533 if (ERROR("SPACING",
5534 "exactly one space required after that #$1\n" . $herecurr) &&
5535 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005536 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005537 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5538 }
5539
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005540 }
5541
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005542# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005543 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5544 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005545 my $which = $1;
5546 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005547 CHK("UNCOMMENTED_DEFINITION",
5548 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005549 }
5550 }
5551# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005552
5553 my $barriers = qr{
5554 mb|
5555 rmb|
5556 wmb|
5557 read_barrier_depends
5558 }x;
5559 my $barrier_stems = qr{
5560 mb__before_atomic|
5561 mb__after_atomic|
5562 store_release|
5563 load_acquire|
5564 store_mb|
5565 (?:$barriers)
5566 }x;
5567 my $all_barriers = qr{
5568 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005569 smp_(?:$barrier_stems)|
5570 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005571 }x;
5572
5573 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005574 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005575 WARN("MEMORY_BARRIER",
5576 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005577 }
5578 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005579
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005580 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5581
5582 if ($realfile !~ m@^include/asm-generic/@ &&
5583 $realfile !~ m@/barrier\.h$@ &&
5584 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5585 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5586 WARN("MEMORY_BARRIER",
5587 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5588 }
5589
Joe Perchescb426e92015-06-25 15:02:46 -07005590# check for waitqueue_active without a comment.
5591 if ($line =~ /\bwaitqueue_active\s*\(/) {
5592 if (!ctx_has_comment($first_line, $linenr)) {
5593 WARN("WAITQUEUE_ACTIVE",
5594 "waitqueue_active without comment\n" . $herecurr);
5595 }
5596 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005597
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005598# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005599 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005600 CHK("ARCH_DEFINES",
5601 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005602 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005603
Joe Perches596ed452017-07-12 14:37:02 -07005604# check that the storage class is not after a type
5605 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005606 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005607 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5608 }
5609# Check that the storage class is at the beginning of a declaration
5610 if ($line =~ /\b$Storage\b/ &&
5611 $line !~ /^.\s*$Storage/ &&
5612 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5613 $1 !~ /[\,\)]\s*$/) {
5614 WARN("STORAGE_CLASS",
5615 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005616 }
5617
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005618# check the location of the inline attribute, that it is between
5619# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005620 if ($line =~ /\b$Type\s+$Inline\b/ ||
5621 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005622 ERROR("INLINE_LOCATION",
5623 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005624 }
5625
Andy Whitcroft8905a672007-11-28 16:21:06 -08005626# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005627 if ($realfile !~ m@\binclude/uapi/@ &&
5628 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005629 if (WARN("INLINE",
5630 "plain inline is preferred over $1\n" . $herecurr) &&
5631 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005632 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005633
5634 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005635 }
5636
Joe Perches3d130fd2011-01-12 17:00:00 -08005637# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005638 if ($realfile !~ m@\binclude/uapi/@ &&
5639 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005640 WARN("PREFER_PACKED",
5641 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005642 }
5643
Joe Perches39b7e282011-07-25 17:13:24 -07005644# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005645 if ($realfile !~ m@\binclude/uapi/@ &&
5646 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005647 WARN("PREFER_ALIGNED",
5648 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005649 }
5650
Joe Perches5f14d3b2012-01-10 15:09:52 -08005651# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005652 if ($realfile !~ m@\binclude/uapi/@ &&
5653 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005654 if (WARN("PREFER_PRINTF",
5655 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5656 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005657 $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 -07005658
5659 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005660 }
5661
Joe Perches6061d942012-03-23 15:02:16 -07005662# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005663 if ($realfile !~ m@\binclude/uapi/@ &&
5664 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005665 if (WARN("PREFER_SCANF",
5666 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5667 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005668 $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 -07005669 }
Joe Perches6061d942012-03-23 15:02:16 -07005670 }
5671
Joe Perches619a9082014-12-10 15:51:35 -08005672# Check for __attribute__ weak, or __weak declarations (may have link issues)
5673 if ($^V && $^V ge 5.10.0 &&
5674 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5675 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5676 $line =~ /\b__weak\b/)) {
5677 ERROR("WEAK_DECLARATION",
5678 "Using weak declarations can have unintended link defects\n" . $herecurr);
5679 }
5680
Tomas Winklerfd39f902016-12-12 16:46:34 -08005681# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005682 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005683 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005684 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5685 my $type = $1;
5686 if ($type =~ /\b($typeC99Typedefs)\b/) {
5687 $type = $1;
5688 my $kernel_type = 'u';
5689 $kernel_type = 's' if ($type =~ /^_*[si]/);
5690 $type =~ /(\d+)/;
5691 $kernel_type .= $1;
5692 if (CHK("PREFER_KERNEL_TYPES",
5693 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5694 $fix) {
5695 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5696 }
5697 }
5698 }
5699
Joe Perches938224b2016-01-20 14:59:15 -08005700# check for cast of C90 native int or longer types constants
5701 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5702 my $cast = $1;
5703 my $const = $2;
5704 if (WARN("TYPECAST_INT_CONSTANT",
5705 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5706 $fix) {
5707 my $suffix = "";
5708 my $newconst = $const;
5709 $newconst =~ s/${Int_type}$//;
5710 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5711 if ($cast =~ /\blong\s+long\b/) {
5712 $suffix .= 'LL';
5713 } elsif ($cast =~ /\blong\b/) {
5714 $suffix .= 'L';
5715 }
5716 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5717 }
5718 }
5719
Joe Perches8f53a9b2010-03-05 13:43:48 -08005720# check for sizeof(&)
5721 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005722 WARN("SIZEOF_ADDRESS",
5723 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005724 }
5725
Joe Perches66c80b62012-07-30 14:41:22 -07005726# check for sizeof without parenthesis
5727 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005728 if (WARN("SIZEOF_PARENTHESIS",
5729 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5730 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005731 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005732 }
Joe Perches66c80b62012-07-30 14:41:22 -07005733 }
5734
Joe Perches88982fe2012-12-17 16:02:00 -08005735# check for struct spinlock declarations
5736 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5737 WARN("USE_SPINLOCK_T",
5738 "struct spinlock should be spinlock_t\n" . $herecurr);
5739 }
5740
Joe Perchesa6962d72013-04-29 16:18:13 -07005741# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005742 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005743 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005744 $fmt =~ s/%%//g;
5745 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005746 if (WARN("PREFER_SEQ_PUTS",
5747 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5748 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005749 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005750 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005751 }
5752 }
5753
Joe Perches0b523762017-05-08 15:55:36 -07005754 # check for vsprintf extension %p<foo> misuses
5755 if ($^V && $^V ge 5.10.0 &&
5756 defined $stat &&
5757 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5758 $1 !~ /^_*volatile_*$/) {
5759 my $bad_extension = "";
5760 my $lc = $stat =~ tr@\n@@;
5761 $lc = $lc + $linenr;
5762 for (my $count = $linenr; $count <= $lc; $count++) {
5763 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5764 $fmt =~ s/%%//g;
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02005765 if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNO]).)/) {
Joe Perches0b523762017-05-08 15:55:36 -07005766 $bad_extension = $1;
5767 last;
5768 }
5769 }
5770 if ($bad_extension ne "") {
5771 my $stat_real = raw_line($linenr, 0);
5772 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5773 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5774 }
5775 WARN("VSPRINTF_POINTER_EXTENSION",
5776 "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
5777 }
5778 }
5779
Andy Whitcroft554e1652012-01-10 15:09:57 -08005780# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005781 if ($^V && $^V ge 5.10.0 &&
5782 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005783 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005784
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005785 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005786 my $ms_val = $7;
5787 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005788
Andy Whitcroft554e1652012-01-10 15:09:57 -08005789 if ($ms_size =~ /^(0x|)0$/i) {
5790 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005791 "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 -08005792 } elsif ($ms_size =~ /^(0x|)1$/i) {
5793 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005794 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5795 }
5796 }
5797
Joe Perches98a9bba2014-01-23 15:54:52 -08005798# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005799# if ($^V && $^V ge 5.10.0 &&
5800# defined $stat &&
5801# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5802# if (WARN("PREFER_ETHER_ADDR_COPY",
5803# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5804# $fix) {
5805# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5806# }
5807# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005808
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005809# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005810# if ($^V && $^V ge 5.10.0 &&
5811# defined $stat &&
5812# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5813# WARN("PREFER_ETHER_ADDR_EQUAL",
5814# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5815# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005816
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005817# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5818# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf3331952016-10-11 13:51:53 -07005819# if ($^V && $^V ge 5.10.0 &&
5820# defined $stat &&
5821# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5822#
5823# my $ms_val = $7;
5824#
5825# if ($ms_val =~ /^(?:0x|)0+$/i) {
5826# if (WARN("PREFER_ETH_ZERO_ADDR",
5827# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5828# $fix) {
5829# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5830# }
5831# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5832# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5833# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5834# $fix) {
5835# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5836# }
5837# }
5838# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005839
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005840# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005841 if ($^V && $^V ge 5.10.0 &&
5842 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005843 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005844 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005845 my $call = $1;
5846 my $cast1 = deparenthesize($2);
5847 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005848 my $cast2 = deparenthesize($7);
5849 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005850 my $cast;
5851
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005852 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005853 $cast = "$cast1 or $cast2";
5854 } elsif ($cast1 ne "") {
5855 $cast = $cast1;
5856 } else {
5857 $cast = $cast2;
5858 }
5859 WARN("MINMAX",
5860 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005861 }
5862 }
5863
Joe Perches4a273192012-07-30 14:41:20 -07005864# check usleep_range arguments
5865 if ($^V && $^V ge 5.10.0 &&
5866 defined $stat &&
5867 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5868 my $min = $1;
5869 my $max = $7;
5870 if ($min eq $max) {
5871 WARN("USLEEP_RANGE",
5872 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5873 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5874 $min > $max) {
5875 WARN("USLEEP_RANGE",
5876 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5877 }
5878 }
5879
Joe Perches823b7942013-11-12 15:10:15 -08005880# check for naked sscanf
5881 if ($^V && $^V ge 5.10.0 &&
5882 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005883 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005884 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5885 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5886 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5887 my $lc = $stat =~ tr@\n@@;
5888 $lc = $lc + $linenr;
5889 my $stat_real = raw_line($linenr, 0);
5890 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5891 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5892 }
5893 WARN("NAKED_SSCANF",
5894 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5895 }
5896
Joe Perchesafc819a2014-06-04 16:12:08 -07005897# check for simple sscanf that should be kstrto<foo>
5898 if ($^V && $^V ge 5.10.0 &&
5899 defined $stat &&
5900 $line =~ /\bsscanf\b/) {
5901 my $lc = $stat =~ tr@\n@@;
5902 $lc = $lc + $linenr;
5903 my $stat_real = raw_line($linenr, 0);
5904 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5905 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5906 }
5907 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5908 my $format = $6;
5909 my $count = $format =~ tr@%@%@;
5910 if ($count == 1 &&
5911 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5912 WARN("SSCANF_TO_KSTRTO",
5913 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5914 }
5915 }
5916 }
5917
Joe Perches70dc8a42013-09-11 14:23:58 -07005918# check for new externs in .h files.
5919 if ($realfile =~ /\.h$/ &&
5920 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005921 if (CHK("AVOID_EXTERNS",
5922 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005923 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005924 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005925 }
5926 }
5927
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005928# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005929 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005930 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005931 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005932 my $function_name = $1;
5933 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005934
5935 my $s = $stat;
5936 if (defined $cond) {
5937 substr($s, 0, length($cond), '');
5938 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005939 if ($s =~ /^\s*;/ &&
5940 $function_name ne 'uninitialized_var')
5941 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005942 WARN("AVOID_EXTERNS",
5943 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005944 }
5945
5946 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005947 WARN("FUNCTION_ARGUMENTS",
5948 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005949 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005950
5951 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5952 $stat =~ /^.\s*extern\s+/)
5953 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005954 WARN("AVOID_EXTERNS",
5955 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005956 }
5957
Joe Perchesa0ad7592017-07-10 15:52:19 -07005958# check for function declarations that have arguments without identifier names
5959 if (defined $stat &&
Joe Perchesca0d8922016-10-11 13:52:16 -07005960 $stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
5961 $1 ne "void") {
5962 my $args = trim($1);
5963 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5964 my $arg = trim($1);
5965 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5966 WARN("FUNCTION_ARGUMENTS",
5967 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5968 }
5969 }
5970 }
5971
Joe Perchesa0ad7592017-07-10 15:52:19 -07005972# check for function definitions
5973 if ($^V && $^V ge 5.10.0 &&
5974 defined $stat &&
5975 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
5976 $context_function = $1;
5977
5978# check for multiline function definition with misplaced open brace
5979 my $ok = 0;
5980 my $cnt = statement_rawlines($stat);
5981 my $herectx = $here . "\n";
5982 for (my $n = 0; $n < $cnt; $n++) {
5983 my $rl = raw_line($linenr, $n);
5984 $herectx .= $rl . "\n";
5985 $ok = 1 if ($rl =~ /^[ \+]\{/);
5986 $ok = 1 if ($rl =~ /\{/ && $n == 0);
5987 last if $rl =~ /^[ \+].*\{/;
5988 }
5989 if (!$ok) {
5990 ERROR("OPEN_BRACE",
5991 "open brace '{' following function definitions go on the next line\n" . $herectx);
5992 }
5993 }
5994
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005995# checks for new __setup's
5996 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5997 my $name = $1;
5998
5999 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006000 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006001 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07006002 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07006003 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006004
6005# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08006006 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006007 WARN("UNNECESSARY_CASTS",
6008 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07006009 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006010
Joe Perchesa640d252013-07-03 15:05:21 -07006011# alloc style
6012# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6013 if ($^V && $^V ge 5.10.0 &&
6014 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6015 CHK("ALLOC_SIZEOF_STRUCT",
6016 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6017 }
6018
Joe Perches60a55362014-06-04 16:12:07 -07006019# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6020 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006021 defined $stat &&
6022 $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 -07006023 my $oldfunc = $3;
6024 my $a1 = $4;
6025 my $a2 = $10;
6026 my $newfunc = "kmalloc_array";
6027 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006028 my $r1 = $a1;
6029 my $r2 = $a2;
6030 if ($a1 =~ /^sizeof\s*\S/) {
6031 $r1 = $a2;
6032 $r2 = $a1;
6033 }
6034 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6035 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006036 my $ctx = '';
6037 my $herectx = $here . "\n";
6038 my $cnt = statement_rawlines($stat);
6039 for (my $n = 0; $n < $cnt; $n++) {
6040 $herectx .= raw_line($linenr, $n) . "\n";
6041 }
Joe Perches60a55362014-06-04 16:12:07 -07006042 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006043 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6044 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006045 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006046 $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 -07006047 }
6048 }
6049 }
6050
Joe Perches972fdea2013-04-29 16:18:12 -07006051# check for krealloc arg reuse
6052 if ($^V && $^V ge 5.10.0 &&
6053 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6054 WARN("KREALLOC_ARG_REUSE",
6055 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6056 }
6057
Joe Perches5ce59ae2013-02-21 16:44:18 -08006058# check for alloc argument mismatch
6059 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6060 WARN("ALLOC_ARRAY_ARGS",
6061 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6062 }
6063
Joe Perchescaf2a542011-01-12 16:59:56 -08006064# check for multiple semicolons
6065 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006066 if (WARN("ONE_SEMICOLON",
6067 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6068 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006069 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006070 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006071 }
6072
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006073# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6074 if ($realfile !~ m@^include/uapi/@ &&
6075 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006076 my $ull = "";
6077 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6078 if (CHK("BIT_MACRO",
6079 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6080 $fix) {
6081 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6082 }
6083 }
6084
Joe Perches2d632742016-05-20 17:04:00 -07006085# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6086 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6087 my $config = $1;
6088 if (WARN("PREFER_IS_ENABLED",
6089 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6090 $fix) {
6091 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6092 }
6093 }
6094
Joe Perchese81f2392014-08-06 16:11:25 -07006095# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006096 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6097 my $has_break = 0;
6098 my $has_statement = 0;
6099 my $count = 0;
6100 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006101 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006102 $prevline--;
6103 my $rline = $rawlines[$prevline - 1];
6104 my $fline = $lines[$prevline - 1];
6105 last if ($fline =~ /^\@\@/);
6106 next if ($fline =~ /^\-/);
6107 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6108 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6109 next if ($fline =~ /^.[\s$;]*$/);
6110 $has_statement = 1;
6111 $count++;
6112 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
6113 }
6114 if (!$has_break && $has_statement) {
6115 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006116 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006117 }
6118 }
6119
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006120# check for switch/default statements without a break;
6121 if ($^V && $^V ge 5.10.0 &&
6122 defined $stat &&
6123 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6124 my $ctx = '';
6125 my $herectx = $here . "\n";
6126 my $cnt = statement_rawlines($stat);
6127 for (my $n = 0; $n < $cnt; $n++) {
6128 $herectx .= raw_line($linenr, $n) . "\n";
6129 }
6130 WARN("DEFAULT_NO_BREAK",
6131 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006132 }
6133
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006134# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006135 if ($line =~ /\b__FUNCTION__\b/) {
6136 if (WARN("USE_FUNC",
6137 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6138 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006139 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006140 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006141 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006142
Joe Perches62ec8182015-02-13 14:38:18 -08006143# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6144 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6145 ERROR("DATE_TIME",
6146 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6147 }
6148
Joe Perches2c924882012-03-23 15:02:20 -07006149# check for use of yield()
6150 if ($line =~ /\byield\s*\(\s*\)/) {
6151 WARN("YIELD",
6152 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6153 }
6154
Joe Perches179f8f42013-07-03 15:05:30 -07006155# check for comparisons against true and false
6156 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6157 my $lead = $1;
6158 my $arg = $2;
6159 my $test = $3;
6160 my $otype = $4;
6161 my $trail = $5;
6162 my $op = "!";
6163
6164 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6165
6166 my $type = lc($otype);
6167 if ($type =~ /^(?:true|false)$/) {
6168 if (("$test" eq "==" && "$type" eq "true") ||
6169 ("$test" eq "!=" && "$type" eq "false")) {
6170 $op = "";
6171 }
6172
6173 CHK("BOOL_COMPARISON",
6174 "Using comparison to $otype is error prone\n" . $herecurr);
6175
6176## maybe suggesting a correct construct would better
6177## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6178
6179 }
6180 }
6181
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006182# check for semaphores initialized locked
6183 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006184 WARN("CONSIDER_COMPLETION",
6185 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006186 }
Joe Perches6712d852012-03-23 15:02:20 -07006187
Joe Perches67d0a072011-10-31 17:13:10 -07006188# recommend kstrto* over simple_strto* and strict_strto*
6189 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006190 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006191 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006192 }
Joe Perches6712d852012-03-23 15:02:20 -07006193
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006194# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006195 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006196 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006197 "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 -07006198 }
Joe Perches6712d852012-03-23 15:02:20 -07006199
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006200# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006201# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006202 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006203 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006204 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006205 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006206 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006207
6208# use of NR_CPUS is usually wrong
6209# ignore definitions of NR_CPUS and usage to define arrays as likely right
6210 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006211 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6212 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006213 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6214 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6215 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006216 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006217 WARN("NR_CPUS",
6218 "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 -07006219 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006220
Joe Perches52ea8502013-11-12 15:10:09 -08006221# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6222 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6223 ERROR("DEFINE_ARCH_HAS",
6224 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6225 }
6226
Joe Perchesacd93622015-02-13 14:38:38 -08006227# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6228 if ($^V && $^V ge 5.10.0 &&
6229 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6230 WARN("LIKELY_MISUSE",
6231 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6232 }
6233
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006234# whine mightly about in_atomic
6235 if ($line =~ /\bin_atomic\s*\(/) {
6236 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006237 ERROR("IN_ATOMIC",
6238 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006239 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006240 WARN("IN_ATOMIC",
6241 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006242 }
6243 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006244
Joe Perches481aea52016-05-20 17:04:08 -07006245# whine about ACCESS_ONCE
6246 if ($^V && $^V ge 5.10.0 &&
6247 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6248 my $par = $1;
6249 my $eq = $2;
6250 my $fun = $3;
6251 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6252 if (defined($eq)) {
6253 if (WARN("PREFER_WRITE_ONCE",
6254 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6255 $fix) {
6256 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6257 }
6258 } else {
6259 if (WARN("PREFER_READ_ONCE",
6260 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6261 $fix) {
6262 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6263 }
6264 }
6265 }
6266
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006267# check for mutex_trylock_recursive usage
6268 if ($line =~ /mutex_trylock_recursive/) {
6269 ERROR("LOCKING",
6270 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6271 }
6272
Peter Zijlstra1704f472010-03-19 01:37:42 +01006273# check for lockdep_set_novalidate_class
6274 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6275 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6276 if ($realfile !~ m@^kernel/lockdep@ &&
6277 $realfile !~ m@^include/linux/lockdep@ &&
6278 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006279 ERROR("LOCKDEP",
6280 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006281 }
6282 }
Dave Jones88f88312011-01-12 16:59:59 -08006283
Joe Perchesb392c642015-04-16 12:44:16 -07006284 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6285 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006286 WARN("EXPORTED_WORLD_WRITABLE",
6287 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006288 }
Joe Perches24358802014-04-03 14:49:13 -07006289
Joe Perches515a2352014-04-03 14:49:24 -07006290# Mode permission misuses where it seems decimal should be octal
6291# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6292 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006293 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006294 $line =~ /$mode_perms_search/) {
6295 foreach my $entry (@mode_permission_funcs) {
6296 my $func = $entry->[0];
6297 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006298
Joe Perches459cf0a2016-10-11 13:52:19 -07006299 my $lc = $stat =~ tr@\n@@;
6300 $lc = $lc + $linenr;
6301 my $stat_real = raw_line($linenr, 0);
6302 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6303 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6304 }
6305
Joe Perches515a2352014-04-03 14:49:24 -07006306 my $skip_args = "";
6307 if ($arg_pos > 1) {
6308 $arg_pos--;
6309 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6310 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006311 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006312 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006313 my $val = $1;
6314 $val = $6 if ($skip_args ne "");
Joe Perchesf90774e2016-10-11 13:51:47 -07006315 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6316 ($val =~ /^$Octal$/ && length($val) ne 4)) {
Joe Perches515a2352014-04-03 14:49:24 -07006317 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006318 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006319 }
6320 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006321 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006322 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006323 }
Joe Perches24358802014-04-03 14:49:13 -07006324 }
6325 }
6326 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006327
Joe Perches459cf0a2016-10-11 13:52:19 -07006328# check for uses of S_<PERMS> that could be octal for readability
6329 if ($line =~ /\b$mode_perms_string_search\b/) {
6330 my $val = "";
6331 my $oval = "";
6332 my $to = 0;
6333 my $curpos = 0;
6334 my $lastpos = 0;
6335 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6336 $curpos = pos($line);
6337 my $match = $2;
6338 my $omatch = $1;
6339 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6340 $lastpos = $curpos;
6341 $to |= $mode_permission_string_types{$match};
6342 $val .= '\s*\|\s*' if ($val ne "");
6343 $val .= $match;
6344 $oval .= $omatch;
6345 }
6346 $oval =~ s/^\s*\|\s*//;
6347 $oval =~ s/\s*\|\s*$//;
6348 my $octal = sprintf("%04o", $to);
6349 if (WARN("SYMBOLIC_PERMS",
6350 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6351 $fix) {
6352 $fixed[$fixlinenr] =~ s/$val/$octal/;
6353 }
6354 }
6355
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006356# validate content of MODULE_LICENSE against list from include/linux/module.h
6357 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6358 my $extracted_string = get_quoted_string($line, $rawline);
6359 my $valid_licenses = qr{
6360 GPL|
6361 GPL\ v2|
6362 GPL\ and\ additional\ rights|
6363 Dual\ BSD/GPL|
6364 Dual\ MIT/GPL|
6365 Dual\ MPL/GPL|
6366 Proprietary
6367 }x;
6368 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6369 WARN("MODULE_LICENSE",
6370 "unknown module license " . $extracted_string . "\n" . $herecurr);
6371 }
6372 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006373 }
6374
6375 # If we have no input at all, then there is nothing to report on
6376 # so just keep quiet.
6377 if ($#rawlines == -1) {
6378 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006379 }
6380
Andy Whitcroft8905a672007-11-28 16:21:06 -08006381 # In mailback mode only produce a report in the negative, for
6382 # things that appear to be patches.
6383 if ($mailback && ($clean == 1 || !$is_patch)) {
6384 exit(0);
6385 }
6386
6387 # This is not a patch, and we are are in 'no-patch' mode so
6388 # just keep quiet.
6389 if (!$chk_patch && !$is_patch) {
6390 exit(0);
6391 }
6392
Joe Perches06330fc2015-06-25 15:03:11 -07006393 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006394 ERROR("NOT_UNIFIED_DIFF",
6395 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006396 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006397 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006398 ERROR("MISSING_SIGN_OFF",
6399 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006400 }
6401
Andy Whitcroft8905a672007-11-28 16:21:06 -08006402 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006403 if ($summary && !($clean == 1 && $quiet == 1)) {
6404 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006405 print "total: $cnt_error errors, $cnt_warn warnings, " .
6406 (($check)? "$cnt_chk checks, " : "") .
6407 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006408 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006409
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006410 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006411 # If there were any defects found and not already fixing them
6412 if (!$clean and !$fix) {
6413 print << "EOM"
6414
6415NOTE: For some of the reported defects, checkpatch may be able to
6416 mechanically convert to the typical style using --fix or --fix-inplace.
6417EOM
6418 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006419 # If there were whitespace errors which cleanpatch can fix
6420 # then suggest that.
6421 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006422 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006423 print << "EOM"
6424
6425NOTE: Whitespace errors detected.
6426 You may wish to use scripts/cleanpatch or scripts/cleanfile
6427EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006428 }
6429 }
6430
Joe Perchesd752fcc2014-08-06 16:11:05 -07006431 if ($clean == 0 && $fix &&
6432 ("@rawlines" ne "@fixed" ||
6433 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006434 my $newfile = $filename;
6435 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006436 my $linecount = 0;
6437 my $f;
6438
Joe Perchesd752fcc2014-08-06 16:11:05 -07006439 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6440
Joe Perches3705ce52013-07-03 15:05:31 -07006441 open($f, '>', $newfile)
6442 or die "$P: Can't open $newfile for write\n";
6443 foreach my $fixed_line (@fixed) {
6444 $linecount++;
6445 if ($file) {
6446 if ($linecount > 3) {
6447 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006448 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006449 }
6450 } else {
6451 print $f $fixed_line . "\n";
6452 }
6453 }
6454 close($f);
6455
6456 if (!$quiet) {
6457 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006458
Joe Perches3705ce52013-07-03 15:05:31 -07006459Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6460
6461Do _NOT_ trust the results written to this file.
6462Do _NOT_ submit these changes without inspecting them for correctness.
6463
6464This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6465No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006466EOM
6467 }
6468 }
6469
Joe Perchesd8469f12015-06-25 15:03:00 -07006470 if ($quiet == 0) {
6471 print "\n";
6472 if ($clean == 1) {
6473 print "$vname has no obvious style problems and is ready for submission.\n";
6474 } else {
6475 print "$vname has style problems, please review.\n";
6476 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006477 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006478 return $clean;
6479}