blob: 3453df9f90ab40a0a3c13126d7401f189415cba4 [file] [log] [blame]
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02001#!/usr/bin/env perl
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Kamil Rytarowskicb77f0d2017-05-07 23:25:26 +02009use warnings;
Joe Perchesc707a812013-07-08 16:00:43 -070010use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080011use File::Basename;
12use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070013use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070014
15my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080016my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070017
Joe Perches000d1cc12011-07-25 17:13:25 -070018my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070019
20use Getopt::Long qw(:config no_auto_abbrev);
21
22my $quiet = 0;
23my $tree = 1;
24my $chk_signoff = 1;
25my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070026my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070027my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080028my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070029my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070030my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070031my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070032my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $check = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -070034my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080035my $summary = 1;
36my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080037my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070038my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070039my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070040my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080041my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070042my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080043my %debug;
Joe Perches34456862013-07-03 15:05:34 -070044my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070045my %use_type = ();
46my @use = ();
47my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070048my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070049my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070050my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080051my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070052my $ignore_perl_version = 0;
53my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070054my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070055my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070056my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070057my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070058my $conststructsfile = "$D/const_structs.checkpatch";
Jerome Forissier75ad8c52017-05-08 15:56:00 -070059my $typedefsfile = "";
John Brooks737c0762017-07-10 15:52:24 -070060my $color = "auto";
Joe Perchesdadf6802016-08-02 14:04:33 -070061my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070062
63sub help {
64 my ($exitcode) = @_;
65
66 print << "EOM";
67Usage: $P [OPTION]... [FILE]...
68Version: $V
69
70Options:
71 -q, --quiet quiet
72 --no-tree run without a kernel tree
73 --no-signoff do not check for 'Signed-off-by' line
74 --patch treat FILE as patchfile (default)
75 --emacs emacs compile window format
76 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070077 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070078 -g, --git treat FILE as a single commit or git revision range
79 single git commit with:
80 <rev>
81 <rev>^
82 <rev>~n
83 multiple git commits with:
84 <rev1>..<rev2>
85 <rev1>...<rev2>
86 <rev>-<count>
87 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070088 -f, --file treat FILE as regular source file
89 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070090 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070091 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070092 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070093 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080094 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070095 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070096 --root=PATH PATH to the kernel tree root
97 --no-summary suppress the per-file summary
98 --mailback only produce a report in case of warnings/errors
99 --summary-file include the filename in summary
100 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
101 'values', 'possible', 'type', and 'attr' (default
102 is all off)
103 --test-only=WORD report only warnings/errors containing WORD
104 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700105 --fix EXPERIMENTAL - may create horrible results
106 If correctable single-line errors exist, create
107 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
108 with potential errors corrected to the preferred
109 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800110 --fix-inplace EXPERIMENTAL - may create horrible results
111 Is the same as --fix, but overwrites the input
112 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700113 --ignore-perl-version override checking of perl version. expect
114 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700115 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700116 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700117 --codespellfile Use this codespell dictionary
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700118 --typedefsfile Read additional types from this file
John Brooks737c0762017-07-10 15:52:24 -0700119 --color[=WHEN] Use colors 'always', 'never', or only when output
120 is a terminal ('auto'). Default is 'auto'.
Hannes Eder77f5b102009-09-21 17:04:37 -0700121 -h, --help, --version display this help and exit
122
123When FILE is - read standard input.
124EOM
125
126 exit($exitcode);
127}
128
Joe Perches3beb42e2016-05-20 17:04:14 -0700129sub uniq {
130 my %seen;
131 return grep { !$seen{$_}++ } @_;
132}
133
134sub list_types {
135 my ($exitcode) = @_;
136
137 my $count = 0;
138
139 local $/ = undef;
140
141 open(my $script, '<', abs_path($P)) or
142 die "$P: Can't read '$P' $!\n";
143
144 my $text = <$script>;
145 close($script);
146
147 my @types = ();
Jean Delvare0547fa52017-09-08 16:16:11 -0700148 # Also catch when type or level is passed through a variable
149 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
Joe Perches3beb42e2016-05-20 17:04:14 -0700150 push (@types, $_);
151 }
152 @types = sort(uniq(@types));
153 print("#\tMessage type\n\n");
154 foreach my $type (@types) {
155 print(++$count . "\t" . $type . "\n");
156 }
157
158 exit($exitcode);
159}
160
Joe Perches000d1cc12011-07-25 17:13:25 -0700161my $conf = which_conf($configuration_file);
162if (-f $conf) {
163 my @conf_args;
164 open(my $conffile, '<', "$conf")
165 or warn "$P: Can't find a readable $configuration_file file $!\n";
166
167 while (<$conffile>) {
168 my $line = $_;
169
170 $line =~ s/\s*\n?$//g;
171 $line =~ s/^\s*//g;
172 $line =~ s/\s+/ /g;
173
174 next if ($line =~ m/^\s*#/);
175 next if ($line =~ m/^\s*$/);
176
177 my @words = split(" ", $line);
178 foreach my $word (@words) {
179 last if ($word =~ m/^#/);
180 push (@conf_args, $word);
181 }
182 }
183 close($conffile);
184 unshift(@ARGV, @conf_args) if @conf_args;
185}
186
John Brooks737c0762017-07-10 15:52:24 -0700187# Perl's Getopt::Long allows options to take optional arguments after a space.
188# Prevent --color by itself from consuming other arguments
189foreach (@ARGV) {
190 if ($_ eq "--color" || $_ eq "-color") {
191 $_ = "--color=$color";
192 }
193}
194
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700195GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700196 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700197 'tree!' => \$tree,
198 'signoff!' => \$chk_signoff,
199 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700200 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800201 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700202 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700203 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700204 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700205 'subjective!' => \$check,
206 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700207 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700208 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700209 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700210 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800211 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700212 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700213 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800214 'summary!' => \$summary,
215 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800216 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700217 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800218 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700219 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800220 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700221 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700222 'codespell!' => \$codespell,
223 'codespellfile=s' => \$codespellfile,
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700224 'typedefsfile=s' => \$typedefsfile,
John Brooks737c0762017-07-10 15:52:24 -0700225 'color=s' => \$color,
226 'no-color' => \$color, #keep old behaviors of -nocolor
227 'nocolor' => \$color, #keep old behaviors of -nocolor
Hannes Eder77f5b102009-09-21 17:04:37 -0700228 'h|help' => \$help,
229 'version' => \$help
230) or help(1);
231
232help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700233
Joe Perches3beb42e2016-05-20 17:04:14 -0700234list_types(0) if ($list_types);
235
Joe Perches9624b8d2014-01-23 15:54:44 -0800236$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700237$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800238
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700239my $exit = 0;
240
Dave Hansend62a2012013-09-11 14:23:56 -0700241if ($^V && $^V lt $minimum_perl_version) {
242 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
243 if (!$ignore_perl_version) {
244 exit(1);
245 }
246}
247
Allen Hubbe45107ff2016-08-02 14:04:47 -0700248#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700249if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700250 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700251}
252
John Brooks737c0762017-07-10 15:52:24 -0700253if ($color =~ /^[01]$/) {
254 $color = !$color;
255} elsif ($color =~ /^always$/i) {
256 $color = 1;
257} elsif ($color =~ /^never$/i) {
258 $color = 0;
259} elsif ($color =~ /^auto$/i) {
260 $color = (-t STDOUT);
261} else {
262 die "Invalid color mode: $color\n";
263}
264
Joe Perches91bfe482013-09-11 14:23:59 -0700265sub hash_save_array_words {
266 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700267
Joe Perches91bfe482013-09-11 14:23:59 -0700268 my @array = split(/,/, join(',', @$arrayRef));
269 foreach my $word (@array) {
270 $word =~ s/\s*\n?$//g;
271 $word =~ s/^\s*//g;
272 $word =~ s/\s+/ /g;
273 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700274
Joe Perches91bfe482013-09-11 14:23:59 -0700275 next if ($word =~ m/^\s*#/);
276 next if ($word =~ m/^\s*$/);
277
278 $hashRef->{$word}++;
279 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700280}
281
Joe Perches91bfe482013-09-11 14:23:59 -0700282sub hash_show_words {
283 my ($hashRef, $prefix) = @_;
284
Joe Perches3c816e42015-06-25 15:03:29 -0700285 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700286 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700287 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700288 print " $word";
289 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700290 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700291 }
292}
293
294hash_save_array_words(\%ignore_type, \@ignore);
295hash_save_array_words(\%use_type, \@use);
296
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800297my $dbg_values = 0;
298my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700299my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700300my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800301for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800302 ## no critic
303 eval "\${dbg_$key} = '$debug{$key}';";
304 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800305}
306
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700307my $rpt_cleaners = 0;
308
Andy Whitcroft8905a672007-11-28 16:21:06 -0800309if ($terse) {
310 $emacs = 1;
311 $quiet++;
312}
313
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700314if ($tree) {
315 if (defined $root) {
316 if (!top_of_kernel_tree($root)) {
317 die "$P: $root: --root does not point at a valid tree\n";
318 }
319 } else {
320 if (top_of_kernel_tree('.')) {
321 $root = '.';
322 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
323 top_of_kernel_tree($1)) {
324 $root = $1;
325 }
326 }
327
328 if (!defined $root) {
329 print "Must be run from the top-level dir. of a kernel tree\n";
330 exit(2);
331 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700332}
333
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700334my $emitted_corrupt = 0;
335
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700336our $Ident = qr{
337 [A-Za-z_][A-Za-z\d_]*
338 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
339 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700340our $Storage = qr{extern|static|asmlinkage};
341our $Sparse = qr{
342 __user|
343 __kernel|
344 __force|
345 __iomem|
346 __must_check|
347 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800348 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700349 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800350 __rcu|
351 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700352 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800353our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
354our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
355our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
356our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
357our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700358
Wolfram Sang52131292010-03-05 13:43:51 -0800359# Notes to $Attribute:
360# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700361our $Attribute = qr{
362 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700363 __percpu|
364 __nocast|
365 __safe|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200366 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700367 __packed__|
368 __packed2__|
369 __naked|
370 __maybe_unused|
371 __always_unused|
372 __noreturn|
373 __used|
374 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800375 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700376 __noclone|
377 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700378 __read_mostly|
379 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700380 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700381 ____cacheline_aligned|
382 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800383 ____cacheline_internodealigned_in_smp|
384 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700385 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700386our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700387our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700388our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
389our $Lval = qr{$Ident(?:$Member)*};
390
Joe Perches95e2c602013-07-03 15:05:20 -0700391our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
392our $Binary = qr{(?i)0b[01]+$Int_type?};
393our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
394our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700395our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800396our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800397our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
398our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
399our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800400our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700401our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800402our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700403our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700404our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700405our $Operators = qr{
406 <=|>=|==|!=|
407 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700408 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700409 }x;
410
Joe Perches91cb5192014-04-03 14:49:32 -0700411our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
412
Joe Perchesab7e23f2015-04-16 12:44:22 -0700413our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800414our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700415our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700416our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800417our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700418our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700420our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800421
Joe Perches15662b32011-10-31 17:13:12 -0700422our $NON_ASCII_UTF8 = qr{
423 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700424 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
425 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
426 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
427 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
428 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
429 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
430}x;
431
Joe Perches15662b32011-10-31 17:13:12 -0700432our $UTF8 = qr{
433 [\x09\x0A\x0D\x20-\x7E] # ASCII
434 | $NON_ASCII_UTF8
435}x;
436
Joe Perchese6176fa2015-06-25 15:02:49 -0700437our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800438our $typeOtherOSTypedefs = qr{(?x:
439 u_(?:char|short|int|long) | # bsd
440 u(?:nchar|short|int|long) # sysv
441)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700442our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700443 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700444 atomic_t
445)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700446our $typeTypedefs = qr{(?x:
447 $typeC99Typedefs\b|
448 $typeOtherOSTypedefs\b|
449 $typeKernelTypedefs\b
450)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700451
Joe Perches6d32f7a2015-11-06 16:31:37 -0800452our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
453
Joe Perches691e6692010-03-05 13:43:51 -0800454our $logFunctions = qr{(?x:
Miles Chen758d7aa2017-02-24 15:01:34 -0800455 printk(?:_ratelimited|_once|_deferred_once|_deferred|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700456 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches87bd4992017-11-17 15:28:48 -0800457 TP_printk|
Joe Perches6e60c022011-07-25 17:13:27 -0700458 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700459 panic|
Joe Perches06668722013-11-12 15:10:07 -0800460 MODULE_[A-Z_]+|
461 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800462)};
463
Joe Perches20112472011-07-25 17:13:23 -0700464our $signature_tags = qr{(?xi:
465 Signed-off-by:|
466 Acked-by:|
467 Tested-by:|
468 Reviewed-by:|
469 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700470 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700471 To:|
472 Cc:
473)};
474
Joe Perches18130872014-08-06 16:11:22 -0700475our @typeListMisordered = (
476 qr{char\s+(?:un)?signed},
477 qr{int\s+(?:(?:un)?signed\s+)?short\s},
478 qr{int\s+short(?:\s+(?:un)?signed)},
479 qr{short\s+int(?:\s+(?:un)?signed)},
480 qr{(?:un)?signed\s+int\s+short},
481 qr{short\s+(?:un)?signed},
482 qr{long\s+int\s+(?:un)?signed},
483 qr{int\s+long\s+(?:un)?signed},
484 qr{long\s+(?:un)?signed\s+int},
485 qr{int\s+(?:un)?signed\s+long},
486 qr{int\s+(?:un)?signed},
487 qr{int\s+long\s+long\s+(?:un)?signed},
488 qr{long\s+long\s+int\s+(?:un)?signed},
489 qr{long\s+long\s+(?:un)?signed\s+int},
490 qr{long\s+long\s+(?:un)?signed},
491 qr{long\s+(?:un)?signed},
492);
493
Andy Whitcroft8905a672007-11-28 16:21:06 -0800494our @typeList = (
495 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700496 qr{(?:(?:un)?signed\s+)?char},
497 qr{(?:(?:un)?signed\s+)?short\s+int},
498 qr{(?:(?:un)?signed\s+)?short},
499 qr{(?:(?:un)?signed\s+)?int},
500 qr{(?:(?:un)?signed\s+)?long\s+int},
501 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
502 qr{(?:(?:un)?signed\s+)?long\s+long},
503 qr{(?:(?:un)?signed\s+)?long},
504 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800505 qr{float},
506 qr{double},
507 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800508 qr{struct\s+$Ident},
509 qr{union\s+$Ident},
510 qr{enum\s+$Ident},
511 qr{${Ident}_t},
512 qr{${Ident}_handler},
513 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700514 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800515);
Joe Perches938224b2016-01-20 14:59:15 -0800516
517our $C90_int_types = qr{(?x:
518 long\s+long\s+int\s+(?:un)?signed|
519 long\s+long\s+(?:un)?signed\s+int|
520 long\s+long\s+(?:un)?signed|
521 (?:(?:un)?signed\s+)?long\s+long\s+int|
522 (?:(?:un)?signed\s+)?long\s+long|
523 int\s+long\s+long\s+(?:un)?signed|
524 int\s+(?:(?:un)?signed\s+)?long\s+long|
525
526 long\s+int\s+(?:un)?signed|
527 long\s+(?:un)?signed\s+int|
528 long\s+(?:un)?signed|
529 (?:(?:un)?signed\s+)?long\s+int|
530 (?:(?:un)?signed\s+)?long|
531 int\s+long\s+(?:un)?signed|
532 int\s+(?:(?:un)?signed\s+)?long|
533
534 int\s+(?:un)?signed|
535 (?:(?:un)?signed\s+)?int
536)};
537
Alex Dowad485ff232015-06-25 15:02:52 -0700538our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700539our @typeListWithAttr = (
540 @typeList,
541 qr{struct\s+$InitAttribute\s+$Ident},
542 qr{union\s+$InitAttribute\s+$Ident},
543);
544
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700545our @modifierList = (
546 qr{fastcall},
547);
Alex Dowad485ff232015-06-25 15:02:52 -0700548our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800549
Joe Perches24358802014-04-03 14:49:13 -0700550our @mode_permission_funcs = (
551 ["module_param", 3],
552 ["module_param_(?:array|named|string)", 4],
553 ["module_param_array_named", 5],
554 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
555 ["proc_create(?:_data|)", 2],
Joe Perches459cf0a2016-10-11 13:52:19 -0700556 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
557 ["IIO_DEV_ATTR_[A-Z_]+", 1],
558 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
559 ["SENSOR_TEMPLATE(?:_2|)", 3],
560 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700561);
562
Joe Perches515a2352014-04-03 14:49:24 -0700563#Create a search pattern for all these functions to speed up a loop below
564our $mode_perms_search = "";
565foreach my $entry (@mode_permission_funcs) {
566 $mode_perms_search .= '|' if ($mode_perms_search ne "");
567 $mode_perms_search .= $entry->[0];
568}
569
Joe Perchesb392c642015-04-16 12:44:16 -0700570our $mode_perms_world_writable = qr{
571 S_IWUGO |
572 S_IWOTH |
573 S_IRWXUGO |
574 S_IALLUGO |
575 0[0-7][0-7][2367]
576}x;
577
Joe Perchesf90774e2016-10-11 13:51:47 -0700578our %mode_permission_string_types = (
579 "S_IRWXU" => 0700,
580 "S_IRUSR" => 0400,
581 "S_IWUSR" => 0200,
582 "S_IXUSR" => 0100,
583 "S_IRWXG" => 0070,
584 "S_IRGRP" => 0040,
585 "S_IWGRP" => 0020,
586 "S_IXGRP" => 0010,
587 "S_IRWXO" => 0007,
588 "S_IROTH" => 0004,
589 "S_IWOTH" => 0002,
590 "S_IXOTH" => 0001,
591 "S_IRWXUGO" => 0777,
592 "S_IRUGO" => 0444,
593 "S_IWUGO" => 0222,
594 "S_IXUGO" => 0111,
595);
596
597#Create a search pattern for all these strings to speed up a loop below
598our $mode_perms_string_search = "";
599foreach my $entry (keys %mode_permission_string_types) {
600 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
601 $mode_perms_string_search .= $entry;
602}
603
Wolfram Sang7840a942010-08-09 17:20:57 -0700604our $allowed_asm_includes = qr{(?x:
605 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700606 memory|
607 time|
608 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700609)};
610# memory.h: ARM has a custom one
611
Kees Cook66b47b42014-10-13 15:51:57 -0700612# Load common spelling mistakes and build regular expression list.
613my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700614my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700615
Joe Perches36061e32014-12-10 15:51:43 -0800616if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800617 while (<$spelling>) {
618 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700619
Joe Perches36061e32014-12-10 15:51:43 -0800620 $line =~ s/\s*\n?$//g;
621 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700622
Joe Perches36061e32014-12-10 15:51:43 -0800623 next if ($line =~ m/^\s*#/);
624 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700625
Joe Perches36061e32014-12-10 15:51:43 -0800626 my ($suspect, $fix) = split(/\|\|/, $line);
627
Joe Perches36061e32014-12-10 15:51:43 -0800628 $spelling_fix{$suspect} = $fix;
629 }
630 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800631} else {
632 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700633}
Kees Cook66b47b42014-10-13 15:51:57 -0700634
Joe Perchesebfd7d62015-04-16 12:44:14 -0700635if ($codespell) {
636 if (open(my $spelling, '<', $codespellfile)) {
637 while (<$spelling>) {
638 my $line = $_;
639
640 $line =~ s/\s*\n?$//g;
641 $line =~ s/^\s*//g;
642
643 next if ($line =~ m/^\s*#/);
644 next if ($line =~ m/^\s*$/);
645 next if ($line =~ m/, disabled/i);
646
647 $line =~ s/,.*$//;
648
649 my ($suspect, $fix) = split(/->/, $line);
650
651 $spelling_fix{$suspect} = $fix;
652 }
653 close($spelling);
654 } else {
655 warn "No codespell typos will be found - file '$codespellfile': $!\n";
656 }
657}
658
659$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
660
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700661sub read_words {
662 my ($wordsRef, $file) = @_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700663
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700664 if (open(my $words, '<', $file)) {
665 while (<$words>) {
666 my $line = $_;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700667
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700668 $line =~ s/\s*\n?$//g;
669 $line =~ s/^\s*//g;
670
671 next if ($line =~ m/^\s*#/);
672 next if ($line =~ m/^\s*$/);
673 if ($line =~ /\s/) {
674 print("$file: '$line' invalid - ignored\n");
675 next;
676 }
677
678 $$wordsRef .= '|' if ($$wordsRef ne "");
679 $$wordsRef .= $line;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700680 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700681 close($file);
682 return 1;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700683 }
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700684
685 return 0;
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700686}
687
Jerome Forissier75ad8c52017-05-08 15:56:00 -0700688my $const_structs = "";
689read_words(\$const_structs, $conststructsfile)
690 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
691
692my $typeOtherTypedefs = "";
693if (length($typedefsfile)) {
694 read_words(\$typeOtherTypedefs, $typedefsfile)
695 or warn "No additional types will be considered - file '$typedefsfile': $!\n";
696}
697$typeTypedefs .= '|' . $typeOtherTypedefs if ($typeOtherTypedefs ne "");
698
Andy Whitcroft8905a672007-11-28 16:21:06 -0800699sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700700 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
701 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700702 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700703 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700704 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700705 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700706 (?:$typeTypedefs\b)|
707 (?:${all}\b)
708 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800709 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700710 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800711 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800712 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700713 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700714 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800715 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700716 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800717 }x;
Joe Perches18130872014-08-06 16:11:22 -0700718 $NonptrTypeMisordered = qr{
719 (?:$Modifier\s+|const\s+)*
720 (?:
721 (?:${Misordered}\b)
722 )
723 (?:\s+$Modifier|\s+const)*
724 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700725 $NonptrTypeWithAttr = qr{
726 (?:$Modifier\s+|const\s+)*
727 (?:
728 (?:typeof|__typeof__)\s*\([^\)]*\)|
729 (?:$typeTypedefs\b)|
730 (?:${allWithAttr}\b)
731 )
732 (?:\s+$Modifier|\s+const)*
733 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800734 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700735 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700736 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700737 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800738 }x;
Joe Perches18130872014-08-06 16:11:22 -0700739 $TypeMisordered = qr{
740 $NonptrTypeMisordered
741 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
742 (?:\s+$Inline|\s+$Modifier)*
743 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700744 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700745 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800746}
747build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700748
Joe Perches7d2367a2011-07-25 17:13:22 -0700749our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700750
751# Using $balanced_parens, $LvalOrFunc, or $FuncArg
752# requires at least perl version v5.10.0
753# Any use must be runtime checked with $^V
754
755our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700756our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800757our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700758
Joe Perchesf8422302014-08-06 16:11:31 -0700759our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700760 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Steffen Maierfe658f92017-07-10 15:52:10 -0700761 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700762 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
763)};
764
Joe Perches7d2367a2011-07-25 17:13:22 -0700765sub deparenthesize {
766 my ($string) = @_;
767 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700768
769 while ($string =~ /^\s*\(.*\)\s*$/) {
770 $string =~ s@^\s*\(\s*@@;
771 $string =~ s@\s*\)\s*$@@;
772 }
773
Joe Perches7d2367a2011-07-25 17:13:22 -0700774 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700775
Joe Perches7d2367a2011-07-25 17:13:22 -0700776 return $string;
777}
778
Joe Perches34456862013-07-03 15:05:34 -0700779sub seed_camelcase_file {
780 my ($file) = @_;
781
782 return if (!(-f $file));
783
784 local $/;
785
786 open(my $include_file, '<', "$file")
787 or warn "$P: Can't read '$file' $!\n";
788 my $text = <$include_file>;
789 close($include_file);
790
791 my @lines = split('\n', $text);
792
793 foreach my $line (@lines) {
794 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
795 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
796 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800797 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
798 $camelcase{$1} = 1;
799 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700800 $camelcase{$1} = 1;
801 }
802 }
803}
804
Joe Perches85b0ee12016-10-11 13:51:44 -0700805sub is_maintained_obsolete {
806 my ($filename) = @_;
807
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800808 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700809
Joe Perches0616efa2016-10-11 13:52:02 -0700810 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
Joe Perches85b0ee12016-10-11 13:51:44 -0700811
812 return $status =~ /obsolete/i;
813}
814
Joe Perches34456862013-07-03 15:05:34 -0700815my $camelcase_seeded = 0;
816sub seed_camelcase_includes {
817 return if ($camelcase_seeded);
818
819 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700820 my $camelcase_cache = "";
821 my @include_files = ();
822
823 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700824
Richard Genoud3645e322014-02-10 14:25:32 -0800825 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700826 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
827 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700828 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700829 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700830 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700831 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700832 @include_files = split('\n', $files);
833 foreach my $file (@include_files) {
834 my $date = POSIX::strftime("%Y%m%d%H%M",
835 localtime((stat $file)[9]));
836 $last_mod_date = $date if ($last_mod_date < $date);
837 }
838 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700839 }
Joe Perchesc707a812013-07-08 16:00:43 -0700840
841 if ($camelcase_cache ne "" && -f $camelcase_cache) {
842 open(my $camelcase_file, '<', "$camelcase_cache")
843 or warn "$P: Can't read '$camelcase_cache' $!\n";
844 while (<$camelcase_file>) {
845 chomp;
846 $camelcase{$_} = 1;
847 }
848 close($camelcase_file);
849
850 return;
851 }
852
Richard Genoud3645e322014-02-10 14:25:32 -0800853 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700854 $files = `git ls-files "include/*.h"`;
855 @include_files = split('\n', $files);
856 }
857
Joe Perches34456862013-07-03 15:05:34 -0700858 foreach my $file (@include_files) {
859 seed_camelcase_file($file);
860 }
Joe Perches351b2a12013-07-03 15:05:36 -0700861
Joe Perchesc707a812013-07-08 16:00:43 -0700862 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700863 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700864 open(my $camelcase_file, '>', "$camelcase_cache")
865 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700866 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
867 print $camelcase_file ("$_\n");
868 }
869 close($camelcase_file);
870 }
Joe Perches34456862013-07-03 15:05:34 -0700871}
872
Joe Perchesd311cd42014-08-06 16:10:57 -0700873sub git_commit_info {
874 my ($commit, $id, $desc) = @_;
875
876 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
877
878 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
879 $output =~ s/^\s*//gm;
880 my @lines = split("\n", $output);
881
Joe Perches0d7835f2015-02-13 14:38:35 -0800882 return ($id, $desc) if ($#lines < 0);
883
Joe Perchesd311cd42014-08-06 16:10:57 -0700884 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
885# Maybe one day convert this block of bash into something that returns
886# all matching commit ids, but it's very slow...
887#
888# echo "checking commits $1..."
889# git rev-list --remotes | grep -i "^$1" |
890# while read line ; do
891# git log --format='%H %s' -1 $line |
892# echo "commit $(cut -c 1-12,41-)"
893# done
894 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
Heinrich Schuchardt948b1332017-07-10 15:52:16 -0700895 $id = undef;
Joe Perchesd311cd42014-08-06 16:10:57 -0700896 } else {
897 $id = substr($lines[0], 0, 12);
898 $desc = substr($lines[0], 41);
899 }
900
901 return ($id, $desc);
902}
903
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904$chk_signoff = 0 if ($file);
905
Andy Whitcroft00df3442007-06-08 13:47:06 -0700906my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800907my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700908my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700909my @fixed_inserted = ();
910my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700911my $fixlinenr = -1;
912
Du, Changbin4a593c32016-05-20 17:04:16 -0700913# If input is git commits, extract all commits from the commit expressions.
914# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
915die "$P: No git repository found\n" if ($git && !-e ".git");
916
917if ($git) {
918 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700919 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700920 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700921 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
922 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700923 } elsif ($commit_expr =~ m/\.\./) {
924 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700925 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700926 $git_range = "-1 $commit_expr";
927 }
928 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
929 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700930 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
931 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700932 my $sha1 = $1;
933 my $subject = $2;
934 unshift(@commits, $sha1);
935 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700936 }
937 }
938 die "$P: no git commits after extraction!\n" if (@commits == 0);
939 @ARGV = @commits;
940}
941
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800942my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700943for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800944 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700945 if ($git) {
946 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
947 die "$P: $filename: git format-patch failed - $!\n";
948 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800949 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700950 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800951 } elsif ($filename eq '-') {
952 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700953 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800954 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700955 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700956 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800957 if ($filename eq '-') {
958 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700959 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700960 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800961 } else {
962 $vname = $filename;
963 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800964 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700965 chomp;
966 push(@rawlines, $_);
967 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800968 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700969
970 if ($#ARGV > 0 && $quiet == 0) {
971 print '-' x length($vname) . "\n";
972 print "$vname\n";
973 print '-' x length($vname) . "\n";
974 }
975
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800976 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700977 $exit = 1;
978 }
979 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800980 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700981 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700982 @fixed_inserted = ();
983 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700984 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700985 @modifierListFile = ();
986 @typeListFile = ();
987 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700988}
989
Joe Perchesd8469f12015-06-25 15:03:00 -0700990if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700991 hash_show_words(\%use_type, "Used");
992 hash_show_words(\%ignore_type, "Ignored");
993
Joe Perchesd8469f12015-06-25 15:03:00 -0700994 if ($^V lt 5.10.0) {
995 print << "EOM"
996
997NOTE: perl $^V is not modern enough to detect all possible issues.
998 An upgrade to at least perl v5.10.0 is suggested.
999EOM
1000 }
1001 if ($exit) {
1002 print << "EOM"
1003
1004NOTE: If any of the errors are false positives, please report
1005 them to the maintainer, see CHECKPATCH in MAINTAINERS.
1006EOM
1007 }
1008}
1009
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001010exit($exit);
1011
1012sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001013 my ($root) = @_;
1014
1015 my @tree_check = (
1016 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
1017 "README", "Documentation", "arch", "include", "drivers",
1018 "fs", "init", "ipc", "kernel", "lib", "scripts",
1019 );
1020
1021 foreach my $check (@tree_check) {
1022 if (! -e $root . '/' . $check) {
1023 return 0;
1024 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001025 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001026 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -07001027}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001028
Joe Perches20112472011-07-25 17:13:23 -07001029sub parse_email {
1030 my ($formatted_email) = @_;
1031
1032 my $name = "";
1033 my $address = "";
1034 my $comment = "";
1035
1036 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
1037 $name = $1;
1038 $address = $2;
1039 $comment = $3 if defined $3;
1040 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
1041 $address = $1;
1042 $comment = $2 if defined $2;
1043 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
1044 $address = $1;
1045 $comment = $2 if defined $2;
1046 $formatted_email =~ s/$address.*$//;
1047 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001048 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001049 $name =~ s/^\"|\"$//g;
1050 # If there's a name left after stripping spaces and
1051 # leading quotes, and the address doesn't have both
1052 # leading and trailing angle brackets, the address
1053 # is invalid. ie:
1054 # "joe smith joe@smith.com" bad
1055 # "joe smith <joe@smith.com" bad
1056 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1057 $name = "";
1058 $address = "";
1059 $comment = "";
1060 }
1061 }
1062
Joe Perches3705ce52013-07-03 15:05:31 -07001063 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001064 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001065 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001066 $address =~ s/^\<|\>$//g;
1067
1068 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1069 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1070 $name = "\"$name\"";
1071 }
1072
1073 return ($name, $address, $comment);
1074}
1075
1076sub format_email {
1077 my ($name, $address) = @_;
1078
1079 my $formatted_email;
1080
Joe Perches3705ce52013-07-03 15:05:31 -07001081 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001082 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001083 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001084
1085 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1086 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1087 $name = "\"$name\"";
1088 }
1089
1090 if ("$name" eq "") {
1091 $formatted_email = "$address";
1092 } else {
1093 $formatted_email = "$name <$address>";
1094 }
1095
1096 return $formatted_email;
1097}
1098
Joe Perchesd311cd42014-08-06 16:10:57 -07001099sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001100 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001101
Joe Perchesbd474ca2014-08-06 16:11:10 -07001102 foreach my $path (split(/:/, $ENV{PATH})) {
1103 if (-e "$path/$bin") {
1104 return "$path/$bin";
1105 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001106 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001107
Joe Perchesbd474ca2014-08-06 16:11:10 -07001108 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001109}
1110
Joe Perches000d1cc12011-07-25 17:13:25 -07001111sub which_conf {
1112 my ($conf) = @_;
1113
1114 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1115 if (-e "$path/$conf") {
1116 return "$path/$conf";
1117 }
1118 }
1119
1120 return "";
1121}
1122
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001123sub expand_tabs {
1124 my ($str) = @_;
1125
1126 my $res = '';
1127 my $n = 0;
1128 for my $c (split(//, $str)) {
1129 if ($c eq "\t") {
1130 $res .= ' ';
1131 $n++;
1132 for (; ($n % 8) != 0; $n++) {
1133 $res .= ' ';
1134 }
1135 next;
1136 }
1137 $res .= $c;
1138 $n++;
1139 }
1140
1141 return $res;
1142}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001143sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001144 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001145 return $res;
1146}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001147
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001148sub line_stats {
1149 my ($line) = @_;
1150
1151 # Drop the diff line leader and expand tabs
1152 $line =~ s/^.//;
1153 $line = expand_tabs($line);
1154
1155 # Pick the indent from the front of the line.
1156 my ($white) = ($line =~ /^(\s*)/);
1157
1158 return (length($line), length($white));
1159}
1160
Andy Whitcroft773647a2008-03-28 14:15:58 -07001161my $sanitise_quote = '';
1162
1163sub sanitise_line_reset {
1164 my ($in_comment) = @_;
1165
1166 if ($in_comment) {
1167 $sanitise_quote = '*/';
1168 } else {
1169 $sanitise_quote = '';
1170 }
1171}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001172sub sanitise_line {
1173 my ($line) = @_;
1174
1175 my $res = '';
1176 my $l = '';
1177
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001178 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001179 my $off = 0;
1180 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001181
Andy Whitcroft773647a2008-03-28 14:15:58 -07001182 # Always copy over the diff marker.
1183 $res = substr($line, 0, 1);
1184
1185 for ($off = 1; $off < length($line); $off++) {
1186 $c = substr($line, $off, 1);
1187
1188 # Comments we are wacking completly including the begin
1189 # and end, all to $;.
1190 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1191 $sanitise_quote = '*/';
1192
1193 substr($res, $off, 2, "$;$;");
1194 $off++;
1195 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001196 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001197 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001198 $sanitise_quote = '';
1199 substr($res, $off, 2, "$;$;");
1200 $off++;
1201 next;
1202 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001203 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1204 $sanitise_quote = '//';
1205
1206 substr($res, $off, 2, $sanitise_quote);
1207 $off++;
1208 next;
1209 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001210
1211 # A \ in a string means ignore the next character.
1212 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1213 $c eq "\\") {
1214 substr($res, $off, 2, 'XX');
1215 $off++;
1216 next;
1217 }
1218 # Regular quotes.
1219 if ($c eq "'" || $c eq '"') {
1220 if ($sanitise_quote eq '') {
1221 $sanitise_quote = $c;
1222
1223 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001224 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001225 } elsif ($sanitise_quote eq $c) {
1226 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001227 }
1228 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001229
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001230 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001231 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1232 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001233 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1234 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001235 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1236 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001237 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001238 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001239 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001240 }
1241
Daniel Walker113f04a2009-09-21 17:04:35 -07001242 if ($sanitise_quote eq '//') {
1243 $sanitise_quote = '';
1244 }
1245
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001246 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001247 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001248 my $clean = 'X' x length($1);
1249 $res =~ s@\<.*\>@<$clean>@;
1250
1251 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001252 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001253 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001254 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001255 }
1256
Joe Perchesdadf6802016-08-02 14:04:33 -07001257 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1258 my $match = $1;
1259 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1260 }
1261
Andy Whitcroft00df3442007-06-08 13:47:06 -07001262 return $res;
1263}
1264
Joe Perchesa6962d72013-04-29 16:18:13 -07001265sub get_quoted_string {
1266 my ($line, $rawline) = @_;
1267
Joe Perches33acb542015-06-25 15:02:54 -07001268 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001269 return substr($rawline, $-[0], $+[0] - $-[0]);
1270}
1271
Andy Whitcroft8905a672007-11-28 16:21:06 -08001272sub ctx_statement_block {
1273 my ($linenr, $remain, $off) = @_;
1274 my $line = $linenr - 1;
1275 my $blk = '';
1276 my $soff = $off;
1277 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001278 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001279
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001280 my $loff = 0;
1281
Andy Whitcroft8905a672007-11-28 16:21:06 -08001282 my $type = '';
1283 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001284 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001285 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001286 my $c;
1287 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001288
1289 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001290 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001291 @stack = (['', 0]) if ($#stack == -1);
1292
Andy Whitcroft773647a2008-03-28 14:15:58 -07001293 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001294 # If we are about to drop off the end, pull in more
1295 # context.
1296 if ($off >= $len) {
1297 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001298 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001299 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001300 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001301 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001303 $len = length($blk);
1304 $line++;
1305 last;
1306 }
1307 # Bail if there is no further context.
1308 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001309 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001310 last;
1311 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001312 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1313 $level++;
1314 $type = '#';
1315 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001316 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001317 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001318 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001319 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001320
Andy Whitcroft773647a2008-03-28 14:15:58 -07001321 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001322
1323 # Handle nested #if/#else.
1324 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1325 push(@stack, [ $type, $level ]);
1326 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1327 ($type, $level) = @{$stack[$#stack - 1]};
1328 } elsif ($remainder =~ /^#\s*endif\b/) {
1329 ($type, $level) = @{pop(@stack)};
1330 }
1331
Andy Whitcroft8905a672007-11-28 16:21:06 -08001332 # Statement ends at the ';' or a close '}' at the
1333 # outermost level.
1334 if ($level == 0 && $c eq ';') {
1335 last;
1336 }
1337
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001338 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001339 if ($level == 0 && $coff_set == 0 &&
1340 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1341 $remainder =~ /^(else)(?:\s|{)/ &&
1342 $remainder !~ /^else\s+if\b/) {
1343 $coff = $off + length($1) - 1;
1344 $coff_set = 1;
1345 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1346 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001347 }
1348
Andy Whitcroft8905a672007-11-28 16:21:06 -08001349 if (($type eq '' || $type eq '(') && $c eq '(') {
1350 $level++;
1351 $type = '(';
1352 }
1353 if ($type eq '(' && $c eq ')') {
1354 $level--;
1355 $type = ($level != 0)? '(' : '';
1356
1357 if ($level == 0 && $coff < $soff) {
1358 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001359 $coff_set = 1;
1360 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001361 }
1362 }
1363 if (($type eq '' || $type eq '{') && $c eq '{') {
1364 $level++;
1365 $type = '{';
1366 }
1367 if ($type eq '{' && $c eq '}') {
1368 $level--;
1369 $type = ($level != 0)? '{' : '';
1370
1371 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001372 if (substr($blk, $off + 1, 1) eq ';') {
1373 $off++;
1374 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001375 last;
1376 }
1377 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001378 # Preprocessor commands end at the newline unless escaped.
1379 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1380 $level--;
1381 $type = '';
1382 $off++;
1383 last;
1384 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001385 $off++;
1386 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001387 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001388 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001389 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001390 $line++;
1391 $remain--;
1392 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001393
1394 my $statement = substr($blk, $soff, $off - $soff + 1);
1395 my $condition = substr($blk, $soff, $coff - $soff + 1);
1396
1397 #warn "STATEMENT<$statement>\n";
1398 #warn "CONDITION<$condition>\n";
1399
Andy Whitcroft773647a2008-03-28 14:15:58 -07001400 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001401
1402 return ($statement, $condition,
1403 $line, $remain + 1, $off - $loff + 1, $level);
1404}
1405
Andy Whitcroftcf655042008-03-04 14:28:20 -08001406sub statement_lines {
1407 my ($stmt) = @_;
1408
1409 # Strip the diff line prefixes and rip blank lines at start and end.
1410 $stmt =~ s/(^|\n)./$1/g;
1411 $stmt =~ s/^\s*//;
1412 $stmt =~ s/\s*$//;
1413
1414 my @stmt_lines = ($stmt =~ /\n/g);
1415
1416 return $#stmt_lines + 2;
1417}
1418
1419sub statement_rawlines {
1420 my ($stmt) = @_;
1421
1422 my @stmt_lines = ($stmt =~ /\n/g);
1423
1424 return $#stmt_lines + 2;
1425}
1426
1427sub statement_block_size {
1428 my ($stmt) = @_;
1429
1430 $stmt =~ s/(^|\n)./$1/g;
1431 $stmt =~ s/^\s*{//;
1432 $stmt =~ s/}\s*$//;
1433 $stmt =~ s/^\s*//;
1434 $stmt =~ s/\s*$//;
1435
1436 my @stmt_lines = ($stmt =~ /\n/g);
1437 my @stmt_statements = ($stmt =~ /;/g);
1438
1439 my $stmt_lines = $#stmt_lines + 2;
1440 my $stmt_statements = $#stmt_statements + 1;
1441
1442 if ($stmt_lines > $stmt_statements) {
1443 return $stmt_lines;
1444 } else {
1445 return $stmt_statements;
1446 }
1447}
1448
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001449sub ctx_statement_full {
1450 my ($linenr, $remain, $off) = @_;
1451 my ($statement, $condition, $level);
1452
1453 my (@chunks);
1454
Andy Whitcroftcf655042008-03-04 14:28:20 -08001455 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001456 ($statement, $condition, $linenr, $remain, $off, $level) =
1457 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001458 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001459 push(@chunks, [ $condition, $statement ]);
1460 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1461 return ($level, $linenr, @chunks);
1462 }
1463
1464 # Pull in the following conditional/block pairs and see if they
1465 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001466 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001467 ($statement, $condition, $linenr, $remain, $off, $level) =
1468 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001469 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001470 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001471 #print "C: push\n";
1472 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001473 }
1474
1475 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001476}
1477
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001478sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001479 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001480 my $line;
1481 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001482 my $blk = '';
1483 my @o;
1484 my @c;
1485 my @res = ();
1486
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001487 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001488 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001489 for ($line = $start; $remain > 0; $line++) {
1490 next if ($rawlines[$line] =~ /^-/);
1491 $remain--;
1492
1493 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001494
1495 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001496 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001497 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001498 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001499 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001500 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001501 $level = pop(@stack);
1502 }
1503
Andy Whitcroft01464f32010-10-26 14:23:19 -07001504 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001505 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1506 if ($off > 0) {
1507 $off--;
1508 next;
1509 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001510
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001511 if ($c eq $close && $level > 0) {
1512 $level--;
1513 last if ($level == 0);
1514 } elsif ($c eq $open) {
1515 $level++;
1516 }
1517 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001518
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001519 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001520 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001521 }
1522
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001523 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001524 }
1525
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001526 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001527}
1528sub ctx_block_outer {
1529 my ($linenr, $remain) = @_;
1530
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001531 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1532 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001533}
1534sub ctx_block {
1535 my ($linenr, $remain) = @_;
1536
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001537 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1538 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001539}
1540sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001541 my ($linenr, $remain, $off) = @_;
1542
1543 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1544 return @r;
1545}
1546sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001547 my ($linenr, $remain) = @_;
1548
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001549 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001550}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001551sub ctx_statement_level {
1552 my ($linenr, $remain, $off) = @_;
1553
1554 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1555}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001556
1557sub ctx_locate_comment {
1558 my ($first_line, $end_line) = @_;
1559
1560 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001561 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001562 return $current_comment if (defined $current_comment);
1563
1564 # Look through the context and try and figure out if there is a
1565 # comment.
1566 my $in_comment = 0;
1567 $current_comment = '';
1568 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001569 my $line = $rawlines[$linenr - 1];
1570 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001571 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1572 $in_comment = 1;
1573 }
1574 if ($line =~ m@/\*@) {
1575 $in_comment = 1;
1576 }
1577 if (!$in_comment && $current_comment ne '') {
1578 $current_comment = '';
1579 }
1580 $current_comment .= $line . "\n" if ($in_comment);
1581 if ($line =~ m@\*/@) {
1582 $in_comment = 0;
1583 }
1584 }
1585
1586 chomp($current_comment);
1587 return($current_comment);
1588}
1589sub ctx_has_comment {
1590 my ($first_line, $end_line) = @_;
1591 my $cmt = ctx_locate_comment($first_line, $end_line);
1592
Andy Whitcroft00df3442007-06-08 13:47:06 -07001593 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001594 ##print "CMMT: $cmt\n";
1595
1596 return ($cmt ne '');
1597}
1598
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001599sub raw_line {
1600 my ($linenr, $cnt) = @_;
1601
1602 my $offset = $linenr - 1;
1603 $cnt++;
1604
1605 my $line;
1606 while ($cnt) {
1607 $line = $rawlines[$offset++];
1608 next if (defined($line) && $line =~ /^-/);
1609 $cnt--;
1610 }
1611
1612 return $line;
1613}
1614
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001615sub cat_vet {
1616 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001617 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001618
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001619 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001620 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1621 $res .= $1;
1622 if ($2 ne '') {
1623 $coded = sprintf("^%c", unpack('C', $2) + 64);
1624 $res .= $coded;
1625 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001626 }
1627 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001628
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001629 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001630}
1631
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001632my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001633my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001634my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001635my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001636
1637sub annotate_reset {
1638 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001639 $av_pending = '_';
1640 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001641 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001642}
1643
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001644sub annotate_values {
1645 my ($stream, $type) = @_;
1646
1647 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001648 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001649 my $cur = $stream;
1650
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001651 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001653 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001654 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001655 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001656 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001657 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001658 print "WS($1)\n" if ($dbg_values > 1);
1659 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001660 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001661 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001662 }
1663
Florian Micklerc023e4732011-01-12 16:59:58 -08001664 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001665 print "CAST($1)\n" if ($dbg_values > 1);
1666 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001667 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001668
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001669 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001670 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001671 $type = 'T';
1672
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001673 } elsif ($cur =~ /^($Modifier)\s*/) {
1674 print "MODIFIER($1)\n" if ($dbg_values > 1);
1675 $type = 'T';
1676
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001677 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001678 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001679 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001680 push(@av_paren_type, $type);
1681 if ($2 ne '') {
1682 $av_pending = 'N';
1683 }
1684 $type = 'E';
1685
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001686 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001687 print "UNDEF($1)\n" if ($dbg_values > 1);
1688 $av_preprocessor = 1;
1689 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001690
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001691 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001692 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001693 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001694
1695 push(@av_paren_type, $type);
1696 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001697 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001698
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001699 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001700 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1701 $av_preprocessor = 1;
1702
1703 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1704
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001705 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001706
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001707 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001708 print "PRE_END($1)\n" if ($dbg_values > 1);
1709
1710 $av_preprocessor = 1;
1711
1712 # Assume all arms of the conditional end as this
1713 # one does, and continue as if the #endif was not here.
1714 pop(@av_paren_type);
1715 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001716 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001717
1718 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001719 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001720
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001721 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1722 print "ATTR($1)\n" if ($dbg_values > 1);
1723 $av_pending = $type;
1724 $type = 'N';
1725
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001726 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001727 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001728 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001729 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001730 }
1731 $type = 'N';
1732
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001733 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001734 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001735 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001736 $type = 'N';
1737
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001738 } elsif ($cur =~/^(case)/o) {
1739 print "CASE($1)\n" if ($dbg_values > 1);
1740 $av_pend_colon = 'C';
1741 $type = 'N';
1742
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001743 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001744 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001745 $type = 'N';
1746
1747 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001748 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001749 push(@av_paren_type, $av_pending);
1750 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001751 $type = 'N';
1752
1753 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001754 my $new_type = pop(@av_paren_type);
1755 if ($new_type ne '_') {
1756 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001757 print "PAREN('$1') -> $type\n"
1758 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001759 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001760 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761 }
1762
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001763 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001764 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001765 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001766 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001767
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001768 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1769 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001770 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001771 } elsif ($type eq 'E') {
1772 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001773 }
1774 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1775 $type = 'V';
1776
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001777 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001778 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001779 $type = 'V';
1780
1781 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001782 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001783 $type = 'N';
1784
Andy Whitcroftcf655042008-03-04 14:28:20 -08001785 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001786 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001787 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001788 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001789
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001790 } elsif ($cur =~/^(,)/) {
1791 print "COMMA($1)\n" if ($dbg_values > 1);
1792 $type = 'C';
1793
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001794 } elsif ($cur =~ /^(\?)/o) {
1795 print "QUESTION($1)\n" if ($dbg_values > 1);
1796 $type = 'N';
1797
1798 } elsif ($cur =~ /^(:)/o) {
1799 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1800
1801 substr($var, length($res), 1, $av_pend_colon);
1802 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1803 $type = 'E';
1804 } else {
1805 $type = 'N';
1806 }
1807 $av_pend_colon = 'O';
1808
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001809 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001810 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001811 $type = 'N';
1812
Andy Whitcroft0d413862008-10-15 22:02:16 -07001813 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001814 my $variant;
1815
1816 print "OPV($1)\n" if ($dbg_values > 1);
1817 if ($type eq 'V') {
1818 $variant = 'B';
1819 } else {
1820 $variant = 'U';
1821 }
1822
1823 substr($var, length($res), 1, $variant);
1824 $type = 'N';
1825
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001826 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001827 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001828 if ($1 ne '++' && $1 ne '--') {
1829 $type = 'N';
1830 }
1831
1832 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001833 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001834 }
1835 if (defined $1) {
1836 $cur = substr($cur, length($1));
1837 $res .= $type x length($1);
1838 }
1839 }
1840
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001841 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001842}
1843
Andy Whitcroft8905a672007-11-28 16:21:06 -08001844sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001845 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001846 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001847 ^(?:
1848 $Modifier|
1849 $Storage|
1850 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001851 DEFINE_\S+
1852 )$|
1853 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001854 goto|
1855 return|
1856 case|
1857 else|
1858 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001859 do|
1860 \#|
1861 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001862 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001863 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001864 )}x;
1865 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1866 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001867 # Check for modifiers.
1868 $possible =~ s/\s*$Storage\s*//g;
1869 $possible =~ s/\s*$Sparse\s*//g;
1870 if ($possible =~ /^\s*$/) {
1871
1872 } elsif ($possible =~ /\s/) {
1873 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001874 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001875 if ($modifier !~ $notPermitted) {
1876 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001877 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001878 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001879 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001880
1881 } else {
1882 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001883 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001884 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001885 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001886 } else {
1887 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001888 }
1889}
1890
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001891my $prefix = '';
1892
Joe Perches000d1cc12011-07-25 17:13:25 -07001893sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001894 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001895
Alexey Dobriyan522b8372017-02-27 14:30:05 -08001896 $type =~ tr/[a-z]/[A-Z]/;
1897
Joe Perchescbec18a2014-04-03 14:49:19 -07001898 return defined $use_type{$type} if (scalar keys %use_type > 0);
1899
1900 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001901}
1902
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001903sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001904 my ($level, $type, $msg) = @_;
1905
1906 if (!show_type($type) ||
1907 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001908 return 0;
1909 }
Joe Perches57230292015-06-25 15:03:03 -07001910 my $output = '';
John Brooks737c0762017-07-10 15:52:24 -07001911 if ($color) {
Joe Perches57230292015-06-25 15:03:03 -07001912 if ($level eq 'ERROR') {
1913 $output .= RED;
1914 } elsif ($level eq 'WARNING') {
1915 $output .= YELLOW;
1916 } else {
1917 $output .= GREEN;
1918 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001919 }
Joe Perches57230292015-06-25 15:03:03 -07001920 $output .= $prefix . $level . ':';
1921 if ($show_types) {
John Brooks737c0762017-07-10 15:52:24 -07001922 $output .= BLUE if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001923 $output .= "$type:";
1924 }
John Brooks737c0762017-07-10 15:52:24 -07001925 $output .= RESET if ($color);
Joe Perches57230292015-06-25 15:03:03 -07001926 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001927
1928 if ($showfile) {
1929 my @lines = split("\n", $output, -1);
1930 splice(@lines, 1, 1);
1931 $output = join("\n", @lines);
1932 }
Joe Perches57230292015-06-25 15:03:03 -07001933 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001934
Joe Perches57230292015-06-25 15:03:03 -07001935 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001936
1937 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001938}
Joe Perchescbec18a2014-04-03 14:49:19 -07001939
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001940sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001941 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001942}
Joe Perches000d1cc12011-07-25 17:13:25 -07001943
Joe Perchesd752fcc2014-08-06 16:11:05 -07001944sub fixup_current_range {
1945 my ($lineRef, $offset, $length) = @_;
1946
1947 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1948 my $o = $1;
1949 my $l = $2;
1950 my $no = $o + $offset;
1951 my $nl = $l + $length;
1952 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1953 }
1954}
1955
1956sub fix_inserted_deleted_lines {
1957 my ($linesRef, $insertedRef, $deletedRef) = @_;
1958
1959 my $range_last_linenr = 0;
1960 my $delta_offset = 0;
1961
1962 my $old_linenr = 0;
1963 my $new_linenr = 0;
1964
1965 my $next_insert = 0;
1966 my $next_delete = 0;
1967
1968 my @lines = ();
1969
1970 my $inserted = @{$insertedRef}[$next_insert++];
1971 my $deleted = @{$deletedRef}[$next_delete++];
1972
1973 foreach my $old_line (@{$linesRef}) {
1974 my $save_line = 1;
1975 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001976 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001977 $delta_offset = 0;
1978 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1979 $range_last_linenr = $new_linenr;
1980 fixup_current_range(\$line, $delta_offset, 0);
1981 }
1982
1983 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1984 $deleted = @{$deletedRef}[$next_delete++];
1985 $save_line = 0;
1986 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1987 }
1988
1989 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1990 push(@lines, ${$inserted}{'LINE'});
1991 $inserted = @{$insertedRef}[$next_insert++];
1992 $new_linenr++;
1993 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1994 }
1995
1996 if ($save_line) {
1997 push(@lines, $line);
1998 $new_linenr++;
1999 }
2000
2001 $old_linenr++;
2002 }
2003
2004 return @lines;
2005}
2006
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002007sub fix_insert_line {
2008 my ($linenr, $line) = @_;
2009
2010 my $inserted = {
2011 LINENR => $linenr,
2012 LINE => $line,
2013 };
2014 push(@fixed_inserted, $inserted);
2015}
2016
2017sub fix_delete_line {
2018 my ($linenr, $line) = @_;
2019
2020 my $deleted = {
2021 LINENR => $linenr,
2022 LINE => $line,
2023 };
2024
2025 push(@fixed_deleted, $deleted);
2026}
2027
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002028sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07002029 my ($type, $msg) = @_;
2030
2031 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002032 our $clean = 0;
2033 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07002034 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002035 }
Joe Perches3705ce52013-07-03 15:05:31 -07002036 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002037}
2038sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07002039 my ($type, $msg) = @_;
2040
2041 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002042 our $clean = 0;
2043 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07002044 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002045 }
Joe Perches3705ce52013-07-03 15:05:31 -07002046 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002047}
2048sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002049 my ($type, $msg) = @_;
2050
2051 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002052 our $clean = 0;
2053 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002054 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002055 }
Joe Perches3705ce52013-07-03 15:05:31 -07002056 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002057}
2058
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002059sub check_absolute_file {
2060 my ($absolute, $herecurr) = @_;
2061 my $file = $absolute;
2062
2063 ##print "absolute<$absolute>\n";
2064
2065 # See if any suffix of this path is a path within the tree.
2066 while ($file =~ s@^[^/]*/@@) {
2067 if (-f "$root/$file") {
2068 ##print "file<$file>\n";
2069 last;
2070 }
2071 }
2072 if (! -f _) {
2073 return 0;
2074 }
2075
2076 # It is, so see if the prefix is acceptable.
2077 my $prefix = $absolute;
2078 substr($prefix, -length($file)) = '';
2079
2080 ##print "prefix<$prefix>\n";
2081 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002082 WARN("USE_RELATIVE_PATH",
2083 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002084 }
2085}
2086
Joe Perches3705ce52013-07-03 15:05:31 -07002087sub trim {
2088 my ($string) = @_;
2089
Joe Perchesb34c6482013-09-11 14:24:01 -07002090 $string =~ s/^\s+|\s+$//g;
2091
2092 return $string;
2093}
2094
2095sub ltrim {
2096 my ($string) = @_;
2097
2098 $string =~ s/^\s+//;
2099
2100 return $string;
2101}
2102
2103sub rtrim {
2104 my ($string) = @_;
2105
2106 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002107
2108 return $string;
2109}
2110
Joe Perches52ea8502013-11-12 15:10:09 -08002111sub string_find_replace {
2112 my ($string, $find, $replace) = @_;
2113
2114 $string =~ s/$find/$replace/g;
2115
2116 return $string;
2117}
2118
Joe Perches3705ce52013-07-03 15:05:31 -07002119sub tabify {
2120 my ($leading) = @_;
2121
2122 my $source_indent = 8;
2123 my $max_spaces_before_tab = $source_indent - 1;
2124 my $spaces_to_tab = " " x $source_indent;
2125
2126 #convert leading spaces to tabs
2127 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2128 #Remove spaces before a tab
2129 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2130
2131 return "$leading";
2132}
2133
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002134sub pos_last_openparen {
2135 my ($line) = @_;
2136
2137 my $pos = 0;
2138
2139 my $opens = $line =~ tr/\(/\(/;
2140 my $closes = $line =~ tr/\)/\)/;
2141
2142 my $last_openparen = 0;
2143
2144 if (($opens == 0) || ($closes >= $opens)) {
2145 return -1;
2146 }
2147
2148 my $len = length($line);
2149
2150 for ($pos = 0; $pos < $len; $pos++) {
2151 my $string = substr($line, $pos);
2152 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2153 $pos += length($1) - 1;
2154 } elsif (substr($line, $pos, 1) eq '(') {
2155 $last_openparen = $pos;
2156 } elsif (index($string, '(') == -1) {
2157 last;
2158 }
2159 }
2160
Joe Perches91cb5192014-04-03 14:49:32 -07002161 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002162}
2163
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002164sub process {
2165 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002166
2167 my $linenr=0;
2168 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002169 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002170 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002171 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002172
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002173 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002174 my $indent;
2175 my $previndent=0;
2176 my $stashindent=0;
2177
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002178 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002179 my $signoff = 0;
2180 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002181 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002182 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002183 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002184 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002185 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002186 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002187 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002188 my $non_utf8_charset = 0;
2189
Joe Perches365dd4e2014-08-06 16:10:42 -07002190 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002191 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002192
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002193 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002194 our $cnt_lines = 0;
2195 our $cnt_error = 0;
2196 our $cnt_warn = 0;
2197 our $cnt_chk = 0;
2198
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002199 # Trace the real file/line as we go.
2200 my $realfile = '';
2201 my $realline = 0;
2202 my $realcnt = 0;
2203 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002204 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002205 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002206 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002207 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002208 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002209
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002210 my $prev_values = 'E';
2211
2212 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002213 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002214 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002215 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002216 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002217
Joe Perches7e51f192013-09-11 14:23:57 -07002218 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002219
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002220 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002221 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002222 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002223 my @setup_docs = ();
2224 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002225
Joe Perchesd8b07712013-11-12 15:10:06 -08002226 my $camelcase_file_seeded = 0;
2227
Andy Whitcroft773647a2008-03-28 14:15:58 -07002228 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002229 my $line;
2230 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002231 $linenr++;
2232 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002233
Joe Perches3705ce52013-07-03 15:05:31 -07002234 push(@fixed, $rawline) if ($fix);
2235
Andy Whitcroft773647a2008-03-28 14:15:58 -07002236 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002237 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002238 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002239 $setup_docs = 1;
2240 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002241 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002242 }
Joe Perches74fd4f32017-05-08 15:56:02 -07002243 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002244 $realline=$1-1;
2245 if (defined $2) {
2246 $realcnt=$3+1;
2247 } else {
2248 $realcnt=1+1;
2249 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002250 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002251
2252 # Guestimate if this is a continuing comment. Run
2253 # the context looking for a comment "edge". If this
2254 # edge is a close comment then we must be in a comment
2255 # at context start.
2256 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002257 my $cnt = $realcnt;
2258 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2259 next if (defined $rawlines[$ln - 1] &&
2260 $rawlines[$ln - 1] =~ /^-/);
2261 $cnt--;
2262 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002263 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002264 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2265 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2266 ($edge) = $1;
2267 last;
2268 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002269 }
2270 if (defined $edge && $edge eq '*/') {
2271 $in_comment = 1;
2272 }
2273
2274 # Guestimate if this is a continuing comment. If this
2275 # is the start of a diff block and this line starts
2276 # ' *' then it is very likely a comment.
2277 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002278 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002279 {
2280 $in_comment = 1;
2281 }
2282
2283 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2284 sanitise_line_reset($in_comment);
2285
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002286 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002287 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002288 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002289 $line = sanitise_line($rawline);
2290 }
2291 push(@lines, $line);
2292
2293 if ($realcnt > 1) {
2294 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2295 } else {
2296 $realcnt = 0;
2297 }
2298
2299 #print "==>$rawline\n";
2300 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002301
2302 if ($setup_docs && $line =~ /^\+/) {
2303 push(@setup_docs, $line);
2304 }
2305 }
2306
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002307 $prefix = '';
2308
Andy Whitcroft773647a2008-03-28 14:15:58 -07002309 $realcnt = 0;
2310 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002311 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002312 foreach my $line (@lines) {
2313 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002314 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002315 my $sline = $line; #copy of $line
2316 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002317
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002318 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002319
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002320#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002321 if (!$in_commit_log &&
Joe Perches74fd4f32017-05-08 15:56:02 -07002322 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2323 my $context = $4;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002324 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002325 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002326 $realline=$1-1;
2327 if (defined $2) {
2328 $realcnt=$3+1;
2329 } else {
2330 $realcnt=1+1;
2331 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002332 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002333 $prev_values = 'E';
2334
Andy Whitcroft773647a2008-03-28 14:15:58 -07002335 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002336 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002337 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002338 $suppress_statement = 0;
Joe Perches74fd4f32017-05-08 15:56:02 -07002339 if ($context =~ /\b(\w+)\s*\(/) {
2340 $context_function = $1;
2341 } else {
2342 undef $context_function;
2343 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002344 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002345
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002346# track the line number as we move through the hunk, note that
2347# new versions of GNU diff omit the leading space on completely
2348# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002349 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002350 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002351 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002352
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002353 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002354 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002355
2356 # Track the previous line.
2357 ($prevline, $stashline) = ($stashline, $line);
2358 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002359 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2360
Andy Whitcroft773647a2008-03-28 14:15:58 -07002361 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002362
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002363 } elsif ($realcnt == 1) {
2364 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002365 }
2366
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002367 my $hunk_line = ($realcnt != 0);
2368
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002369 $here = "#$linenr: " if (!$file);
2370 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002371
Joe Perches2ac73b42014-06-04 16:12:05 -07002372 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002373 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002374 if ($line =~ /^diff --git.*?(\S+)$/) {
2375 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002376 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002377 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002378 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002379 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002380 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002381 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002382 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002383
2384 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002385 if (!$file && $tree && $p1_prefix ne '' &&
2386 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002387 WARN("PATCH_PREFIX",
2388 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002389 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002390
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002391 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002392 ERROR("MODIFIED_INCLUDE_ASM",
2393 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
Andy Whitcroft773647a2008-03-28 14:15:58 -07002394 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002395 $found_file = 1;
2396 }
2397
Joe Perches34d88152015-06-25 15:03:05 -07002398#make up the handle for any error we report on this line
2399 if ($showfile) {
2400 $prefix = "$realfile:$realline: "
2401 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002402 if ($file) {
2403 $prefix = "$filename:$realline: ";
2404 } else {
2405 $prefix = "$filename:$linenr: ";
2406 }
Joe Perches34d88152015-06-25 15:03:05 -07002407 }
2408
Joe Perches2ac73b42014-06-04 16:12:05 -07002409 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002410 if (is_maintained_obsolete($realfile)) {
2411 WARN("OBSOLETE",
2412 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2413 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002414 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002415 $check = 1;
2416 } else {
2417 $check = $check_orig;
2418 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419 next;
2420 }
2421
Randy Dunlap389834b2007-06-08 13:47:03 -07002422 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002423
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002424 my $hereline = "$here\n$rawline\n";
2425 my $herecurr = "$here\n$rawline\n";
2426 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002427
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002428 $cnt_lines++ if ($realcnt != 0);
2429
Joe Perchese518e9a2015-06-25 15:03:27 -07002430# Check if the commit log has what seems like a diff which can confuse patch
2431 if ($in_commit_log && !$commit_log_has_diff &&
2432 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2433 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2434 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2435 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2436 ERROR("DIFF_IN_COMMIT_MSG",
2437 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2438 $commit_log_has_diff = 1;
2439 }
2440
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002441# Check for incorrect file permissions
2442 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2443 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002444 if ($realfile !~ m@scripts/@ &&
2445 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002446 ERROR("EXECUTE_PERMISSIONS",
2447 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002448 }
2449 }
2450
Joe Perches20112472011-07-25 17:13:23 -07002451# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002452 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002453 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002454 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002455 }
2456
Joe Perchese0d975b2014-12-10 15:51:49 -08002457# Check if MAINTAINERS is being updated. If so, there's probably no need to
2458# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2459 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2460 $reported_maintainer_file = 1;
2461 }
2462
Joe Perches20112472011-07-25 17:13:23 -07002463# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002464 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002465 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002466 my $space_before = $1;
2467 my $sign_off = $2;
2468 my $space_after = $3;
2469 my $email = $4;
2470 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2471
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002472 if ($sign_off !~ /$signature_tags/) {
2473 WARN("BAD_SIGN_OFF",
2474 "Non-standard signature: $sign_off\n" . $herecurr);
2475 }
Joe Perches20112472011-07-25 17:13:23 -07002476 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002477 if (WARN("BAD_SIGN_OFF",
2478 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2479 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002480 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002481 "$ucfirst_sign_off $email";
2482 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002483 }
Joe Perches20112472011-07-25 17:13:23 -07002484 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002485 if (WARN("BAD_SIGN_OFF",
2486 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2487 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002488 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002489 "$ucfirst_sign_off $email";
2490 }
2491
Joe Perches20112472011-07-25 17:13:23 -07002492 }
2493 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002494 if (WARN("BAD_SIGN_OFF",
2495 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2496 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002497 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002498 "$ucfirst_sign_off $email";
2499 }
Joe Perches20112472011-07-25 17:13:23 -07002500 }
2501
2502 my ($email_name, $email_address, $comment) = parse_email($email);
2503 my $suggested_email = format_email(($email_name, $email_address));
2504 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002505 ERROR("BAD_SIGN_OFF",
2506 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002507 } else {
2508 my $dequoted = $suggested_email;
2509 $dequoted =~ s/^"//;
2510 $dequoted =~ s/" </ </;
2511 # Don't force email to have quotes
2512 # Allow just an angle bracketed address
2513 if ("$dequoted$comment" ne $email &&
2514 "<$email_address>$comment" ne $email &&
2515 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002516 WARN("BAD_SIGN_OFF",
2517 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002518 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002519 }
Joe Perches7e51f192013-09-11 14:23:57 -07002520
2521# Check for duplicate signatures
2522 my $sig_nospace = $line;
2523 $sig_nospace =~ s/\s//g;
2524 $sig_nospace = lc($sig_nospace);
2525 if (defined $signatures{$sig_nospace}) {
2526 WARN("BAD_SIGN_OFF",
2527 "Duplicate signature\n" . $herecurr);
2528 } else {
2529 $signatures{$sig_nospace} = 1;
2530 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002531 }
2532
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002533# Check email subject for common tools that don't need to be mentioned
2534 if ($in_header_lines &&
2535 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2536 WARN("EMAIL_SUBJECT",
2537 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2538 }
2539
Joe Perches9b3189e2014-06-04 16:12:10 -07002540# Check for old stable address
2541 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2542 ERROR("STABLE_ADDRESS",
2543 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2544 }
2545
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002546# Check for unwanted Gerrit info
2547 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2548 ERROR("GERRIT_CHANGE_ID",
2549 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2550 }
2551
Joe Perches369c8dd2015-11-06 16:31:34 -08002552# Check if the commit log is in a possible stack dump
2553 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2554 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2555 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2556 # timestamp
2557 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2558 # stack dump address
2559 $commit_log_possible_stack_dump = 1;
2560 }
2561
Joe Perches2a076f42015-04-16 12:44:28 -07002562# Check for line lengths > 75 in commit log, warn once
2563 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002564 length($line) > 75 &&
2565 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2566 # file delta changes
2567 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2568 # filename then :
2569 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2570 # A Fixes: or Link: line
2571 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002572 WARN("COMMIT_LOG_LONG_LINE",
2573 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2574 $commit_log_long_line = 1;
2575 }
2576
Joe Perchesbf4daf12015-09-09 15:37:50 -07002577# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002578 if ($in_commit_log && $commit_log_possible_stack_dump &&
2579 $line =~ /^\s*$/) {
2580 $commit_log_possible_stack_dump = 0;
2581 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002582
Joe Perches0d7835f2015-02-13 14:38:35 -08002583# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002584 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002585 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wange882dbf2017-05-08 15:55:54 -07002586 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002587 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002588 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002589 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2590 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002591 my $init_char = "c";
2592 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002593 my $short = 1;
2594 my $long = 0;
2595 my $case = 1;
2596 my $space = 1;
2597 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002598 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002599 my $id = '0123456789ab';
2600 my $orig_desc = "commit description";
2601 my $description = "";
2602
Joe Perchesfe043ea2015-09-09 15:37:25 -07002603 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2604 $init_char = $1;
2605 $orig_commit = lc($2);
2606 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2607 $orig_commit = lc($1);
2608 }
2609
Joe Perches0d7835f2015-02-13 14:38:35 -08002610 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2611 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2612 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2613 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2614 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2615 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002616 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002617 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2618 defined $rawlines[$linenr] &&
2619 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2620 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002621 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002622 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2623 defined $rawlines[$linenr] &&
2624 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2625 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2626 $orig_desc = $1;
2627 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2628 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002629 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002630 }
2631
2632 ($id, $description) = git_commit_info($orig_commit,
2633 $id, $orig_desc);
2634
Heinrich Schuchardt948b1332017-07-10 15:52:16 -07002635 if (defined($id) &&
2636 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002637 ERROR("GIT_COMMIT_ID",
2638 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2639 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002640 }
2641
Joe Perches13f19372014-08-06 16:10:59 -07002642# Check for added, moved or deleted files
2643 if (!$reported_maintainer_file && !$in_commit_log &&
2644 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2645 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2646 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2647 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002648 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002649 $reported_maintainer_file = 1;
2650 WARN("FILE_PATH_CHANGES",
2651 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2652 }
2653
Andy Whitcroft00df3442007-06-08 13:47:06 -07002654# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002655 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002656 ERROR("CORRUPTED_PATCH",
2657 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002658 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002659 }
2660
2661# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2662 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002663 $rawline !~ m/^$UTF8*$/) {
2664 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2665
2666 my $blank = copy_spacing($rawline);
2667 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2668 my $hereptr = "$hereline$ptr\n";
2669
Joe Perches34d99212011-07-25 17:13:26 -07002670 CHK("INVALID_UTF8",
2671 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002672 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002673
Joe Perches15662b32011-10-31 17:13:12 -07002674# Check if it's the start of a commit log
2675# (not a header line and we haven't seen the patch filename)
2676 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Percheseb3a58d2017-05-08 15:55:42 -07002677 !($rawline =~ /^\s+(?:\S|$)/ ||
2678 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002679 $in_header_lines = 0;
2680 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002681 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002682 }
2683
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002684# Check if there is UTF-8 in a commit log when a mail header has explicitly
2685# declined it, i.e defined some charset where it is missing.
2686 if ($in_header_lines &&
2687 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2688 $1 !~ /utf-8/i) {
2689 $non_utf8_charset = 1;
2690 }
2691
2692 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002693 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002694 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002695 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2696 }
2697
Joe Perchesd6430f72016-12-12 16:46:28 -08002698# Check for absolute kernel paths in commit message
2699 if ($tree && $in_commit_log) {
2700 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2701 my $file = $1;
2702
2703 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2704 check_absolute_file($1, $herecurr)) {
2705 #
2706 } else {
2707 check_absolute_file($file, $herecurr);
2708 }
2709 }
2710 }
2711
Kees Cook66b47b42014-10-13 15:51:57 -07002712# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002713 if (defined($misspellings) &&
2714 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002715 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002716 my $typo = $1;
2717 my $typo_fix = $spelling_fix{lc($typo)};
2718 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2719 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
Jean Delvare0675a8f2017-09-08 16:16:07 -07002720 my $msg_level = \&WARN;
2721 $msg_level = \&CHK if ($file);
2722 if (&{$msg_level}("TYPO_SPELLING",
2723 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
Kees Cook66b47b42014-10-13 15:51:57 -07002724 $fix) {
2725 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2726 }
2727 }
2728 }
2729
Andy Whitcroft306708542008-10-15 22:02:28 -07002730# ignore non-hunk lines and lines being removed
2731 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002732
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002733#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002734 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002735 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002736 if (ERROR("DOS_LINE_ENDINGS",
2737 "DOS line endings\n" . $herevet) &&
2738 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002739 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002740 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002741 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2742 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002743 if (ERROR("TRAILING_WHITESPACE",
2744 "trailing whitespace\n" . $herevet) &&
2745 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002746 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002747 }
2748
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002749 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002750 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002751
Josh Triplett4783f892013-11-12 15:10:12 -08002752# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002753 if ($rawline =~ /\bwrite to the Free/i ||
Matthew Wilcox1bde5612017-02-24 15:01:38 -08002754 $rawline =~ /\b675\s+Mass\s+Ave/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002755 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2756 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002757 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Jean Delvare0675a8f2017-09-08 16:16:07 -07002758 my $msg_level = \&ERROR;
2759 $msg_level = \&CHK if ($file);
2760 &{$msg_level}("FSF_MAILING_ADDRESS",
2761 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
Josh Triplett4783f892013-11-12 15:10:12 -08002762 }
2763
Andi Kleen33549572010-05-24 14:33:29 -07002764# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002765# Only applies when adding the entry originally, after that we do not have
2766# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002767 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002768 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002769 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002770 my $cnt = $realcnt;
2771 my $ln = $linenr + 1;
2772 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002773 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002774 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002775 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002776 $f = $lines[$ln - 1];
2777 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2778 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002779
2780 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002781 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002782
Joe Perches8d73e0e2014-08-06 16:10:46 -07002783 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002784 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002785 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002786 $length = -1;
2787 }
2788
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002789 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002790 $f =~ s/#.*//;
2791 $f =~ s/^\s+//;
2792 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002793 if ($f =~ /^\s*config\s/) {
2794 $is_end = 1;
2795 last;
2796 }
Andi Kleen33549572010-05-24 14:33:29 -07002797 $length++;
2798 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002799 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2800 WARN("CONFIG_DESCRIPTION",
2801 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2802 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002803 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002804 }
2805
Joe Perches628f91a2017-07-10 15:52:07 -07002806# check for MAINTAINERS entries that don't have the right form
2807 if ($realfile =~ /^MAINTAINERS$/ &&
2808 $rawline =~ /^\+[A-Z]:/ &&
2809 $rawline !~ /^\+[A-Z]:\t\S/) {
2810 if (WARN("MAINTAINERS_STYLE",
2811 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) &&
2812 $fix) {
2813 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/;
2814 }
2815 }
2816
Christoph Jaeger327953e2015-02-13 14:38:29 -08002817# discourage the use of boolean for type definition attributes of Kconfig options
2818 if ($realfile =~ /Kconfig/ &&
2819 $line =~ /^\+\s*\bboolean\b/) {
2820 WARN("CONFIG_TYPE_BOOLEAN",
2821 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2822 }
2823
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002824 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2825 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2826 my $flag = $1;
2827 my $replacement = {
2828 'EXTRA_AFLAGS' => 'asflags-y',
2829 'EXTRA_CFLAGS' => 'ccflags-y',
2830 'EXTRA_CPPFLAGS' => 'cppflags-y',
2831 'EXTRA_LDFLAGS' => 'ldflags-y',
2832 };
2833
2834 WARN("DEPRECATED_VARIABLE",
2835 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2836 }
2837
Rob Herringbff5da42014-01-23 15:54:51 -08002838# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002839 if (defined $root &&
2840 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2841 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2842
Rob Herringbff5da42014-01-23 15:54:51 -08002843 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2844
Florian Vaussardcc933192014-04-03 14:49:27 -07002845 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2846 my $vp_file = $dt_path . "vendor-prefixes.txt";
2847
Rob Herringbff5da42014-01-23 15:54:51 -08002848 foreach my $compat (@compats) {
2849 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002850 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2851 my $compat3 = $compat;
2852 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2853 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002854 if ( $? >> 8 ) {
2855 WARN("UNDOCUMENTED_DT_STRING",
2856 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2857 }
2858
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002859 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2860 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002861 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002862 if ( $? >> 8 ) {
2863 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002864 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002865 }
2866 }
2867 }
2868
Andy Whitcroft5368df202008-10-15 22:02:27 -07002869# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002870 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002871
Joe Perches47e0c882015-06-25 15:02:57 -07002872# line length limit (with some exclusions)
2873#
2874# There are a few types of lines that may extend beyond $max_line_length:
2875# logging functions like pr_info that end in a string
2876# lines with a single string
2877# #defines that are a single string
2878#
2879# There are 3 different line length message types:
Jean Delvareab1ecab2017-09-08 16:16:04 -07002880# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
Joe Perches47e0c882015-06-25 15:02:57 -07002881# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2882# LONG_LINE all other lines longer than $max_line_length
2883#
2884# if LONG_LINE is ignored, the other 2 types are also ignored
2885#
2886
Joe Perchesb4749e92015-07-17 16:24:01 -07002887 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002888 my $msg_type = "LONG_LINE";
2889
2890 # Check the allowed long line types first
2891
2892 # logging functions that end in a string that starts
2893 # before $max_line_length
2894 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2895 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2896 $msg_type = "";
2897
2898 # lines with only strings (w/ possible termination)
2899 # #defines with only strings
2900 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2901 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2902 $msg_type = "";
2903
Joe Perchescc147502017-11-17 15:28:44 -08002904 # More special cases
2905 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ ||
2906 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) {
Joe Perchesd560a5f2016-08-02 14:04:31 -07002907 $msg_type = "";
2908
Joe Perches47e0c882015-06-25 15:02:57 -07002909 # Otherwise set the alternate message types
2910
2911 # a comment starts before $max_line_length
2912 } elsif ($line =~ /($;[\s$;]*)$/ &&
2913 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2914 $msg_type = "LONG_LINE_COMMENT"
2915
2916 # a quoted string starts before $max_line_length
2917 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2918 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2919 $msg_type = "LONG_LINE_STRING"
2920 }
2921
2922 if ($msg_type ne "" &&
2923 (show_type("LONG_LINE") || show_type($msg_type))) {
2924 WARN($msg_type,
2925 "line over $max_line_length characters\n" . $herecurr);
2926 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002927 }
2928
Andy Whitcroft8905a672007-11-28 16:21:06 -08002929# check for adding lines without a newline.
2930 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002931 WARN("MISSING_EOF_NEWLINE",
2932 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002933 }
2934
Mike Frysinger42e41c52009-09-21 17:04:40 -07002935# Blackfin: use hi/lo macros
2936 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2937 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2938 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002939 ERROR("LO_MACRO",
2940 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002941 }
2942 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2943 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002944 ERROR("HI_MACRO",
2945 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002946 }
2947 }
2948
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002949# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002950 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002951
2952# at the beginning of a line any tabs must come first and anything
2953# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002954 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2955 $rawline =~ /^\+\s* \s*/) {
2956 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002957 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002958 if (ERROR("CODE_INDENT",
2959 "code indent should use tabs where possible\n" . $herevet) &&
2960 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002961 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002962 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002963 }
2964
Alberto Panizzo08e44362010-03-05 13:43:54 -08002965# check for space before tabs.
2966 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2967 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002968 if (WARN("SPACE_BEFORE_TAB",
2969 "please, no space before tabs\n" . $herevet) &&
2970 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002971 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002972 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002973 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002974 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002975 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002976 }
2977
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002978# check for && or || at the start of a line
2979 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2980 CHK("LOGICAL_CONTINUATIONS",
2981 "Logical continuations should be on the previous line\n" . $hereprev);
2982 }
2983
Joe Perchesa91e8992016-05-20 17:04:05 -07002984# check indentation starts on a tab stop
2985 if ($^V && $^V ge 5.10.0 &&
2986 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2987 my $indent = length($1);
2988 if ($indent % 8) {
2989 if (WARN("TABSTOP",
2990 "Statements should start on a tabstop\n" . $herecurr) &&
2991 $fix) {
2992 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2993 }
2994 }
2995 }
2996
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002997# check multi-line statement indentation matches previous line
2998 if ($^V && $^V ge 5.10.0 &&
Joe Perchesfd71f632017-07-10 15:52:30 -07002999 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003000 $prevline =~ /^\+(\t*)(.*)$/;
3001 my $oldindent = $1;
3002 my $rest = $2;
3003
3004 my $pos = pos_last_openparen($rest);
3005 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003006 $line =~ /^(\+| )([ \t]*)/;
3007 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003008
3009 my $goodtabindent = $oldindent .
3010 "\t" x ($pos / 8) .
3011 " " x ($pos % 8);
3012 my $goodspaceindent = $oldindent . " " x $pos;
3013
3014 if ($newindent ne $goodtabindent &&
3015 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003016
3017 if (CHK("PARENTHESIS_ALIGNMENT",
3018 "Alignment should match open parenthesis\n" . $hereprev) &&
3019 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003020 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003021 s/^\+[ \t]*/\+$goodtabindent/;
3022 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003023 }
3024 }
3025 }
3026
Joe Perches6ab3a972015-04-16 12:44:05 -07003027# check for space after cast like "(int) foo" or "(struct foo) bar"
3028# avoid checking a few false positives:
3029# "sizeof(<type>)" or "__alignof__(<type>)"
3030# function pointer declarations like "(*foo)(int) = bar;"
3031# structure definitions like "(struct foo) { 0 };"
3032# multiline macros that define functions
3033# known attributes or the __attribute__ keyword
3034 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3035 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003036 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003037 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003038 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003039 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003040 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003041 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003042 }
3043
Joe Perches86406b12015-09-09 15:37:41 -07003044# Block comment styles
3045# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003046 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003047 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003048 $rawline =~ /^\+[ \t]*\*/ &&
3049 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003050 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3051 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3052 }
3053
Joe Perches86406b12015-09-09 15:37:41 -07003054# Block comments use * on subsequent lines
3055 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3056 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003057 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003058 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003059 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003060 WARN("BLOCK_COMMENT_STYLE",
3061 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003062 }
3063
Joe Perches86406b12015-09-09 15:37:41 -07003064# Block comments use */ on trailing lines
3065 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003066 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3067 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3068 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003069 WARN("BLOCK_COMMENT_STYLE",
3070 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003071 }
3072
Joe Perches08eb9b82016-10-11 13:51:50 -07003073# Block comment * alignment
3074 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003075 $line =~ /^\+[ \t]*$;/ && #leading comment
3076 $rawline =~ /^\+[ \t]*\*/ && #leading *
3077 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003078 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003079 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3080 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003081 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003082 if (defined($1)) {
3083 $oldindent = expand_tabs($1);
3084 } else {
3085 $prevrawline =~ m@^\+(.*/?)\*@;
3086 $oldindent = expand_tabs($1);
3087 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003088 $rawline =~ m@^\+([ \t]*)\*@;
3089 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003090 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003091 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003092 WARN("BLOCK_COMMENT_STYLE",
3093 "Block comments should align the * on each line\n" . $hereprev);
3094 }
3095 }
3096
Joe Perches7f619192014-08-06 16:10:39 -07003097# check for missing blank lines after struct/union declarations
3098# with exceptions for various attributes and macros
3099 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3100 $line =~ /^\+/ &&
3101 !($line =~ /^\+\s*$/ ||
3102 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3103 $line =~ /^\+\s*MODULE_/i ||
3104 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3105 $line =~ /^\+[a-z_]*init/ ||
3106 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3107 $line =~ /^\+\s*DECLARE/ ||
3108 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003109 if (CHK("LINE_SPACING",
3110 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3111 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003112 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003113 }
Joe Perches7f619192014-08-06 16:10:39 -07003114 }
3115
Joe Perches365dd4e2014-08-06 16:10:42 -07003116# check for multiple consecutive blank lines
3117 if ($prevline =~ /^[\+ ]\s*$/ &&
3118 $line =~ /^\+\s*$/ &&
3119 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003120 if (CHK("LINE_SPACING",
3121 "Please don't use multiple blank lines\n" . $hereprev) &&
3122 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003123 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003124 }
3125
Joe Perches365dd4e2014-08-06 16:10:42 -07003126 $last_blank_line = $linenr;
3127 }
3128
Joe Perches3b617e32014-04-03 14:49:28 -07003129# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003130 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3131 # actual declarations
3132 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003133 # function pointer declarations
3134 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003135 # foo bar; where foo is some local typedef or #define
3136 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3137 # known declaration macros
3138 $prevline =~ /^\+\s+$declaration_macros/) &&
3139 # for "else if" which can look like "$Ident $Ident"
3140 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3141 # other possible extensions of declaration lines
3142 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3143 # not starting a section or a macro "\" extended line
3144 $prevline =~ /(?:\{\s*|\\)$/) &&
3145 # looks like a declaration
3146 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003147 # function pointer declarations
3148 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003149 # foo bar; where foo is some local typedef or #define
3150 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3151 # known declaration macros
3152 $sline =~ /^\+\s+$declaration_macros/ ||
3153 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003154 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003155 # start or end of block or continuation of declaration
3156 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3157 # bitfield continuation
3158 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3159 # other possible extensions of declaration lines
3160 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3161 # indentation of previous and current line are the same
3162 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003163 if (WARN("LINE_SPACING",
3164 "Missing a blank line after declarations\n" . $hereprev) &&
3165 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003166 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003167 }
Joe Perches3b617e32014-04-03 14:49:28 -07003168 }
3169
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003170# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003171# Exceptions:
3172# 1) within comments
3173# 2) indented preprocessor commands
3174# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003175 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003176 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003177 if (WARN("LEADING_SPACE",
3178 "please, no spaces at the start of a line\n" . $herevet) &&
3179 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003180 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003181 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003182 }
3183
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003184# check we are in a valid C source file if not then ignore this hunk
3185 next if ($realfile !~ /\.(h|c)$/);
3186
Joe Perches5751a242017-11-17 15:28:52 -08003187# check for unusual line ending [ or (
3188 if ($line =~ /^\+.*([\[\(])\s*$/) {
3189 CHK("OPEN_ENDED_LINE",
3190 "Lines should not end with a '$1'\n" . $herecurr);
3191 }
3192
Joe Perches4dbed762017-05-08 15:55:39 -07003193# check if this appears to be the start function declaration, save the name
3194 if ($sline =~ /^\+\{\s*$/ &&
3195 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) {
3196 $context_function = $1;
3197 }
3198
3199# check if this appears to be the end of function declaration
3200 if ($sline =~ /^\+\}\s*$/) {
3201 undef $context_function;
3202 }
3203
Joe Perches032a4c02014-08-06 16:10:29 -07003204# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003205# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003206# if the previous line is a break or return and is indented 1 tab more...
3207 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3208 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003209 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3210 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3211 defined $lines[$linenr] &&
3212 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003213 WARN("UNNECESSARY_ELSE",
3214 "else is not generally useful after a break or return\n" . $hereprev);
3215 }
3216 }
3217
Joe Perchesc00df192014-08-06 16:11:01 -07003218# check indentation of a line with a break;
3219# if the previous line is a goto or return and is indented the same # of tabs
3220 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3221 my $tabs = $1;
3222 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3223 WARN("UNNECESSARY_BREAK",
3224 "break is not useful after a goto or return\n" . $hereprev);
3225 }
3226 }
3227
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003228# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003229 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003230 WARN("CVS_KEYWORD",
3231 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003232 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003233
Mike Frysinger42e41c52009-09-21 17:04:40 -07003234# Blackfin: don't use __builtin_bfin_[cs]sync
3235 if ($line =~ /__builtin_bfin_csync/) {
3236 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003237 ERROR("CSYNC",
3238 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003239 }
3240 if ($line =~ /__builtin_bfin_ssync/) {
3241 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003242 ERROR("SSYNC",
3243 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003244 }
3245
Joe Perches56e77d72013-02-21 16:44:14 -08003246# check for old HOTPLUG __dev<foo> section markings
3247 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3248 WARN("HOTPLUG_SECTION",
3249 "Using $1 is unnecessary\n" . $herecurr);
3250 }
3251
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003252# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003253 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3254 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003255#print "LINE<$line>\n";
Joe Perchesca819862017-07-10 15:52:13 -07003256 if ($linenr > $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003257 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003258 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003259 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003260 $stat =~ s/\n./\n /g;
3261 $cond =~ s/\n./\n /g;
3262
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003263#print "linenr<$linenr> <$stat>\n";
3264 # If this statement has no statement boundaries within
3265 # it there is no point in retrying a statement scan
3266 # until we hit end of it.
3267 my $frag = $stat; $frag =~ s/;+\s*$//;
3268 if ($frag !~ /(?:{|;)/) {
3269#print "skip<$line_nr_next>\n";
3270 $suppress_statement = $line_nr_next;
3271 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003272
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003273 # Find the real next line.
3274 $realline_next = $line_nr_next;
3275 if (defined $realline_next &&
3276 (!defined $lines[$realline_next - 1] ||
3277 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3278 $realline_next++;
3279 }
3280
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003281 my $s = $stat;
3282 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003283
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003284 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003285 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003286
3287 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003288 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003289
Andy Whitcroft463f2862009-09-21 17:04:34 -07003290 } elsif ($s =~ /^.\s*else\b/s) {
3291
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003292 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003293 } 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 -07003294 my $type = $1;
3295 $type =~ s/\s+/ /g;
3296 possible($type, "A:" . $s);
3297
Andy Whitcroft8905a672007-11-28 16:21:06 -08003298 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003299 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003300 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003301 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003302
3303 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003304 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003305 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003306 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003307
3308 # Check for any sort of function declaration.
3309 # int foo(something bar, other baz);
3310 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003311 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 -08003312 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003313
Andy Whitcroftcf655042008-03-04 14:28:20 -08003314 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003315 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003316 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003317
Andy Whitcroft8905a672007-11-28 16:21:06 -08003318 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003319 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003320
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003321 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003322 }
3323 }
3324 }
3325
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003326 }
3327
Andy Whitcroft653d4872007-06-23 17:16:34 -07003328#
3329# Checks which may be anchored in the context.
3330#
3331
3332# Check for switch () and associated case and default
3333# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003334 if ($line=~/\bswitch\s*\(.*\)/) {
3335 my $err = '';
3336 my $sep = '';
3337 my @ctx = ctx_block_outer($linenr, $realcnt);
3338 shift(@ctx);
3339 for my $ctx (@ctx) {
3340 my ($clen, $cindent) = line_stats($ctx);
3341 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3342 $indent != $cindent) {
3343 $err .= "$sep$ctx\n";
3344 $sep = '';
3345 } else {
3346 $sep = "[...]\n";
3347 }
3348 }
3349 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003350 ERROR("SWITCH_CASE_INDENT_LEVEL",
3351 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003352 }
3353 }
3354
3355# if/while/etc brace do not go on next line, unless defining a do while loop,
3356# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003357 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 -07003358 my $pre_ctx = "$1$2";
3359
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003360 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003361
3362 if ($line =~ /^\+\t{6,}/) {
3363 WARN("DEEP_INDENTATION",
3364 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3365 }
3366
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003367 my $ctx_cnt = $realcnt - $#ctx - 1;
3368 my $ctx = join("\n", @ctx);
3369
Andy Whitcroft548596d2008-07-23 21:29:01 -07003370 my $ctx_ln = $linenr;
3371 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003372
Andy Whitcroft548596d2008-07-23 21:29:01 -07003373 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3374 defined $lines[$ctx_ln - 1] &&
3375 $lines[$ctx_ln - 1] =~ /^-/)) {
3376 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3377 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003378 $ctx_ln++;
3379 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003380
Andy Whitcroft53210162008-07-23 21:29:03 -07003381 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3382 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003383
Joe Perchesd752fcc2014-08-06 16:11:05 -07003384 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003385 ERROR("OPEN_BRACE",
3386 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003387 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003388 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003389 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3390 $ctx =~ /\)\s*\;\s*$/ &&
3391 defined $lines[$ctx_ln - 1])
3392 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003393 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3394 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003395 WARN("TRAILING_SEMICOLON",
3396 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003397 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003398 }
3399 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003400 }
3401
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003402# Check relative indent for conditionals and blocks.
Joe Perchesf6950a72017-05-08 15:56:05 -07003403 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 -08003404 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3405 ctx_statement_block($linenr, $realcnt, 0)
3406 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003407 my ($s, $c) = ($stat, $cond);
3408
3409 substr($s, 0, length($c), '');
3410
Joe Perches9f5af482015-09-09 15:37:30 -07003411 # remove inline comments
3412 $s =~ s/$;/ /g;
3413 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003414
3415 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003416 my @newlines = ($c =~ /\n/gs);
3417 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003418
Joe Perches9f5af482015-09-09 15:37:30 -07003419 # Make sure we remove the line prefixes as we have
3420 # none on the first line, and are going to readd them
3421 # where necessary.
3422 $s =~ s/\n./\n/gs;
3423 while ($s =~ /\n\s+\\\n/) {
3424 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3425 }
3426
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003427 # We want to check the first line inside the block
3428 # starting at the end of the conditional, so remove:
3429 # 1) any blank line termination
3430 # 2) any opening brace { on end of the line
3431 # 3) any do (...) {
3432 my $continuation = 0;
3433 my $check = 0;
3434 $s =~ s/^.*\bdo\b//;
3435 $s =~ s/^\s*{//;
3436 if ($s =~ s/^\s*\\//) {
3437 $continuation = 1;
3438 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003439 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003440 $check = 1;
3441 $cond_lines++;
3442 }
3443
3444 # Also ignore a loop construct at the end of a
3445 # preprocessor statement.
3446 if (($prevline =~ /^.\s*#\s*define\s/ ||
3447 $prevline =~ /\\\s*$/) && $continuation == 0) {
3448 $check = 0;
3449 }
3450
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003451 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003452 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003453 while ($cond_ptr != $cond_lines) {
3454 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003455
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003456 # If we see an #else/#elif then the code
3457 # is not linear.
3458 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3459 $check = 0;
3460 }
3461
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003462 # Ignore:
3463 # 1) blank lines, they should be at 0,
3464 # 2) preprocessor lines, and
3465 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003466 if ($continuation ||
3467 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003468 $s =~ /^\s*#\s*?/ ||
3469 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003470 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003471 if ($s =~ s/^.*?\n//) {
3472 $cond_lines++;
3473 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003474 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003475 }
3476
3477 my (undef, $sindent) = line_stats("+" . $s);
3478 my $stat_real = raw_line($linenr, $cond_lines);
3479
3480 # Check if either of these lines are modified, else
3481 # this is not this patch's fault.
3482 if (!defined($stat_real) ||
3483 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3484 $check = 0;
3485 }
3486 if (defined($stat_real) && $cond_lines > 1) {
3487 $stat_real = "[...]\n$stat_real";
3488 }
3489
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003490 #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 -07003491
Joe Perches9f5af482015-09-09 15:37:30 -07003492 if ($check && $s ne '' &&
3493 (($sindent % 8) != 0 ||
3494 ($sindent < $indent) ||
Joe Perchesf6950a72017-05-08 15:56:05 -07003495 ($sindent == $indent &&
3496 ($s !~ /^\s*(?:\}|\{|else\b)/)) ||
Joe Perches9f5af482015-09-09 15:37:30 -07003497 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003498 WARN("SUSPECT_CODE_INDENT",
3499 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003500 }
3501 }
3502
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003503 # Track the 'values' across context and added lines.
3504 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003505 my ($curr_values, $curr_vars) =
3506 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003507 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003508 if ($dbg_values) {
3509 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003510 print "$linenr > .$outline\n";
3511 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003512 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003513 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003514 $prev_values = substr($curr_values, -1);
3515
Andy Whitcroft00df3442007-06-08 13:47:06 -07003516#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003517 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003518
Joe Perches11ca40a2016-12-12 16:46:31 -08003519# check for dereferences that span multiple lines
3520 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3521 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3522 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3523 my $ref = $1;
3524 $line =~ /^.\s*($Lval)/;
3525 $ref .= $1;
3526 $ref =~ s/\s//g;
3527 WARN("MULTILINE_DEREFERENCE",
3528 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3529 }
3530
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003531# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003532 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 -07003533 my $type = $1;
3534 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003535 $var = "" if (!defined $var);
3536 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003537 my $sign = $1;
3538 my $pointer = $2;
3539
3540 $pointer = "" if (!defined $pointer);
3541
3542 if (WARN("UNSPECIFIED_INT",
3543 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3544 $fix) {
3545 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003546 my $comp_pointer = $pointer;
3547 $comp_pointer =~ s/\s//g;
3548 $decl .= $comp_pointer;
3549 $decl = rtrim($decl) if ($var eq "");
3550 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003551 }
3552 }
3553 }
3554
Andy Whitcroft653d4872007-06-23 17:16:34 -07003555# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003556 if ($dbg_type) {
3557 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003558 ERROR("TEST_TYPE",
3559 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003560 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003561 ERROR("TEST_NOT_TYPE",
3562 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003563 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003564 next;
3565 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003566# TEST: allow direct testing of the attribute matcher.
3567 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003568 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003569 ERROR("TEST_ATTR",
3570 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003571 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003572 ERROR("TEST_NOT_ATTR",
3573 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003574 }
3575 next;
3576 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003577
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003578# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003579 if ($line =~ /^.\s*{/ &&
3580 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003581 if (ERROR("OPEN_BRACE",
3582 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003583 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3584 fix_delete_line($fixlinenr - 1, $prevrawline);
3585 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003586 my $fixedline = $prevrawline;
3587 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003588 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003589 $fixedline = $line;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003590 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003591 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003592 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003593 }
3594
Andy Whitcroft653d4872007-06-23 17:16:34 -07003595#
3596# Checks which are anchored on the added line.
3597#
3598
3599# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003600 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003601 my $path = $1;
3602 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003603 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003604 "malformed #include filename\n" . $herecurr);
3605 }
3606 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3607 ERROR("UAPI_INCLUDE",
3608 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003609 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003610 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003611
3612# no C99 // comments
3613 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003614 if (ERROR("C99_COMMENTS",
3615 "do not use C99 // comments\n" . $herecurr) &&
3616 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003617 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003618 if ($line =~ /\/\/(.*)$/) {
3619 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003620 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003621 }
3622 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003623 }
3624 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003625 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003626 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003627
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003628# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3629# the whole statement.
3630#print "APW <$lines[$realline_next - 1]>\n";
3631 if (defined $realline_next &&
3632 exists $lines[$realline_next - 1] &&
3633 !defined $suppress_export{$realline_next} &&
3634 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3635 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003636 # Handle definitions which produce identifiers with
3637 # a prefix:
3638 # XXX(foo);
3639 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003640 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003641 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003642 $name =~ /^${Ident}_$2/) {
3643#print "FOO C name<$name>\n";
3644 $suppress_export{$realline_next} = 1;
3645
3646 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003647 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003648 ^.DEFINE_$Ident\(\Q$name\E\)|
3649 ^.DECLARE_$Ident\(\Q$name\E\)|
3650 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003651 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3652 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003653 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003654#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3655 $suppress_export{$realline_next} = 2;
3656 } else {
3657 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003658 }
3659 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003660 if (!defined $suppress_export{$linenr} &&
3661 $prevline =~ /^.\s*$/ &&
3662 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3663 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3664#print "FOO B <$lines[$linenr - 1]>\n";
3665 $suppress_export{$linenr} = 2;
3666 }
3667 if (defined $suppress_export{$linenr} &&
3668 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003669 WARN("EXPORT_SYMBOL",
3670 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003671 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003672
Joe Eloff5150bda2010-08-09 17:21:00 -07003673# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003674 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003675 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003676 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003677 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003678 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003679 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003680 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003681# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003682 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003683 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003684 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003685 $herecurr) &&
3686 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003687 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003688 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003689 }
3690
Joe Perches18130872014-08-06 16:11:22 -07003691# check for misordered declarations of char/short/int/long with signed/unsigned
3692 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3693 my $tmp = trim($1);
3694 WARN("MISORDERED_TYPE",
3695 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3696 }
3697
Joe Perchescb710ec2010-10-26 14:23:20 -07003698# check for static const char * arrays.
3699 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003700 WARN("STATIC_CONST_CHAR_ARRAY",
3701 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003702 $herecurr);
3703 }
3704
3705# check for static char foo[] = "bar" declarations.
3706 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003707 WARN("STATIC_CONST_CHAR_ARRAY",
3708 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003709 $herecurr);
3710 }
3711
Joe Perchesab7e23f2015-04-16 12:44:22 -07003712# check for const <foo> const where <foo> is not a pointer or array type
3713 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3714 my $found = $1;
3715 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3716 WARN("CONST_CONST",
3717 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3718 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3719 WARN("CONST_CONST",
3720 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3721 }
3722 }
3723
Joe Perches9b0fa602014-04-03 14:49:18 -07003724# check for non-global char *foo[] = {"bar", ...} declarations.
3725 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3726 WARN("STATIC_CONST_CHAR_ARRAY",
3727 "char * array declaration might be better as static const\n" .
3728 $herecurr);
3729 }
3730
Joe Perchesb598b672015-04-16 12:44:36 -07003731# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3732 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3733 my $array = $1;
3734 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3735 my $array_div = $1;
3736 if (WARN("ARRAY_SIZE",
3737 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3738 $fix) {
3739 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3740 }
3741 }
3742 }
3743
Joe Perchesb36190c2014-01-27 17:07:18 -08003744# check for function declarations without arguments like "int foo()"
3745 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3746 if (ERROR("FUNCTION_WITHOUT_ARGS",
3747 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3748 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003749 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003750 }
3751 }
3752
Andy Whitcroft653d4872007-06-23 17:16:34 -07003753# check for new typedefs, only function parameters and sparse annotations
3754# make sense.
3755 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003756 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003757 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003758 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003759 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003760 WARN("NEW_TYPEDEFS",
3761 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003762 }
3763
3764# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003765 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003766 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3767 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003768 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003769
Andy Whitcroft65863862009-01-06 14:41:21 -08003770 # Should start with a space.
3771 $to =~ s/^(\S)/ $1/;
3772 # Should not end with a space.
3773 $to =~ s/\s+$//;
3774 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003775 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003776 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003777
Joe Perches3705ce52013-07-03 15:05:31 -07003778## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003779 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003780 if (ERROR("POINTER_LOCATION",
3781 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3782 $fix) {
3783 my $sub_from = $ident;
3784 my $sub_to = $ident;
3785 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003786 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003787 s@\Q$sub_from\E@$sub_to@;
3788 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003789 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003790 }
3791 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3792 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003793 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003794
Andy Whitcroft65863862009-01-06 14:41:21 -08003795 # Should start with a space.
3796 $to =~ s/^(\S)/ $1/;
3797 # Should not end with a space.
3798 $to =~ s/\s+$//;
3799 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003800 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003801 }
3802 # Modifiers should have spaces.
3803 $to =~ s/(\b$Modifier$)/$1 /;
3804
Joe Perches3705ce52013-07-03 15:05:31 -07003805## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003806 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003807 if (ERROR("POINTER_LOCATION",
3808 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3809 $fix) {
3810
3811 my $sub_from = $match;
3812 my $sub_to = $match;
3813 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003814 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003815 s@\Q$sub_from\E@$sub_to@;
3816 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003817 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003818 }
3819
Joe Perches9d3e3c72015-09-09 15:37:27 -07003820# avoid BUG() or BUG_ON()
3821 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07003822 my $msg_level = \&WARN;
3823 $msg_level = \&CHK if ($file);
3824 &{$msg_level}("AVOID_BUG",
3825 "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 -07003826 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003827
Joe Perches9d3e3c72015-09-09 15:37:27 -07003828# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003829 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003830 WARN("LINUX_VERSION_CODE",
3831 "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 -08003832 }
3833
Joe Perches17441222011-06-15 15:08:17 -07003834# check for uses of printk_ratelimit
3835 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003836 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003837 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003838 }
3839
Joe Percheseeef5732017-11-17 15:28:41 -08003840# printk should use KERN_* levels
3841 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) {
3842 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3843 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003844 }
3845
Joe Perches243f3802012-05-31 16:26:09 -07003846 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3847 my $orig = $1;
3848 my $level = lc($orig);
3849 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003850 my $level2 = $level;
3851 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003852 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003853 "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 -07003854 }
3855
3856 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003857 if (WARN("PREFER_PR_LEVEL",
3858 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3859 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003860 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003861 s/\bpr_warning\b/pr_warn/;
3862 }
Joe Perches243f3802012-05-31 16:26:09 -07003863 }
3864
Joe Perchesdc139312013-02-21 16:44:13 -08003865 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3866 my $orig = $1;
3867 my $level = lc($orig);
3868 $level = "warn" if ($level eq "warning");
3869 $level = "dbg" if ($level eq "debug");
3870 WARN("PREFER_DEV_LEVEL",
3871 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3872 }
3873
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003874# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3875# number of false positives, but assembly files are not checked, so at
3876# least the arch entry code will not trigger this warning.
3877 if ($line =~ /\bENOSYS\b/) {
3878 WARN("ENOSYS",
3879 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3880 }
3881
Andy Whitcroft653d4872007-06-23 17:16:34 -07003882# function brace can't be on same line, except for #defines of do while,
3883# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003884 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003885 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003886 if (ERROR("OPEN_BRACE",
3887 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3888 $fix) {
3889 fix_delete_line($fixlinenr, $rawline);
3890 my $fixed_line = $rawline;
3891 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3892 my $line1 = $1;
3893 my $line2 = $2;
3894 fix_insert_line($fixlinenr, ltrim($line1));
3895 fix_insert_line($fixlinenr, "\+{");
3896 if ($line2 !~ /^\s*$/) {
3897 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3898 }
3899 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003900 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003901
Andy Whitcroft8905a672007-11-28 16:21:06 -08003902# open braces for enum, union and struct go on the same line.
3903 if ($line =~ /^.\s*{/ &&
3904 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003905 if (ERROR("OPEN_BRACE",
3906 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3907 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3908 fix_delete_line($fixlinenr - 1, $prevrawline);
3909 fix_delete_line($fixlinenr, $rawline);
3910 my $fixedline = rtrim($prevrawline) . " {";
3911 fix_insert_line($fixlinenr, $fixedline);
3912 $fixedline = $rawline;
Cyril Bur8d81ae02017-07-10 15:52:21 -07003913 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003914 if ($fixedline !~ /^\+\s*$/) {
3915 fix_insert_line($fixlinenr, $fixedline);
3916 }
3917 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003918 }
3919
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003920# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003921 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3922 if (WARN("SPACING",
3923 "missing space after $1 definition\n" . $herecurr) &&
3924 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003925 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003926 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3927 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003928 }
3929
Joe Perches31070b52014-01-23 15:54:49 -08003930# Function pointer declarations
3931# check spacing between type, funcptr, and args
3932# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003933 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003934 my $declare = $1;
3935 my $pre_pointer_space = $2;
3936 my $post_pointer_space = $3;
3937 my $funcname = $4;
3938 my $post_funcname_space = $5;
3939 my $pre_args_space = $6;
3940
Joe Perches91f72e92014-04-03 14:49:12 -07003941# the $Declare variable will capture all spaces after the type
3942# so check it for a missing trailing missing space but pointer return types
3943# don't need a space so don't warn for those.
3944 my $post_declare_space = "";
3945 if ($declare =~ /(\s+)$/) {
3946 $post_declare_space = $1;
3947 $declare = rtrim($declare);
3948 }
3949 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003950 WARN("SPACING",
3951 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003952 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003953 }
3954
3955# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003956# This test is not currently implemented because these declarations are
3957# equivalent to
3958# int foo(int bar, ...)
3959# and this is form shouldn't/doesn't generate a checkpatch warning.
3960#
3961# elsif ($declare =~ /\s{2,}$/) {
3962# WARN("SPACING",
3963# "Multiple spaces after return type\n" . $herecurr);
3964# }
Joe Perches31070b52014-01-23 15:54:49 -08003965
3966# unnecessary space "type ( *funcptr)(args...)"
3967 if (defined $pre_pointer_space &&
3968 $pre_pointer_space =~ /^\s/) {
3969 WARN("SPACING",
3970 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3971 }
3972
3973# unnecessary space "type (* funcptr)(args...)"
3974 if (defined $post_pointer_space &&
3975 $post_pointer_space =~ /^\s/) {
3976 WARN("SPACING",
3977 "Unnecessary space before function pointer name\n" . $herecurr);
3978 }
3979
3980# unnecessary space "type (*funcptr )(args...)"
3981 if (defined $post_funcname_space &&
3982 $post_funcname_space =~ /^\s/) {
3983 WARN("SPACING",
3984 "Unnecessary space after function pointer name\n" . $herecurr);
3985 }
3986
3987# unnecessary space "type (*funcptr) (args...)"
3988 if (defined $pre_args_space &&
3989 $pre_args_space =~ /^\s/) {
3990 WARN("SPACING",
3991 "Unnecessary space before function pointer arguments\n" . $herecurr);
3992 }
3993
3994 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003995 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003996 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003997 }
3998 }
3999
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004000# check for spacing round square brackets; allowed:
4001# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004002# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4003# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004004 while ($line =~ /(.*?\s)\[/g) {
4005 my ($where, $prefix) = ($-[1], $1);
4006 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004007 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004008 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004009 if (ERROR("BRACKET_SPACE",
4010 "space prohibited before open square bracket '['\n" . $herecurr) &&
4011 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004012 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004013 s/^(\+.*?)\s+\[/$1\[/;
4014 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004015 }
4016 }
4017
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004018# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004019 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004020 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004021 my $ctx_before = substr($line, 0, $-[1]);
4022 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004023
4024 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004025 if ($name =~ /^(?:
4026 if|for|while|switch|return|case|
4027 volatile|__volatile__|
4028 __attribute__|format|__extension__|
4029 asm|__asm__)$/x)
4030 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004031 # cpp #define statements have non-optional spaces, ie
4032 # if there is a space between the name and the open
4033 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004034 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004035
4036 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004037 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004038
4039 # If this whole things ends with a type its most
4040 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004041 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004042
4043 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004044 if (WARN("SPACING",
4045 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4046 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004047 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004048 s/\b$name\s+\(/$name\(/;
4049 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004050 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004051 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004052
Andy Whitcroft653d4872007-06-23 17:16:34 -07004053# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004054 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004055 my $fixed_line = "";
4056 my $line_fixed = 0;
4057
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004058 my $ops = qr{
4059 <<=|>>=|<=|>=|==|!=|
4060 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4061 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004062 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004063 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004064 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004065 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004066
4067## print("element count: <" . $#elements . ">\n");
4068## foreach my $el (@elements) {
4069## print("el: <$el>\n");
4070## }
4071
4072 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004073 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004074
Joe Perches3705ce52013-07-03 15:05:31 -07004075 foreach my $el (@elements) {
4076 push(@fix_elements, substr($rawline, $off, length($el)));
4077 $off += length($el);
4078 }
4079
4080 $off = 0;
4081
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004082 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004083 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004084
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004085 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004086
4087 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4088
4089## print("n: <$n> good: <$good>\n");
4090
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004091 $off += length($elements[$n]);
4092
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004093 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004094 my $ca = substr($opline, 0, $off);
4095 my $cc = '';
4096 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4097 $cc = substr($opline, $off + length($elements[$n + 1]));
4098 }
4099 my $cb = "$ca$;$cc";
4100
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004101 my $a = '';
4102 $a = 'V' if ($elements[$n] ne '');
4103 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004104 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004105 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4106 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004107 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004108
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004109 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004110
4111 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004112 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004113 $c = 'V' if ($elements[$n + 2] ne '');
4114 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004115 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004116 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4117 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004118 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004119 } else {
4120 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004121 }
4122
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004123 my $ctx = "${a}x${c}";
4124
4125 my $at = "(ctx:$ctx)";
4126
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004127 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004128 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004129
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004130 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004131 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004132
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004133 # Get the full operator variant.
4134 my $opv = $op . substr($curr_vars, $off, 1);
4135
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004136 # Ignore operators passed as parameters.
4137 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004138 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004139
Andy Whitcroftcf655042008-03-04 14:28:20 -08004140# # Ignore comments
4141# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004142
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004143 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004144 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004145 if ($ctx !~ /.x[WEBC]/ &&
4146 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004147 if (ERROR("SPACING",
4148 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004149 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004150 $line_fixed = 1;
4151 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004152 }
4153
4154 # // is a comment
4155 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004156
Joe Perchesb00e4812014-04-03 14:49:33 -07004157 # : when part of a bitfield
4158 } elsif ($opv eq ':B') {
4159 # skip the bitfield test for now
4160
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004161 # No spaces for:
4162 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004163 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004164 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004165 if (ERROR("SPACING",
4166 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004167 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004168 if (defined $fix_elements[$n + 2]) {
4169 $fix_elements[$n + 2] =~ s/^\s+//;
4170 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004171 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004172 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004173 }
4174
Joe Perches23810972014-12-10 15:51:32 -08004175 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004176 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004177 my $rtrim_before = 0;
4178 my $space_after = 0;
4179 if ($ctx =~ /Wx./) {
4180 if (ERROR("SPACING",
4181 "space prohibited before that '$op' $at\n" . $hereptr)) {
4182 $line_fixed = 1;
4183 $rtrim_before = 1;
4184 }
4185 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004186 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004187 if (ERROR("SPACING",
4188 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004189 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004190 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004191 $space_after = 1;
4192 }
4193 }
4194 if ($rtrim_before || $space_after) {
4195 if ($rtrim_before) {
4196 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4197 } else {
4198 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4199 }
4200 if ($space_after) {
4201 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004202 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004203 }
4204
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004205 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004206 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004207 #warn "'*' is part of type\n";
4208
4209 # unary operators should have a space before and
4210 # none after. May be left adjacent to another
4211 # unary operator, or a cast
4212 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004213 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004214 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004215 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004216 if (ERROR("SPACING",
4217 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004218 if ($n != $last_after + 2) {
4219 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4220 $line_fixed = 1;
4221 }
Joe Perches3705ce52013-07-03 15:05:31 -07004222 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004223 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004224 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004225 # A unary '*' may be const
4226
4227 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004228 if (ERROR("SPACING",
4229 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004230 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004231 if (defined $fix_elements[$n + 2]) {
4232 $fix_elements[$n + 2] =~ s/^\s+//;
4233 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004234 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004235 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004236 }
4237
4238 # unary ++ and unary -- are allowed no space on one side.
4239 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004240 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004241 if (ERROR("SPACING",
4242 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004243 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004244 $line_fixed = 1;
4245 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004246 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004247 if ($ctx =~ /Wx[BE]/ ||
4248 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004249 if (ERROR("SPACING",
4250 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004251 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004252 $line_fixed = 1;
4253 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004254 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004255 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004256 if (ERROR("SPACING",
4257 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004258 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004259 if (defined $fix_elements[$n + 2]) {
4260 $fix_elements[$n + 2] =~ s/^\s+//;
4261 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004262 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004263 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004264 }
4265
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004266 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004267 } elsif ($op eq '<<' or $op eq '>>' or
4268 $op eq '&' or $op eq '^' or $op eq '|' or
4269 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004270 $op eq '*' or $op eq '/' or
4271 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004272 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004273 if ($check) {
4274 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4275 if (CHK("SPACING",
4276 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4277 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4278 $fix_elements[$n + 2] =~ s/^\s+//;
4279 $line_fixed = 1;
4280 }
4281 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4282 if (CHK("SPACING",
4283 "space preferred before that '$op' $at\n" . $hereptr)) {
4284 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4285 $line_fixed = 1;
4286 }
4287 }
4288 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004289 if (ERROR("SPACING",
4290 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004291 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4292 if (defined $fix_elements[$n + 2]) {
4293 $fix_elements[$n + 2] =~ s/^\s+//;
4294 }
Joe Perches3705ce52013-07-03 15:05:31 -07004295 $line_fixed = 1;
4296 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004297 }
4298
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004299 # A colon needs no spaces before when it is
4300 # terminating a case value or a label.
4301 } elsif ($opv eq ':C' || $opv eq ':L') {
4302 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004303 if (ERROR("SPACING",
4304 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004305 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004306 $line_fixed = 1;
4307 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004308 }
4309
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004310 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004311 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004312 my $ok = 0;
4313
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004314 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004315 if (($op eq '<' &&
4316 $cc =~ /^\S+\@\S+>/) ||
4317 ($op eq '>' &&
4318 $ca =~ /<\S+\@\S+$/))
4319 {
4320 $ok = 1;
4321 }
4322
Joe Perchese0df7e12015-04-16 12:44:53 -07004323 # for asm volatile statements
4324 # ignore a colon with another
4325 # colon immediately before or after
4326 if (($op eq ':') &&
4327 ($ca =~ /:$/ || $cc =~ /^:/)) {
4328 $ok = 1;
4329 }
4330
Joe Perches84731622013-11-12 15:10:05 -08004331 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004332 if ($ok == 0) {
Jean Delvare0675a8f2017-09-08 16:16:07 -07004333 my $msg_level = \&ERROR;
4334 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
Joe Perches84731622013-11-12 15:10:05 -08004335
Jean Delvare0675a8f2017-09-08 16:16:07 -07004336 if (&{$msg_level}("SPACING",
4337 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004338 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4339 if (defined $fix_elements[$n + 2]) {
4340 $fix_elements[$n + 2] =~ s/^\s+//;
4341 }
Joe Perches3705ce52013-07-03 15:05:31 -07004342 $line_fixed = 1;
4343 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004344 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004345 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004346 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004347
4348## print("n: <$n> GOOD: <$good>\n");
4349
4350 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004351 }
Joe Perches3705ce52013-07-03 15:05:31 -07004352
4353 if (($#elements % 2) == 0) {
4354 $fixed_line = $fixed_line . $fix_elements[$#elements];
4355 }
4356
Joe Perches194f66f2014-08-06 16:11:03 -07004357 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4358 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004359 }
4360
4361
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004362 }
4363
Joe Perches786b6322013-07-03 15:05:32 -07004364# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004365 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004366 if (WARN("SPACING",
4367 "space prohibited before semicolon\n" . $herecurr) &&
4368 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004369 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004370 s/^(\+.*\S)\s+;/$1;/;
4371 }
4372 }
4373
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004374# check for multiple assignments
4375 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004376 CHK("MULTIPLE_ASSIGNMENTS",
4377 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004378 }
4379
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004380## # check for multiple declarations, allowing for a function declaration
4381## # continuation.
4382## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4383## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4384##
4385## # Remove any bracketed sections to ensure we do not
4386## # falsly report the parameters of functions.
4387## my $ln = $line;
4388## while ($ln =~ s/\([^\(\)]*\)//g) {
4389## }
4390## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004391## WARN("MULTIPLE_DECLARATION",
4392## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004393## }
4394## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004395
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004396#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004397 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004398 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004399 if (ERROR("SPACING",
4400 "space required before the open brace '{'\n" . $herecurr) &&
4401 $fix) {
Cyril Bur8d81ae02017-07-10 15:52:21 -07004402 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004403 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004404 }
4405
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004406## # check for blank lines before declarations
4407## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4408## $prevrawline =~ /^.\s*$/) {
4409## WARN("SPACING",
4410## "No blank lines before declarations\n" . $hereprev);
4411## }
4412##
4413
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004414# closing brace should have a space following it when it has anything
4415# on the line
4416 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004417 if (ERROR("SPACING",
4418 "space required after that close brace '}'\n" . $herecurr) &&
4419 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004420 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004421 s/}((?!(?:,|;|\)))\S)/} $1/;
4422 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004423 }
4424
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004425# check spacing on square brackets
4426 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004427 if (ERROR("SPACING",
4428 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4429 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004430 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004431 s/\[\s+/\[/;
4432 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004433 }
4434 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004435 if (ERROR("SPACING",
4436 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4437 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004438 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004439 s/\s+\]/\]/;
4440 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004441 }
4442
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004443# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004444 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4445 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004446 if (ERROR("SPACING",
4447 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4448 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004449 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004450 s/\(\s+/\(/;
4451 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004452 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004453 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004454 $line !~ /for\s*\(.*;\s+\)/ &&
4455 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004456 if (ERROR("SPACING",
4457 "space prohibited before that close 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 }
4463
Joe Perchese2826fd2014-08-06 16:10:48 -07004464# check unnecessary parentheses around addressof/dereference single $Lvals
4465# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4466
4467 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004468 my $var = $1;
4469 if (CHK("UNNECESSARY_PARENTHESES",
4470 "Unnecessary parentheses around $var\n" . $herecurr) &&
4471 $fix) {
4472 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4473 }
4474 }
4475
4476# check for unnecessary parentheses around function pointer uses
4477# ie: (foo->bar)(); should be foo->bar();
4478# but not "if (foo->bar) (" to avoid some false positives
4479 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4480 my $var = $2;
4481 if (CHK("UNNECESSARY_PARENTHESES",
4482 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4483 $fix) {
4484 my $var2 = deparenthesize($var);
4485 $var2 =~ s/\s//g;
4486 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4487 }
4488 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004489
Joe Perches63b7c732017-09-08 16:16:01 -07004490# check for unnecessary parentheses around comparisons in if uses
4491 if ($^V && $^V ge 5.10.0 && defined($stat) &&
4492 $stat =~ /(^.\s*if\s*($balanced_parens))/) {
4493 my $if_stat = $1;
4494 my $test = substr($2, 1, -1);
4495 my $herectx;
4496 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4497 my $match = $1;
4498 # avoid parentheses around potential macro args
4499 next if ($match =~ /^\s*\w+\s*$/);
4500 if (!defined($herectx)) {
4501 $herectx = $here . "\n";
4502 my $cnt = statement_rawlines($if_stat);
4503 for (my $n = 0; $n < $cnt; $n++) {
4504 my $rl = raw_line($linenr, $n);
4505 $herectx .= $rl . "\n";
4506 last if $rl =~ /^[ \+].*\{/;
4507 }
4508 }
4509 CHK("UNNECESSARY_PARENTHESES",
4510 "Unnecessary parentheses around '$match'\n" . $herectx);
4511 }
4512 }
4513
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004514#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004515 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004516 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004517 if (WARN("INDENTED_LABEL",
4518 "labels should not be indented\n" . $herecurr) &&
4519 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004520 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004521 s/^(.)\s+/$1/;
4522 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004523 }
4524
Joe Perches5b9553a2014-04-03 14:49:21 -07004525# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004526 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004527 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004528 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004529 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4530 my $value = $1;
4531 $value = deparenthesize($value);
4532 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4533 ERROR("RETURN_PARENTHESES",
4534 "return is not a function, parentheses are not required\n" . $herecurr);
4535 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004536 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004537 ERROR("SPACING",
4538 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004539 }
4540 }
Joe Perches507e5142013-11-12 15:10:13 -08004541
Joe Perchesb43ae212014-06-23 13:22:07 -07004542# unnecessary return in a void function
4543# at end-of-function, with the previous line a single leading tab, then return;
4544# and the line before that not a goto label target like "out:"
4545 if ($sline =~ /^[ \+]}\s*$/ &&
4546 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4547 $linenr >= 3 &&
4548 $lines[$linenr - 3] =~ /^[ +]/ &&
4549 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004550 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004551 "void function return statements are not generally useful\n" . $hereprev);
4552 }
Joe Perches9819cf22014-06-04 16:12:09 -07004553
Joe Perches189248d2014-01-23 15:54:47 -08004554# if statements using unnecessary parentheses - ie: if ((foo == bar))
4555 if ($^V && $^V ge 5.10.0 &&
4556 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4557 my $openparens = $1;
4558 my $count = $openparens =~ tr@\(@\(@;
4559 my $msg = "";
4560 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4561 my $comp = $4; #Not $1 because of $LvalOrFunc
4562 $msg = " - maybe == should be = ?" if ($comp eq "==");
4563 WARN("UNNECESSARY_PARENTHESES",
4564 "Unnecessary parentheses$msg\n" . $herecurr);
4565 }
4566 }
4567
Joe Perchesc5595fa2015-09-09 15:37:58 -07004568# comparisons with a constant or upper case identifier on the left
4569# avoid cases like "foo + BAR < baz"
4570# only fix matches surrounded by parentheses to avoid incorrect
4571# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4572 if ($^V && $^V ge 5.10.0 &&
4573 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4574 my $lead = $1;
4575 my $const = $2;
4576 my $comp = $3;
4577 my $to = $4;
4578 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004579 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004580 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4581 WARN("CONSTANT_COMPARISON",
4582 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4583 $fix) {
4584 if ($comp eq "<") {
4585 $newcomp = ">";
4586 } elsif ($comp eq "<=") {
4587 $newcomp = ">=";
4588 } elsif ($comp eq ">") {
4589 $newcomp = "<";
4590 } elsif ($comp eq ">=") {
4591 $newcomp = "<=";
4592 }
4593 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4594 }
4595 }
4596
Joe Perchesf34e4a42015-04-16 12:44:19 -07004597# Return of what appears to be an errno should normally be negative
4598 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004599 my $name = $1;
4600 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004601 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004602 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004603 }
4604 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004605
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004606# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004607 if ($line =~ /\b(if|while|for|switch)\(/) {
4608 if (ERROR("SPACING",
4609 "space required before the open parenthesis '('\n" . $herecurr) &&
4610 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004611 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004612 s/\b(if|while|for|switch)\(/$1 \(/;
4613 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004614 }
4615
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004616# Check for illegal assignment in if conditional -- and check for trailing
4617# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004618 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004619 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4620 ctx_statement_block($linenr, $realcnt, 0)
4621 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004622 my ($stat_next) = ctx_statement_block($line_nr_next,
4623 $remain_next, $off_next);
4624 $stat_next =~ s/\n./\n /g;
4625 ##print "stat<$stat> stat_next<$stat_next>\n";
4626
4627 if ($stat_next =~ /^\s*while\b/) {
4628 # If the statement carries leading newlines,
4629 # then count those as offsets.
4630 my ($whitespace) =
4631 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4632 my $offset =
4633 statement_rawlines($whitespace) - 1;
4634
4635 $suppress_whiletrailers{$line_nr_next +
4636 $offset} = 1;
4637 }
4638 }
4639 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004640 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004641 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004642 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004643
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004644 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004645 ERROR("ASSIGN_IN_IF",
4646 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004647 }
4648
4649 # Find out what is on the end of the line after the
4650 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004651 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004652 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004653 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004654 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4655 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004656 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004657 # Find out how long the conditional actually is.
4658 my @newlines = ($c =~ /\n/gs);
4659 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004660 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004661
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004662 $stat_real = raw_line($linenr, $cond_lines)
4663 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004664 if (defined($stat_real) && $cond_lines > 1) {
4665 $stat_real = "[...]\n$stat_real";
4666 }
4667
Joe Perches000d1cc12011-07-25 17:13:25 -07004668 ERROR("TRAILING_STATEMENTS",
4669 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004670 }
4671 }
4672
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004673# Check for bitwise tests written as boolean
4674 if ($line =~ /
4675 (?:
4676 (?:\[|\(|\&\&|\|\|)
4677 \s*0[xX][0-9]+\s*
4678 (?:\&\&|\|\|)
4679 |
4680 (?:\&\&|\|\|)
4681 \s*0[xX][0-9]+\s*
4682 (?:\&\&|\|\||\)|\])
4683 )/x)
4684 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004685 WARN("HEXADECIMAL_BOOLEAN_TEST",
4686 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004687 }
4688
Andy Whitcroft8905a672007-11-28 16:21:06 -08004689# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004690 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4691 my $s = $1;
4692 $s =~ s/$;//g; # Remove any comments
4693 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004694 ERROR("TRAILING_STATEMENTS",
4695 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004696 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004697 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004698# if should not continue a brace
4699 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004700 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004701 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004702 $herecurr);
4703 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004704# case and default should not have general statements after them
4705 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4706 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004707 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004708 \s*return\s+
4709 )/xg)
4710 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004711 ERROR("TRAILING_STATEMENTS",
4712 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004713 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004714
4715 # Check for }<nl>else {, these must be at the same
4716 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004717 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4718 $previndent == $indent) {
4719 if (ERROR("ELSE_AFTER_BRACE",
4720 "else should follow close brace '}'\n" . $hereprev) &&
4721 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4722 fix_delete_line($fixlinenr - 1, $prevrawline);
4723 fix_delete_line($fixlinenr, $rawline);
4724 my $fixedline = $prevrawline;
4725 $fixedline =~ s/}\s*$//;
4726 if ($fixedline !~ /^\+\s*$/) {
4727 fix_insert_line($fixlinenr, $fixedline);
4728 }
4729 $fixedline = $rawline;
4730 $fixedline =~ s/^(.\s*)else/$1} else/;
4731 fix_insert_line($fixlinenr, $fixedline);
4732 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004733 }
4734
Joe Perches8b8856f2014-08-06 16:11:14 -07004735 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4736 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004737 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4738
4739 # Find out what is on the end of the line after the
4740 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004741 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004742 $s =~ s/\n.*//g;
4743
4744 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004745 if (ERROR("WHILE_AFTER_BRACE",
4746 "while should follow close brace '}'\n" . $hereprev) &&
4747 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4748 fix_delete_line($fixlinenr - 1, $prevrawline);
4749 fix_delete_line($fixlinenr, $rawline);
4750 my $fixedline = $prevrawline;
4751 my $trailing = $rawline;
4752 $trailing =~ s/^\+//;
4753 $trailing = trim($trailing);
4754 $fixedline =~ s/}\s*$/} $trailing/;
4755 fix_insert_line($fixlinenr, $fixedline);
4756 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004757 }
4758 }
4759
Joe Perches95e2c602013-07-03 15:05:20 -07004760#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004761 while ($line =~ m{($Constant|$Lval)}g) {
4762 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004763
4764#gcc binary extension
4765 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004766 if (WARN("GCC_BINARY_CONSTANT",
4767 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4768 $fix) {
4769 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004770 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004771 s/\b$var\b/$hexval/;
4772 }
Joe Perches95e2c602013-07-03 15:05:20 -07004773 }
4774
4775#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004776 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004777 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004778#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004779 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004780#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004781 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4782#Ignore some three character SI units explicitly, like MiB and KHz
4783 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004784 while ($var =~ m{($Ident)}g) {
4785 my $word = $1;
4786 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004787 if ($check) {
4788 seed_camelcase_includes();
4789 if (!$file && !$camelcase_file_seeded) {
4790 seed_camelcase_file($realfile);
4791 $camelcase_file_seeded = 1;
4792 }
4793 }
Joe Perches7e781f62013-09-11 14:23:55 -07004794 if (!defined $camelcase{$word}) {
4795 $camelcase{$word} = 1;
4796 CHK("CAMELCASE",
4797 "Avoid CamelCase: <$word>\n" . $herecurr);
4798 }
Joe Perches34456862013-07-03 15:05:34 -07004799 }
Joe Perches323c1262012-12-17 16:02:07 -08004800 }
4801 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004802
4803#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004804 if ($line =~ /\#\s*define.*\\\s+$/) {
4805 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4806 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4807 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004808 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004809 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004810 }
4811
Fabian Frederick0e212e02015-04-16 12:44:25 -07004812# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4813# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004814 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004815 my $file = "$1.h";
4816 my $checkfile = "include/linux/$file";
4817 if (-f "$root/$checkfile" &&
4818 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004819 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004820 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004821 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4822 if ($asminclude > 0) {
4823 if ($realfile =~ m{^arch/}) {
4824 CHK("ARCH_INCLUDE_LINUX",
4825 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4826 } else {
4827 WARN("INCLUDE_LINUX",
4828 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4829 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004830 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004831 }
4832 }
4833
Andy Whitcroft653d4872007-06-23 17:16:34 -07004834# multi-statement macros should be enclosed in a do while loop, grab the
4835# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004836# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004837 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4838 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004839 my $ln = $linenr;
4840 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004841 my ($off, $dstat, $dcond, $rest);
4842 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004843 my $has_flow_statement = 0;
4844 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004845 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004846 ctx_statement_block($linenr, $realcnt, 0);
4847 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004848 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004849 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004850
Joe Perches08a28432014-10-13 15:51:55 -07004851 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004852 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004853
Joe Perchesf59b64b2016-10-11 13:52:08 -07004854 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4855 my $define_args = $1;
4856 my $define_stmt = $dstat;
4857 my @def_args = ();
4858
4859 if (defined $define_args && $define_args ne "") {
4860 $define_args = substr($define_args, 1, length($define_args) - 2);
4861 $define_args =~ s/\s*//g;
4862 @def_args = split(",", $define_args);
4863 }
4864
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004865 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004866 $dstat =~ s/\\\n.//g;
4867 $dstat =~ s/^\s*//s;
4868 $dstat =~ s/\s*$//s;
4869
4870 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004871 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4872 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004873 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004874 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004875 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004876
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004877 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004878 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4879 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004880 {
4881 }
4882
Joe Perches42e15292016-03-15 14:58:01 -07004883 # Make asm volatile uses seem like a generic function
4884 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4885
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004886 my $exceptions = qr{
4887 $Declare|
4888 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004889 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004890 DECLARE_PER_CPU|
4891 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004892 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004893 union|
4894 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004895 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004896 ^\"|\"$|
4897 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004898 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004899 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004900
4901 $ctx =~ s/\n*$//;
4902 my $herectx = $here . "\n";
4903 my $stmt_cnt = statement_rawlines($ctx);
4904
4905 for (my $n = 0; $n < $stmt_cnt; $n++) {
4906 $herectx .= raw_line($linenr, $n) . "\n";
4907 }
4908
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004909 if ($dstat ne '' &&
4910 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4911 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004912 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004913 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004914 $dstat !~ /$exceptions/ &&
4915 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004916 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004917 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004918 $dstat !~ /^for\s*$Constant$/ && # for (...)
4919 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4920 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004921 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004922 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004923 {
Joe Perchese7955562017-05-08 15:55:48 -07004924 if ($dstat =~ /^\s*if\b/) {
4925 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4926 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4927 } elsif ($dstat =~ /;/) {
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004928 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4929 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4930 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004931 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004932 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004933 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004934
4935 }
Joe Perches52076492016-10-11 13:52:14 -07004936
4937 # Make $define_stmt single line, comment-free, etc
4938 my @stmt_array = split('\n', $define_stmt);
4939 my $first = 1;
4940 $define_stmt = "";
4941 foreach my $l (@stmt_array) {
4942 $l =~ s/\\$//;
4943 if ($first) {
4944 $define_stmt = $l;
4945 $first = 0;
4946 } elsif ($l =~ /^[\+ ]/) {
4947 $define_stmt .= substr($l, 1);
4948 }
4949 }
4950 $define_stmt =~ s/$;//g;
4951 $define_stmt =~ s/\s+/ /g;
4952 $define_stmt = trim($define_stmt);
4953
Joe Perchesf59b64b2016-10-11 13:52:08 -07004954# check if any macro arguments are reused (ignore '...' and 'type')
4955 foreach my $arg (@def_args) {
4956 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07004957 next if ($arg =~ /^type$/i);
Joe Perches7fe528a22017-07-10 15:52:27 -07004958 my $tmp_stmt = $define_stmt;
4959 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4960 $tmp_stmt =~ s/\#+\s*$arg\b//g;
4961 $tmp_stmt =~ s/\b$arg\s*\#\#//g;
4962 my $use_cnt = $tmp_stmt =~ s/\b$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004963 if ($use_cnt > 1) {
4964 CHK("MACRO_ARG_REUSE",
4965 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07004966 }
4967# check if any macro arguments may have other precedence issues
Joe Perches7fe528a22017-07-10 15:52:27 -07004968 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
Joe Perches9192d412016-10-11 13:52:11 -07004969 ((defined($1) && $1 ne ',') ||
4970 (defined($2) && $2 ne ','))) {
4971 CHK("MACRO_ARG_PRECEDENCE",
4972 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07004973 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004974 }
Joe Perches5023d342012-12-17 16:01:47 -08004975
Joe Perches08a28432014-10-13 15:51:55 -07004976# check for macros with flow control, but without ## concatenation
4977# ## concatenation is commonly a macro that defines a function so ignore those
4978 if ($has_flow_statement && !$has_arg_concat) {
4979 my $herectx = $here . "\n";
4980 my $cnt = statement_rawlines($ctx);
4981
4982 for (my $n = 0; $n < $cnt; $n++) {
4983 $herectx .= raw_line($linenr, $n) . "\n";
4984 }
4985 WARN("MACRO_WITH_FLOW_CONTROL",
4986 "Macros with flow control statements should be avoided\n" . "$herectx");
4987 }
4988
Joe Perches481eb482012-12-17 16:01:56 -08004989# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004990
4991 } else {
4992 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004993 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4994 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004995 $line =~ /^\+.*\\$/) {
4996 WARN("LINE_CONTINUATIONS",
4997 "Avoid unnecessary line continuations\n" . $herecurr);
4998 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004999 }
5000
Joe Perchesb13edf72012-07-30 14:41:24 -07005001# do {} while (0) macro tests:
5002# single-statement macros do not need to be enclosed in do while (0) loop,
5003# macro should not end with a semicolon
5004 if ($^V && $^V ge 5.10.0 &&
5005 $realfile !~ m@/vmlinux.lds.h$@ &&
5006 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
5007 my $ln = $linenr;
5008 my $cnt = $realcnt;
5009 my ($off, $dstat, $dcond, $rest);
5010 my $ctx = '';
5011 ($dstat, $dcond, $ln, $cnt, $off) =
5012 ctx_statement_block($linenr, $realcnt, 0);
5013 $ctx = $dstat;
5014
5015 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08005016 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07005017
5018 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5019 my $stmts = $2;
5020 my $semis = $3;
5021
5022 $ctx =~ s/\n*$//;
5023 my $cnt = statement_rawlines($ctx);
5024 my $herectx = $here . "\n";
5025
5026 for (my $n = 0; $n < $cnt; $n++) {
5027 $herectx .= raw_line($linenr, $n) . "\n";
5028 }
5029
Joe Perchesac8e97f2012-08-21 16:15:53 -07005030 if (($stmts =~ tr/;/;/) == 1 &&
5031 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07005032 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
5033 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
5034 }
5035 if (defined $semis && $semis ne "") {
5036 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
5037 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
5038 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07005039 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
5040 $ctx =~ s/\n*$//;
5041 my $cnt = statement_rawlines($ctx);
5042 my $herectx = $here . "\n";
5043
5044 for (my $n = 0; $n < $cnt; $n++) {
5045 $herectx .= raw_line($linenr, $n) . "\n";
5046 }
5047
5048 WARN("TRAILING_SEMICOLON",
5049 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07005050 }
5051 }
5052
Mike Frysinger080ba922009-01-06 14:41:25 -08005053# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5054# all assignments may have only one of the following with an assignment:
5055# .
5056# ALIGN(...)
5057# VMLINUX_SYMBOL(...)
5058 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005059 WARN("MISSING_VMLINUX_SYMBOL",
5060 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08005061 }
5062
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005063# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005064 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
5065 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08005066 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005067 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005068 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5069 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005070 my @allowed = ();
5071 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005072 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005073 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005074 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005075 for my $chunk (@chunks) {
5076 my ($cond, $block) = @{$chunk};
5077
Andy Whitcroft773647a2008-03-28 14:15:58 -07005078 # If the condition carries leading newlines, then count those as offsets.
5079 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5080 my $offset = statement_rawlines($whitespace) - 1;
5081
Joe Perchesaad4f612012-03-23 15:02:19 -07005082 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005083 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5084
5085 # We have looked at and allowed this specific line.
5086 $suppress_ifbraces{$ln + $offset} = 1;
5087
5088 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005089 $ln += statement_rawlines($block) - 1;
5090
Andy Whitcroft773647a2008-03-28 14:15:58 -07005091 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005092
5093 $seen++ if ($block =~ /^\s*{/);
5094
Joe Perchesaad4f612012-03-23 15:02:19 -07005095 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005096 if (statement_lines($cond) > 1) {
5097 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005098 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005099 }
5100 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005101 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005102 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005103 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005104 if (statement_block_size($block) > 1) {
5105 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005106 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005107 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005108 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005109 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005110 if ($seen) {
5111 my $sum_allowed = 0;
5112 foreach (@allowed) {
5113 $sum_allowed += $_;
5114 }
5115 if ($sum_allowed == 0) {
5116 WARN("BRACES",
5117 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5118 } elsif ($sum_allowed != $allow &&
5119 $seen != $allow) {
5120 CHK("BRACES",
5121 "braces {} should be used on all arms of this statement\n" . $herectx);
5122 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005123 }
5124 }
5125 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005126 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005127 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005128 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005129
Andy Whitcroftcf655042008-03-04 14:28:20 -08005130 # Check the pre-context.
5131 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5132 #print "APW: ALLOWED: pre<$1>\n";
5133 $allowed = 1;
5134 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005135
5136 my ($level, $endln, @chunks) =
5137 ctx_statement_full($linenr, $realcnt, $-[0]);
5138
Andy Whitcroftcf655042008-03-04 14:28:20 -08005139 # Check the condition.
5140 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005141 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005142 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005143 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005144 }
5145 if (statement_lines($cond) > 1) {
5146 #print "APW: ALLOWED: cond<$cond>\n";
5147 $allowed = 1;
5148 }
5149 if ($block =~/\b(?:if|for|while)\b/) {
5150 #print "APW: ALLOWED: block<$block>\n";
5151 $allowed = 1;
5152 }
5153 if (statement_block_size($block) > 1) {
5154 #print "APW: ALLOWED: lines block<$block>\n";
5155 $allowed = 1;
5156 }
5157 # Check the post-context.
5158 if (defined $chunks[1]) {
5159 my ($cond, $block) = @{$chunks[1]};
5160 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005161 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005162 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005163 if ($block =~ /^\s*\{/) {
5164 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5165 $allowed = 1;
5166 }
5167 }
5168 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005169 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005170 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005171
Andy Whitcroftf0556632008-10-15 22:02:23 -07005172 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005173 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005174 }
5175
Joe Perches000d1cc12011-07-25 17:13:25 -07005176 WARN("BRACES",
5177 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005178 }
5179 }
5180
Joe Perchese4c5bab2017-02-24 15:01:41 -08005181# check for single line unbalanced braces
Sven Eckelmann95330472017-02-24 15:01:43 -08005182 if ($sline =~ /^.\s*\}\s*else\s*$/ ||
5183 $sline =~ /^.\s*else\s*\{\s*$/) {
Joe Perchese4c5bab2017-02-24 15:01:41 -08005184 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr);
5185 }
5186
Joe Perches0979ae62012-12-17 16:01:59 -08005187# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005188 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005189 if (CHK("BRACES",
5190 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5191 $fix && $prevrawline =~ /^\+/) {
5192 fix_delete_line($fixlinenr - 1, $prevrawline);
5193 }
Joe Perches0979ae62012-12-17 16:01:59 -08005194 }
Joe Perches77b9a532013-07-03 15:05:29 -07005195 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005196 if (CHK("BRACES",
5197 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5198 $fix) {
5199 fix_delete_line($fixlinenr, $rawline);
5200 }
Joe Perches0979ae62012-12-17 16:01:59 -08005201 }
5202
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005203# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005204 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5205 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005206 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005207 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005208 }
5209
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005210# Check for user-visible strings broken across lines, which breaks the ability
5211# to grep for the string. Make exceptions when the previous string ends in a
5212# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5213# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005214 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005215 $prevline =~ /"\s*$/ &&
5216 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5217 if (WARN("SPLIT_STRING",
5218 "quoted string split across lines\n" . $hereprev) &&
5219 $fix &&
5220 $prevrawline =~ /^\+.*"\s*$/ &&
5221 $last_coalesced_string_linenr != $linenr - 1) {
5222 my $extracted_string = get_quoted_string($line, $rawline);
5223 my $comma_close = "";
5224 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5225 $comma_close = $1;
5226 }
5227
5228 fix_delete_line($fixlinenr - 1, $prevrawline);
5229 fix_delete_line($fixlinenr, $rawline);
5230 my $fixedline = $prevrawline;
5231 $fixedline =~ s/"\s*$//;
5232 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5233 fix_insert_line($fixlinenr - 1, $fixedline);
5234 $fixedline = $rawline;
5235 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5236 if ($fixedline !~ /\+\s*$/) {
5237 fix_insert_line($fixlinenr, $fixedline);
5238 }
5239 $last_coalesced_string_linenr = $linenr;
5240 }
5241 }
5242
5243# check for missing a space in a string concatenation
5244 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5245 WARN('MISSING_SPACE',
5246 "break quoted strings at a space character\n" . $hereprev);
5247 }
5248
Joe Perchese4b7d302017-05-08 15:55:51 -07005249# check for an embedded function name in a string when the function is known
5250# This does not work very well for -f --file checking as it depends on patch
5251# context providing the function name or a single line form for in-file
5252# function declarations
Joe Perches77cb8542017-02-24 15:01:28 -08005253 if ($line =~ /^\+.*$String/ &&
5254 defined($context_function) &&
Joe Perchese4b7d302017-05-08 15:55:51 -07005255 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ &&
5256 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) {
Joe Perches77cb8542017-02-24 15:01:28 -08005257 WARN("EMBEDDED_FUNCTION_NAME",
Joe Perchese4b7d302017-05-08 15:55:51 -07005258 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
Joe Perches77cb8542017-02-24 15:01:28 -08005259 }
5260
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005261# check for spaces before a quoted newline
5262 if ($rawline =~ /^.*\".*\s\\n/) {
5263 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5264 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5265 $fix) {
5266 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5267 }
5268
5269 }
5270
Joe Perchesf17dba42014-10-13 15:51:51 -07005271# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005272 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005273 CHK("CONCATENATED_STRING",
5274 "Concatenated strings should use spaces between elements\n" . $herecurr);
5275 }
5276
Joe Perches90ad30e2014-12-10 15:51:59 -08005277# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005278 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005279 WARN("STRING_FRAGMENTS",
5280 "Consecutive strings are generally better as a single string\n" . $herecurr);
5281 }
5282
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005283# check for non-standard and hex prefixed decimal printf formats
5284 my $show_L = 1; #don't show the same defect twice
5285 my $show_Z = 1;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005286 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005287 my $string = substr($rawline, $-[1], $+[1] - $-[1]);
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005288 $string =~ s/%%/__/g;
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005289 # check for %L
5290 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005291 WARN("PRINTF_L",
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005292 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr);
5293 $show_L = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005294 }
Alexey Dobriyan522b8372017-02-27 14:30:05 -08005295 # check for %Z
5296 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) {
5297 WARN("PRINTF_Z",
5298 "%Z$1 is non-standard C, use %z$1\n" . $herecurr);
5299 $show_Z = 0;
5300 }
5301 # check for 0x<decimal>
5302 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) {
5303 ERROR("PRINTF_0XDECIMAL",
Joe Perches6e300752015-09-09 15:37:47 -07005304 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5305 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005306 }
5307
5308# check for line continuations in quoted strings with odd counts of "
5309 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5310 WARN("LINE_CONTINUATIONS",
5311 "Avoid line continuations in quoted strings\n" . $herecurr);
5312 }
5313
Andy Whitcroft00df3442007-06-08 13:47:06 -07005314# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005315 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005316 CHK("REDUNDANT_CODE",
5317 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005318 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005319 }
5320
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005321# check for needless "if (<foo>) fn(<foo>)" uses
5322 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005323 my $tested = quotemeta($1);
5324 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5325 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5326 my $func = $1;
5327 if (WARN('NEEDLESS_IF',
5328 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5329 $fix) {
5330 my $do_fix = 1;
5331 my $leading_tabs = "";
5332 my $new_leading_tabs = "";
5333 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5334 $leading_tabs = $1;
5335 } else {
5336 $do_fix = 0;
5337 }
5338 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5339 $new_leading_tabs = $1;
5340 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5341 $do_fix = 0;
5342 }
5343 } else {
5344 $do_fix = 0;
5345 }
5346 if ($do_fix) {
5347 fix_delete_line($fixlinenr - 1, $prevrawline);
5348 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5349 }
5350 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005351 }
5352 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005353
Joe Perchesebfdc402014-08-06 16:10:27 -07005354# check for unnecessary "Out of Memory" messages
5355 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5356 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5357 (defined $1 || defined $3) &&
5358 $linenr > 3) {
5359 my $testval = $2;
5360 my $testline = $lines[$linenr - 3];
5361
5362 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5363# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5364
Joe Perchesfb0d0e02017-07-10 15:52:04 -07005365 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 -07005366 WARN("OOM_MESSAGE",
5367 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5368 }
5369 }
5370
Joe Perchesf78d98f2014-10-13 15:52:01 -07005371# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005372 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005373 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5374 my $level = $1;
5375 if (WARN("UNNECESSARY_KERN_LEVEL",
5376 "Possible unnecessary $level\n" . $herecurr) &&
5377 $fix) {
5378 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5379 }
5380 }
5381
Joe Perches45c55e92017-02-24 15:01:31 -08005382# check for logging continuations
5383 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) {
5384 WARN("LOGGING_CONTINUATION",
5385 "Avoid logging continuation uses where feasible\n" . $herecurr);
5386 }
5387
Joe Perchesabb08a52014-12-10 15:51:46 -08005388# check for mask then right shift without a parentheses
5389 if ($^V && $^V ge 5.10.0 &&
5390 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5391 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5392 WARN("MASK_THEN_SHIFT",
5393 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5394 }
5395
Joe Perchesb75ac612014-12-10 15:52:02 -08005396# check for pointer comparisons to NULL
5397 if ($^V && $^V ge 5.10.0) {
5398 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5399 my $val = $1;
5400 my $equal = "!";
5401 $equal = "" if ($4 eq "!=");
5402 if (CHK("COMPARISON_TO_NULL",
5403 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5404 $fix) {
5405 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5406 }
5407 }
5408 }
5409
Joe Perches8716de32013-09-11 14:24:05 -07005410# check for bad placement of section $InitAttribute (e.g.: __initdata)
5411 if ($line =~ /(\b$InitAttribute\b)/) {
5412 my $attr = $1;
5413 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5414 my $ptr = $1;
5415 my $var = $2;
5416 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5417 ERROR("MISPLACED_INIT",
5418 "$attr should be placed after $var\n" . $herecurr)) ||
5419 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5420 WARN("MISPLACED_INIT",
5421 "$attr should be placed after $var\n" . $herecurr))) &&
5422 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005423 $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 -07005424 }
5425 }
5426 }
5427
Joe Perchese970b8842013-11-12 15:10:10 -08005428# check for $InitAttributeData (ie: __initdata) with const
5429 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5430 my $attr = $1;
5431 $attr =~ /($InitAttributePrefix)(.*)/;
5432 my $attr_prefix = $1;
5433 my $attr_type = $2;
5434 if (ERROR("INIT_ATTRIBUTE",
5435 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5436 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005437 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005438 s/$InitAttributeData/${attr_prefix}initconst/;
5439 }
5440 }
5441
5442# check for $InitAttributeConst (ie: __initconst) without const
5443 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5444 my $attr = $1;
5445 if (ERROR("INIT_ATTRIBUTE",
5446 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5447 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005448 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005449 /(^\+\s*(?:static\s+))/;
5450 $lead = rtrim($1);
5451 $lead = "$lead " if ($lead !~ /^\+$/);
5452 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005453 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005454 }
5455 }
5456
Joe Perchesc17893c2015-04-16 12:44:42 -07005457# check for __read_mostly with const non-pointer (should just be const)
5458 if ($line =~ /\b__read_mostly\b/ &&
5459 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5460 if (ERROR("CONST_READ_MOSTLY",
5461 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5462 $fix) {
5463 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5464 }
5465 }
5466
Joe Perchesfbdb8132014-04-03 14:49:14 -07005467# don't use __constant_<foo> functions outside of include/uapi/
5468 if ($realfile !~ m@^include/uapi/@ &&
5469 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5470 my $constant_func = $1;
5471 my $func = $constant_func;
5472 $func =~ s/^__constant_//;
5473 if (WARN("CONSTANT_CONVERSION",
5474 "$constant_func should be $func\n" . $herecurr) &&
5475 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005476 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005477 }
5478 }
5479
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005480# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005481 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005482 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005483 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005484 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005485 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005486 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5487 }
5488 if ($delay > 2000) {
5489 WARN("LONG_UDELAY",
5490 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005491 }
5492 }
5493
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005494# warn about unexpectedly long msleep's
5495 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5496 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005497 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005498 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005499 }
5500 }
5501
Joe Perches36ec1932013-07-03 15:05:25 -07005502# check for comparisons of jiffies
5503 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5504 WARN("JIFFIES_COMPARISON",
5505 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5506 }
5507
Joe Perches9d7a34a2013-07-03 15:05:26 -07005508# check for comparisons of get_jiffies_64()
5509 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5510 WARN("JIFFIES_COMPARISON",
5511 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5512 }
5513
Andy Whitcroft00df3442007-06-08 13:47:06 -07005514# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005515# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005516# print "#ifdef in C files should be avoided\n";
5517# print "$herecurr";
5518# $clean = 0;
5519# }
5520
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005521# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005522 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005523 if (ERROR("SPACING",
5524 "exactly one space required after that #$1\n" . $herecurr) &&
5525 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005526 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005527 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5528 }
5529
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005530 }
5531
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005532# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005533 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5534 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005535 my $which = $1;
5536 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005537 CHK("UNCOMMENTED_DEFINITION",
5538 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005539 }
5540 }
5541# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005542
5543 my $barriers = qr{
5544 mb|
5545 rmb|
5546 wmb|
5547 read_barrier_depends
5548 }x;
5549 my $barrier_stems = qr{
5550 mb__before_atomic|
5551 mb__after_atomic|
5552 store_release|
5553 load_acquire|
5554 store_mb|
5555 (?:$barriers)
5556 }x;
5557 my $all_barriers = qr{
5558 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005559 smp_(?:$barrier_stems)|
5560 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005561 }x;
5562
5563 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005564 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005565 WARN("MEMORY_BARRIER",
5566 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005567 }
5568 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005569
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005570 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5571
5572 if ($realfile !~ m@^include/asm-generic/@ &&
5573 $realfile !~ m@/barrier\.h$@ &&
5574 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5575 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5576 WARN("MEMORY_BARRIER",
5577 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5578 }
5579
Joe Perchescb426e92015-06-25 15:02:46 -07005580# check for waitqueue_active without a comment.
5581 if ($line =~ /\bwaitqueue_active\s*\(/) {
5582 if (!ctx_has_comment($first_line, $linenr)) {
5583 WARN("WAITQUEUE_ACTIVE",
5584 "waitqueue_active without comment\n" . $herecurr);
5585 }
5586 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005587
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005588# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005589 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005590 CHK("ARCH_DEFINES",
5591 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005592 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005593
Joe Perches596ed452017-07-12 14:37:02 -07005594# check that the storage class is not after a type
5595 if ($line =~ /\b($Type)\s+($Storage)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005596 WARN("STORAGE_CLASS",
Joe Perches596ed452017-07-12 14:37:02 -07005597 "storage class '$2' should be located before type '$1'\n" . $herecurr);
5598 }
5599# Check that the storage class is at the beginning of a declaration
5600 if ($line =~ /\b$Storage\b/ &&
5601 $line !~ /^.\s*$Storage/ &&
5602 $line =~ /^.\s*(.+?)\$Storage\s/ &&
5603 $1 !~ /[\,\)]\s*$/) {
5604 WARN("STORAGE_CLASS",
5605 "storage class should be at the beginning of the declaration\n" . $herecurr);
Tobias Klauserd4977c72010-05-24 14:33:30 -07005606 }
5607
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005608# check the location of the inline attribute, that it is between
5609# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005610 if ($line =~ /\b$Type\s+$Inline\b/ ||
5611 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005612 ERROR("INLINE_LOCATION",
5613 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005614 }
5615
Andy Whitcroft8905a672007-11-28 16:21:06 -08005616# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005617 if ($realfile !~ m@\binclude/uapi/@ &&
5618 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005619 if (WARN("INLINE",
5620 "plain inline is preferred over $1\n" . $herecurr) &&
5621 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005622 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005623
5624 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005625 }
5626
Joe Perches3d130fd2011-01-12 17:00:00 -08005627# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005628 if ($realfile !~ m@\binclude/uapi/@ &&
5629 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005630 WARN("PREFER_PACKED",
5631 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005632 }
5633
Joe Perches39b7e282011-07-25 17:13:24 -07005634# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005635 if ($realfile !~ m@\binclude/uapi/@ &&
5636 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005637 WARN("PREFER_ALIGNED",
5638 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005639 }
5640
Joe Perches5f14d3b2012-01-10 15:09:52 -08005641# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005642 if ($realfile !~ m@\binclude/uapi/@ &&
5643 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005644 if (WARN("PREFER_PRINTF",
5645 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5646 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005647 $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 -07005648
5649 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005650 }
5651
Joe Perches6061d942012-03-23 15:02:16 -07005652# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005653 if ($realfile !~ m@\binclude/uapi/@ &&
5654 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005655 if (WARN("PREFER_SCANF",
5656 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5657 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005658 $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 -07005659 }
Joe Perches6061d942012-03-23 15:02:16 -07005660 }
5661
Joe Perches619a9082014-12-10 15:51:35 -08005662# Check for __attribute__ weak, or __weak declarations (may have link issues)
5663 if ($^V && $^V ge 5.10.0 &&
5664 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5665 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5666 $line =~ /\b__weak\b/)) {
5667 ERROR("WEAK_DECLARATION",
5668 "Using weak declarations can have unintended link defects\n" . $herecurr);
5669 }
5670
Tomas Winklerfd39f902016-12-12 16:46:34 -08005671# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005672 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005673 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005674 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5675 my $type = $1;
5676 if ($type =~ /\b($typeC99Typedefs)\b/) {
5677 $type = $1;
5678 my $kernel_type = 'u';
5679 $kernel_type = 's' if ($type =~ /^_*[si]/);
5680 $type =~ /(\d+)/;
5681 $kernel_type .= $1;
5682 if (CHK("PREFER_KERNEL_TYPES",
5683 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5684 $fix) {
5685 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5686 }
5687 }
5688 }
5689
Joe Perches938224b2016-01-20 14:59:15 -08005690# check for cast of C90 native int or longer types constants
5691 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5692 my $cast = $1;
5693 my $const = $2;
5694 if (WARN("TYPECAST_INT_CONSTANT",
5695 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5696 $fix) {
5697 my $suffix = "";
5698 my $newconst = $const;
5699 $newconst =~ s/${Int_type}$//;
5700 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5701 if ($cast =~ /\blong\s+long\b/) {
5702 $suffix .= 'LL';
5703 } elsif ($cast =~ /\blong\b/) {
5704 $suffix .= 'L';
5705 }
5706 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5707 }
5708 }
5709
Joe Perches8f53a9b2010-03-05 13:43:48 -08005710# check for sizeof(&)
5711 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005712 WARN("SIZEOF_ADDRESS",
5713 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005714 }
5715
Joe Perches66c80b62012-07-30 14:41:22 -07005716# check for sizeof without parenthesis
5717 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005718 if (WARN("SIZEOF_PARENTHESIS",
5719 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5720 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005721 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005722 }
Joe Perches66c80b62012-07-30 14:41:22 -07005723 }
5724
Joe Perches88982fe2012-12-17 16:02:00 -08005725# check for struct spinlock declarations
5726 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5727 WARN("USE_SPINLOCK_T",
5728 "struct spinlock should be spinlock_t\n" . $herecurr);
5729 }
5730
Joe Perchesa6962d72013-04-29 16:18:13 -07005731# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005732 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005733 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005734 $fmt =~ s/%%//g;
5735 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005736 if (WARN("PREFER_SEQ_PUTS",
5737 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5738 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005739 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005740 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005741 }
5742 }
5743
Joe Perches0b523762017-05-08 15:55:36 -07005744 # check for vsprintf extension %p<foo> misuses
5745 if ($^V && $^V ge 5.10.0 &&
5746 defined $stat &&
5747 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5748 $1 !~ /^_*volatile_*$/) {
5749 my $bad_extension = "";
5750 my $lc = $stat =~ tr@\n@@;
5751 $lc = $lc + $linenr;
5752 for (my $count = $linenr; $count <= $lc; $count++) {
5753 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5754 $fmt =~ s/%%//g;
Pantelis Antoniouce4fecf2015-01-21 19:06:14 +02005755 if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNO]).)/) {
Joe Perches0b523762017-05-08 15:55:36 -07005756 $bad_extension = $1;
5757 last;
5758 }
5759 }
5760 if ($bad_extension ne "") {
5761 my $stat_real = raw_line($linenr, 0);
5762 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5763 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5764 }
5765 WARN("VSPRINTF_POINTER_EXTENSION",
5766 "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
5767 }
5768 }
5769
Andy Whitcroft554e1652012-01-10 15:09:57 -08005770# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005771 if ($^V && $^V ge 5.10.0 &&
5772 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005773 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005774
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005775 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005776 my $ms_val = $7;
5777 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005778
Andy Whitcroft554e1652012-01-10 15:09:57 -08005779 if ($ms_size =~ /^(0x|)0$/i) {
5780 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005781 "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 -08005782 } elsif ($ms_size =~ /^(0x|)1$/i) {
5783 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005784 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5785 }
5786 }
5787
Joe Perches98a9bba2014-01-23 15:54:52 -08005788# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005789# if ($^V && $^V ge 5.10.0 &&
5790# defined $stat &&
5791# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5792# if (WARN("PREFER_ETHER_ADDR_COPY",
5793# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5794# $fix) {
5795# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5796# }
5797# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005798
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005799# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf333195d2016-10-11 13:51:53 -07005800# if ($^V && $^V ge 5.10.0 &&
5801# defined $stat &&
5802# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5803# WARN("PREFER_ETHER_ADDR_EQUAL",
5804# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5805# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005806
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005807# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5808# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf333195d2016-10-11 13:51:53 -07005809# if ($^V && $^V ge 5.10.0 &&
5810# defined $stat &&
5811# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5812#
5813# my $ms_val = $7;
5814#
5815# if ($ms_val =~ /^(?:0x|)0+$/i) {
5816# if (WARN("PREFER_ETH_ZERO_ADDR",
5817# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5818# $fix) {
5819# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5820# }
5821# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5822# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5823# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5824# $fix) {
5825# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5826# }
5827# }
5828# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005829
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005830# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005831 if ($^V && $^V ge 5.10.0 &&
5832 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005833 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005834 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005835 my $call = $1;
5836 my $cast1 = deparenthesize($2);
5837 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005838 my $cast2 = deparenthesize($7);
5839 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005840 my $cast;
5841
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005842 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005843 $cast = "$cast1 or $cast2";
5844 } elsif ($cast1 ne "") {
5845 $cast = $cast1;
5846 } else {
5847 $cast = $cast2;
5848 }
5849 WARN("MINMAX",
5850 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005851 }
5852 }
5853
Joe Perches4a273192012-07-30 14:41:20 -07005854# check usleep_range arguments
5855 if ($^V && $^V ge 5.10.0 &&
5856 defined $stat &&
5857 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5858 my $min = $1;
5859 my $max = $7;
5860 if ($min eq $max) {
5861 WARN("USLEEP_RANGE",
5862 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5863 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5864 $min > $max) {
5865 WARN("USLEEP_RANGE",
5866 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5867 }
5868 }
5869
Joe Perches823b7942013-11-12 15:10:15 -08005870# check for naked sscanf
5871 if ($^V && $^V ge 5.10.0 &&
5872 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005873 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005874 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5875 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5876 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5877 my $lc = $stat =~ tr@\n@@;
5878 $lc = $lc + $linenr;
5879 my $stat_real = raw_line($linenr, 0);
5880 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5881 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5882 }
5883 WARN("NAKED_SSCANF",
5884 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5885 }
5886
Joe Perchesafc819a2014-06-04 16:12:08 -07005887# check for simple sscanf that should be kstrto<foo>
5888 if ($^V && $^V ge 5.10.0 &&
5889 defined $stat &&
5890 $line =~ /\bsscanf\b/) {
5891 my $lc = $stat =~ tr@\n@@;
5892 $lc = $lc + $linenr;
5893 my $stat_real = raw_line($linenr, 0);
5894 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5895 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5896 }
5897 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5898 my $format = $6;
5899 my $count = $format =~ tr@%@%@;
5900 if ($count == 1 &&
5901 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5902 WARN("SSCANF_TO_KSTRTO",
5903 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5904 }
5905 }
5906 }
5907
Joe Perches70dc8a42013-09-11 14:23:58 -07005908# check for new externs in .h files.
5909 if ($realfile =~ /\.h$/ &&
5910 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005911 if (CHK("AVOID_EXTERNS",
5912 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005913 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005914 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005915 }
5916 }
5917
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005918# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005919 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005920 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005921 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005922 my $function_name = $1;
5923 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005924
5925 my $s = $stat;
5926 if (defined $cond) {
5927 substr($s, 0, length($cond), '');
5928 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005929 if ($s =~ /^\s*;/ &&
5930 $function_name ne 'uninitialized_var')
5931 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005932 WARN("AVOID_EXTERNS",
5933 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005934 }
5935
5936 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005937 WARN("FUNCTION_ARGUMENTS",
5938 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005939 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005940
5941 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5942 $stat =~ /^.\s*extern\s+/)
5943 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005944 WARN("AVOID_EXTERNS",
5945 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005946 }
5947
Joe Perchesa0ad7592017-07-10 15:52:19 -07005948# check for function declarations that have arguments without identifier names
5949 if (defined $stat &&
Miles Chen25bdda22017-11-17 15:28:34 -08005950 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
Joe Perchesca0d8922016-10-11 13:52:16 -07005951 $1 ne "void") {
5952 my $args = trim($1);
5953 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5954 my $arg = trim($1);
5955 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5956 WARN("FUNCTION_ARGUMENTS",
5957 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5958 }
5959 }
5960 }
5961
Joe Perchesa0ad7592017-07-10 15:52:19 -07005962# check for function definitions
5963 if ($^V && $^V ge 5.10.0 &&
5964 defined $stat &&
5965 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) {
5966 $context_function = $1;
5967
5968# check for multiline function definition with misplaced open brace
5969 my $ok = 0;
5970 my $cnt = statement_rawlines($stat);
5971 my $herectx = $here . "\n";
5972 for (my $n = 0; $n < $cnt; $n++) {
5973 my $rl = raw_line($linenr, $n);
5974 $herectx .= $rl . "\n";
5975 $ok = 1 if ($rl =~ /^[ \+]\{/);
5976 $ok = 1 if ($rl =~ /\{/ && $n == 0);
5977 last if $rl =~ /^[ \+].*\{/;
5978 }
5979 if (!$ok) {
5980 ERROR("OPEN_BRACE",
5981 "open brace '{' following function definitions go on the next line\n" . $herectx);
5982 }
5983 }
5984
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005985# checks for new __setup's
5986 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5987 my $name = $1;
5988
5989 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005990 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005991 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005992 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005993 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005994
5995# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005996 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005997 WARN("UNNECESSARY_CASTS",
5998 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005999 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006000
Joe Perchesa640d252013-07-03 15:05:21 -07006001# alloc style
6002# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6003 if ($^V && $^V ge 5.10.0 &&
6004 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6005 CHK("ALLOC_SIZEOF_STRUCT",
6006 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
6007 }
6008
Joe Perches60a55362014-06-04 16:12:07 -07006009# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6010 if ($^V && $^V ge 5.10.0 &&
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006011 defined $stat &&
6012 $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 -07006013 my $oldfunc = $3;
6014 my $a1 = $4;
6015 my $a2 = $10;
6016 my $newfunc = "kmalloc_array";
6017 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07006018 my $r1 = $a1;
6019 my $r2 = $a2;
6020 if ($a1 =~ /^sizeof\s*\S/) {
6021 $r1 = $a2;
6022 $r2 = $a1;
6023 }
6024 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
6025 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006026 my $ctx = '';
6027 my $herectx = $here . "\n";
6028 my $cnt = statement_rawlines($stat);
6029 for (my $n = 0; $n < $cnt; $n++) {
6030 $herectx .= raw_line($linenr, $n) . "\n";
6031 }
Joe Perches60a55362014-06-04 16:12:07 -07006032 if (WARN("ALLOC_WITH_MULTIPLY",
Joe Perches1b4a2ed2017-05-08 15:55:57 -07006033 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) &&
6034 $cnt == 1 &&
Joe Perches60a55362014-06-04 16:12:07 -07006035 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006036 $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 -07006037 }
6038 }
6039 }
6040
Joe Perches972fdea2013-04-29 16:18:12 -07006041# check for krealloc arg reuse
6042 if ($^V && $^V ge 5.10.0 &&
6043 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
6044 WARN("KREALLOC_ARG_REUSE",
6045 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
6046 }
6047
Joe Perches5ce59ae2013-02-21 16:44:18 -08006048# check for alloc argument mismatch
6049 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
6050 WARN("ALLOC_ARRAY_ARGS",
6051 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
6052 }
6053
Joe Perchescaf2a542011-01-12 16:59:56 -08006054# check for multiple semicolons
6055 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07006056 if (WARN("ONE_SEMICOLON",
6057 "Statements terminations use 1 semicolon\n" . $herecurr) &&
6058 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006059 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006060 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006061 }
6062
Tomas Winklercec3aaa2016-08-02 14:04:39 -07006063# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6064 if ($realfile !~ m@^include/uapi/@ &&
6065 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08006066 my $ull = "";
6067 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
6068 if (CHK("BIT_MACRO",
6069 "Prefer using the BIT$ull macro\n" . $herecurr) &&
6070 $fix) {
6071 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
6072 }
6073 }
6074
Joe Perches2d632742016-05-20 17:04:00 -07006075# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6076 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6077 my $config = $1;
6078 if (WARN("PREFER_IS_ENABLED",
6079 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
6080 $fix) {
6081 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
6082 }
6083 }
6084
Joe Perchese81f2392014-08-06 16:11:25 -07006085# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08006086 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
6087 my $has_break = 0;
6088 my $has_statement = 0;
6089 my $count = 0;
6090 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006091 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006092 $prevline--;
6093 my $rline = $rawlines[$prevline - 1];
6094 my $fline = $lines[$prevline - 1];
6095 last if ($fline =~ /^\@\@/);
6096 next if ($fline =~ /^\-/);
6097 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6098 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6099 next if ($fline =~ /^.[\s$;]*$/);
6100 $has_statement = 1;
6101 $count++;
Heinrich Schuchardt258f79d2017-11-17 15:28:38 -08006102 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006103 }
6104 if (!$has_break && $has_statement) {
6105 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08006106 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08006107 }
6108 }
6109
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006110# check for switch/default statements without a break;
6111 if ($^V && $^V ge 5.10.0 &&
6112 defined $stat &&
6113 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6114 my $ctx = '';
6115 my $herectx = $here . "\n";
6116 my $cnt = statement_rawlines($stat);
6117 for (my $n = 0; $n < $cnt; $n++) {
6118 $herectx .= raw_line($linenr, $n) . "\n";
6119 }
6120 WARN("DEFAULT_NO_BREAK",
6121 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006122 }
6123
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006124# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006125 if ($line =~ /\b__FUNCTION__\b/) {
6126 if (WARN("USE_FUNC",
6127 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6128 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006129 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006130 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006131 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006132
Joe Perches62ec8182015-02-13 14:38:18 -08006133# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6134 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6135 ERROR("DATE_TIME",
6136 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6137 }
6138
Joe Perches2c924882012-03-23 15:02:20 -07006139# check for use of yield()
6140 if ($line =~ /\byield\s*\(\s*\)/) {
6141 WARN("YIELD",
6142 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6143 }
6144
Joe Perches179f8f42013-07-03 15:05:30 -07006145# check for comparisons against true and false
6146 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6147 my $lead = $1;
6148 my $arg = $2;
6149 my $test = $3;
6150 my $otype = $4;
6151 my $trail = $5;
6152 my $op = "!";
6153
6154 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6155
6156 my $type = lc($otype);
6157 if ($type =~ /^(?:true|false)$/) {
6158 if (("$test" eq "==" && "$type" eq "true") ||
6159 ("$test" eq "!=" && "$type" eq "false")) {
6160 $op = "";
6161 }
6162
6163 CHK("BOOL_COMPARISON",
6164 "Using comparison to $otype is error prone\n" . $herecurr);
6165
6166## maybe suggesting a correct construct would better
6167## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6168
6169 }
6170 }
6171
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006172# check for semaphores initialized locked
6173 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006174 WARN("CONSIDER_COMPLETION",
6175 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006176 }
Joe Perches6712d852012-03-23 15:02:20 -07006177
Joe Perches67d0a072011-10-31 17:13:10 -07006178# recommend kstrto* over simple_strto* and strict_strto*
6179 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006180 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006181 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006182 }
Joe Perches6712d852012-03-23 15:02:20 -07006183
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006184# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006185 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006186 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006187 "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 -07006188 }
Joe Perches6712d852012-03-23 15:02:20 -07006189
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006190# check for various structs that are normally const (ops, kgdb, device_tree)
Joe Perchesd9190e42017-05-08 15:55:45 -07006191# and avoid what seem like struct definitions 'struct foo {'
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006192 if ($line !~ /\bconst\b/ &&
Joe Perchesd9190e42017-05-08 15:55:45 -07006193 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006194 WARN("CONST_STRUCT",
Joe Perchesd9190e42017-05-08 15:55:45 -07006195 "struct $1 should normally be const\n" . $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006196 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006197
6198# use of NR_CPUS is usually wrong
6199# ignore definitions of NR_CPUS and usage to define arrays as likely right
6200 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006201 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6202 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006203 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6204 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6205 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006206 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006207 WARN("NR_CPUS",
6208 "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 -07006209 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006210
Joe Perches52ea8502013-11-12 15:10:09 -08006211# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6212 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6213 ERROR("DEFINE_ARCH_HAS",
6214 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6215 }
6216
Joe Perchesacd93622015-02-13 14:38:38 -08006217# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6218 if ($^V && $^V ge 5.10.0 &&
6219 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6220 WARN("LIKELY_MISUSE",
6221 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6222 }
6223
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006224# whine mightly about in_atomic
6225 if ($line =~ /\bin_atomic\s*\(/) {
6226 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006227 ERROR("IN_ATOMIC",
6228 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006229 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006230 WARN("IN_ATOMIC",
6231 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006232 }
6233 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006234
Joe Perches481aea52016-05-20 17:04:08 -07006235# whine about ACCESS_ONCE
6236 if ($^V && $^V ge 5.10.0 &&
6237 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6238 my $par = $1;
6239 my $eq = $2;
6240 my $fun = $3;
6241 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6242 if (defined($eq)) {
6243 if (WARN("PREFER_WRITE_ONCE",
6244 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6245 $fix) {
6246 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6247 }
6248 } else {
6249 if (WARN("PREFER_READ_ONCE",
6250 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6251 $fix) {
6252 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6253 }
6254 }
6255 }
6256
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006257# check for mutex_trylock_recursive usage
6258 if ($line =~ /mutex_trylock_recursive/) {
6259 ERROR("LOCKING",
6260 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6261 }
6262
Peter Zijlstra1704f472010-03-19 01:37:42 +01006263# check for lockdep_set_novalidate_class
6264 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6265 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6266 if ($realfile !~ m@^kernel/lockdep@ &&
6267 $realfile !~ m@^include/linux/lockdep@ &&
6268 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006269 ERROR("LOCKDEP",
6270 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006271 }
6272 }
Dave Jones88f88312011-01-12 16:59:59 -08006273
Joe Perchesb392c642015-04-16 12:44:16 -07006274 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6275 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006276 WARN("EXPORTED_WORLD_WRITABLE",
6277 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006278 }
Joe Perches24358802014-04-03 14:49:13 -07006279
Joe Perches515a2352014-04-03 14:49:24 -07006280# Mode permission misuses where it seems decimal should be octal
6281# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6282 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006283 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006284 $line =~ /$mode_perms_search/) {
6285 foreach my $entry (@mode_permission_funcs) {
6286 my $func = $entry->[0];
6287 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006288
Joe Perches459cf0a2016-10-11 13:52:19 -07006289 my $lc = $stat =~ tr@\n@@;
6290 $lc = $lc + $linenr;
6291 my $stat_real = raw_line($linenr, 0);
6292 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6293 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6294 }
6295
Joe Perches515a2352014-04-03 14:49:24 -07006296 my $skip_args = "";
6297 if ($arg_pos > 1) {
6298 $arg_pos--;
6299 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6300 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006301 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006302 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006303 my $val = $1;
6304 $val = $6 if ($skip_args ne "");
Joe Perchesf90774e2016-10-11 13:51:47 -07006305 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6306 ($val =~ /^$Octal$/ && length($val) ne 4)) {
Joe Perches515a2352014-04-03 14:49:24 -07006307 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006308 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006309 }
6310 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006311 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006312 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006313 }
Joe Perches24358802014-04-03 14:49:13 -07006314 }
6315 }
6316 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006317
Joe Perches459cf0a2016-10-11 13:52:19 -07006318# check for uses of S_<PERMS> that could be octal for readability
6319 if ($line =~ /\b$mode_perms_string_search\b/) {
6320 my $val = "";
6321 my $oval = "";
6322 my $to = 0;
6323 my $curpos = 0;
6324 my $lastpos = 0;
6325 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6326 $curpos = pos($line);
6327 my $match = $2;
6328 my $omatch = $1;
6329 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6330 $lastpos = $curpos;
6331 $to |= $mode_permission_string_types{$match};
6332 $val .= '\s*\|\s*' if ($val ne "");
6333 $val .= $match;
6334 $oval .= $omatch;
6335 }
6336 $oval =~ s/^\s*\|\s*//;
6337 $oval =~ s/\s*\|\s*$//;
6338 my $octal = sprintf("%04o", $to);
6339 if (WARN("SYMBOLIC_PERMS",
6340 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6341 $fix) {
6342 $fixed[$fixlinenr] =~ s/$val/$octal/;
6343 }
6344 }
6345
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006346# validate content of MODULE_LICENSE against list from include/linux/module.h
6347 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6348 my $extracted_string = get_quoted_string($line, $rawline);
6349 my $valid_licenses = qr{
6350 GPL|
6351 GPL\ v2|
6352 GPL\ and\ additional\ rights|
6353 Dual\ BSD/GPL|
6354 Dual\ MIT/GPL|
6355 Dual\ MPL/GPL|
6356 Proprietary
6357 }x;
6358 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6359 WARN("MODULE_LICENSE",
6360 "unknown module license " . $extracted_string . "\n" . $herecurr);
6361 }
6362 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006363 }
6364
6365 # If we have no input at all, then there is nothing to report on
6366 # so just keep quiet.
6367 if ($#rawlines == -1) {
6368 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006369 }
6370
Andy Whitcroft8905a672007-11-28 16:21:06 -08006371 # In mailback mode only produce a report in the negative, for
6372 # things that appear to be patches.
6373 if ($mailback && ($clean == 1 || !$is_patch)) {
6374 exit(0);
6375 }
6376
6377 # This is not a patch, and we are are in 'no-patch' mode so
6378 # just keep quiet.
6379 if (!$chk_patch && !$is_patch) {
6380 exit(0);
6381 }
6382
Stafford Hornea08ffbe2017-10-03 16:16:51 -07006383 if (!$is_patch && $filename !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006384 ERROR("NOT_UNIFIED_DIFF",
6385 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006386 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006387 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006388 ERROR("MISSING_SIGN_OFF",
6389 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006390 }
6391
Andy Whitcroft8905a672007-11-28 16:21:06 -08006392 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006393 if ($summary && !($clean == 1 && $quiet == 1)) {
6394 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006395 print "total: $cnt_error errors, $cnt_warn warnings, " .
6396 (($check)? "$cnt_chk checks, " : "") .
6397 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006398 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006399
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006400 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006401 # If there were any defects found and not already fixing them
6402 if (!$clean and !$fix) {
6403 print << "EOM"
6404
6405NOTE: For some of the reported defects, checkpatch may be able to
6406 mechanically convert to the typical style using --fix or --fix-inplace.
6407EOM
6408 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006409 # If there were whitespace errors which cleanpatch can fix
6410 # then suggest that.
6411 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006412 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006413 print << "EOM"
6414
6415NOTE: Whitespace errors detected.
6416 You may wish to use scripts/cleanpatch or scripts/cleanfile
6417EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006418 }
6419 }
6420
Joe Perchesd752fcc2014-08-06 16:11:05 -07006421 if ($clean == 0 && $fix &&
6422 ("@rawlines" ne "@fixed" ||
6423 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006424 my $newfile = $filename;
6425 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006426 my $linecount = 0;
6427 my $f;
6428
Joe Perchesd752fcc2014-08-06 16:11:05 -07006429 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6430
Joe Perches3705ce52013-07-03 15:05:31 -07006431 open($f, '>', $newfile)
6432 or die "$P: Can't open $newfile for write\n";
6433 foreach my $fixed_line (@fixed) {
6434 $linecount++;
6435 if ($file) {
6436 if ($linecount > 3) {
6437 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006438 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006439 }
6440 } else {
6441 print $f $fixed_line . "\n";
6442 }
6443 }
6444 close($f);
6445
6446 if (!$quiet) {
6447 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006448
Joe Perches3705ce52013-07-03 15:05:31 -07006449Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6450
6451Do _NOT_ trust the results written to this file.
6452Do _NOT_ submit these changes without inspecting them for correctness.
6453
6454This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6455No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006456EOM
6457 }
6458 }
6459
Joe Perchesd8469f12015-06-25 15:03:00 -07006460 if ($quiet == 0) {
6461 print "\n";
6462 if ($clean == 1) {
6463 print "$vname has no obvious style problems and is ready for submission.\n";
6464 } else {
6465 print "$vname has style problems, please review.\n";
6466 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006467 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006468 return $clean;
6469}