blob: 0ef3d837f2aa14b3a8673216b24de83c64f6a58f [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
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 Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070030my $git = 0;
Joe Perches0dea9f12016-05-20 17:04:19 -070031my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070033my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080034my $summary = 1;
35my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080036my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070037my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070038my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070039my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080040my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070041my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080042my %debug;
Joe Perches34456862013-07-03 15:05:34 -070043my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070044my %use_type = ();
45my @use = ();
46my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070047my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070048my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070049my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080050my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070051my $ignore_perl_version = 0;
52my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070053my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070054my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070055my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070056my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070057my $conststructsfile = "$D/const_structs.checkpatch";
Joe Perches57230292015-06-25 15:03:03 -070058my $color = 1;
Joe Perchesdadf6802016-08-02 14:04:33 -070059my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070060
61sub help {
62 my ($exitcode) = @_;
63
64 print << "EOM";
65Usage: $P [OPTION]... [FILE]...
66Version: $V
67
68Options:
69 -q, --quiet quiet
70 --no-tree run without a kernel tree
71 --no-signoff do not check for 'Signed-off-by' line
72 --patch treat FILE as patchfile (default)
73 --emacs emacs compile window format
74 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070075 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070076 -g, --git treat FILE as a single commit or git revision range
77 single git commit with:
78 <rev>
79 <rev>^
80 <rev>~n
81 multiple git commits with:
82 <rev1>..<rev2>
83 <rev1>...<rev2>
84 <rev>-<count>
85 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070086 -f, --file treat FILE as regular source file
87 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070088 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070089 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070090 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070091 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080092 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070093 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070094 --root=PATH PATH to the kernel tree root
95 --no-summary suppress the per-file summary
96 --mailback only produce a report in case of warnings/errors
97 --summary-file include the filename in summary
98 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
99 'values', 'possible', 'type', and 'attr' (default
100 is all off)
101 --test-only=WORD report only warnings/errors containing WORD
102 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700103 --fix EXPERIMENTAL - may create horrible results
104 If correctable single-line errors exist, create
105 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
106 with potential errors corrected to the preferred
107 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800108 --fix-inplace EXPERIMENTAL - may create horrible results
109 Is the same as --fix, but overwrites the input
110 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700111 --ignore-perl-version override checking of perl version. expect
112 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700113 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700114 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700115 --codespellfile Use this codespell dictionary
Joe Perches57230292015-06-25 15:03:03 -0700116 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700117 -h, --help, --version display this help and exit
118
119When FILE is - read standard input.
120EOM
121
122 exit($exitcode);
123}
124
Joe Perches3beb42e2016-05-20 17:04:14 -0700125sub uniq {
126 my %seen;
127 return grep { !$seen{$_}++ } @_;
128}
129
130sub list_types {
131 my ($exitcode) = @_;
132
133 my $count = 0;
134
135 local $/ = undef;
136
137 open(my $script, '<', abs_path($P)) or
138 die "$P: Can't read '$P' $!\n";
139
140 my $text = <$script>;
141 close($script);
142
143 my @types = ();
144 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
145 push (@types, $_);
146 }
147 @types = sort(uniq(@types));
148 print("#\tMessage type\n\n");
149 foreach my $type (@types) {
150 print(++$count . "\t" . $type . "\n");
151 }
152
153 exit($exitcode);
154}
155
Joe Perches000d1cc12011-07-25 17:13:25 -0700156my $conf = which_conf($configuration_file);
157if (-f $conf) {
158 my @conf_args;
159 open(my $conffile, '<', "$conf")
160 or warn "$P: Can't find a readable $configuration_file file $!\n";
161
162 while (<$conffile>) {
163 my $line = $_;
164
165 $line =~ s/\s*\n?$//g;
166 $line =~ s/^\s*//g;
167 $line =~ s/\s+/ /g;
168
169 next if ($line =~ m/^\s*#/);
170 next if ($line =~ m/^\s*$/);
171
172 my @words = split(" ", $line);
173 foreach my $word (@words) {
174 last if ($word =~ m/^#/);
175 push (@conf_args, $word);
176 }
177 }
178 close($conffile);
179 unshift(@ARGV, @conf_args) if @conf_args;
180}
181
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700182GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700183 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700184 'tree!' => \$tree,
185 'signoff!' => \$chk_signoff,
186 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700187 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800188 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700189 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700190 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700191 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700192 'subjective!' => \$check,
193 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700194 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700195 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700196 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700197 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800198 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700199 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700200 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800201 'summary!' => \$summary,
202 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800203 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700204 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800205 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700206 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800207 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700208 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700209 'codespell!' => \$codespell,
210 'codespellfile=s' => \$codespellfile,
Joe Perches57230292015-06-25 15:03:03 -0700211 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700212 'h|help' => \$help,
213 'version' => \$help
214) or help(1);
215
216help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700217
Joe Perches3beb42e2016-05-20 17:04:14 -0700218list_types(0) if ($list_types);
219
Joe Perches9624b8d2014-01-23 15:54:44 -0800220$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700221$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800222
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700223my $exit = 0;
224
Dave Hansend62a2012013-09-11 14:23:56 -0700225if ($^V && $^V lt $minimum_perl_version) {
226 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
227 if (!$ignore_perl_version) {
228 exit(1);
229 }
230}
231
Allen Hubbe45107ff2016-08-02 14:04:47 -0700232#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700233if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700234 push(@ARGV, '-');
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700235}
236
Joe Perches91bfe482013-09-11 14:23:59 -0700237sub hash_save_array_words {
238 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700239
Joe Perches91bfe482013-09-11 14:23:59 -0700240 my @array = split(/,/, join(',', @$arrayRef));
241 foreach my $word (@array) {
242 $word =~ s/\s*\n?$//g;
243 $word =~ s/^\s*//g;
244 $word =~ s/\s+/ /g;
245 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700246
Joe Perches91bfe482013-09-11 14:23:59 -0700247 next if ($word =~ m/^\s*#/);
248 next if ($word =~ m/^\s*$/);
249
250 $hashRef->{$word}++;
251 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700252}
253
Joe Perches91bfe482013-09-11 14:23:59 -0700254sub hash_show_words {
255 my ($hashRef, $prefix) = @_;
256
Joe Perches3c816e42015-06-25 15:03:29 -0700257 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700258 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700259 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700260 print " $word";
261 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700262 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700263 }
264}
265
266hash_save_array_words(\%ignore_type, \@ignore);
267hash_save_array_words(\%use_type, \@use);
268
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800269my $dbg_values = 0;
270my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700271my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700272my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800273for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800274 ## no critic
275 eval "\${dbg_$key} = '$debug{$key}';";
276 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800277}
278
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700279my $rpt_cleaners = 0;
280
Andy Whitcroft8905a672007-11-28 16:21:06 -0800281if ($terse) {
282 $emacs = 1;
283 $quiet++;
284}
285
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700286if ($tree) {
287 if (defined $root) {
288 if (!top_of_kernel_tree($root)) {
289 die "$P: $root: --root does not point at a valid tree\n";
290 }
291 } else {
292 if (top_of_kernel_tree('.')) {
293 $root = '.';
294 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
295 top_of_kernel_tree($1)) {
296 $root = $1;
297 }
298 }
299
300 if (!defined $root) {
301 print "Must be run from the top-level dir. of a kernel tree\n";
302 exit(2);
303 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700304}
305
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700306my $emitted_corrupt = 0;
307
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700308our $Ident = qr{
309 [A-Za-z_][A-Za-z\d_]*
310 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
311 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700312our $Storage = qr{extern|static|asmlinkage};
313our $Sparse = qr{
314 __user|
315 __kernel|
316 __force|
317 __iomem|
318 __must_check|
319 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800320 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700321 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800322 __rcu|
323 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700324 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800325our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
326our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
327our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
328our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
329our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700330
Wolfram Sang52131292010-03-05 13:43:51 -0800331# Notes to $Attribute:
332# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700333our $Attribute = qr{
334 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700335 __percpu|
336 __nocast|
337 __safe|
338 __bitwise__|
339 __packed__|
340 __packed2__|
341 __naked|
342 __maybe_unused|
343 __always_unused|
344 __noreturn|
345 __used|
346 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800347 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700348 __noclone|
349 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700350 __read_mostly|
351 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700352 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700353 ____cacheline_aligned|
354 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800355 ____cacheline_internodealigned_in_smp|
356 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700357 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700358our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700359our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700360our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
361our $Lval = qr{$Ident(?:$Member)*};
362
Joe Perches95e2c602013-07-03 15:05:20 -0700363our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
364our $Binary = qr{(?i)0b[01]+$Int_type?};
365our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
366our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700367our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800368our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800369our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
370our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
371our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800372our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700373our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800374our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700375our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700376our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700377our $Operators = qr{
378 <=|>=|==|!=|
379 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700380 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700381 }x;
382
Joe Perches91cb5192014-04-03 14:49:32 -0700383our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
384
Joe Perchesab7e23f2015-04-16 12:44:22 -0700385our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800386our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700387our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700388our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800389our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700390our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800391our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700392our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800393
Joe Perches15662b32011-10-31 17:13:12 -0700394our $NON_ASCII_UTF8 = qr{
395 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700396 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
397 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
398 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
399 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
400 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
401 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
402}x;
403
Joe Perches15662b32011-10-31 17:13:12 -0700404our $UTF8 = qr{
405 [\x09\x0A\x0D\x20-\x7E] # ASCII
406 | $NON_ASCII_UTF8
407}x;
408
Joe Perchese6176fa2015-06-25 15:02:49 -0700409our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800410our $typeOtherOSTypedefs = qr{(?x:
411 u_(?:char|short|int|long) | # bsd
412 u(?:nchar|short|int|long) # sysv
413)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700414our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700415 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700416 atomic_t
417)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700418our $typeTypedefs = qr{(?x:
419 $typeC99Typedefs\b|
420 $typeOtherOSTypedefs\b|
421 $typeKernelTypedefs\b
422)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700423
Joe Perches6d32f7a2015-11-06 16:31:37 -0800424our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
425
Joe Perches691e6692010-03-05 13:43:51 -0800426our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700427 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700428 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700429 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700430 panic|
Joe Perches06668722013-11-12 15:10:07 -0800431 MODULE_[A-Z_]+|
432 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800433)};
434
Joe Perches20112472011-07-25 17:13:23 -0700435our $signature_tags = qr{(?xi:
436 Signed-off-by:|
437 Acked-by:|
438 Tested-by:|
439 Reviewed-by:|
440 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700441 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700442 To:|
443 Cc:
444)};
445
Joe Perches18130872014-08-06 16:11:22 -0700446our @typeListMisordered = (
447 qr{char\s+(?:un)?signed},
448 qr{int\s+(?:(?:un)?signed\s+)?short\s},
449 qr{int\s+short(?:\s+(?:un)?signed)},
450 qr{short\s+int(?:\s+(?:un)?signed)},
451 qr{(?:un)?signed\s+int\s+short},
452 qr{short\s+(?:un)?signed},
453 qr{long\s+int\s+(?:un)?signed},
454 qr{int\s+long\s+(?:un)?signed},
455 qr{long\s+(?:un)?signed\s+int},
456 qr{int\s+(?:un)?signed\s+long},
457 qr{int\s+(?:un)?signed},
458 qr{int\s+long\s+long\s+(?:un)?signed},
459 qr{long\s+long\s+int\s+(?:un)?signed},
460 qr{long\s+long\s+(?:un)?signed\s+int},
461 qr{long\s+long\s+(?:un)?signed},
462 qr{long\s+(?:un)?signed},
463);
464
Andy Whitcroft8905a672007-11-28 16:21:06 -0800465our @typeList = (
466 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700467 qr{(?:(?:un)?signed\s+)?char},
468 qr{(?:(?:un)?signed\s+)?short\s+int},
469 qr{(?:(?:un)?signed\s+)?short},
470 qr{(?:(?:un)?signed\s+)?int},
471 qr{(?:(?:un)?signed\s+)?long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
473 qr{(?:(?:un)?signed\s+)?long\s+long},
474 qr{(?:(?:un)?signed\s+)?long},
475 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800476 qr{float},
477 qr{double},
478 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800479 qr{struct\s+$Ident},
480 qr{union\s+$Ident},
481 qr{enum\s+$Ident},
482 qr{${Ident}_t},
483 qr{${Ident}_handler},
484 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700485 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800486);
Joe Perches938224b2016-01-20 14:59:15 -0800487
488our $C90_int_types = qr{(?x:
489 long\s+long\s+int\s+(?:un)?signed|
490 long\s+long\s+(?:un)?signed\s+int|
491 long\s+long\s+(?:un)?signed|
492 (?:(?:un)?signed\s+)?long\s+long\s+int|
493 (?:(?:un)?signed\s+)?long\s+long|
494 int\s+long\s+long\s+(?:un)?signed|
495 int\s+(?:(?:un)?signed\s+)?long\s+long|
496
497 long\s+int\s+(?:un)?signed|
498 long\s+(?:un)?signed\s+int|
499 long\s+(?:un)?signed|
500 (?:(?:un)?signed\s+)?long\s+int|
501 (?:(?:un)?signed\s+)?long|
502 int\s+long\s+(?:un)?signed|
503 int\s+(?:(?:un)?signed\s+)?long|
504
505 int\s+(?:un)?signed|
506 (?:(?:un)?signed\s+)?int
507)};
508
Alex Dowad485ff232015-06-25 15:02:52 -0700509our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700510our @typeListWithAttr = (
511 @typeList,
512 qr{struct\s+$InitAttribute\s+$Ident},
513 qr{union\s+$InitAttribute\s+$Ident},
514);
515
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700516our @modifierList = (
517 qr{fastcall},
518);
Alex Dowad485ff232015-06-25 15:02:52 -0700519our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800520
Joe Perches24358802014-04-03 14:49:13 -0700521our @mode_permission_funcs = (
522 ["module_param", 3],
523 ["module_param_(?:array|named|string)", 4],
524 ["module_param_array_named", 5],
525 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
526 ["proc_create(?:_data|)", 2],
527 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
528);
529
Joe Perches515a2352014-04-03 14:49:24 -0700530#Create a search pattern for all these functions to speed up a loop below
531our $mode_perms_search = "";
532foreach my $entry (@mode_permission_funcs) {
533 $mode_perms_search .= '|' if ($mode_perms_search ne "");
534 $mode_perms_search .= $entry->[0];
535}
536
Joe Perchesb392c642015-04-16 12:44:16 -0700537our $mode_perms_world_writable = qr{
538 S_IWUGO |
539 S_IWOTH |
540 S_IRWXUGO |
541 S_IALLUGO |
542 0[0-7][0-7][2367]
543}x;
544
Joe Perchesf90774e2016-10-11 13:51:47 -0700545our %mode_permission_string_types = (
546 "S_IRWXU" => 0700,
547 "S_IRUSR" => 0400,
548 "S_IWUSR" => 0200,
549 "S_IXUSR" => 0100,
550 "S_IRWXG" => 0070,
551 "S_IRGRP" => 0040,
552 "S_IWGRP" => 0020,
553 "S_IXGRP" => 0010,
554 "S_IRWXO" => 0007,
555 "S_IROTH" => 0004,
556 "S_IWOTH" => 0002,
557 "S_IXOTH" => 0001,
558 "S_IRWXUGO" => 0777,
559 "S_IRUGO" => 0444,
560 "S_IWUGO" => 0222,
561 "S_IXUGO" => 0111,
562);
563
564#Create a search pattern for all these strings to speed up a loop below
565our $mode_perms_string_search = "";
566foreach my $entry (keys %mode_permission_string_types) {
567 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
568 $mode_perms_string_search .= $entry;
569}
570
Wolfram Sang7840a942010-08-09 17:20:57 -0700571our $allowed_asm_includes = qr{(?x:
572 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700573 memory|
574 time|
575 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700576)};
577# memory.h: ARM has a custom one
578
Kees Cook66b47b42014-10-13 15:51:57 -0700579# Load common spelling mistakes and build regular expression list.
580my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700581my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700582
Joe Perches36061e32014-12-10 15:51:43 -0800583if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800584 while (<$spelling>) {
585 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700586
Joe Perches36061e32014-12-10 15:51:43 -0800587 $line =~ s/\s*\n?$//g;
588 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700589
Joe Perches36061e32014-12-10 15:51:43 -0800590 next if ($line =~ m/^\s*#/);
591 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700592
Joe Perches36061e32014-12-10 15:51:43 -0800593 my ($suspect, $fix) = split(/\|\|/, $line);
594
Joe Perches36061e32014-12-10 15:51:43 -0800595 $spelling_fix{$suspect} = $fix;
596 }
597 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800598} else {
599 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700600}
Kees Cook66b47b42014-10-13 15:51:57 -0700601
Joe Perchesebfd7d62015-04-16 12:44:14 -0700602if ($codespell) {
603 if (open(my $spelling, '<', $codespellfile)) {
604 while (<$spelling>) {
605 my $line = $_;
606
607 $line =~ s/\s*\n?$//g;
608 $line =~ s/^\s*//g;
609
610 next if ($line =~ m/^\s*#/);
611 next if ($line =~ m/^\s*$/);
612 next if ($line =~ m/, disabled/i);
613
614 $line =~ s/,.*$//;
615
616 my ($suspect, $fix) = split(/->/, $line);
617
618 $spelling_fix{$suspect} = $fix;
619 }
620 close($spelling);
621 } else {
622 warn "No codespell typos will be found - file '$codespellfile': $!\n";
623 }
624}
625
626$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
627
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700628my $const_structs = "";
629if (open(my $conststructs, '<', $conststructsfile)) {
630 while (<$conststructs>) {
631 my $line = $_;
632
633 $line =~ s/\s*\n?$//g;
634 $line =~ s/^\s*//g;
635
636 next if ($line =~ m/^\s*#/);
637 next if ($line =~ m/^\s*$/);
638 if ($line =~ /\s/) {
639 print("$conststructsfile: '$line' invalid - ignored\n");
640 next;
641 }
642
643 $const_structs .= '|' if ($const_structs ne "");
644 $const_structs .= $line;
645 }
646 close($conststructsfile);
647} else {
648 warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
649}
650
Andy Whitcroft8905a672007-11-28 16:21:06 -0800651sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700652 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
653 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700654 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700655 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700656 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700657 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700658 (?:$typeTypedefs\b)|
659 (?:${all}\b)
660 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800661 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700662 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800663 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800664 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700665 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700666 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800667 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700668 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800669 }x;
Joe Perches18130872014-08-06 16:11:22 -0700670 $NonptrTypeMisordered = qr{
671 (?:$Modifier\s+|const\s+)*
672 (?:
673 (?:${Misordered}\b)
674 )
675 (?:\s+$Modifier|\s+const)*
676 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700677 $NonptrTypeWithAttr = qr{
678 (?:$Modifier\s+|const\s+)*
679 (?:
680 (?:typeof|__typeof__)\s*\([^\)]*\)|
681 (?:$typeTypedefs\b)|
682 (?:${allWithAttr}\b)
683 )
684 (?:\s+$Modifier|\s+const)*
685 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800686 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700687 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700688 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700689 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800690 }x;
Joe Perches18130872014-08-06 16:11:22 -0700691 $TypeMisordered = qr{
692 $NonptrTypeMisordered
693 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
694 (?:\s+$Inline|\s+$Modifier)*
695 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700696 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700697 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800698}
699build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700700
Joe Perches7d2367a2011-07-25 17:13:22 -0700701our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700702
703# Using $balanced_parens, $LvalOrFunc, or $FuncArg
704# requires at least perl version v5.10.0
705# Any use must be runtime checked with $^V
706
707our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700708our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800709our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700710
Joe Perchesf8422302014-08-06 16:11:31 -0700711our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700712 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700713 (?:$Storage\s+)?LIST_HEAD\s*\(|
714 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
715)};
716
Joe Perches7d2367a2011-07-25 17:13:22 -0700717sub deparenthesize {
718 my ($string) = @_;
719 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700720
721 while ($string =~ /^\s*\(.*\)\s*$/) {
722 $string =~ s@^\s*\(\s*@@;
723 $string =~ s@\s*\)\s*$@@;
724 }
725
Joe Perches7d2367a2011-07-25 17:13:22 -0700726 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700727
Joe Perches7d2367a2011-07-25 17:13:22 -0700728 return $string;
729}
730
Joe Perches34456862013-07-03 15:05:34 -0700731sub seed_camelcase_file {
732 my ($file) = @_;
733
734 return if (!(-f $file));
735
736 local $/;
737
738 open(my $include_file, '<', "$file")
739 or warn "$P: Can't read '$file' $!\n";
740 my $text = <$include_file>;
741 close($include_file);
742
743 my @lines = split('\n', $text);
744
745 foreach my $line (@lines) {
746 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
747 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
748 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800749 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
750 $camelcase{$1} = 1;
751 } 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 -0700752 $camelcase{$1} = 1;
753 }
754 }
755}
756
Joe Perches85b0ee12016-10-11 13:51:44 -0700757sub is_maintained_obsolete {
758 my ($filename) = @_;
759
760 return 0 if (!(-e "$root/scripts/get_maintainer.pl"));
761
Joe Perches0616efa2016-10-11 13:52:02 -0700762 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 -0700763
764 return $status =~ /obsolete/i;
765}
766
Joe Perches34456862013-07-03 15:05:34 -0700767my $camelcase_seeded = 0;
768sub seed_camelcase_includes {
769 return if ($camelcase_seeded);
770
771 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700772 my $camelcase_cache = "";
773 my @include_files = ();
774
775 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700776
Richard Genoud3645e322014-02-10 14:25:32 -0800777 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700778 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
779 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700780 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700781 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700782 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700783 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700784 @include_files = split('\n', $files);
785 foreach my $file (@include_files) {
786 my $date = POSIX::strftime("%Y%m%d%H%M",
787 localtime((stat $file)[9]));
788 $last_mod_date = $date if ($last_mod_date < $date);
789 }
790 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700791 }
Joe Perchesc707a812013-07-08 16:00:43 -0700792
793 if ($camelcase_cache ne "" && -f $camelcase_cache) {
794 open(my $camelcase_file, '<', "$camelcase_cache")
795 or warn "$P: Can't read '$camelcase_cache' $!\n";
796 while (<$camelcase_file>) {
797 chomp;
798 $camelcase{$_} = 1;
799 }
800 close($camelcase_file);
801
802 return;
803 }
804
Richard Genoud3645e322014-02-10 14:25:32 -0800805 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700806 $files = `git ls-files "include/*.h"`;
807 @include_files = split('\n', $files);
808 }
809
Joe Perches34456862013-07-03 15:05:34 -0700810 foreach my $file (@include_files) {
811 seed_camelcase_file($file);
812 }
Joe Perches351b2a12013-07-03 15:05:36 -0700813
Joe Perchesc707a812013-07-08 16:00:43 -0700814 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700815 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700816 open(my $camelcase_file, '>', "$camelcase_cache")
817 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700818 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
819 print $camelcase_file ("$_\n");
820 }
821 close($camelcase_file);
822 }
Joe Perches34456862013-07-03 15:05:34 -0700823}
824
Joe Perchesd311cd42014-08-06 16:10:57 -0700825sub git_commit_info {
826 my ($commit, $id, $desc) = @_;
827
828 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
829
830 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
831 $output =~ s/^\s*//gm;
832 my @lines = split("\n", $output);
833
Joe Perches0d7835f2015-02-13 14:38:35 -0800834 return ($id, $desc) if ($#lines < 0);
835
Joe Perchesd311cd42014-08-06 16:10:57 -0700836 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
837# Maybe one day convert this block of bash into something that returns
838# all matching commit ids, but it's very slow...
839#
840# echo "checking commits $1..."
841# git rev-list --remotes | grep -i "^$1" |
842# while read line ; do
843# git log --format='%H %s' -1 $line |
844# echo "commit $(cut -c 1-12,41-)"
845# done
846 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
847 } else {
848 $id = substr($lines[0], 0, 12);
849 $desc = substr($lines[0], 41);
850 }
851
852 return ($id, $desc);
853}
854
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700855$chk_signoff = 0 if ($file);
856
Andy Whitcroft00df3442007-06-08 13:47:06 -0700857my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800858my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700859my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700860my @fixed_inserted = ();
861my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700862my $fixlinenr = -1;
863
Du, Changbin4a593c32016-05-20 17:04:16 -0700864# If input is git commits, extract all commits from the commit expressions.
865# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
866die "$P: No git repository found\n" if ($git && !-e ".git");
867
868if ($git) {
869 my @commits = ();
Joe Perches0dea9f12016-05-20 17:04:19 -0700870 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700871 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700872 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
873 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700874 } elsif ($commit_expr =~ m/\.\./) {
875 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700876 } else {
Joe Perches0dea9f12016-05-20 17:04:19 -0700877 $git_range = "-1 $commit_expr";
878 }
879 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
880 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700881 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
882 next if (!defined($1) || !defined($2));
Joe Perches0dea9f12016-05-20 17:04:19 -0700883 my $sha1 = $1;
884 my $subject = $2;
885 unshift(@commits, $sha1);
886 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700887 }
888 }
889 die "$P: no git commits after extraction!\n" if (@commits == 0);
890 @ARGV = @commits;
891}
892
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800893my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700894for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800895 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700896 if ($git) {
897 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
898 die "$P: $filename: git format-patch failed - $!\n";
899 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800900 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700901 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800902 } elsif ($filename eq '-') {
903 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800905 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700906 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700907 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800908 if ($filename eq '-') {
909 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700910 } elsif ($git) {
Joe Perches0dea9f12016-05-20 17:04:19 -0700911 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800912 } else {
913 $vname = $filename;
914 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800915 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700916 chomp;
917 push(@rawlines, $_);
918 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800919 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700920
921 if ($#ARGV > 0 && $quiet == 0) {
922 print '-' x length($vname) . "\n";
923 print "$vname\n";
924 print '-' x length($vname) . "\n";
925 }
926
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800927 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700928 $exit = 1;
929 }
930 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800931 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700932 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700933 @fixed_inserted = ();
934 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700935 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700936 @modifierListFile = ();
937 @typeListFile = ();
938 build_types();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700939}
940
Joe Perchesd8469f12015-06-25 15:03:00 -0700941if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700942 hash_show_words(\%use_type, "Used");
943 hash_show_words(\%ignore_type, "Ignored");
944
Joe Perchesd8469f12015-06-25 15:03:00 -0700945 if ($^V lt 5.10.0) {
946 print << "EOM"
947
948NOTE: perl $^V is not modern enough to detect all possible issues.
949 An upgrade to at least perl v5.10.0 is suggested.
950EOM
951 }
952 if ($exit) {
953 print << "EOM"
954
955NOTE: If any of the errors are false positives, please report
956 them to the maintainer, see CHECKPATCH in MAINTAINERS.
957EOM
958 }
959}
960
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700961exit($exit);
962
963sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700964 my ($root) = @_;
965
966 my @tree_check = (
967 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
968 "README", "Documentation", "arch", "include", "drivers",
969 "fs", "init", "ipc", "kernel", "lib", "scripts",
970 );
971
972 foreach my $check (@tree_check) {
973 if (! -e $root . '/' . $check) {
974 return 0;
975 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700976 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700977 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700978}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700979
Joe Perches20112472011-07-25 17:13:23 -0700980sub parse_email {
981 my ($formatted_email) = @_;
982
983 my $name = "";
984 my $address = "";
985 my $comment = "";
986
987 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
988 $name = $1;
989 $address = $2;
990 $comment = $3 if defined $3;
991 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
992 $address = $1;
993 $comment = $2 if defined $2;
994 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
995 $address = $1;
996 $comment = $2 if defined $2;
997 $formatted_email =~ s/$address.*$//;
998 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700999 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001000 $name =~ s/^\"|\"$//g;
1001 # If there's a name left after stripping spaces and
1002 # leading quotes, and the address doesn't have both
1003 # leading and trailing angle brackets, the address
1004 # is invalid. ie:
1005 # "joe smith joe@smith.com" bad
1006 # "joe smith <joe@smith.com" bad
1007 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1008 $name = "";
1009 $address = "";
1010 $comment = "";
1011 }
1012 }
1013
Joe Perches3705ce52013-07-03 15:05:31 -07001014 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001015 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001016 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001017 $address =~ s/^\<|\>$//g;
1018
1019 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1020 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1021 $name = "\"$name\"";
1022 }
1023
1024 return ($name, $address, $comment);
1025}
1026
1027sub format_email {
1028 my ($name, $address) = @_;
1029
1030 my $formatted_email;
1031
Joe Perches3705ce52013-07-03 15:05:31 -07001032 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001033 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001034 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001035
1036 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1037 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1038 $name = "\"$name\"";
1039 }
1040
1041 if ("$name" eq "") {
1042 $formatted_email = "$address";
1043 } else {
1044 $formatted_email = "$name <$address>";
1045 }
1046
1047 return $formatted_email;
1048}
1049
Joe Perchesd311cd42014-08-06 16:10:57 -07001050sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001051 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001052
Joe Perchesbd474ca2014-08-06 16:11:10 -07001053 foreach my $path (split(/:/, $ENV{PATH})) {
1054 if (-e "$path/$bin") {
1055 return "$path/$bin";
1056 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001057 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001058
Joe Perchesbd474ca2014-08-06 16:11:10 -07001059 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001060}
1061
Joe Perches000d1cc12011-07-25 17:13:25 -07001062sub which_conf {
1063 my ($conf) = @_;
1064
1065 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1066 if (-e "$path/$conf") {
1067 return "$path/$conf";
1068 }
1069 }
1070
1071 return "";
1072}
1073
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001074sub expand_tabs {
1075 my ($str) = @_;
1076
1077 my $res = '';
1078 my $n = 0;
1079 for my $c (split(//, $str)) {
1080 if ($c eq "\t") {
1081 $res .= ' ';
1082 $n++;
1083 for (; ($n % 8) != 0; $n++) {
1084 $res .= ' ';
1085 }
1086 next;
1087 }
1088 $res .= $c;
1089 $n++;
1090 }
1091
1092 return $res;
1093}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001094sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001095 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001096 return $res;
1097}
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001098
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001099sub line_stats {
1100 my ($line) = @_;
1101
1102 # Drop the diff line leader and expand tabs
1103 $line =~ s/^.//;
1104 $line = expand_tabs($line);
1105
1106 # Pick the indent from the front of the line.
1107 my ($white) = ($line =~ /^(\s*)/);
1108
1109 return (length($line), length($white));
1110}
1111
Andy Whitcroft773647a2008-03-28 14:15:58 -07001112my $sanitise_quote = '';
1113
1114sub sanitise_line_reset {
1115 my ($in_comment) = @_;
1116
1117 if ($in_comment) {
1118 $sanitise_quote = '*/';
1119 } else {
1120 $sanitise_quote = '';
1121 }
1122}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001123sub sanitise_line {
1124 my ($line) = @_;
1125
1126 my $res = '';
1127 my $l = '';
1128
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001129 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001130 my $off = 0;
1131 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001132
Andy Whitcroft773647a2008-03-28 14:15:58 -07001133 # Always copy over the diff marker.
1134 $res = substr($line, 0, 1);
1135
1136 for ($off = 1; $off < length($line); $off++) {
1137 $c = substr($line, $off, 1);
1138
1139 # Comments we are wacking completly including the begin
1140 # and end, all to $;.
1141 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1142 $sanitise_quote = '*/';
1143
1144 substr($res, $off, 2, "$;$;");
1145 $off++;
1146 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001147 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001148 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001149 $sanitise_quote = '';
1150 substr($res, $off, 2, "$;$;");
1151 $off++;
1152 next;
1153 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001154 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1155 $sanitise_quote = '//';
1156
1157 substr($res, $off, 2, $sanitise_quote);
1158 $off++;
1159 next;
1160 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001161
1162 # A \ in a string means ignore the next character.
1163 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1164 $c eq "\\") {
1165 substr($res, $off, 2, 'XX');
1166 $off++;
1167 next;
1168 }
1169 # Regular quotes.
1170 if ($c eq "'" || $c eq '"') {
1171 if ($sanitise_quote eq '') {
1172 $sanitise_quote = $c;
1173
1174 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001175 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001176 } elsif ($sanitise_quote eq $c) {
1177 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001178 }
1179 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001180
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001181 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001182 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1183 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001184 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1185 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001186 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1187 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001188 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001189 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001190 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001191 }
1192
Daniel Walker113f04a2009-09-21 17:04:35 -07001193 if ($sanitise_quote eq '//') {
1194 $sanitise_quote = '';
1195 }
1196
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001197 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001198 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001199 my $clean = 'X' x length($1);
1200 $res =~ s@\<.*\>@<$clean>@;
1201
1202 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001203 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001204 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001205 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001206 }
1207
Joe Perchesdadf6802016-08-02 14:04:33 -07001208 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1209 my $match = $1;
1210 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1211 }
1212
Andy Whitcroft00df3442007-06-08 13:47:06 -07001213 return $res;
1214}
1215
Joe Perchesa6962d72013-04-29 16:18:13 -07001216sub get_quoted_string {
1217 my ($line, $rawline) = @_;
1218
Joe Perches33acb542015-06-25 15:02:54 -07001219 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001220 return substr($rawline, $-[0], $+[0] - $-[0]);
1221}
1222
Andy Whitcroft8905a672007-11-28 16:21:06 -08001223sub ctx_statement_block {
1224 my ($linenr, $remain, $off) = @_;
1225 my $line = $linenr - 1;
1226 my $blk = '';
1227 my $soff = $off;
1228 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001229 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001230
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001231 my $loff = 0;
1232
Andy Whitcroft8905a672007-11-28 16:21:06 -08001233 my $type = '';
1234 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001235 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001236 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001237 my $c;
1238 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001239
1240 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001241 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001242 @stack = (['', 0]) if ($#stack == -1);
1243
Andy Whitcroft773647a2008-03-28 14:15:58 -07001244 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001245 # If we are about to drop off the end, pull in more
1246 # context.
1247 if ($off >= $len) {
1248 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001249 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001250 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001251 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001252 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001253 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001254 $len = length($blk);
1255 $line++;
1256 last;
1257 }
1258 # Bail if there is no further context.
1259 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001260 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001261 last;
1262 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001263 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1264 $level++;
1265 $type = '#';
1266 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001267 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001268 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001269 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001270 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001271
Andy Whitcroft773647a2008-03-28 14:15:58 -07001272 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001273
1274 # Handle nested #if/#else.
1275 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1276 push(@stack, [ $type, $level ]);
1277 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1278 ($type, $level) = @{$stack[$#stack - 1]};
1279 } elsif ($remainder =~ /^#\s*endif\b/) {
1280 ($type, $level) = @{pop(@stack)};
1281 }
1282
Andy Whitcroft8905a672007-11-28 16:21:06 -08001283 # Statement ends at the ';' or a close '}' at the
1284 # outermost level.
1285 if ($level == 0 && $c eq ';') {
1286 last;
1287 }
1288
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001289 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001290 if ($level == 0 && $coff_set == 0 &&
1291 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1292 $remainder =~ /^(else)(?:\s|{)/ &&
1293 $remainder !~ /^else\s+if\b/) {
1294 $coff = $off + length($1) - 1;
1295 $coff_set = 1;
1296 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1297 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001298 }
1299
Andy Whitcroft8905a672007-11-28 16:21:06 -08001300 if (($type eq '' || $type eq '(') && $c eq '(') {
1301 $level++;
1302 $type = '(';
1303 }
1304 if ($type eq '(' && $c eq ')') {
1305 $level--;
1306 $type = ($level != 0)? '(' : '';
1307
1308 if ($level == 0 && $coff < $soff) {
1309 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001310 $coff_set = 1;
1311 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001312 }
1313 }
1314 if (($type eq '' || $type eq '{') && $c eq '{') {
1315 $level++;
1316 $type = '{';
1317 }
1318 if ($type eq '{' && $c eq '}') {
1319 $level--;
1320 $type = ($level != 0)? '{' : '';
1321
1322 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001323 if (substr($blk, $off + 1, 1) eq ';') {
1324 $off++;
1325 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001326 last;
1327 }
1328 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001329 # Preprocessor commands end at the newline unless escaped.
1330 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1331 $level--;
1332 $type = '';
1333 $off++;
1334 last;
1335 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001336 $off++;
1337 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001338 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001339 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001340 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001341 $line++;
1342 $remain--;
1343 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001344
1345 my $statement = substr($blk, $soff, $off - $soff + 1);
1346 my $condition = substr($blk, $soff, $coff - $soff + 1);
1347
1348 #warn "STATEMENT<$statement>\n";
1349 #warn "CONDITION<$condition>\n";
1350
Andy Whitcroft773647a2008-03-28 14:15:58 -07001351 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001352
1353 return ($statement, $condition,
1354 $line, $remain + 1, $off - $loff + 1, $level);
1355}
1356
Andy Whitcroftcf655042008-03-04 14:28:20 -08001357sub statement_lines {
1358 my ($stmt) = @_;
1359
1360 # Strip the diff line prefixes and rip blank lines at start and end.
1361 $stmt =~ s/(^|\n)./$1/g;
1362 $stmt =~ s/^\s*//;
1363 $stmt =~ s/\s*$//;
1364
1365 my @stmt_lines = ($stmt =~ /\n/g);
1366
1367 return $#stmt_lines + 2;
1368}
1369
1370sub statement_rawlines {
1371 my ($stmt) = @_;
1372
1373 my @stmt_lines = ($stmt =~ /\n/g);
1374
1375 return $#stmt_lines + 2;
1376}
1377
1378sub statement_block_size {
1379 my ($stmt) = @_;
1380
1381 $stmt =~ s/(^|\n)./$1/g;
1382 $stmt =~ s/^\s*{//;
1383 $stmt =~ s/}\s*$//;
1384 $stmt =~ s/^\s*//;
1385 $stmt =~ s/\s*$//;
1386
1387 my @stmt_lines = ($stmt =~ /\n/g);
1388 my @stmt_statements = ($stmt =~ /;/g);
1389
1390 my $stmt_lines = $#stmt_lines + 2;
1391 my $stmt_statements = $#stmt_statements + 1;
1392
1393 if ($stmt_lines > $stmt_statements) {
1394 return $stmt_lines;
1395 } else {
1396 return $stmt_statements;
1397 }
1398}
1399
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001400sub ctx_statement_full {
1401 my ($linenr, $remain, $off) = @_;
1402 my ($statement, $condition, $level);
1403
1404 my (@chunks);
1405
Andy Whitcroftcf655042008-03-04 14:28:20 -08001406 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001407 ($statement, $condition, $linenr, $remain, $off, $level) =
1408 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001409 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001410 push(@chunks, [ $condition, $statement ]);
1411 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1412 return ($level, $linenr, @chunks);
1413 }
1414
1415 # Pull in the following conditional/block pairs and see if they
1416 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001417 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001418 ($statement, $condition, $linenr, $remain, $off, $level) =
1419 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001420 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001421 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001422 #print "C: push\n";
1423 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001424 }
1425
1426 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001427}
1428
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001429sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001430 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001431 my $line;
1432 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001433 my $blk = '';
1434 my @o;
1435 my @c;
1436 my @res = ();
1437
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001438 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001439 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001440 for ($line = $start; $remain > 0; $line++) {
1441 next if ($rawlines[$line] =~ /^-/);
1442 $remain--;
1443
1444 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001445
1446 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001447 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001448 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001449 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001450 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001451 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001452 $level = pop(@stack);
1453 }
1454
Andy Whitcroft01464f32010-10-26 14:23:19 -07001455 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001456 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1457 if ($off > 0) {
1458 $off--;
1459 next;
1460 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001461
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001462 if ($c eq $close && $level > 0) {
1463 $level--;
1464 last if ($level == 0);
1465 } elsif ($c eq $open) {
1466 $level++;
1467 }
1468 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001469
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001470 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001471 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001472 }
1473
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001474 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001475 }
1476
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001477 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001478}
1479sub ctx_block_outer {
1480 my ($linenr, $remain) = @_;
1481
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001482 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1483 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001484}
1485sub ctx_block {
1486 my ($linenr, $remain) = @_;
1487
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001488 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1489 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001490}
1491sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001492 my ($linenr, $remain, $off) = @_;
1493
1494 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1495 return @r;
1496}
1497sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001498 my ($linenr, $remain) = @_;
1499
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001500 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001501}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001502sub ctx_statement_level {
1503 my ($linenr, $remain, $off) = @_;
1504
1505 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1506}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001507
1508sub ctx_locate_comment {
1509 my ($first_line, $end_line) = @_;
1510
1511 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001512 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001513 return $current_comment if (defined $current_comment);
1514
1515 # Look through the context and try and figure out if there is a
1516 # comment.
1517 my $in_comment = 0;
1518 $current_comment = '';
1519 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001520 my $line = $rawlines[$linenr - 1];
1521 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001522 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1523 $in_comment = 1;
1524 }
1525 if ($line =~ m@/\*@) {
1526 $in_comment = 1;
1527 }
1528 if (!$in_comment && $current_comment ne '') {
1529 $current_comment = '';
1530 }
1531 $current_comment .= $line . "\n" if ($in_comment);
1532 if ($line =~ m@\*/@) {
1533 $in_comment = 0;
1534 }
1535 }
1536
1537 chomp($current_comment);
1538 return($current_comment);
1539}
1540sub ctx_has_comment {
1541 my ($first_line, $end_line) = @_;
1542 my $cmt = ctx_locate_comment($first_line, $end_line);
1543
Andy Whitcroft00df3442007-06-08 13:47:06 -07001544 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001545 ##print "CMMT: $cmt\n";
1546
1547 return ($cmt ne '');
1548}
1549
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001550sub raw_line {
1551 my ($linenr, $cnt) = @_;
1552
1553 my $offset = $linenr - 1;
1554 $cnt++;
1555
1556 my $line;
1557 while ($cnt) {
1558 $line = $rawlines[$offset++];
1559 next if (defined($line) && $line =~ /^-/);
1560 $cnt--;
1561 }
1562
1563 return $line;
1564}
1565
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001566sub cat_vet {
1567 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001568 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001569
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001570 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001571 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1572 $res .= $1;
1573 if ($2 ne '') {
1574 $coded = sprintf("^%c", unpack('C', $2) + 64);
1575 $res .= $coded;
1576 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001577 }
1578 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001579
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001580 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001581}
1582
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001583my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001584my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001585my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001586my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001587
1588sub annotate_reset {
1589 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001590 $av_pending = '_';
1591 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001592 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001593}
1594
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001595sub annotate_values {
1596 my ($stream, $type) = @_;
1597
1598 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001599 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001600 my $cur = $stream;
1601
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001602 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001603
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001604 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001605 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001606 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001607 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001608 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001609 print "WS($1)\n" if ($dbg_values > 1);
1610 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001611 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001612 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001613 }
1614
Florian Micklerc023e4732011-01-12 16:59:58 -08001615 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001616 print "CAST($1)\n" if ($dbg_values > 1);
1617 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001618 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001619
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001620 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001621 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001622 $type = 'T';
1623
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001624 } elsif ($cur =~ /^($Modifier)\s*/) {
1625 print "MODIFIER($1)\n" if ($dbg_values > 1);
1626 $type = 'T';
1627
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001628 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001629 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001630 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001631 push(@av_paren_type, $type);
1632 if ($2 ne '') {
1633 $av_pending = 'N';
1634 }
1635 $type = 'E';
1636
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001637 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001638 print "UNDEF($1)\n" if ($dbg_values > 1);
1639 $av_preprocessor = 1;
1640 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001641
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001642 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001643 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001644 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001645
1646 push(@av_paren_type, $type);
1647 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001648 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001649
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001650 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001651 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1652 $av_preprocessor = 1;
1653
1654 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1655
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001656 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001657
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001658 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001659 print "PRE_END($1)\n" if ($dbg_values > 1);
1660
1661 $av_preprocessor = 1;
1662
1663 # Assume all arms of the conditional end as this
1664 # one does, and continue as if the #endif was not here.
1665 pop(@av_paren_type);
1666 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001667 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001668
1669 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001670 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001671
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001672 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1673 print "ATTR($1)\n" if ($dbg_values > 1);
1674 $av_pending = $type;
1675 $type = 'N';
1676
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001677 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001678 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001679 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001680 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001681 }
1682 $type = 'N';
1683
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001684 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001685 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001686 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001687 $type = 'N';
1688
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001689 } elsif ($cur =~/^(case)/o) {
1690 print "CASE($1)\n" if ($dbg_values > 1);
1691 $av_pend_colon = 'C';
1692 $type = 'N';
1693
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001694 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001695 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001696 $type = 'N';
1697
1698 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001699 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001700 push(@av_paren_type, $av_pending);
1701 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001702 $type = 'N';
1703
1704 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001705 my $new_type = pop(@av_paren_type);
1706 if ($new_type ne '_') {
1707 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001708 print "PAREN('$1') -> $type\n"
1709 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001710 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001711 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001712 }
1713
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001714 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001715 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001716 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001717 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001718
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001719 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1720 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001721 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001722 } elsif ($type eq 'E') {
1723 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001724 }
1725 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1726 $type = 'V';
1727
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001728 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001729 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001730 $type = 'V';
1731
1732 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001733 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001734 $type = 'N';
1735
Andy Whitcroftcf655042008-03-04 14:28:20 -08001736 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001737 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001738 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001739 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001740
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001741 } elsif ($cur =~/^(,)/) {
1742 print "COMMA($1)\n" if ($dbg_values > 1);
1743 $type = 'C';
1744
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001745 } elsif ($cur =~ /^(\?)/o) {
1746 print "QUESTION($1)\n" if ($dbg_values > 1);
1747 $type = 'N';
1748
1749 } elsif ($cur =~ /^(:)/o) {
1750 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1751
1752 substr($var, length($res), 1, $av_pend_colon);
1753 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1754 $type = 'E';
1755 } else {
1756 $type = 'N';
1757 }
1758 $av_pend_colon = 'O';
1759
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001760 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001761 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001762 $type = 'N';
1763
Andy Whitcroft0d413862008-10-15 22:02:16 -07001764 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001765 my $variant;
1766
1767 print "OPV($1)\n" if ($dbg_values > 1);
1768 if ($type eq 'V') {
1769 $variant = 'B';
1770 } else {
1771 $variant = 'U';
1772 }
1773
1774 substr($var, length($res), 1, $variant);
1775 $type = 'N';
1776
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001777 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001778 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001779 if ($1 ne '++' && $1 ne '--') {
1780 $type = 'N';
1781 }
1782
1783 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001784 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001785 }
1786 if (defined $1) {
1787 $cur = substr($cur, length($1));
1788 $res .= $type x length($1);
1789 }
1790 }
1791
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001792 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001793}
1794
Andy Whitcroft8905a672007-11-28 16:21:06 -08001795sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001796 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001797 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001798 ^(?:
1799 $Modifier|
1800 $Storage|
1801 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001802 DEFINE_\S+
1803 )$|
1804 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001805 goto|
1806 return|
1807 case|
1808 else|
1809 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001810 do|
1811 \#|
1812 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001813 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001814 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001815 )}x;
1816 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1817 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001818 # Check for modifiers.
1819 $possible =~ s/\s*$Storage\s*//g;
1820 $possible =~ s/\s*$Sparse\s*//g;
1821 if ($possible =~ /^\s*$/) {
1822
1823 } elsif ($possible =~ /\s/) {
1824 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001825 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001826 if ($modifier !~ $notPermitted) {
1827 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001828 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001829 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001830 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001831
1832 } else {
1833 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001834 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001835 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001836 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001837 } else {
1838 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001839 }
1840}
1841
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001842my $prefix = '';
1843
Joe Perches000d1cc12011-07-25 17:13:25 -07001844sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001845 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001846
Joe Perchescbec18a2014-04-03 14:49:19 -07001847 return defined $use_type{$type} if (scalar keys %use_type > 0);
1848
1849 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001850}
1851
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001852sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001853 my ($level, $type, $msg) = @_;
1854
1855 if (!show_type($type) ||
1856 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001857 return 0;
1858 }
Joe Perches57230292015-06-25 15:03:03 -07001859 my $output = '';
1860 if (-t STDOUT && $color) {
1861 if ($level eq 'ERROR') {
1862 $output .= RED;
1863 } elsif ($level eq 'WARNING') {
1864 $output .= YELLOW;
1865 } else {
1866 $output .= GREEN;
1867 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001868 }
Joe Perches57230292015-06-25 15:03:03 -07001869 $output .= $prefix . $level . ':';
1870 if ($show_types) {
1871 $output .= BLUE if (-t STDOUT && $color);
1872 $output .= "$type:";
1873 }
1874 $output .= RESET if (-t STDOUT && $color);
1875 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001876
1877 if ($showfile) {
1878 my @lines = split("\n", $output, -1);
1879 splice(@lines, 1, 1);
1880 $output = join("\n", @lines);
1881 }
Joe Perches57230292015-06-25 15:03:03 -07001882 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001883
Joe Perches57230292015-06-25 15:03:03 -07001884 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001885
1886 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001887}
Joe Perchescbec18a2014-04-03 14:49:19 -07001888
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001889sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001890 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001891}
Joe Perches000d1cc12011-07-25 17:13:25 -07001892
Joe Perchesd752fcc2014-08-06 16:11:05 -07001893sub fixup_current_range {
1894 my ($lineRef, $offset, $length) = @_;
1895
1896 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1897 my $o = $1;
1898 my $l = $2;
1899 my $no = $o + $offset;
1900 my $nl = $l + $length;
1901 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1902 }
1903}
1904
1905sub fix_inserted_deleted_lines {
1906 my ($linesRef, $insertedRef, $deletedRef) = @_;
1907
1908 my $range_last_linenr = 0;
1909 my $delta_offset = 0;
1910
1911 my $old_linenr = 0;
1912 my $new_linenr = 0;
1913
1914 my $next_insert = 0;
1915 my $next_delete = 0;
1916
1917 my @lines = ();
1918
1919 my $inserted = @{$insertedRef}[$next_insert++];
1920 my $deleted = @{$deletedRef}[$next_delete++];
1921
1922 foreach my $old_line (@{$linesRef}) {
1923 my $save_line = 1;
1924 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001925 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001926 $delta_offset = 0;
1927 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1928 $range_last_linenr = $new_linenr;
1929 fixup_current_range(\$line, $delta_offset, 0);
1930 }
1931
1932 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1933 $deleted = @{$deletedRef}[$next_delete++];
1934 $save_line = 0;
1935 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1936 }
1937
1938 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1939 push(@lines, ${$inserted}{'LINE'});
1940 $inserted = @{$insertedRef}[$next_insert++];
1941 $new_linenr++;
1942 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1943 }
1944
1945 if ($save_line) {
1946 push(@lines, $line);
1947 $new_linenr++;
1948 }
1949
1950 $old_linenr++;
1951 }
1952
1953 return @lines;
1954}
1955
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001956sub fix_insert_line {
1957 my ($linenr, $line) = @_;
1958
1959 my $inserted = {
1960 LINENR => $linenr,
1961 LINE => $line,
1962 };
1963 push(@fixed_inserted, $inserted);
1964}
1965
1966sub fix_delete_line {
1967 my ($linenr, $line) = @_;
1968
1969 my $deleted = {
1970 LINENR => $linenr,
1971 LINE => $line,
1972 };
1973
1974 push(@fixed_deleted, $deleted);
1975}
1976
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001977sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001978 my ($type, $msg) = @_;
1979
1980 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001981 our $clean = 0;
1982 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001983 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001984 }
Joe Perches3705ce52013-07-03 15:05:31 -07001985 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001986}
1987sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001988 my ($type, $msg) = @_;
1989
1990 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001991 our $clean = 0;
1992 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001993 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001994 }
Joe Perches3705ce52013-07-03 15:05:31 -07001995 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001996}
1997sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001998 my ($type, $msg) = @_;
1999
2000 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002001 our $clean = 0;
2002 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002003 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002004 }
Joe Perches3705ce52013-07-03 15:05:31 -07002005 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002006}
2007
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002008sub check_absolute_file {
2009 my ($absolute, $herecurr) = @_;
2010 my $file = $absolute;
2011
2012 ##print "absolute<$absolute>\n";
2013
2014 # See if any suffix of this path is a path within the tree.
2015 while ($file =~ s@^[^/]*/@@) {
2016 if (-f "$root/$file") {
2017 ##print "file<$file>\n";
2018 last;
2019 }
2020 }
2021 if (! -f _) {
2022 return 0;
2023 }
2024
2025 # It is, so see if the prefix is acceptable.
2026 my $prefix = $absolute;
2027 substr($prefix, -length($file)) = '';
2028
2029 ##print "prefix<$prefix>\n";
2030 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002031 WARN("USE_RELATIVE_PATH",
2032 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002033 }
2034}
2035
Joe Perches3705ce52013-07-03 15:05:31 -07002036sub trim {
2037 my ($string) = @_;
2038
Joe Perchesb34c6482013-09-11 14:24:01 -07002039 $string =~ s/^\s+|\s+$//g;
2040
2041 return $string;
2042}
2043
2044sub ltrim {
2045 my ($string) = @_;
2046
2047 $string =~ s/^\s+//;
2048
2049 return $string;
2050}
2051
2052sub rtrim {
2053 my ($string) = @_;
2054
2055 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002056
2057 return $string;
2058}
2059
Joe Perches52ea8502013-11-12 15:10:09 -08002060sub string_find_replace {
2061 my ($string, $find, $replace) = @_;
2062
2063 $string =~ s/$find/$replace/g;
2064
2065 return $string;
2066}
2067
Joe Perches3705ce52013-07-03 15:05:31 -07002068sub tabify {
2069 my ($leading) = @_;
2070
2071 my $source_indent = 8;
2072 my $max_spaces_before_tab = $source_indent - 1;
2073 my $spaces_to_tab = " " x $source_indent;
2074
2075 #convert leading spaces to tabs
2076 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2077 #Remove spaces before a tab
2078 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2079
2080 return "$leading";
2081}
2082
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002083sub pos_last_openparen {
2084 my ($line) = @_;
2085
2086 my $pos = 0;
2087
2088 my $opens = $line =~ tr/\(/\(/;
2089 my $closes = $line =~ tr/\)/\)/;
2090
2091 my $last_openparen = 0;
2092
2093 if (($opens == 0) || ($closes >= $opens)) {
2094 return -1;
2095 }
2096
2097 my $len = length($line);
2098
2099 for ($pos = 0; $pos < $len; $pos++) {
2100 my $string = substr($line, $pos);
2101 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2102 $pos += length($1) - 1;
2103 } elsif (substr($line, $pos, 1) eq '(') {
2104 $last_openparen = $pos;
2105 } elsif (index($string, '(') == -1) {
2106 last;
2107 }
2108 }
2109
Joe Perches91cb5192014-04-03 14:49:32 -07002110 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002111}
2112
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002113sub process {
2114 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002115
2116 my $linenr=0;
2117 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002118 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002119 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002120 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002121
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002122 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002123 my $indent;
2124 my $previndent=0;
2125 my $stashindent=0;
2126
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002127 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002128 my $signoff = 0;
2129 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002130 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002131 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002132 my $has_commit_log = 0; #Encountered lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002133 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002134 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002135 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002136 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002137 my $non_utf8_charset = 0;
2138
Joe Perches365dd4e2014-08-06 16:10:42 -07002139 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002140 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002141
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002142 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002143 our $cnt_lines = 0;
2144 our $cnt_error = 0;
2145 our $cnt_warn = 0;
2146 our $cnt_chk = 0;
2147
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002148 # Trace the real file/line as we go.
2149 my $realfile = '';
2150 my $realline = 0;
2151 my $realcnt = 0;
2152 my $here = '';
2153 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002154 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002155 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002156 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002157
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002158 my $prev_values = 'E';
2159
2160 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002161 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002162 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002163 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002164 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002165
Joe Perches7e51f192013-09-11 14:23:57 -07002166 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002167
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002168 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002169 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002170 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002171 my @setup_docs = ();
2172 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002173
Joe Perchesd8b07712013-11-12 15:10:06 -08002174 my $camelcase_file_seeded = 0;
2175
Andy Whitcroft773647a2008-03-28 14:15:58 -07002176 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002177 my $line;
2178 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002179 $linenr++;
2180 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002181
Joe Perches3705ce52013-07-03 15:05:31 -07002182 push(@fixed, $rawline) if ($fix);
2183
Andy Whitcroft773647a2008-03-28 14:15:58 -07002184 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002185 $setup_docs = 0;
2186 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2187 $setup_docs = 1;
2188 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002189 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002190 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002191 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2192 $realline=$1-1;
2193 if (defined $2) {
2194 $realcnt=$3+1;
2195 } else {
2196 $realcnt=1+1;
2197 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002198 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002199
2200 # Guestimate if this is a continuing comment. Run
2201 # the context looking for a comment "edge". If this
2202 # edge is a close comment then we must be in a comment
2203 # at context start.
2204 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002205 my $cnt = $realcnt;
2206 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2207 next if (defined $rawlines[$ln - 1] &&
2208 $rawlines[$ln - 1] =~ /^-/);
2209 $cnt--;
2210 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002211 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002212 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2213 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2214 ($edge) = $1;
2215 last;
2216 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002217 }
2218 if (defined $edge && $edge eq '*/') {
2219 $in_comment = 1;
2220 }
2221
2222 # Guestimate if this is a continuing comment. If this
2223 # is the start of a diff block and this line starts
2224 # ' *' then it is very likely a comment.
2225 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002226 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002227 {
2228 $in_comment = 1;
2229 }
2230
2231 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2232 sanitise_line_reset($in_comment);
2233
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002234 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002235 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002236 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002237 $line = sanitise_line($rawline);
2238 }
2239 push(@lines, $line);
2240
2241 if ($realcnt > 1) {
2242 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2243 } else {
2244 $realcnt = 0;
2245 }
2246
2247 #print "==>$rawline\n";
2248 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002249
2250 if ($setup_docs && $line =~ /^\+/) {
2251 push(@setup_docs, $line);
2252 }
2253 }
2254
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002255 $prefix = '';
2256
Andy Whitcroft773647a2008-03-28 14:15:58 -07002257 $realcnt = 0;
2258 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002259 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002260 foreach my $line (@lines) {
2261 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002262 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002263 my $sline = $line; #copy of $line
2264 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002265
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002266 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002267
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002268#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002269 if (!$in_commit_log &&
2270 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002271 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002272 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002273 $realline=$1-1;
2274 if (defined $2) {
2275 $realcnt=$3+1;
2276 } else {
2277 $realcnt=1+1;
2278 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002279 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002280 $prev_values = 'E';
2281
Andy Whitcroft773647a2008-03-28 14:15:58 -07002282 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002283 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002284 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002285 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002286 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002287
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002288# track the line number as we move through the hunk, note that
2289# new versions of GNU diff omit the leading space on completely
2290# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002291 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002292 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002293 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002294
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002295 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002296 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002297
2298 # Track the previous line.
2299 ($prevline, $stashline) = ($stashline, $line);
2300 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002301 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2302
Andy Whitcroft773647a2008-03-28 14:15:58 -07002303 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002304
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002305 } elsif ($realcnt == 1) {
2306 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002307 }
2308
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002309 my $hunk_line = ($realcnt != 0);
2310
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002311 $here = "#$linenr: " if (!$file);
2312 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002313
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002314 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002315 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002316 if ($line =~ /^diff --git.*?(\S+)$/) {
2317 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002318 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002319 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002320 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002321 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002322 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002323 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002324 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002325
2326 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002327 if (!$file && $tree && $p1_prefix ne '' &&
2328 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002329 WARN("PATCH_PREFIX",
2330 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002331 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002332
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002333 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002334 ERROR("MODIFIED_INCLUDE_ASM",
2335 "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 -07002336 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002337 $found_file = 1;
2338 }
2339
Joe Perches34d88152015-06-25 15:03:05 -07002340#make up the handle for any error we report on this line
2341 if ($showfile) {
2342 $prefix = "$realfile:$realline: "
2343 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002344 if ($file) {
2345 $prefix = "$filename:$realline: ";
2346 } else {
2347 $prefix = "$filename:$linenr: ";
2348 }
Joe Perches34d88152015-06-25 15:03:05 -07002349 }
2350
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002351 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002352 if (is_maintained_obsolete($realfile)) {
2353 WARN("OBSOLETE",
2354 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2355 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002356 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002357 $check = 1;
2358 } else {
2359 $check = $check_orig;
2360 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002361 next;
2362 }
2363
Randy Dunlap389834b2007-06-08 13:47:03 -07002364 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002365
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002366 my $hereline = "$here\n$rawline\n";
2367 my $herecurr = "$here\n$rawline\n";
2368 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002369
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002370 $cnt_lines++ if ($realcnt != 0);
2371
Joe Perchese518e9a2015-06-25 15:03:27 -07002372# Check if the commit log has what seems like a diff which can confuse patch
2373 if ($in_commit_log && !$commit_log_has_diff &&
2374 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2375 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2376 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2377 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2378 ERROR("DIFF_IN_COMMIT_MSG",
2379 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2380 $commit_log_has_diff = 1;
2381 }
2382
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002383# Check for incorrect file permissions
2384 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2385 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002386 if ($realfile !~ m@scripts/@ &&
2387 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002388 ERROR("EXECUTE_PERMISSIONS",
2389 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002390 }
2391 }
2392
Joe Perches20112472011-07-25 17:13:23 -07002393# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002394 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002395 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002396 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002397 }
2398
Joe Perchese0d975b2014-12-10 15:51:49 -08002399# Check if MAINTAINERS is being updated. If so, there's probably no need to
2400# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2401 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2402 $reported_maintainer_file = 1;
2403 }
2404
Joe Perches20112472011-07-25 17:13:23 -07002405# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002406 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002407 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002408 my $space_before = $1;
2409 my $sign_off = $2;
2410 my $space_after = $3;
2411 my $email = $4;
2412 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2413
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002414 if ($sign_off !~ /$signature_tags/) {
2415 WARN("BAD_SIGN_OFF",
2416 "Non-standard signature: $sign_off\n" . $herecurr);
2417 }
Joe Perches20112472011-07-25 17:13:23 -07002418 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002419 if (WARN("BAD_SIGN_OFF",
2420 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2421 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002422 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002423 "$ucfirst_sign_off $email";
2424 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002425 }
Joe Perches20112472011-07-25 17:13:23 -07002426 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002427 if (WARN("BAD_SIGN_OFF",
2428 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2429 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002430 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002431 "$ucfirst_sign_off $email";
2432 }
2433
Joe Perches20112472011-07-25 17:13:23 -07002434 }
2435 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002436 if (WARN("BAD_SIGN_OFF",
2437 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2438 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002439 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002440 "$ucfirst_sign_off $email";
2441 }
Joe Perches20112472011-07-25 17:13:23 -07002442 }
2443
2444 my ($email_name, $email_address, $comment) = parse_email($email);
2445 my $suggested_email = format_email(($email_name, $email_address));
2446 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002447 ERROR("BAD_SIGN_OFF",
2448 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002449 } else {
2450 my $dequoted = $suggested_email;
2451 $dequoted =~ s/^"//;
2452 $dequoted =~ s/" </ </;
2453 # Don't force email to have quotes
2454 # Allow just an angle bracketed address
2455 if ("$dequoted$comment" ne $email &&
2456 "<$email_address>$comment" ne $email &&
2457 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002458 WARN("BAD_SIGN_OFF",
2459 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002460 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002461 }
Joe Perches7e51f192013-09-11 14:23:57 -07002462
2463# Check for duplicate signatures
2464 my $sig_nospace = $line;
2465 $sig_nospace =~ s/\s//g;
2466 $sig_nospace = lc($sig_nospace);
2467 if (defined $signatures{$sig_nospace}) {
2468 WARN("BAD_SIGN_OFF",
2469 "Duplicate signature\n" . $herecurr);
2470 } else {
2471 $signatures{$sig_nospace} = 1;
2472 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002473 }
2474
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002475# Check email subject for common tools that don't need to be mentioned
2476 if ($in_header_lines &&
2477 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2478 WARN("EMAIL_SUBJECT",
2479 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2480 }
2481
Joe Perches9b3189e2014-06-04 16:12:10 -07002482# Check for old stable address
2483 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2484 ERROR("STABLE_ADDRESS",
2485 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2486 }
2487
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002488# Check for unwanted Gerrit info
2489 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2490 ERROR("GERRIT_CHANGE_ID",
2491 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2492 }
2493
Joe Perches369c8dd2015-11-06 16:31:34 -08002494# Check if the commit log is in a possible stack dump
2495 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2496 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2497 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2498 # timestamp
2499 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2500 # stack dump address
2501 $commit_log_possible_stack_dump = 1;
2502 }
2503
Joe Perches2a076f42015-04-16 12:44:28 -07002504# Check for line lengths > 75 in commit log, warn once
2505 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002506 length($line) > 75 &&
2507 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2508 # file delta changes
2509 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2510 # filename then :
2511 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2512 # A Fixes: or Link: line
2513 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002514 WARN("COMMIT_LOG_LONG_LINE",
2515 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2516 $commit_log_long_line = 1;
2517 }
2518
Joe Perchesbf4daf12015-09-09 15:37:50 -07002519# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002520 if ($in_commit_log && $commit_log_possible_stack_dump &&
2521 $line =~ /^\s*$/) {
2522 $commit_log_possible_stack_dump = 0;
2523 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002524
Joe Perches0d7835f2015-02-13 14:38:35 -08002525# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002526 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002527 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002528 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002529 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002530 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2531 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002532 my $init_char = "c";
2533 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002534 my $short = 1;
2535 my $long = 0;
2536 my $case = 1;
2537 my $space = 1;
2538 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002539 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002540 my $id = '0123456789ab';
2541 my $orig_desc = "commit description";
2542 my $description = "";
2543
Joe Perchesfe043ea2015-09-09 15:37:25 -07002544 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2545 $init_char = $1;
2546 $orig_commit = lc($2);
2547 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2548 $orig_commit = lc($1);
2549 }
2550
Joe Perches0d7835f2015-02-13 14:38:35 -08002551 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2552 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2553 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2554 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2555 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2556 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002557 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002558 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2559 defined $rawlines[$linenr] &&
2560 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2561 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002562 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002563 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2564 defined $rawlines[$linenr] &&
2565 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2566 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2567 $orig_desc = $1;
2568 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2569 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002570 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002571 }
2572
2573 ($id, $description) = git_commit_info($orig_commit,
2574 $id, $orig_desc);
2575
Joe Perches19c146a2015-02-13 14:39:00 -08002576 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002577 ERROR("GIT_COMMIT_ID",
2578 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2579 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002580 }
2581
Joe Perches13f19372014-08-06 16:10:59 -07002582# Check for added, moved or deleted files
2583 if (!$reported_maintainer_file && !$in_commit_log &&
2584 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2585 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2586 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2587 (defined($1) || defined($2))))) {
2588 $reported_maintainer_file = 1;
2589 WARN("FILE_PATH_CHANGES",
2590 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2591 }
2592
Andy Whitcroft00df3442007-06-08 13:47:06 -07002593# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002594 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002595 ERROR("CORRUPTED_PATCH",
2596 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002597 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002598 }
2599
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002600# Check for absolute kernel paths.
2601 if ($tree) {
2602 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2603 my $file = $1;
2604
2605 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2606 check_absolute_file($1, $herecurr)) {
2607 #
2608 } else {
2609 check_absolute_file($file, $herecurr);
2610 }
2611 }
2612 }
2613
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002614# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2615 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002616 $rawline !~ m/^$UTF8*$/) {
2617 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2618
2619 my $blank = copy_spacing($rawline);
2620 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2621 my $hereptr = "$hereline$ptr\n";
2622
Joe Perches34d99212011-07-25 17:13:26 -07002623 CHK("INVALID_UTF8",
2624 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002625 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002626
Joe Perches15662b32011-10-31 17:13:12 -07002627# Check if it's the start of a commit log
2628# (not a header line and we haven't seen the patch filename)
2629 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002630 !($rawline =~ /^\s+\S/ ||
2631 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002632 $in_header_lines = 0;
2633 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002634 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002635 }
2636
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002637# Check if there is UTF-8 in a commit log when a mail header has explicitly
2638# declined it, i.e defined some charset where it is missing.
2639 if ($in_header_lines &&
2640 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2641 $1 !~ /utf-8/i) {
2642 $non_utf8_charset = 1;
2643 }
2644
2645 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002646 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002647 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002648 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2649 }
2650
Kees Cook66b47b42014-10-13 15:51:57 -07002651# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002652 if (defined($misspellings) &&
2653 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002654 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002655 my $typo = $1;
2656 my $typo_fix = $spelling_fix{lc($typo)};
2657 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2658 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2659 my $msg_type = \&WARN;
2660 $msg_type = \&CHK if ($file);
2661 if (&{$msg_type}("TYPO_SPELLING",
2662 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2663 $fix) {
2664 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2665 }
2666 }
2667 }
2668
Andy Whitcroft306708542008-10-15 22:02:28 -07002669# ignore non-hunk lines and lines being removed
2670 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002671
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002672#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002673 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002674 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002675 if (ERROR("DOS_LINE_ENDINGS",
2676 "DOS line endings\n" . $herevet) &&
2677 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002678 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002679 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002680 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2681 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002682 if (ERROR("TRAILING_WHITESPACE",
2683 "trailing whitespace\n" . $herevet) &&
2684 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002685 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002686 }
2687
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002688 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002689 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002690
Josh Triplett4783f892013-11-12 15:10:12 -08002691# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002692 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002693 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2694 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002695 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2696 my $msg_type = \&ERROR;
2697 $msg_type = \&CHK if ($file);
2698 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002699 "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 -08002700 }
2701
Andi Kleen33549572010-05-24 14:33:29 -07002702# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002703# Only applies when adding the entry originally, after that we do not have
2704# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002705 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002706 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002707 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002708 my $cnt = $realcnt;
2709 my $ln = $linenr + 1;
2710 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002711 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002712 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002713 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002714 $f = $lines[$ln - 1];
2715 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2716 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002717
2718 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002719 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002720
Joe Perches8d73e0e2014-08-06 16:10:46 -07002721 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002722 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002723 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002724 $length = -1;
2725 }
2726
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002727 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002728 $f =~ s/#.*//;
2729 $f =~ s/^\s+//;
2730 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002731 if ($f =~ /^\s*config\s/) {
2732 $is_end = 1;
2733 last;
2734 }
Andi Kleen33549572010-05-24 14:33:29 -07002735 $length++;
2736 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002737 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2738 WARN("CONFIG_DESCRIPTION",
2739 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2740 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002741 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002742 }
2743
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002744# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2745 if ($realfile =~ /Kconfig/ &&
2746 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2747 WARN("CONFIG_EXPERIMENTAL",
2748 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2749 }
2750
Christoph Jaeger327953e2015-02-13 14:38:29 -08002751# discourage the use of boolean for type definition attributes of Kconfig options
2752 if ($realfile =~ /Kconfig/ &&
2753 $line =~ /^\+\s*\bboolean\b/) {
2754 WARN("CONFIG_TYPE_BOOLEAN",
2755 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2756 }
2757
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002758 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2759 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2760 my $flag = $1;
2761 my $replacement = {
2762 'EXTRA_AFLAGS' => 'asflags-y',
2763 'EXTRA_CFLAGS' => 'ccflags-y',
2764 'EXTRA_CPPFLAGS' => 'cppflags-y',
2765 'EXTRA_LDFLAGS' => 'ldflags-y',
2766 };
2767
2768 WARN("DEPRECATED_VARIABLE",
2769 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2770 }
2771
Rob Herringbff5da42014-01-23 15:54:51 -08002772# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002773 if (defined $root &&
2774 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2775 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2776
Rob Herringbff5da42014-01-23 15:54:51 -08002777 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2778
Florian Vaussardcc933192014-04-03 14:49:27 -07002779 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2780 my $vp_file = $dt_path . "vendor-prefixes.txt";
2781
Rob Herringbff5da42014-01-23 15:54:51 -08002782 foreach my $compat (@compats) {
2783 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002784 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2785 my $compat3 = $compat;
2786 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2787 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002788 if ( $? >> 8 ) {
2789 WARN("UNDOCUMENTED_DT_STRING",
2790 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2791 }
2792
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002793 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2794 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002795 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002796 if ( $? >> 8 ) {
2797 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002798 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002799 }
2800 }
2801 }
2802
Andy Whitcroft5368df22008-10-15 22:02:27 -07002803# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002804 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002805
Joe Perches47e0c882015-06-25 15:02:57 -07002806# line length limit (with some exclusions)
2807#
2808# There are a few types of lines that may extend beyond $max_line_length:
2809# logging functions like pr_info that end in a string
2810# lines with a single string
2811# #defines that are a single string
2812#
2813# There are 3 different line length message types:
2814# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2815# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2816# LONG_LINE all other lines longer than $max_line_length
2817#
2818# if LONG_LINE is ignored, the other 2 types are also ignored
2819#
2820
Joe Perchesb4749e92015-07-17 16:24:01 -07002821 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002822 my $msg_type = "LONG_LINE";
2823
2824 # Check the allowed long line types first
2825
2826 # logging functions that end in a string that starts
2827 # before $max_line_length
2828 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2829 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2830 $msg_type = "";
2831
2832 # lines with only strings (w/ possible termination)
2833 # #defines with only strings
2834 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2835 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2836 $msg_type = "";
2837
Joe Perchesd560a5f2016-08-02 14:04:31 -07002838 # EFI_GUID is another special case
2839 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2840 $msg_type = "";
2841
Joe Perches47e0c882015-06-25 15:02:57 -07002842 # Otherwise set the alternate message types
2843
2844 # a comment starts before $max_line_length
2845 } elsif ($line =~ /($;[\s$;]*)$/ &&
2846 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2847 $msg_type = "LONG_LINE_COMMENT"
2848
2849 # a quoted string starts before $max_line_length
2850 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2851 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2852 $msg_type = "LONG_LINE_STRING"
2853 }
2854
2855 if ($msg_type ne "" &&
2856 (show_type("LONG_LINE") || show_type($msg_type))) {
2857 WARN($msg_type,
2858 "line over $max_line_length characters\n" . $herecurr);
2859 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002860 }
2861
Andy Whitcroft8905a672007-11-28 16:21:06 -08002862# check for adding lines without a newline.
2863 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002864 WARN("MISSING_EOF_NEWLINE",
2865 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002866 }
2867
Mike Frysinger42e41c52009-09-21 17:04:40 -07002868# Blackfin: use hi/lo macros
2869 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2870 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2871 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002872 ERROR("LO_MACRO",
2873 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002874 }
2875 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2876 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002877 ERROR("HI_MACRO",
2878 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002879 }
2880 }
2881
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002882# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002883 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002884
2885# at the beginning of a line any tabs must come first and anything
2886# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002887 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2888 $rawline =~ /^\+\s* \s*/) {
2889 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002890 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002891 if (ERROR("CODE_INDENT",
2892 "code indent should use tabs where possible\n" . $herevet) &&
2893 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002894 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002895 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002896 }
2897
Alberto Panizzo08e44362010-03-05 13:43:54 -08002898# check for space before tabs.
2899 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2900 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002901 if (WARN("SPACE_BEFORE_TAB",
2902 "please, no space before tabs\n" . $herevet) &&
2903 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002904 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002905 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002906 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002907 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002908 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002909 }
2910
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002911# check for && or || at the start of a line
2912 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2913 CHK("LOGICAL_CONTINUATIONS",
2914 "Logical continuations should be on the previous line\n" . $hereprev);
2915 }
2916
Joe Perchesa91e8992016-05-20 17:04:05 -07002917# check indentation starts on a tab stop
2918 if ($^V && $^V ge 5.10.0 &&
2919 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2920 my $indent = length($1);
2921 if ($indent % 8) {
2922 if (WARN("TABSTOP",
2923 "Statements should start on a tabstop\n" . $herecurr) &&
2924 $fix) {
2925 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2926 }
2927 }
2928 }
2929
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002930# check multi-line statement indentation matches previous line
2931 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002932 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002933 $prevline =~ /^\+(\t*)(.*)$/;
2934 my $oldindent = $1;
2935 my $rest = $2;
2936
2937 my $pos = pos_last_openparen($rest);
2938 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002939 $line =~ /^(\+| )([ \t]*)/;
2940 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002941
2942 my $goodtabindent = $oldindent .
2943 "\t" x ($pos / 8) .
2944 " " x ($pos % 8);
2945 my $goodspaceindent = $oldindent . " " x $pos;
2946
2947 if ($newindent ne $goodtabindent &&
2948 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002949
2950 if (CHK("PARENTHESIS_ALIGNMENT",
2951 "Alignment should match open parenthesis\n" . $hereprev) &&
2952 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002953 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002954 s/^\+[ \t]*/\+$goodtabindent/;
2955 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002956 }
2957 }
2958 }
2959
Joe Perches6ab3a972015-04-16 12:44:05 -07002960# check for space after cast like "(int) foo" or "(struct foo) bar"
2961# avoid checking a few false positives:
2962# "sizeof(<type>)" or "__alignof__(<type>)"
2963# function pointer declarations like "(*foo)(int) = bar;"
2964# structure definitions like "(struct foo) { 0 };"
2965# multiline macros that define functions
2966# known attributes or the __attribute__ keyword
2967 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2968 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002969 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002970 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002971 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002972 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002973 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002974 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002975 }
2976
Joe Perches86406b12015-09-09 15:37:41 -07002977# Block comment styles
2978# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002979 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002980 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002981 $rawline =~ /^\+[ \t]*\*/ &&
2982 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002983 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2984 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2985 }
2986
Joe Perches86406b12015-09-09 15:37:41 -07002987# Block comments use * on subsequent lines
2988 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2989 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002990 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002991 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002992 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002993 WARN("BLOCK_COMMENT_STYLE",
2994 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002995 }
2996
Joe Perches86406b12015-09-09 15:37:41 -07002997# Block comments use */ on trailing lines
2998 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002999 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3000 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3001 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003002 WARN("BLOCK_COMMENT_STYLE",
3003 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003004 }
3005
Joe Perches08eb9b82016-10-11 13:51:50 -07003006# Block comment * alignment
3007 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003008 $line =~ /^\+[ \t]*$;/ && #leading comment
3009 $rawline =~ /^\+[ \t]*\*/ && #leading *
3010 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003011 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003012 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3013 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003014 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003015 if (defined($1)) {
3016 $oldindent = expand_tabs($1);
3017 } else {
3018 $prevrawline =~ m@^\+(.*/?)\*@;
3019 $oldindent = expand_tabs($1);
3020 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003021 $rawline =~ m@^\+([ \t]*)\*@;
3022 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003023 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003024 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003025 WARN("BLOCK_COMMENT_STYLE",
3026 "Block comments should align the * on each line\n" . $hereprev);
3027 }
3028 }
3029
Joe Perches7f619192014-08-06 16:10:39 -07003030# check for missing blank lines after struct/union declarations
3031# with exceptions for various attributes and macros
3032 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3033 $line =~ /^\+/ &&
3034 !($line =~ /^\+\s*$/ ||
3035 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3036 $line =~ /^\+\s*MODULE_/i ||
3037 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3038 $line =~ /^\+[a-z_]*init/ ||
3039 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3040 $line =~ /^\+\s*DECLARE/ ||
3041 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003042 if (CHK("LINE_SPACING",
3043 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3044 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003045 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003046 }
Joe Perches7f619192014-08-06 16:10:39 -07003047 }
3048
Joe Perches365dd4e2014-08-06 16:10:42 -07003049# check for multiple consecutive blank lines
3050 if ($prevline =~ /^[\+ ]\s*$/ &&
3051 $line =~ /^\+\s*$/ &&
3052 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003053 if (CHK("LINE_SPACING",
3054 "Please don't use multiple blank lines\n" . $hereprev) &&
3055 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003056 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003057 }
3058
Joe Perches365dd4e2014-08-06 16:10:42 -07003059 $last_blank_line = $linenr;
3060 }
3061
Joe Perches3b617e32014-04-03 14:49:28 -07003062# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003063 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3064 # actual declarations
3065 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003066 # function pointer declarations
3067 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003068 # foo bar; where foo is some local typedef or #define
3069 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3070 # known declaration macros
3071 $prevline =~ /^\+\s+$declaration_macros/) &&
3072 # for "else if" which can look like "$Ident $Ident"
3073 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3074 # other possible extensions of declaration lines
3075 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3076 # not starting a section or a macro "\" extended line
3077 $prevline =~ /(?:\{\s*|\\)$/) &&
3078 # looks like a declaration
3079 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003080 # function pointer declarations
3081 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003082 # foo bar; where foo is some local typedef or #define
3083 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3084 # known declaration macros
3085 $sline =~ /^\+\s+$declaration_macros/ ||
3086 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003087 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003088 # start or end of block or continuation of declaration
3089 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3090 # bitfield continuation
3091 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3092 # other possible extensions of declaration lines
3093 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3094 # indentation of previous and current line are the same
3095 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003096 if (WARN("LINE_SPACING",
3097 "Missing a blank line after declarations\n" . $hereprev) &&
3098 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003099 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003100 }
Joe Perches3b617e32014-04-03 14:49:28 -07003101 }
3102
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003103# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003104# Exceptions:
3105# 1) within comments
3106# 2) indented preprocessor commands
3107# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003108 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003109 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003110 if (WARN("LEADING_SPACE",
3111 "please, no spaces at the start of a line\n" . $herevet) &&
3112 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003113 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003114 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003115 }
3116
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003117# check we are in a valid C source file if not then ignore this hunk
3118 next if ($realfile !~ /\.(h|c)$/);
3119
Joe Perches032a4c02014-08-06 16:10:29 -07003120# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003121# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003122# if the previous line is a break or return and is indented 1 tab more...
3123 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3124 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003125 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3126 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3127 defined $lines[$linenr] &&
3128 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003129 WARN("UNNECESSARY_ELSE",
3130 "else is not generally useful after a break or return\n" . $hereprev);
3131 }
3132 }
3133
Joe Perchesc00df192014-08-06 16:11:01 -07003134# check indentation of a line with a break;
3135# if the previous line is a goto or return and is indented the same # of tabs
3136 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3137 my $tabs = $1;
3138 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3139 WARN("UNNECESSARY_BREAK",
3140 "break is not useful after a goto or return\n" . $hereprev);
3141 }
3142 }
3143
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003144# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3145 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3146 WARN("CONFIG_EXPERIMENTAL",
3147 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3148 }
3149
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003150# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003151 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003152 WARN("CVS_KEYWORD",
3153 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003154 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003155
Mike Frysinger42e41c52009-09-21 17:04:40 -07003156# Blackfin: don't use __builtin_bfin_[cs]sync
3157 if ($line =~ /__builtin_bfin_csync/) {
3158 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003159 ERROR("CSYNC",
3160 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003161 }
3162 if ($line =~ /__builtin_bfin_ssync/) {
3163 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003164 ERROR("SSYNC",
3165 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003166 }
3167
Joe Perches56e77d72013-02-21 16:44:14 -08003168# check for old HOTPLUG __dev<foo> section markings
3169 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3170 WARN("HOTPLUG_SECTION",
3171 "Using $1 is unnecessary\n" . $herecurr);
3172 }
3173
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003174# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003175 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3176 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003177#print "LINE<$line>\n";
3178 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003179 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003180 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003181 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003182 $stat =~ s/\n./\n /g;
3183 $cond =~ s/\n./\n /g;
3184
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003185#print "linenr<$linenr> <$stat>\n";
3186 # If this statement has no statement boundaries within
3187 # it there is no point in retrying a statement scan
3188 # until we hit end of it.
3189 my $frag = $stat; $frag =~ s/;+\s*$//;
3190 if ($frag !~ /(?:{|;)/) {
3191#print "skip<$line_nr_next>\n";
3192 $suppress_statement = $line_nr_next;
3193 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003194
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003195 # Find the real next line.
3196 $realline_next = $line_nr_next;
3197 if (defined $realline_next &&
3198 (!defined $lines[$realline_next - 1] ||
3199 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3200 $realline_next++;
3201 }
3202
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003203 my $s = $stat;
3204 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003205
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003206 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003207 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003208
3209 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003210 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003211
Andy Whitcroft463f2862009-09-21 17:04:34 -07003212 } elsif ($s =~ /^.\s*else\b/s) {
3213
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003214 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003215 } 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 -07003216 my $type = $1;
3217 $type =~ s/\s+/ /g;
3218 possible($type, "A:" . $s);
3219
Andy Whitcroft8905a672007-11-28 16:21:06 -08003220 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003221 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003222 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003223 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003224
3225 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003226 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003227 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003228 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003229
3230 # Check for any sort of function declaration.
3231 # int foo(something bar, other baz);
3232 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003233 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 -08003234 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003235
Andy Whitcroftcf655042008-03-04 14:28:20 -08003236 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003237 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003238 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003239
Andy Whitcroft8905a672007-11-28 16:21:06 -08003240 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003241 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003242
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003243 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003244 }
3245 }
3246 }
3247
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003248 }
3249
Andy Whitcroft653d4872007-06-23 17:16:34 -07003250#
3251# Checks which may be anchored in the context.
3252#
3253
3254# Check for switch () and associated case and default
3255# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003256 if ($line=~/\bswitch\s*\(.*\)/) {
3257 my $err = '';
3258 my $sep = '';
3259 my @ctx = ctx_block_outer($linenr, $realcnt);
3260 shift(@ctx);
3261 for my $ctx (@ctx) {
3262 my ($clen, $cindent) = line_stats($ctx);
3263 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3264 $indent != $cindent) {
3265 $err .= "$sep$ctx\n";
3266 $sep = '';
3267 } else {
3268 $sep = "[...]\n";
3269 }
3270 }
3271 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003272 ERROR("SWITCH_CASE_INDENT_LEVEL",
3273 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003274 }
3275 }
3276
3277# if/while/etc brace do not go on next line, unless defining a do while loop,
3278# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003279 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 -07003280 my $pre_ctx = "$1$2";
3281
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003282 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003283
3284 if ($line =~ /^\+\t{6,}/) {
3285 WARN("DEEP_INDENTATION",
3286 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3287 }
3288
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003289 my $ctx_cnt = $realcnt - $#ctx - 1;
3290 my $ctx = join("\n", @ctx);
3291
Andy Whitcroft548596d2008-07-23 21:29:01 -07003292 my $ctx_ln = $linenr;
3293 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003294
Andy Whitcroft548596d2008-07-23 21:29:01 -07003295 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3296 defined $lines[$ctx_ln - 1] &&
3297 $lines[$ctx_ln - 1] =~ /^-/)) {
3298 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3299 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003300 $ctx_ln++;
3301 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003302
Andy Whitcroft53210162008-07-23 21:29:03 -07003303 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3304 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003305
Joe Perchesd752fcc2014-08-06 16:11:05 -07003306 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003307 ERROR("OPEN_BRACE",
3308 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003309 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003310 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003311 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3312 $ctx =~ /\)\s*\;\s*$/ &&
3313 defined $lines[$ctx_ln - 1])
3314 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003315 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3316 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003317 WARN("TRAILING_SEMICOLON",
3318 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003319 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003320 }
3321 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003322 }
3323
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003324# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003325 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003326 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3327 ctx_statement_block($linenr, $realcnt, 0)
3328 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003329 my ($s, $c) = ($stat, $cond);
3330
3331 substr($s, 0, length($c), '');
3332
Joe Perches9f5af482015-09-09 15:37:30 -07003333 # remove inline comments
3334 $s =~ s/$;/ /g;
3335 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003336
3337 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003338 my @newlines = ($c =~ /\n/gs);
3339 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003340
Joe Perches9f5af482015-09-09 15:37:30 -07003341 # Make sure we remove the line prefixes as we have
3342 # none on the first line, and are going to readd them
3343 # where necessary.
3344 $s =~ s/\n./\n/gs;
3345 while ($s =~ /\n\s+\\\n/) {
3346 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3347 }
3348
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003349 # We want to check the first line inside the block
3350 # starting at the end of the conditional, so remove:
3351 # 1) any blank line termination
3352 # 2) any opening brace { on end of the line
3353 # 3) any do (...) {
3354 my $continuation = 0;
3355 my $check = 0;
3356 $s =~ s/^.*\bdo\b//;
3357 $s =~ s/^\s*{//;
3358 if ($s =~ s/^\s*\\//) {
3359 $continuation = 1;
3360 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003361 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003362 $check = 1;
3363 $cond_lines++;
3364 }
3365
3366 # Also ignore a loop construct at the end of a
3367 # preprocessor statement.
3368 if (($prevline =~ /^.\s*#\s*define\s/ ||
3369 $prevline =~ /\\\s*$/) && $continuation == 0) {
3370 $check = 0;
3371 }
3372
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003373 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003374 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003375 while ($cond_ptr != $cond_lines) {
3376 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003377
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003378 # If we see an #else/#elif then the code
3379 # is not linear.
3380 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3381 $check = 0;
3382 }
3383
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003384 # Ignore:
3385 # 1) blank lines, they should be at 0,
3386 # 2) preprocessor lines, and
3387 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003388 if ($continuation ||
3389 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003390 $s =~ /^\s*#\s*?/ ||
3391 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003392 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003393 if ($s =~ s/^.*?\n//) {
3394 $cond_lines++;
3395 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003396 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003397 }
3398
3399 my (undef, $sindent) = line_stats("+" . $s);
3400 my $stat_real = raw_line($linenr, $cond_lines);
3401
3402 # Check if either of these lines are modified, else
3403 # this is not this patch's fault.
3404 if (!defined($stat_real) ||
3405 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3406 $check = 0;
3407 }
3408 if (defined($stat_real) && $cond_lines > 1) {
3409 $stat_real = "[...]\n$stat_real";
3410 }
3411
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003412 #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 -07003413
Joe Perches9f5af482015-09-09 15:37:30 -07003414 if ($check && $s ne '' &&
3415 (($sindent % 8) != 0 ||
3416 ($sindent < $indent) ||
3417 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003418 WARN("SUSPECT_CODE_INDENT",
3419 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003420 }
3421 }
3422
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003423 # Track the 'values' across context and added lines.
3424 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003425 my ($curr_values, $curr_vars) =
3426 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003427 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003428 if ($dbg_values) {
3429 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003430 print "$linenr > .$outline\n";
3431 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003432 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003433 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003434 $prev_values = substr($curr_values, -1);
3435
Andy Whitcroft00df3442007-06-08 13:47:06 -07003436#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003437 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003438
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003439# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003440 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 -07003441 my $type = $1;
3442 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003443 $var = "" if (!defined $var);
3444 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003445 my $sign = $1;
3446 my $pointer = $2;
3447
3448 $pointer = "" if (!defined $pointer);
3449
3450 if (WARN("UNSPECIFIED_INT",
3451 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3452 $fix) {
3453 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003454 my $comp_pointer = $pointer;
3455 $comp_pointer =~ s/\s//g;
3456 $decl .= $comp_pointer;
3457 $decl = rtrim($decl) if ($var eq "");
3458 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003459 }
3460 }
3461 }
3462
Andy Whitcroft653d4872007-06-23 17:16:34 -07003463# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003464 if ($dbg_type) {
3465 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003466 ERROR("TEST_TYPE",
3467 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003468 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003469 ERROR("TEST_NOT_TYPE",
3470 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003471 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003472 next;
3473 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003474# TEST: allow direct testing of the attribute matcher.
3475 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003476 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003477 ERROR("TEST_ATTR",
3478 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003479 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003480 ERROR("TEST_NOT_ATTR",
3481 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003482 }
3483 next;
3484 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003485
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003486# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003487 if ($line =~ /^.\s*{/ &&
3488 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003489 if (ERROR("OPEN_BRACE",
3490 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003491 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3492 fix_delete_line($fixlinenr - 1, $prevrawline);
3493 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003494 my $fixedline = $prevrawline;
3495 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003496 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003497 $fixedline = $line;
3498 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003499 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003500 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003501 }
3502
Andy Whitcroft653d4872007-06-23 17:16:34 -07003503#
3504# Checks which are anchored on the added line.
3505#
3506
3507# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003508 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003509 my $path = $1;
3510 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003511 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003512 "malformed #include filename\n" . $herecurr);
3513 }
3514 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3515 ERROR("UAPI_INCLUDE",
3516 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003517 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003518 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003519
3520# no C99 // comments
3521 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003522 if (ERROR("C99_COMMENTS",
3523 "do not use C99 // comments\n" . $herecurr) &&
3524 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003525 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003526 if ($line =~ /\/\/(.*)$/) {
3527 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003528 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003529 }
3530 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003531 }
3532 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003533 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003534 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003535
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003536# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3537# the whole statement.
3538#print "APW <$lines[$realline_next - 1]>\n";
3539 if (defined $realline_next &&
3540 exists $lines[$realline_next - 1] &&
3541 !defined $suppress_export{$realline_next} &&
3542 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3543 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003544 # Handle definitions which produce identifiers with
3545 # a prefix:
3546 # XXX(foo);
3547 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003548 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003549 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003550 $name =~ /^${Ident}_$2/) {
3551#print "FOO C name<$name>\n";
3552 $suppress_export{$realline_next} = 1;
3553
3554 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003555 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003556 ^.DEFINE_$Ident\(\Q$name\E\)|
3557 ^.DECLARE_$Ident\(\Q$name\E\)|
3558 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003559 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3560 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003561 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003562#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3563 $suppress_export{$realline_next} = 2;
3564 } else {
3565 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003566 }
3567 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003568 if (!defined $suppress_export{$linenr} &&
3569 $prevline =~ /^.\s*$/ &&
3570 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3571 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3572#print "FOO B <$lines[$linenr - 1]>\n";
3573 $suppress_export{$linenr} = 2;
3574 }
3575 if (defined $suppress_export{$linenr} &&
3576 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003577 WARN("EXPORT_SYMBOL",
3578 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003579 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003580
Joe Eloff5150bda2010-08-09 17:21:00 -07003581# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003582 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003583 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003584 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003585 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003586 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003587 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003588 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003589# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003590 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003591 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003592 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003593 $herecurr) &&
3594 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003595 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003596 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003597 }
3598
Joe Perches18130872014-08-06 16:11:22 -07003599# check for misordered declarations of char/short/int/long with signed/unsigned
3600 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3601 my $tmp = trim($1);
3602 WARN("MISORDERED_TYPE",
3603 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3604 }
3605
Joe Perchescb710ec2010-10-26 14:23:20 -07003606# check for static const char * arrays.
3607 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003608 WARN("STATIC_CONST_CHAR_ARRAY",
3609 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003610 $herecurr);
3611 }
3612
3613# check for static char foo[] = "bar" declarations.
3614 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003615 WARN("STATIC_CONST_CHAR_ARRAY",
3616 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003617 $herecurr);
3618 }
3619
Joe Perchesab7e23f2015-04-16 12:44:22 -07003620# check for const <foo> const where <foo> is not a pointer or array type
3621 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3622 my $found = $1;
3623 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3624 WARN("CONST_CONST",
3625 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3626 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3627 WARN("CONST_CONST",
3628 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3629 }
3630 }
3631
Joe Perches9b0fa602014-04-03 14:49:18 -07003632# check for non-global char *foo[] = {"bar", ...} declarations.
3633 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3634 WARN("STATIC_CONST_CHAR_ARRAY",
3635 "char * array declaration might be better as static const\n" .
3636 $herecurr);
3637 }
3638
Joe Perchesb598b672015-04-16 12:44:36 -07003639# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3640 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3641 my $array = $1;
3642 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3643 my $array_div = $1;
3644 if (WARN("ARRAY_SIZE",
3645 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3646 $fix) {
3647 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3648 }
3649 }
3650 }
3651
Joe Perchesb36190c2014-01-27 17:07:18 -08003652# check for function declarations without arguments like "int foo()"
3653 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3654 if (ERROR("FUNCTION_WITHOUT_ARGS",
3655 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3656 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003657 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003658 }
3659 }
3660
Andy Whitcroft653d4872007-06-23 17:16:34 -07003661# check for new typedefs, only function parameters and sparse annotations
3662# make sense.
3663 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003664 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003665 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003666 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003667 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003668 WARN("NEW_TYPEDEFS",
3669 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003670 }
3671
3672# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003673 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003674 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3675 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003676 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003677
Andy Whitcroft65863862009-01-06 14:41:21 -08003678 # Should start with a space.
3679 $to =~ s/^(\S)/ $1/;
3680 # Should not end with a space.
3681 $to =~ s/\s+$//;
3682 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003683 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003684 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003685
Joe Perches3705ce52013-07-03 15:05:31 -07003686## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003687 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003688 if (ERROR("POINTER_LOCATION",
3689 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3690 $fix) {
3691 my $sub_from = $ident;
3692 my $sub_to = $ident;
3693 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003694 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003695 s@\Q$sub_from\E@$sub_to@;
3696 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003697 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003698 }
3699 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3700 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003701 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003702
Andy Whitcroft65863862009-01-06 14:41:21 -08003703 # Should start with a space.
3704 $to =~ s/^(\S)/ $1/;
3705 # Should not end with a space.
3706 $to =~ s/\s+$//;
3707 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003708 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003709 }
3710 # Modifiers should have spaces.
3711 $to =~ s/(\b$Modifier$)/$1 /;
3712
Joe Perches3705ce52013-07-03 15:05:31 -07003713## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003714 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003715 if (ERROR("POINTER_LOCATION",
3716 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3717 $fix) {
3718
3719 my $sub_from = $match;
3720 my $sub_to = $match;
3721 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003722 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003723 s@\Q$sub_from\E@$sub_to@;
3724 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003725 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003726 }
3727
Joe Perches9d3e3c72015-09-09 15:37:27 -07003728# avoid BUG() or BUG_ON()
3729 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3730 my $msg_type = \&WARN;
3731 $msg_type = \&CHK if ($file);
3732 &{$msg_type}("AVOID_BUG",
3733 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3734 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003735
Joe Perches9d3e3c72015-09-09 15:37:27 -07003736# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003737 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003738 WARN("LINUX_VERSION_CODE",
3739 "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 -08003740 }
3741
Joe Perches17441222011-06-15 15:08:17 -07003742# check for uses of printk_ratelimit
3743 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003744 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003745 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003746 }
3747
Andy Whitcroft00df3442007-06-08 13:47:06 -07003748# printk should use KERN_* levels. Note that follow on printk's on the
3749# same line do not need a level, so we use the current block context
3750# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003751# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003752# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003753 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003754 my $ok = 0;
3755 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3756 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003757 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003758 # with "\n" ignore it, else it is to blame
3759 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3760 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3761 $ok = 1;
3762 }
3763 last;
3764 }
3765 }
3766 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003767 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3768 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003769 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003770 }
3771
Joe Perches243f3802012-05-31 16:26:09 -07003772 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3773 my $orig = $1;
3774 my $level = lc($orig);
3775 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003776 my $level2 = $level;
3777 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003778 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003779 "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 -07003780 }
3781
3782 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003783 if (WARN("PREFER_PR_LEVEL",
3784 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3785 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003786 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003787 s/\bpr_warning\b/pr_warn/;
3788 }
Joe Perches243f3802012-05-31 16:26:09 -07003789 }
3790
Joe Perchesdc139312013-02-21 16:44:13 -08003791 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3792 my $orig = $1;
3793 my $level = lc($orig);
3794 $level = "warn" if ($level eq "warning");
3795 $level = "dbg" if ($level eq "debug");
3796 WARN("PREFER_DEV_LEVEL",
3797 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3798 }
3799
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003800# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3801# number of false positives, but assembly files are not checked, so at
3802# least the arch entry code will not trigger this warning.
3803 if ($line =~ /\bENOSYS\b/) {
3804 WARN("ENOSYS",
3805 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3806 }
3807
Andy Whitcroft653d4872007-06-23 17:16:34 -07003808# function brace can't be on same line, except for #defines of do while,
3809# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003810 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003811 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003812 if (ERROR("OPEN_BRACE",
3813 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3814 $fix) {
3815 fix_delete_line($fixlinenr, $rawline);
3816 my $fixed_line = $rawline;
3817 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3818 my $line1 = $1;
3819 my $line2 = $2;
3820 fix_insert_line($fixlinenr, ltrim($line1));
3821 fix_insert_line($fixlinenr, "\+{");
3822 if ($line2 !~ /^\s*$/) {
3823 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3824 }
3825 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003826 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003827
Andy Whitcroft8905a672007-11-28 16:21:06 -08003828# open braces for enum, union and struct go on the same line.
3829 if ($line =~ /^.\s*{/ &&
3830 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003831 if (ERROR("OPEN_BRACE",
3832 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3833 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3834 fix_delete_line($fixlinenr - 1, $prevrawline);
3835 fix_delete_line($fixlinenr, $rawline);
3836 my $fixedline = rtrim($prevrawline) . " {";
3837 fix_insert_line($fixlinenr, $fixedline);
3838 $fixedline = $rawline;
3839 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3840 if ($fixedline !~ /^\+\s*$/) {
3841 fix_insert_line($fixlinenr, $fixedline);
3842 }
3843 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003844 }
3845
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003846# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003847 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3848 if (WARN("SPACING",
3849 "missing space after $1 definition\n" . $herecurr) &&
3850 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003851 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003852 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3853 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003854 }
3855
Joe Perches31070b52014-01-23 15:54:49 -08003856# Function pointer declarations
3857# check spacing between type, funcptr, and args
3858# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003859 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003860 my $declare = $1;
3861 my $pre_pointer_space = $2;
3862 my $post_pointer_space = $3;
3863 my $funcname = $4;
3864 my $post_funcname_space = $5;
3865 my $pre_args_space = $6;
3866
Joe Perches91f72e92014-04-03 14:49:12 -07003867# the $Declare variable will capture all spaces after the type
3868# so check it for a missing trailing missing space but pointer return types
3869# don't need a space so don't warn for those.
3870 my $post_declare_space = "";
3871 if ($declare =~ /(\s+)$/) {
3872 $post_declare_space = $1;
3873 $declare = rtrim($declare);
3874 }
3875 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003876 WARN("SPACING",
3877 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003878 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003879 }
3880
3881# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003882# This test is not currently implemented because these declarations are
3883# equivalent to
3884# int foo(int bar, ...)
3885# and this is form shouldn't/doesn't generate a checkpatch warning.
3886#
3887# elsif ($declare =~ /\s{2,}$/) {
3888# WARN("SPACING",
3889# "Multiple spaces after return type\n" . $herecurr);
3890# }
Joe Perches31070b52014-01-23 15:54:49 -08003891
3892# unnecessary space "type ( *funcptr)(args...)"
3893 if (defined $pre_pointer_space &&
3894 $pre_pointer_space =~ /^\s/) {
3895 WARN("SPACING",
3896 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3897 }
3898
3899# unnecessary space "type (* funcptr)(args...)"
3900 if (defined $post_pointer_space &&
3901 $post_pointer_space =~ /^\s/) {
3902 WARN("SPACING",
3903 "Unnecessary space before function pointer name\n" . $herecurr);
3904 }
3905
3906# unnecessary space "type (*funcptr )(args...)"
3907 if (defined $post_funcname_space &&
3908 $post_funcname_space =~ /^\s/) {
3909 WARN("SPACING",
3910 "Unnecessary space after function pointer name\n" . $herecurr);
3911 }
3912
3913# unnecessary space "type (*funcptr) (args...)"
3914 if (defined $pre_args_space &&
3915 $pre_args_space =~ /^\s/) {
3916 WARN("SPACING",
3917 "Unnecessary space before function pointer arguments\n" . $herecurr);
3918 }
3919
3920 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003921 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003922 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003923 }
3924 }
3925
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003926# check for spacing round square brackets; allowed:
3927# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003928# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3929# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003930 while ($line =~ /(.*?\s)\[/g) {
3931 my ($where, $prefix) = ($-[1], $1);
3932 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003933 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003934 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003935 if (ERROR("BRACKET_SPACE",
3936 "space prohibited before open square bracket '['\n" . $herecurr) &&
3937 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003938 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003939 s/^(\+.*?)\s+\[/$1\[/;
3940 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003941 }
3942 }
3943
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003944# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003945 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003946 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003947 my $ctx_before = substr($line, 0, $-[1]);
3948 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003949
3950 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003951 if ($name =~ /^(?:
3952 if|for|while|switch|return|case|
3953 volatile|__volatile__|
3954 __attribute__|format|__extension__|
3955 asm|__asm__)$/x)
3956 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003957 # cpp #define statements have non-optional spaces, ie
3958 # if there is a space between the name and the open
3959 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003960 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003961
3962 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003963 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003964
3965 # If this whole things ends with a type its most
3966 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003967 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003968
3969 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003970 if (WARN("SPACING",
3971 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3972 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003973 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003974 s/\b$name\s+\(/$name\(/;
3975 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003976 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003977 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003978
Andy Whitcroft653d4872007-06-23 17:16:34 -07003979# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003980 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003981 my $fixed_line = "";
3982 my $line_fixed = 0;
3983
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003984 my $ops = qr{
3985 <<=|>>=|<=|>=|==|!=|
3986 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3987 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003988 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003989 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003990 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003991 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003992
3993## print("element count: <" . $#elements . ">\n");
3994## foreach my $el (@elements) {
3995## print("el: <$el>\n");
3996## }
3997
3998 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003999 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004000
Joe Perches3705ce52013-07-03 15:05:31 -07004001 foreach my $el (@elements) {
4002 push(@fix_elements, substr($rawline, $off, length($el)));
4003 $off += length($el);
4004 }
4005
4006 $off = 0;
4007
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004008 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004009 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004010
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004011 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004012
4013 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4014
4015## print("n: <$n> good: <$good>\n");
4016
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004017 $off += length($elements[$n]);
4018
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004019 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004020 my $ca = substr($opline, 0, $off);
4021 my $cc = '';
4022 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4023 $cc = substr($opline, $off + length($elements[$n + 1]));
4024 }
4025 my $cb = "$ca$;$cc";
4026
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004027 my $a = '';
4028 $a = 'V' if ($elements[$n] ne '');
4029 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004030 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004031 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4032 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004033 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004034
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004035 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004036
4037 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004038 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004039 $c = 'V' if ($elements[$n + 2] ne '');
4040 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004041 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004042 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4043 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004044 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004045 } else {
4046 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004047 }
4048
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004049 my $ctx = "${a}x${c}";
4050
4051 my $at = "(ctx:$ctx)";
4052
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004053 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004054 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004055
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004056 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004057 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004058
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004059 # Get the full operator variant.
4060 my $opv = $op . substr($curr_vars, $off, 1);
4061
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004062 # Ignore operators passed as parameters.
4063 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004064 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004065
Andy Whitcroftcf655042008-03-04 14:28:20 -08004066# # Ignore comments
4067# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004068
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004069 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004070 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004071 if ($ctx !~ /.x[WEBC]/ &&
4072 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004073 if (ERROR("SPACING",
4074 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004075 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004076 $line_fixed = 1;
4077 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004078 }
4079
4080 # // is a comment
4081 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004082
Joe Perchesb00e4812014-04-03 14:49:33 -07004083 # : when part of a bitfield
4084 } elsif ($opv eq ':B') {
4085 # skip the bitfield test for now
4086
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004087 # No spaces for:
4088 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004089 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004090 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004091 if (ERROR("SPACING",
4092 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004093 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004094 if (defined $fix_elements[$n + 2]) {
4095 $fix_elements[$n + 2] =~ s/^\s+//;
4096 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004097 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004098 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004099 }
4100
Joe Perches23810972014-12-10 15:51:32 -08004101 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004102 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004103 my $rtrim_before = 0;
4104 my $space_after = 0;
4105 if ($ctx =~ /Wx./) {
4106 if (ERROR("SPACING",
4107 "space prohibited before that '$op' $at\n" . $hereptr)) {
4108 $line_fixed = 1;
4109 $rtrim_before = 1;
4110 }
4111 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004112 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004113 if (ERROR("SPACING",
4114 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004115 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004116 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004117 $space_after = 1;
4118 }
4119 }
4120 if ($rtrim_before || $space_after) {
4121 if ($rtrim_before) {
4122 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4123 } else {
4124 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4125 }
4126 if ($space_after) {
4127 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004128 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004129 }
4130
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004131 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004132 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004133 #warn "'*' is part of type\n";
4134
4135 # unary operators should have a space before and
4136 # none after. May be left adjacent to another
4137 # unary operator, or a cast
4138 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004139 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004140 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004141 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004142 if (ERROR("SPACING",
4143 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004144 if ($n != $last_after + 2) {
4145 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4146 $line_fixed = 1;
4147 }
Joe Perches3705ce52013-07-03 15:05:31 -07004148 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004149 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004150 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004151 # A unary '*' may be const
4152
4153 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004154 if (ERROR("SPACING",
4155 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004156 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004157 if (defined $fix_elements[$n + 2]) {
4158 $fix_elements[$n + 2] =~ s/^\s+//;
4159 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004160 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004161 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004162 }
4163
4164 # unary ++ and unary -- are allowed no space on one side.
4165 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004166 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004167 if (ERROR("SPACING",
4168 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004169 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004170 $line_fixed = 1;
4171 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004172 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004173 if ($ctx =~ /Wx[BE]/ ||
4174 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004175 if (ERROR("SPACING",
4176 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004177 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004178 $line_fixed = 1;
4179 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004180 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004181 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004182 if (ERROR("SPACING",
4183 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004184 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004185 if (defined $fix_elements[$n + 2]) {
4186 $fix_elements[$n + 2] =~ s/^\s+//;
4187 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004188 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004189 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004190 }
4191
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004192 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004193 } elsif ($op eq '<<' or $op eq '>>' or
4194 $op eq '&' or $op eq '^' or $op eq '|' or
4195 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004196 $op eq '*' or $op eq '/' or
4197 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004198 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004199 if ($check) {
4200 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4201 if (CHK("SPACING",
4202 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4203 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4204 $fix_elements[$n + 2] =~ s/^\s+//;
4205 $line_fixed = 1;
4206 }
4207 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4208 if (CHK("SPACING",
4209 "space preferred before that '$op' $at\n" . $hereptr)) {
4210 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4211 $line_fixed = 1;
4212 }
4213 }
4214 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004215 if (ERROR("SPACING",
4216 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004217 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4218 if (defined $fix_elements[$n + 2]) {
4219 $fix_elements[$n + 2] =~ s/^\s+//;
4220 }
Joe Perches3705ce52013-07-03 15:05:31 -07004221 $line_fixed = 1;
4222 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004223 }
4224
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004225 # A colon needs no spaces before when it is
4226 # terminating a case value or a label.
4227 } elsif ($opv eq ':C' || $opv eq ':L') {
4228 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004229 if (ERROR("SPACING",
4230 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004231 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004232 $line_fixed = 1;
4233 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004234 }
4235
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004236 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004237 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004238 my $ok = 0;
4239
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004240 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004241 if (($op eq '<' &&
4242 $cc =~ /^\S+\@\S+>/) ||
4243 ($op eq '>' &&
4244 $ca =~ /<\S+\@\S+$/))
4245 {
4246 $ok = 1;
4247 }
4248
Joe Perchese0df7e12015-04-16 12:44:53 -07004249 # for asm volatile statements
4250 # ignore a colon with another
4251 # colon immediately before or after
4252 if (($op eq ':') &&
4253 ($ca =~ /:$/ || $cc =~ /^:/)) {
4254 $ok = 1;
4255 }
4256
Joe Perches84731622013-11-12 15:10:05 -08004257 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004258 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004259 my $msg_type = \&ERROR;
4260 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4261
4262 if (&{$msg_type}("SPACING",
4263 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004264 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4265 if (defined $fix_elements[$n + 2]) {
4266 $fix_elements[$n + 2] =~ s/^\s+//;
4267 }
Joe Perches3705ce52013-07-03 15:05:31 -07004268 $line_fixed = 1;
4269 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004270 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004271 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004272 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004273
4274## print("n: <$n> GOOD: <$good>\n");
4275
4276 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004277 }
Joe Perches3705ce52013-07-03 15:05:31 -07004278
4279 if (($#elements % 2) == 0) {
4280 $fixed_line = $fixed_line . $fix_elements[$#elements];
4281 }
4282
Joe Perches194f66f2014-08-06 16:11:03 -07004283 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4284 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004285 }
4286
4287
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004288 }
4289
Joe Perches786b6322013-07-03 15:05:32 -07004290# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004291 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004292 if (WARN("SPACING",
4293 "space prohibited before semicolon\n" . $herecurr) &&
4294 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004295 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004296 s/^(\+.*\S)\s+;/$1;/;
4297 }
4298 }
4299
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004300# check for multiple assignments
4301 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004302 CHK("MULTIPLE_ASSIGNMENTS",
4303 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004304 }
4305
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004306## # check for multiple declarations, allowing for a function declaration
4307## # continuation.
4308## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4309## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4310##
4311## # Remove any bracketed sections to ensure we do not
4312## # falsly report the parameters of functions.
4313## my $ln = $line;
4314## while ($ln =~ s/\([^\(\)]*\)//g) {
4315## }
4316## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004317## WARN("MULTIPLE_DECLARATION",
4318## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004319## }
4320## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004321
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004322#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004323 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004324 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004325 if (ERROR("SPACING",
4326 "space required before the open brace '{'\n" . $herecurr) &&
4327 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004328 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004329 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004330 }
4331
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004332## # check for blank lines before declarations
4333## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4334## $prevrawline =~ /^.\s*$/) {
4335## WARN("SPACING",
4336## "No blank lines before declarations\n" . $hereprev);
4337## }
4338##
4339
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004340# closing brace should have a space following it when it has anything
4341# on the line
4342 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004343 if (ERROR("SPACING",
4344 "space required after that close brace '}'\n" . $herecurr) &&
4345 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004346 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004347 s/}((?!(?:,|;|\)))\S)/} $1/;
4348 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004349 }
4350
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004351# check spacing on square brackets
4352 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004353 if (ERROR("SPACING",
4354 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4355 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004356 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004357 s/\[\s+/\[/;
4358 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004359 }
4360 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004361 if (ERROR("SPACING",
4362 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4363 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004364 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004365 s/\s+\]/\]/;
4366 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004367 }
4368
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004369# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004370 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4371 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004372 if (ERROR("SPACING",
4373 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4374 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004375 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004376 s/\(\s+/\(/;
4377 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004378 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004379 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004380 $line !~ /for\s*\(.*;\s+\)/ &&
4381 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004382 if (ERROR("SPACING",
4383 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4384 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004385 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004386 s/\s+\)/\)/;
4387 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004388 }
4389
Joe Perchese2826fd2014-08-06 16:10:48 -07004390# check unnecessary parentheses around addressof/dereference single $Lvals
4391# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4392
4393 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004394 my $var = $1;
4395 if (CHK("UNNECESSARY_PARENTHESES",
4396 "Unnecessary parentheses around $var\n" . $herecurr) &&
4397 $fix) {
4398 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4399 }
4400 }
4401
4402# check for unnecessary parentheses around function pointer uses
4403# ie: (foo->bar)(); should be foo->bar();
4404# but not "if (foo->bar) (" to avoid some false positives
4405 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4406 my $var = $2;
4407 if (CHK("UNNECESSARY_PARENTHESES",
4408 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4409 $fix) {
4410 my $var2 = deparenthesize($var);
4411 $var2 =~ s/\s//g;
4412 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4413 }
4414 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004415
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004416#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004417 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004418 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004419 if (WARN("INDENTED_LABEL",
4420 "labels should not be indented\n" . $herecurr) &&
4421 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004422 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004423 s/^(.)\s+/$1/;
4424 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004425 }
4426
Joe Perches5b9553a2014-04-03 14:49:21 -07004427# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004428 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004429 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004430 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004431 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4432 my $value = $1;
4433 $value = deparenthesize($value);
4434 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4435 ERROR("RETURN_PARENTHESES",
4436 "return is not a function, parentheses are not required\n" . $herecurr);
4437 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004438 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004439 ERROR("SPACING",
4440 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004441 }
4442 }
Joe Perches507e5142013-11-12 15:10:13 -08004443
Joe Perchesb43ae212014-06-23 13:22:07 -07004444# unnecessary return in a void function
4445# at end-of-function, with the previous line a single leading tab, then return;
4446# and the line before that not a goto label target like "out:"
4447 if ($sline =~ /^[ \+]}\s*$/ &&
4448 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4449 $linenr >= 3 &&
4450 $lines[$linenr - 3] =~ /^[ +]/ &&
4451 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004452 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004453 "void function return statements are not generally useful\n" . $hereprev);
4454 }
Joe Perches9819cf22014-06-04 16:12:09 -07004455
Joe Perches189248d2014-01-23 15:54:47 -08004456# if statements using unnecessary parentheses - ie: if ((foo == bar))
4457 if ($^V && $^V ge 5.10.0 &&
4458 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4459 my $openparens = $1;
4460 my $count = $openparens =~ tr@\(@\(@;
4461 my $msg = "";
4462 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4463 my $comp = $4; #Not $1 because of $LvalOrFunc
4464 $msg = " - maybe == should be = ?" if ($comp eq "==");
4465 WARN("UNNECESSARY_PARENTHESES",
4466 "Unnecessary parentheses$msg\n" . $herecurr);
4467 }
4468 }
4469
Joe Perchesc5595fa2015-09-09 15:37:58 -07004470# comparisons with a constant or upper case identifier on the left
4471# avoid cases like "foo + BAR < baz"
4472# only fix matches surrounded by parentheses to avoid incorrect
4473# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4474 if ($^V && $^V ge 5.10.0 &&
4475 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4476 my $lead = $1;
4477 my $const = $2;
4478 my $comp = $3;
4479 my $to = $4;
4480 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004481 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004482 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4483 WARN("CONSTANT_COMPARISON",
4484 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4485 $fix) {
4486 if ($comp eq "<") {
4487 $newcomp = ">";
4488 } elsif ($comp eq "<=") {
4489 $newcomp = ">=";
4490 } elsif ($comp eq ">") {
4491 $newcomp = "<";
4492 } elsif ($comp eq ">=") {
4493 $newcomp = "<=";
4494 }
4495 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4496 }
4497 }
4498
Joe Perchesf34e4a42015-04-16 12:44:19 -07004499# Return of what appears to be an errno should normally be negative
4500 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004501 my $name = $1;
4502 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004503 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004504 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004505 }
4506 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004507
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004508# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004509 if ($line =~ /\b(if|while|for|switch)\(/) {
4510 if (ERROR("SPACING",
4511 "space required before the open parenthesis '('\n" . $herecurr) &&
4512 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004513 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004514 s/\b(if|while|for|switch)\(/$1 \(/;
4515 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004516 }
4517
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004518# Check for illegal assignment in if conditional -- and check for trailing
4519# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004520 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004521 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4522 ctx_statement_block($linenr, $realcnt, 0)
4523 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004524 my ($stat_next) = ctx_statement_block($line_nr_next,
4525 $remain_next, $off_next);
4526 $stat_next =~ s/\n./\n /g;
4527 ##print "stat<$stat> stat_next<$stat_next>\n";
4528
4529 if ($stat_next =~ /^\s*while\b/) {
4530 # If the statement carries leading newlines,
4531 # then count those as offsets.
4532 my ($whitespace) =
4533 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4534 my $offset =
4535 statement_rawlines($whitespace) - 1;
4536
4537 $suppress_whiletrailers{$line_nr_next +
4538 $offset} = 1;
4539 }
4540 }
4541 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004542 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004543 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004544 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004545
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004546 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004547 ERROR("ASSIGN_IN_IF",
4548 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004549 }
4550
4551 # Find out what is on the end of the line after the
4552 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004553 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004554 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004555 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004556 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4557 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004558 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004559 # Find out how long the conditional actually is.
4560 my @newlines = ($c =~ /\n/gs);
4561 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004562 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004563
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004564 $stat_real = raw_line($linenr, $cond_lines)
4565 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004566 if (defined($stat_real) && $cond_lines > 1) {
4567 $stat_real = "[...]\n$stat_real";
4568 }
4569
Joe Perches000d1cc12011-07-25 17:13:25 -07004570 ERROR("TRAILING_STATEMENTS",
4571 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004572 }
4573 }
4574
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004575# Check for bitwise tests written as boolean
4576 if ($line =~ /
4577 (?:
4578 (?:\[|\(|\&\&|\|\|)
4579 \s*0[xX][0-9]+\s*
4580 (?:\&\&|\|\|)
4581 |
4582 (?:\&\&|\|\|)
4583 \s*0[xX][0-9]+\s*
4584 (?:\&\&|\|\||\)|\])
4585 )/x)
4586 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004587 WARN("HEXADECIMAL_BOOLEAN_TEST",
4588 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004589 }
4590
Andy Whitcroft8905a672007-11-28 16:21:06 -08004591# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004592 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4593 my $s = $1;
4594 $s =~ s/$;//g; # Remove any comments
4595 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004596 ERROR("TRAILING_STATEMENTS",
4597 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004598 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004599 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004600# if should not continue a brace
4601 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004602 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004603 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004604 $herecurr);
4605 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004606# case and default should not have general statements after them
4607 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4608 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004609 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004610 \s*return\s+
4611 )/xg)
4612 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004613 ERROR("TRAILING_STATEMENTS",
4614 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004615 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004616
4617 # Check for }<nl>else {, these must be at the same
4618 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004619 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4620 $previndent == $indent) {
4621 if (ERROR("ELSE_AFTER_BRACE",
4622 "else should follow close brace '}'\n" . $hereprev) &&
4623 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4624 fix_delete_line($fixlinenr - 1, $prevrawline);
4625 fix_delete_line($fixlinenr, $rawline);
4626 my $fixedline = $prevrawline;
4627 $fixedline =~ s/}\s*$//;
4628 if ($fixedline !~ /^\+\s*$/) {
4629 fix_insert_line($fixlinenr, $fixedline);
4630 }
4631 $fixedline = $rawline;
4632 $fixedline =~ s/^(.\s*)else/$1} else/;
4633 fix_insert_line($fixlinenr, $fixedline);
4634 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004635 }
4636
Joe Perches8b8856f2014-08-06 16:11:14 -07004637 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4638 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004639 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4640
4641 # Find out what is on the end of the line after the
4642 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004643 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004644 $s =~ s/\n.*//g;
4645
4646 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004647 if (ERROR("WHILE_AFTER_BRACE",
4648 "while should follow close brace '}'\n" . $hereprev) &&
4649 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4650 fix_delete_line($fixlinenr - 1, $prevrawline);
4651 fix_delete_line($fixlinenr, $rawline);
4652 my $fixedline = $prevrawline;
4653 my $trailing = $rawline;
4654 $trailing =~ s/^\+//;
4655 $trailing = trim($trailing);
4656 $fixedline =~ s/}\s*$/} $trailing/;
4657 fix_insert_line($fixlinenr, $fixedline);
4658 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004659 }
4660 }
4661
Joe Perches95e2c602013-07-03 15:05:20 -07004662#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004663 while ($line =~ m{($Constant|$Lval)}g) {
4664 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004665
4666#gcc binary extension
4667 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004668 if (WARN("GCC_BINARY_CONSTANT",
4669 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4670 $fix) {
4671 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004672 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004673 s/\b$var\b/$hexval/;
4674 }
Joe Perches95e2c602013-07-03 15:05:20 -07004675 }
4676
4677#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004678 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004679 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004680#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004681 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004682#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004683 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4684#Ignore some three character SI units explicitly, like MiB and KHz
4685 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004686 while ($var =~ m{($Ident)}g) {
4687 my $word = $1;
4688 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004689 if ($check) {
4690 seed_camelcase_includes();
4691 if (!$file && !$camelcase_file_seeded) {
4692 seed_camelcase_file($realfile);
4693 $camelcase_file_seeded = 1;
4694 }
4695 }
Joe Perches7e781f62013-09-11 14:23:55 -07004696 if (!defined $camelcase{$word}) {
4697 $camelcase{$word} = 1;
4698 CHK("CAMELCASE",
4699 "Avoid CamelCase: <$word>\n" . $herecurr);
4700 }
Joe Perches34456862013-07-03 15:05:34 -07004701 }
Joe Perches323c1262012-12-17 16:02:07 -08004702 }
4703 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004704
4705#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004706 if ($line =~ /\#\s*define.*\\\s+$/) {
4707 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4708 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4709 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004710 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004711 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004712 }
4713
Fabian Frederick0e212e02015-04-16 12:44:25 -07004714# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4715# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004716 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004717 my $file = "$1.h";
4718 my $checkfile = "include/linux/$file";
4719 if (-f "$root/$checkfile" &&
4720 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004721 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004722 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004723 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4724 if ($asminclude > 0) {
4725 if ($realfile =~ m{^arch/}) {
4726 CHK("ARCH_INCLUDE_LINUX",
4727 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4728 } else {
4729 WARN("INCLUDE_LINUX",
4730 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4731 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004732 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004733 }
4734 }
4735
Andy Whitcroft653d4872007-06-23 17:16:34 -07004736# multi-statement macros should be enclosed in a do while loop, grab the
4737# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004738# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004739 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4740 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004741 my $ln = $linenr;
4742 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004743 my ($off, $dstat, $dcond, $rest);
4744 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004745 my $has_flow_statement = 0;
4746 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004747 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004748 ctx_statement_block($linenr, $realcnt, 0);
4749 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004750 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004751 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004752
Joe Perches08a28432014-10-13 15:51:55 -07004753 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004754 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004755
Joe Perchesf59b64b2016-10-11 13:52:08 -07004756 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4757 my $define_args = $1;
4758 my $define_stmt = $dstat;
4759 my @def_args = ();
4760
4761 if (defined $define_args && $define_args ne "") {
4762 $define_args = substr($define_args, 1, length($define_args) - 2);
4763 $define_args =~ s/\s*//g;
4764 @def_args = split(",", $define_args);
4765 }
4766
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004767 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004768 $dstat =~ s/\\\n.//g;
4769 $dstat =~ s/^\s*//s;
4770 $dstat =~ s/\s*$//s;
4771
4772 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004773 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4774 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004775 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004776 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004777 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004778
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004779 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004780 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4781 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004782 {
4783 }
4784
Joe Perches42e15292016-03-15 14:58:01 -07004785 # Make asm volatile uses seem like a generic function
4786 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4787
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004788 my $exceptions = qr{
4789 $Declare|
4790 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004791 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004792 DECLARE_PER_CPU|
4793 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004794 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004795 union|
4796 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004797 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004798 ^\"|\"$|
4799 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004800 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004801 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004802
4803 $ctx =~ s/\n*$//;
4804 my $herectx = $here . "\n";
4805 my $stmt_cnt = statement_rawlines($ctx);
4806
4807 for (my $n = 0; $n < $stmt_cnt; $n++) {
4808 $herectx .= raw_line($linenr, $n) . "\n";
4809 }
4810
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004811 if ($dstat ne '' &&
4812 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4813 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004814 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004815 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004816 $dstat !~ /$exceptions/ &&
4817 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004818 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004819 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004820 $dstat !~ /^for\s*$Constant$/ && # for (...)
4821 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4822 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004823 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004824 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004825 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004826
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004827 if ($dstat =~ /;/) {
4828 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4829 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4830 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004831 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004832 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004833 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004834
4835 }
Joe Perches52076492016-10-11 13:52:14 -07004836
4837 # Make $define_stmt single line, comment-free, etc
4838 my @stmt_array = split('\n', $define_stmt);
4839 my $first = 1;
4840 $define_stmt = "";
4841 foreach my $l (@stmt_array) {
4842 $l =~ s/\\$//;
4843 if ($first) {
4844 $define_stmt = $l;
4845 $first = 0;
4846 } elsif ($l =~ /^[\+ ]/) {
4847 $define_stmt .= substr($l, 1);
4848 }
4849 }
4850 $define_stmt =~ s/$;//g;
4851 $define_stmt =~ s/\s+/ /g;
4852 $define_stmt = trim($define_stmt);
4853
Joe Perchesf59b64b2016-10-11 13:52:08 -07004854# check if any macro arguments are reused (ignore '...' and 'type')
4855 foreach my $arg (@def_args) {
4856 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07004857 next if ($arg =~ /^type$/i);
Joe Perchesf59b64b2016-10-11 13:52:08 -07004858 my $tmp = $define_stmt;
4859 $tmp =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
Joe Perches52076492016-10-11 13:52:14 -07004860 $tmp =~ s/\#+\s*$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004861 $tmp =~ s/\b$arg\s*\#\#//g;
4862 my $use_cnt = $tmp =~ s/\b$arg\b//g;
4863 if ($use_cnt > 1) {
4864 CHK("MACRO_ARG_REUSE",
4865 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07004866 }
4867# check if any macro arguments may have other precedence issues
4868 if ($define_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
4869 ((defined($1) && $1 ne ',') ||
4870 (defined($2) && $2 ne ','))) {
4871 CHK("MACRO_ARG_PRECEDENCE",
4872 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07004873 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004874 }
Joe Perches5023d342012-12-17 16:01:47 -08004875
Joe Perches08a28432014-10-13 15:51:55 -07004876# check for macros with flow control, but without ## concatenation
4877# ## concatenation is commonly a macro that defines a function so ignore those
4878 if ($has_flow_statement && !$has_arg_concat) {
4879 my $herectx = $here . "\n";
4880 my $cnt = statement_rawlines($ctx);
4881
4882 for (my $n = 0; $n < $cnt; $n++) {
4883 $herectx .= raw_line($linenr, $n) . "\n";
4884 }
4885 WARN("MACRO_WITH_FLOW_CONTROL",
4886 "Macros with flow control statements should be avoided\n" . "$herectx");
4887 }
4888
Joe Perches481eb482012-12-17 16:01:56 -08004889# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004890
4891 } else {
4892 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004893 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4894 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004895 $line =~ /^\+.*\\$/) {
4896 WARN("LINE_CONTINUATIONS",
4897 "Avoid unnecessary line continuations\n" . $herecurr);
4898 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004899 }
4900
Joe Perchesb13edf72012-07-30 14:41:24 -07004901# do {} while (0) macro tests:
4902# single-statement macros do not need to be enclosed in do while (0) loop,
4903# macro should not end with a semicolon
4904 if ($^V && $^V ge 5.10.0 &&
4905 $realfile !~ m@/vmlinux.lds.h$@ &&
4906 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4907 my $ln = $linenr;
4908 my $cnt = $realcnt;
4909 my ($off, $dstat, $dcond, $rest);
4910 my $ctx = '';
4911 ($dstat, $dcond, $ln, $cnt, $off) =
4912 ctx_statement_block($linenr, $realcnt, 0);
4913 $ctx = $dstat;
4914
4915 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004916 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004917
4918 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4919 my $stmts = $2;
4920 my $semis = $3;
4921
4922 $ctx =~ s/\n*$//;
4923 my $cnt = statement_rawlines($ctx);
4924 my $herectx = $here . "\n";
4925
4926 for (my $n = 0; $n < $cnt; $n++) {
4927 $herectx .= raw_line($linenr, $n) . "\n";
4928 }
4929
Joe Perchesac8e97f2012-08-21 16:15:53 -07004930 if (($stmts =~ tr/;/;/) == 1 &&
4931 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004932 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4933 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4934 }
4935 if (defined $semis && $semis ne "") {
4936 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4937 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4938 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004939 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4940 $ctx =~ s/\n*$//;
4941 my $cnt = statement_rawlines($ctx);
4942 my $herectx = $here . "\n";
4943
4944 for (my $n = 0; $n < $cnt; $n++) {
4945 $herectx .= raw_line($linenr, $n) . "\n";
4946 }
4947
4948 WARN("TRAILING_SEMICOLON",
4949 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004950 }
4951 }
4952
Mike Frysinger080ba922009-01-06 14:41:25 -08004953# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4954# all assignments may have only one of the following with an assignment:
4955# .
4956# ALIGN(...)
4957# VMLINUX_SYMBOL(...)
4958 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004959 WARN("MISSING_VMLINUX_SYMBOL",
4960 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004961 }
4962
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004963# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004964 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4965 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004966 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004967 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004968 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4969 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004970 my @allowed = ();
4971 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004972 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004973 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004974 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004975 for my $chunk (@chunks) {
4976 my ($cond, $block) = @{$chunk};
4977
Andy Whitcroft773647a2008-03-28 14:15:58 -07004978 # If the condition carries leading newlines, then count those as offsets.
4979 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4980 my $offset = statement_rawlines($whitespace) - 1;
4981
Joe Perchesaad4f612012-03-23 15:02:19 -07004982 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004983 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4984
4985 # We have looked at and allowed this specific line.
4986 $suppress_ifbraces{$ln + $offset} = 1;
4987
4988 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004989 $ln += statement_rawlines($block) - 1;
4990
Andy Whitcroft773647a2008-03-28 14:15:58 -07004991 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004992
4993 $seen++ if ($block =~ /^\s*{/);
4994
Joe Perchesaad4f612012-03-23 15:02:19 -07004995 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004996 if (statement_lines($cond) > 1) {
4997 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004998 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004999 }
5000 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005001 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005002 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005003 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005004 if (statement_block_size($block) > 1) {
5005 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005006 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005007 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005008 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005009 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005010 if ($seen) {
5011 my $sum_allowed = 0;
5012 foreach (@allowed) {
5013 $sum_allowed += $_;
5014 }
5015 if ($sum_allowed == 0) {
5016 WARN("BRACES",
5017 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5018 } elsif ($sum_allowed != $allow &&
5019 $seen != $allow) {
5020 CHK("BRACES",
5021 "braces {} should be used on all arms of this statement\n" . $herectx);
5022 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005023 }
5024 }
5025 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005026 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005027 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005028 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005029
Andy Whitcroftcf655042008-03-04 14:28:20 -08005030 # Check the pre-context.
5031 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5032 #print "APW: ALLOWED: pre<$1>\n";
5033 $allowed = 1;
5034 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005035
5036 my ($level, $endln, @chunks) =
5037 ctx_statement_full($linenr, $realcnt, $-[0]);
5038
Andy Whitcroftcf655042008-03-04 14:28:20 -08005039 # Check the condition.
5040 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005041 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005042 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005043 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005044 }
5045 if (statement_lines($cond) > 1) {
5046 #print "APW: ALLOWED: cond<$cond>\n";
5047 $allowed = 1;
5048 }
5049 if ($block =~/\b(?:if|for|while)\b/) {
5050 #print "APW: ALLOWED: block<$block>\n";
5051 $allowed = 1;
5052 }
5053 if (statement_block_size($block) > 1) {
5054 #print "APW: ALLOWED: lines block<$block>\n";
5055 $allowed = 1;
5056 }
5057 # Check the post-context.
5058 if (defined $chunks[1]) {
5059 my ($cond, $block) = @{$chunks[1]};
5060 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005061 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005062 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005063 if ($block =~ /^\s*\{/) {
5064 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5065 $allowed = 1;
5066 }
5067 }
5068 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005069 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005070 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005071
Andy Whitcroftf0556632008-10-15 22:02:23 -07005072 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005073 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005074 }
5075
Joe Perches000d1cc12011-07-25 17:13:25 -07005076 WARN("BRACES",
5077 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005078 }
5079 }
5080
Joe Perches0979ae62012-12-17 16:01:59 -08005081# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005082 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005083 if (CHK("BRACES",
5084 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5085 $fix && $prevrawline =~ /^\+/) {
5086 fix_delete_line($fixlinenr - 1, $prevrawline);
5087 }
Joe Perches0979ae62012-12-17 16:01:59 -08005088 }
Joe Perches77b9a532013-07-03 15:05:29 -07005089 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005090 if (CHK("BRACES",
5091 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5092 $fix) {
5093 fix_delete_line($fixlinenr, $rawline);
5094 }
Joe Perches0979ae62012-12-17 16:01:59 -08005095 }
5096
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005097# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005098 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5099 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005100 WARN("VOLATILE",
5101 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005102 }
5103
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005104# Check for user-visible strings broken across lines, which breaks the ability
5105# to grep for the string. Make exceptions when the previous string ends in a
5106# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5107# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005108 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005109 $prevline =~ /"\s*$/ &&
5110 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5111 if (WARN("SPLIT_STRING",
5112 "quoted string split across lines\n" . $hereprev) &&
5113 $fix &&
5114 $prevrawline =~ /^\+.*"\s*$/ &&
5115 $last_coalesced_string_linenr != $linenr - 1) {
5116 my $extracted_string = get_quoted_string($line, $rawline);
5117 my $comma_close = "";
5118 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5119 $comma_close = $1;
5120 }
5121
5122 fix_delete_line($fixlinenr - 1, $prevrawline);
5123 fix_delete_line($fixlinenr, $rawline);
5124 my $fixedline = $prevrawline;
5125 $fixedline =~ s/"\s*$//;
5126 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5127 fix_insert_line($fixlinenr - 1, $fixedline);
5128 $fixedline = $rawline;
5129 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5130 if ($fixedline !~ /\+\s*$/) {
5131 fix_insert_line($fixlinenr, $fixedline);
5132 }
5133 $last_coalesced_string_linenr = $linenr;
5134 }
5135 }
5136
5137# check for missing a space in a string concatenation
5138 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5139 WARN('MISSING_SPACE',
5140 "break quoted strings at a space character\n" . $hereprev);
5141 }
5142
5143# check for spaces before a quoted newline
5144 if ($rawline =~ /^.*\".*\s\\n/) {
5145 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5146 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5147 $fix) {
5148 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5149 }
5150
5151 }
5152
Joe Perchesf17dba42014-10-13 15:51:51 -07005153# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005154 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005155 CHK("CONCATENATED_STRING",
5156 "Concatenated strings should use spaces between elements\n" . $herecurr);
5157 }
5158
Joe Perches90ad30e2014-12-10 15:51:59 -08005159# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005160 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005161 WARN("STRING_FRAGMENTS",
5162 "Consecutive strings are generally better as a single string\n" . $herecurr);
5163 }
5164
Joe Perches6e300752015-09-09 15:37:47 -07005165# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005166 my $string;
5167 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5168 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5169 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005170 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005171 WARN("PRINTF_L",
5172 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5173 last;
5174 }
Joe Perches6e300752015-09-09 15:37:47 -07005175 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5176 ERROR("PRINTF_0xDECIMAL",
5177 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5178 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005179 }
5180
5181# check for line continuations in quoted strings with odd counts of "
5182 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5183 WARN("LINE_CONTINUATIONS",
5184 "Avoid line continuations in quoted strings\n" . $herecurr);
5185 }
5186
Andy Whitcroft00df3442007-06-08 13:47:06 -07005187# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005188 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005189 CHK("REDUNDANT_CODE",
5190 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005191 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005192 }
5193
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005194# check for needless "if (<foo>) fn(<foo>)" uses
5195 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005196 my $tested = quotemeta($1);
5197 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5198 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5199 my $func = $1;
5200 if (WARN('NEEDLESS_IF',
5201 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5202 $fix) {
5203 my $do_fix = 1;
5204 my $leading_tabs = "";
5205 my $new_leading_tabs = "";
5206 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5207 $leading_tabs = $1;
5208 } else {
5209 $do_fix = 0;
5210 }
5211 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5212 $new_leading_tabs = $1;
5213 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5214 $do_fix = 0;
5215 }
5216 } else {
5217 $do_fix = 0;
5218 }
5219 if ($do_fix) {
5220 fix_delete_line($fixlinenr - 1, $prevrawline);
5221 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5222 }
5223 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005224 }
5225 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005226
Joe Perchesebfdc402014-08-06 16:10:27 -07005227# check for unnecessary "Out of Memory" messages
5228 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5229 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5230 (defined $1 || defined $3) &&
5231 $linenr > 3) {
5232 my $testval = $2;
5233 my $testline = $lines[$linenr - 3];
5234
5235 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5236# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5237
5238 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5239 WARN("OOM_MESSAGE",
5240 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5241 }
5242 }
5243
Joe Perchesf78d98f2014-10-13 15:52:01 -07005244# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005245 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005246 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5247 my $level = $1;
5248 if (WARN("UNNECESSARY_KERN_LEVEL",
5249 "Possible unnecessary $level\n" . $herecurr) &&
5250 $fix) {
5251 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5252 }
5253 }
5254
Joe Perchesabb08a52014-12-10 15:51:46 -08005255# check for mask then right shift without a parentheses
5256 if ($^V && $^V ge 5.10.0 &&
5257 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5258 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5259 WARN("MASK_THEN_SHIFT",
5260 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5261 }
5262
Joe Perchesb75ac612014-12-10 15:52:02 -08005263# check for pointer comparisons to NULL
5264 if ($^V && $^V ge 5.10.0) {
5265 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5266 my $val = $1;
5267 my $equal = "!";
5268 $equal = "" if ($4 eq "!=");
5269 if (CHK("COMPARISON_TO_NULL",
5270 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5271 $fix) {
5272 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5273 }
5274 }
5275 }
5276
Joe Perches8716de32013-09-11 14:24:05 -07005277# check for bad placement of section $InitAttribute (e.g.: __initdata)
5278 if ($line =~ /(\b$InitAttribute\b)/) {
5279 my $attr = $1;
5280 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5281 my $ptr = $1;
5282 my $var = $2;
5283 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5284 ERROR("MISPLACED_INIT",
5285 "$attr should be placed after $var\n" . $herecurr)) ||
5286 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5287 WARN("MISPLACED_INIT",
5288 "$attr should be placed after $var\n" . $herecurr))) &&
5289 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005290 $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 -07005291 }
5292 }
5293 }
5294
Joe Perchese970b882013-11-12 15:10:10 -08005295# check for $InitAttributeData (ie: __initdata) with const
5296 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5297 my $attr = $1;
5298 $attr =~ /($InitAttributePrefix)(.*)/;
5299 my $attr_prefix = $1;
5300 my $attr_type = $2;
5301 if (ERROR("INIT_ATTRIBUTE",
5302 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5303 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005304 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005305 s/$InitAttributeData/${attr_prefix}initconst/;
5306 }
5307 }
5308
5309# check for $InitAttributeConst (ie: __initconst) without const
5310 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5311 my $attr = $1;
5312 if (ERROR("INIT_ATTRIBUTE",
5313 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5314 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005315 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005316 /(^\+\s*(?:static\s+))/;
5317 $lead = rtrim($1);
5318 $lead = "$lead " if ($lead !~ /^\+$/);
5319 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005320 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08005321 }
5322 }
5323
Joe Perchesc17893c2015-04-16 12:44:42 -07005324# check for __read_mostly with const non-pointer (should just be const)
5325 if ($line =~ /\b__read_mostly\b/ &&
5326 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5327 if (ERROR("CONST_READ_MOSTLY",
5328 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5329 $fix) {
5330 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5331 }
5332 }
5333
Joe Perchesfbdb8132014-04-03 14:49:14 -07005334# don't use __constant_<foo> functions outside of include/uapi/
5335 if ($realfile !~ m@^include/uapi/@ &&
5336 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5337 my $constant_func = $1;
5338 my $func = $constant_func;
5339 $func =~ s/^__constant_//;
5340 if (WARN("CONSTANT_CONVERSION",
5341 "$constant_func should be $func\n" . $herecurr) &&
5342 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005343 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005344 }
5345 }
5346
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005347# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005348 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005349 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005350 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005351 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005352 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005353 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5354 }
5355 if ($delay > 2000) {
5356 WARN("LONG_UDELAY",
5357 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005358 }
5359 }
5360
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005361# warn about unexpectedly long msleep's
5362 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5363 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005364 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005365 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005366 }
5367 }
5368
Joe Perches36ec1932013-07-03 15:05:25 -07005369# check for comparisons of jiffies
5370 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5371 WARN("JIFFIES_COMPARISON",
5372 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5373 }
5374
Joe Perches9d7a34a2013-07-03 15:05:26 -07005375# check for comparisons of get_jiffies_64()
5376 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5377 WARN("JIFFIES_COMPARISON",
5378 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5379 }
5380
Andy Whitcroft00df3442007-06-08 13:47:06 -07005381# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005382# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005383# print "#ifdef in C files should be avoided\n";
5384# print "$herecurr";
5385# $clean = 0;
5386# }
5387
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005388# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005389 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005390 if (ERROR("SPACING",
5391 "exactly one space required after that #$1\n" . $herecurr) &&
5392 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005393 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005394 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5395 }
5396
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005397 }
5398
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005399# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005400 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5401 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005402 my $which = $1;
5403 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005404 CHK("UNCOMMENTED_DEFINITION",
5405 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005406 }
5407 }
5408# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005409
5410 my $barriers = qr{
5411 mb|
5412 rmb|
5413 wmb|
5414 read_barrier_depends
5415 }x;
5416 my $barrier_stems = qr{
5417 mb__before_atomic|
5418 mb__after_atomic|
5419 store_release|
5420 load_acquire|
5421 store_mb|
5422 (?:$barriers)
5423 }x;
5424 my $all_barriers = qr{
5425 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005426 smp_(?:$barrier_stems)|
5427 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005428 }x;
5429
5430 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005431 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005432 WARN("MEMORY_BARRIER",
5433 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005434 }
5435 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005436
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005437 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5438
5439 if ($realfile !~ m@^include/asm-generic/@ &&
5440 $realfile !~ m@/barrier\.h$@ &&
5441 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5442 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5443 WARN("MEMORY_BARRIER",
5444 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5445 }
5446
Joe Perchescb426e92015-06-25 15:02:46 -07005447# check for waitqueue_active without a comment.
5448 if ($line =~ /\bwaitqueue_active\s*\(/) {
5449 if (!ctx_has_comment($first_line, $linenr)) {
5450 WARN("WAITQUEUE_ACTIVE",
5451 "waitqueue_active without comment\n" . $herecurr);
5452 }
5453 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005454
5455# Check for expedited grace periods that interrupt non-idle non-nohz
5456# online CPUs. These expedited can therefore degrade real-time response
5457# if used carelessly, and should be avoided where not absolutely
5458# needed. It is always OK to use synchronize_rcu_expedited() and
5459# synchronize_sched_expedited() at boot time (before real-time applications
5460# start) and in error situations where real-time response is compromised in
5461# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5462# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5463# Of course, nothing comes for free, and srcu_read_lock() and
5464# srcu_read_unlock() do contain full memory barriers in payment for
5465# synchronize_srcu_expedited() non-interruption properties.
5466 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5467 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5468 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5469
5470 }
5471
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005472# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005473 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005474 CHK("ARCH_DEFINES",
5475 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005476 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005477
Tobias Klauserd4977c72010-05-24 14:33:30 -07005478# Check that the storage class is at the beginning of a declaration
5479 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005480 WARN("STORAGE_CLASS",
5481 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005482 }
5483
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005484# check the location of the inline attribute, that it is between
5485# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005486 if ($line =~ /\b$Type\s+$Inline\b/ ||
5487 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005488 ERROR("INLINE_LOCATION",
5489 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005490 }
5491
Andy Whitcroft8905a672007-11-28 16:21:06 -08005492# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005493 if ($realfile !~ m@\binclude/uapi/@ &&
5494 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005495 if (WARN("INLINE",
5496 "plain inline is preferred over $1\n" . $herecurr) &&
5497 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005498 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005499
5500 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005501 }
5502
Joe Perches3d130fd2011-01-12 17:00:00 -08005503# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005504 if ($realfile !~ m@\binclude/uapi/@ &&
5505 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005506 WARN("PREFER_PACKED",
5507 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005508 }
5509
Joe Perches39b7e282011-07-25 17:13:24 -07005510# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005511 if ($realfile !~ m@\binclude/uapi/@ &&
5512 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005513 WARN("PREFER_ALIGNED",
5514 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005515 }
5516
Joe Perches5f14d3b2012-01-10 15:09:52 -08005517# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005518 if ($realfile !~ m@\binclude/uapi/@ &&
5519 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005520 if (WARN("PREFER_PRINTF",
5521 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5522 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005523 $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 -07005524
5525 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005526 }
5527
Joe Perches6061d942012-03-23 15:02:16 -07005528# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005529 if ($realfile !~ m@\binclude/uapi/@ &&
5530 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005531 if (WARN("PREFER_SCANF",
5532 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5533 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005534 $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 -07005535 }
Joe Perches6061d942012-03-23 15:02:16 -07005536 }
5537
Joe Perches619a9082014-12-10 15:51:35 -08005538# Check for __attribute__ weak, or __weak declarations (may have link issues)
5539 if ($^V && $^V ge 5.10.0 &&
5540 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5541 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5542 $line =~ /\b__weak\b/)) {
5543 ERROR("WEAK_DECLARATION",
5544 "Using weak declarations can have unintended link defects\n" . $herecurr);
5545 }
5546
Joe Perchese6176fa2015-06-25 15:02:49 -07005547# check for c99 types like uint8_t used outside of uapi/
5548 if ($realfile !~ m@\binclude/uapi/@ &&
5549 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5550 my $type = $1;
5551 if ($type =~ /\b($typeC99Typedefs)\b/) {
5552 $type = $1;
5553 my $kernel_type = 'u';
5554 $kernel_type = 's' if ($type =~ /^_*[si]/);
5555 $type =~ /(\d+)/;
5556 $kernel_type .= $1;
5557 if (CHK("PREFER_KERNEL_TYPES",
5558 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5559 $fix) {
5560 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5561 }
5562 }
5563 }
5564
Joe Perches938224b2016-01-20 14:59:15 -08005565# check for cast of C90 native int or longer types constants
5566 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5567 my $cast = $1;
5568 my $const = $2;
5569 if (WARN("TYPECAST_INT_CONSTANT",
5570 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5571 $fix) {
5572 my $suffix = "";
5573 my $newconst = $const;
5574 $newconst =~ s/${Int_type}$//;
5575 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5576 if ($cast =~ /\blong\s+long\b/) {
5577 $suffix .= 'LL';
5578 } elsif ($cast =~ /\blong\b/) {
5579 $suffix .= 'L';
5580 }
5581 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5582 }
5583 }
5584
Joe Perches8f53a9b2010-03-05 13:43:48 -08005585# check for sizeof(&)
5586 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005587 WARN("SIZEOF_ADDRESS",
5588 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005589 }
5590
Joe Perches66c80b62012-07-30 14:41:22 -07005591# check for sizeof without parenthesis
5592 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005593 if (WARN("SIZEOF_PARENTHESIS",
5594 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5595 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005596 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005597 }
Joe Perches66c80b62012-07-30 14:41:22 -07005598 }
5599
Joe Perches88982fe2012-12-17 16:02:00 -08005600# check for struct spinlock declarations
5601 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5602 WARN("USE_SPINLOCK_T",
5603 "struct spinlock should be spinlock_t\n" . $herecurr);
5604 }
5605
Joe Perchesa6962d72013-04-29 16:18:13 -07005606# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005607 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005608 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005609 $fmt =~ s/%%//g;
5610 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005611 if (WARN("PREFER_SEQ_PUTS",
5612 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5613 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005614 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005615 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005616 }
5617 }
5618
Andy Whitcroft554e1652012-01-10 15:09:57 -08005619# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005620 if ($^V && $^V ge 5.10.0 &&
5621 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005622 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005623
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005624 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005625 my $ms_val = $7;
5626 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005627
Andy Whitcroft554e1652012-01-10 15:09:57 -08005628 if ($ms_size =~ /^(0x|)0$/i) {
5629 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005630 "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 -08005631 } elsif ($ms_size =~ /^(0x|)1$/i) {
5632 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005633 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5634 }
5635 }
5636
Joe Perches98a9bba2014-01-23 15:54:52 -08005637# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005638# if ($^V && $^V ge 5.10.0 &&
5639# defined $stat &&
5640# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5641# if (WARN("PREFER_ETHER_ADDR_COPY",
5642# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5643# $fix) {
5644# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5645# }
5646# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005647
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005648# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005649# if ($^V && $^V ge 5.10.0 &&
5650# defined $stat &&
5651# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5652# WARN("PREFER_ETHER_ADDR_EQUAL",
5653# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5654# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005655
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005656# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5657# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf3331952016-10-11 13:51:53 -07005658# if ($^V && $^V ge 5.10.0 &&
5659# defined $stat &&
5660# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5661#
5662# my $ms_val = $7;
5663#
5664# if ($ms_val =~ /^(?:0x|)0+$/i) {
5665# if (WARN("PREFER_ETH_ZERO_ADDR",
5666# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5667# $fix) {
5668# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5669# }
5670# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5671# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5672# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5673# $fix) {
5674# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5675# }
5676# }
5677# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005678
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005679# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005680 if ($^V && $^V ge 5.10.0 &&
5681 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005682 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005683 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005684 my $call = $1;
5685 my $cast1 = deparenthesize($2);
5686 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005687 my $cast2 = deparenthesize($7);
5688 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005689 my $cast;
5690
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005691 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005692 $cast = "$cast1 or $cast2";
5693 } elsif ($cast1 ne "") {
5694 $cast = $cast1;
5695 } else {
5696 $cast = $cast2;
5697 }
5698 WARN("MINMAX",
5699 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005700 }
5701 }
5702
Joe Perches4a273192012-07-30 14:41:20 -07005703# check usleep_range arguments
5704 if ($^V && $^V ge 5.10.0 &&
5705 defined $stat &&
5706 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5707 my $min = $1;
5708 my $max = $7;
5709 if ($min eq $max) {
5710 WARN("USLEEP_RANGE",
5711 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5712 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5713 $min > $max) {
5714 WARN("USLEEP_RANGE",
5715 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5716 }
5717 }
5718
Joe Perches823b7942013-11-12 15:10:15 -08005719# check for naked sscanf
5720 if ($^V && $^V ge 5.10.0 &&
5721 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005722 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005723 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5724 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5725 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5726 my $lc = $stat =~ tr@\n@@;
5727 $lc = $lc + $linenr;
5728 my $stat_real = raw_line($linenr, 0);
5729 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5730 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5731 }
5732 WARN("NAKED_SSCANF",
5733 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5734 }
5735
Joe Perchesafc819a2014-06-04 16:12:08 -07005736# check for simple sscanf that should be kstrto<foo>
5737 if ($^V && $^V ge 5.10.0 &&
5738 defined $stat &&
5739 $line =~ /\bsscanf\b/) {
5740 my $lc = $stat =~ tr@\n@@;
5741 $lc = $lc + $linenr;
5742 my $stat_real = raw_line($linenr, 0);
5743 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5744 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5745 }
5746 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5747 my $format = $6;
5748 my $count = $format =~ tr@%@%@;
5749 if ($count == 1 &&
5750 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5751 WARN("SSCANF_TO_KSTRTO",
5752 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5753 }
5754 }
5755 }
5756
Joe Perches70dc8a42013-09-11 14:23:58 -07005757# check for new externs in .h files.
5758 if ($realfile =~ /\.h$/ &&
5759 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005760 if (CHK("AVOID_EXTERNS",
5761 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005762 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005763 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005764 }
5765 }
5766
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005767# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005768 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005769 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005770 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005771 my $function_name = $1;
5772 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005773
5774 my $s = $stat;
5775 if (defined $cond) {
5776 substr($s, 0, length($cond), '');
5777 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005778 if ($s =~ /^\s*;/ &&
5779 $function_name ne 'uninitialized_var')
5780 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005781 WARN("AVOID_EXTERNS",
5782 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005783 }
5784
5785 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005786 WARN("FUNCTION_ARGUMENTS",
5787 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005788 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005789
5790 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5791 $stat =~ /^.\s*extern\s+/)
5792 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005793 WARN("AVOID_EXTERNS",
5794 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005795 }
5796
5797# checks for new __setup's
5798 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5799 my $name = $1;
5800
5801 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005802 CHK("UNDOCUMENTED_SETUP",
5803 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005804 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005805 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005806
5807# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005808 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005809 WARN("UNNECESSARY_CASTS",
5810 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005811 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005812
Joe Perchesa640d252013-07-03 15:05:21 -07005813# alloc style
5814# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5815 if ($^V && $^V ge 5.10.0 &&
5816 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5817 CHK("ALLOC_SIZEOF_STRUCT",
5818 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5819 }
5820
Joe Perches60a55362014-06-04 16:12:07 -07005821# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5822 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005823 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
Joe Perches60a55362014-06-04 16:12:07 -07005824 my $oldfunc = $3;
5825 my $a1 = $4;
5826 my $a2 = $10;
5827 my $newfunc = "kmalloc_array";
5828 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005829 my $r1 = $a1;
5830 my $r2 = $a2;
5831 if ($a1 =~ /^sizeof\s*\S/) {
5832 $r1 = $a2;
5833 $r2 = $a1;
5834 }
5835 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5836 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005837 if (WARN("ALLOC_WITH_MULTIPLY",
5838 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5839 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005840 $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 -07005841
5842 }
5843 }
5844 }
5845
Joe Perches972fdea2013-04-29 16:18:12 -07005846# check for krealloc arg reuse
5847 if ($^V && $^V ge 5.10.0 &&
5848 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5849 WARN("KREALLOC_ARG_REUSE",
5850 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5851 }
5852
Joe Perches5ce59ae2013-02-21 16:44:18 -08005853# check for alloc argument mismatch
5854 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5855 WARN("ALLOC_ARRAY_ARGS",
5856 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5857 }
5858
Joe Perchescaf2a542011-01-12 16:59:56 -08005859# check for multiple semicolons
5860 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005861 if (WARN("ONE_SEMICOLON",
5862 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5863 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005864 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005865 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005866 }
5867
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005868# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5869 if ($realfile !~ m@^include/uapi/@ &&
5870 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08005871 my $ull = "";
5872 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5873 if (CHK("BIT_MACRO",
5874 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5875 $fix) {
5876 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5877 }
5878 }
5879
Joe Perches2d632742016-05-20 17:04:00 -07005880# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5881 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5882 my $config = $1;
5883 if (WARN("PREFER_IS_ENABLED",
5884 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5885 $fix) {
5886 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5887 }
5888 }
5889
Joe Perchese81f2392014-08-06 16:11:25 -07005890# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005891 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5892 my $has_break = 0;
5893 my $has_statement = 0;
5894 my $count = 0;
5895 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005896 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005897 $prevline--;
5898 my $rline = $rawlines[$prevline - 1];
5899 my $fline = $lines[$prevline - 1];
5900 last if ($fline =~ /^\@\@/);
5901 next if ($fline =~ /^\-/);
5902 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5903 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5904 next if ($fline =~ /^.[\s$;]*$/);
5905 $has_statement = 1;
5906 $count++;
5907 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5908 }
5909 if (!$has_break && $has_statement) {
5910 WARN("MISSING_BREAK",
5911 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5912 }
5913 }
5914
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005915# check for switch/default statements without a break;
5916 if ($^V && $^V ge 5.10.0 &&
5917 defined $stat &&
5918 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5919 my $ctx = '';
5920 my $herectx = $here . "\n";
5921 my $cnt = statement_rawlines($stat);
5922 for (my $n = 0; $n < $cnt; $n++) {
5923 $herectx .= raw_line($linenr, $n) . "\n";
5924 }
5925 WARN("DEFAULT_NO_BREAK",
5926 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005927 }
5928
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005929# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005930 if ($line =~ /\b__FUNCTION__\b/) {
5931 if (WARN("USE_FUNC",
5932 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5933 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005934 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005935 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005936 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005937
Joe Perches62ec8182015-02-13 14:38:18 -08005938# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5939 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5940 ERROR("DATE_TIME",
5941 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5942 }
5943
Joe Perches2c924882012-03-23 15:02:20 -07005944# check for use of yield()
5945 if ($line =~ /\byield\s*\(\s*\)/) {
5946 WARN("YIELD",
5947 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5948 }
5949
Joe Perches179f8f42013-07-03 15:05:30 -07005950# check for comparisons against true and false
5951 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5952 my $lead = $1;
5953 my $arg = $2;
5954 my $test = $3;
5955 my $otype = $4;
5956 my $trail = $5;
5957 my $op = "!";
5958
5959 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5960
5961 my $type = lc($otype);
5962 if ($type =~ /^(?:true|false)$/) {
5963 if (("$test" eq "==" && "$type" eq "true") ||
5964 ("$test" eq "!=" && "$type" eq "false")) {
5965 $op = "";
5966 }
5967
5968 CHK("BOOL_COMPARISON",
5969 "Using comparison to $otype is error prone\n" . $herecurr);
5970
5971## maybe suggesting a correct construct would better
5972## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5973
5974 }
5975 }
5976
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005977# check for semaphores initialized locked
5978 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005979 WARN("CONSIDER_COMPLETION",
5980 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005981 }
Joe Perches6712d852012-03-23 15:02:20 -07005982
Joe Perches67d0a072011-10-31 17:13:10 -07005983# recommend kstrto* over simple_strto* and strict_strto*
5984 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005985 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005986 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005987 }
Joe Perches6712d852012-03-23 15:02:20 -07005988
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005989# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005990 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005991 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005992 "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 -07005993 }
Joe Perches6712d852012-03-23 15:02:20 -07005994
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005995# check for various structs that are normally const (ops, kgdb, device_tree)
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005996 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005997 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005998 WARN("CONST_STRUCT",
5999 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006000 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006001 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006002
6003# use of NR_CPUS is usually wrong
6004# ignore definitions of NR_CPUS and usage to define arrays as likely right
6005 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006006 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6007 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006008 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6009 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6010 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006011 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006012 WARN("NR_CPUS",
6013 "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 -07006014 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006015
Joe Perches52ea8502013-11-12 15:10:09 -08006016# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6017 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6018 ERROR("DEFINE_ARCH_HAS",
6019 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6020 }
6021
Joe Perchesacd93622015-02-13 14:38:38 -08006022# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6023 if ($^V && $^V ge 5.10.0 &&
6024 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6025 WARN("LIKELY_MISUSE",
6026 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6027 }
6028
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006029# whine mightly about in_atomic
6030 if ($line =~ /\bin_atomic\s*\(/) {
6031 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006032 ERROR("IN_ATOMIC",
6033 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006034 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006035 WARN("IN_ATOMIC",
6036 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006037 }
6038 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006039
Joe Perches481aea52016-05-20 17:04:08 -07006040# whine about ACCESS_ONCE
6041 if ($^V && $^V ge 5.10.0 &&
6042 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6043 my $par = $1;
6044 my $eq = $2;
6045 my $fun = $3;
6046 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6047 if (defined($eq)) {
6048 if (WARN("PREFER_WRITE_ONCE",
6049 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6050 $fix) {
6051 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6052 }
6053 } else {
6054 if (WARN("PREFER_READ_ONCE",
6055 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6056 $fix) {
6057 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6058 }
6059 }
6060 }
6061
Peter Zijlstra1704f472010-03-19 01:37:42 +01006062# check for lockdep_set_novalidate_class
6063 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6064 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6065 if ($realfile !~ m@^kernel/lockdep@ &&
6066 $realfile !~ m@^include/linux/lockdep@ &&
6067 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006068 ERROR("LOCKDEP",
6069 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006070 }
6071 }
Dave Jones88f88312011-01-12 16:59:59 -08006072
Joe Perchesb392c642015-04-16 12:44:16 -07006073 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6074 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006075 WARN("EXPORTED_WORLD_WRITABLE",
6076 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006077 }
Joe Perches24358802014-04-03 14:49:13 -07006078
Joe Perches515a2352014-04-03 14:49:24 -07006079# Mode permission misuses where it seems decimal should be octal
6080# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6081 if ($^V && $^V ge 5.10.0 &&
6082 $line =~ /$mode_perms_search/) {
6083 foreach my $entry (@mode_permission_funcs) {
6084 my $func = $entry->[0];
6085 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006086
Joe Perches515a2352014-04-03 14:49:24 -07006087 my $skip_args = "";
6088 if ($arg_pos > 1) {
6089 $arg_pos--;
6090 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6091 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006092 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches515a2352014-04-03 14:49:24 -07006093 if ($line =~ /$test/) {
6094 my $val = $1;
6095 $val = $6 if ($skip_args ne "");
Joe Perchesf90774e2016-10-11 13:51:47 -07006096 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6097 ($val =~ /^$Octal$/ && length($val) ne 4)) {
Joe Perches515a2352014-04-03 14:49:24 -07006098 ERROR("NON_OCTAL_PERMISSIONS",
6099 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesf90774e2016-10-11 13:51:47 -07006100 }
6101 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006102 ERROR("EXPORTED_WORLD_WRITABLE",
6103 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006104 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006105 if ($val =~ /\b$mode_perms_string_search\b/) {
6106 my $to = 0;
6107 while ($val =~ /\b($mode_perms_string_search)\b(?:\s*\|\s*)?\s*/g) {
6108 $to |= $mode_permission_string_types{$1};
6109 }
6110 my $new = sprintf("%04o", $to);
6111 if (WARN("SYMBOLIC_PERMS",
6112 "Symbolic permissions are not preferred. Consider using octal permissions $new.\n" . $herecurr) &&
6113 $fix) {
6114 $fixed[$fixlinenr] =~ s/\Q$val\E/$new/;
6115 }
6116 }
Joe Perches24358802014-04-03 14:49:13 -07006117 }
6118 }
6119 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006120
6121# validate content of MODULE_LICENSE against list from include/linux/module.h
6122 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6123 my $extracted_string = get_quoted_string($line, $rawline);
6124 my $valid_licenses = qr{
6125 GPL|
6126 GPL\ v2|
6127 GPL\ and\ additional\ rights|
6128 Dual\ BSD/GPL|
6129 Dual\ MIT/GPL|
6130 Dual\ MPL/GPL|
6131 Proprietary
6132 }x;
6133 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6134 WARN("MODULE_LICENSE",
6135 "unknown module license " . $extracted_string . "\n" . $herecurr);
6136 }
6137 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006138 }
6139
6140 # If we have no input at all, then there is nothing to report on
6141 # so just keep quiet.
6142 if ($#rawlines == -1) {
6143 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006144 }
6145
Andy Whitcroft8905a672007-11-28 16:21:06 -08006146 # In mailback mode only produce a report in the negative, for
6147 # things that appear to be patches.
6148 if ($mailback && ($clean == 1 || !$is_patch)) {
6149 exit(0);
6150 }
6151
6152 # This is not a patch, and we are are in 'no-patch' mode so
6153 # just keep quiet.
6154 if (!$chk_patch && !$is_patch) {
6155 exit(0);
6156 }
6157
Joe Perches06330fc2015-06-25 15:03:11 -07006158 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006159 ERROR("NOT_UNIFIED_DIFF",
6160 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006161 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006162 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006163 ERROR("MISSING_SIGN_OFF",
6164 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006165 }
6166
Andy Whitcroft8905a672007-11-28 16:21:06 -08006167 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006168 if ($summary && !($clean == 1 && $quiet == 1)) {
6169 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006170 print "total: $cnt_error errors, $cnt_warn warnings, " .
6171 (($check)? "$cnt_chk checks, " : "") .
6172 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006173 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006174
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006175 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006176 # If there were any defects found and not already fixing them
6177 if (!$clean and !$fix) {
6178 print << "EOM"
6179
6180NOTE: For some of the reported defects, checkpatch may be able to
6181 mechanically convert to the typical style using --fix or --fix-inplace.
6182EOM
6183 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006184 # If there were whitespace errors which cleanpatch can fix
6185 # then suggest that.
6186 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006187 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006188 print << "EOM"
6189
6190NOTE: Whitespace errors detected.
6191 You may wish to use scripts/cleanpatch or scripts/cleanfile
6192EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006193 }
6194 }
6195
Joe Perchesd752fcc2014-08-06 16:11:05 -07006196 if ($clean == 0 && $fix &&
6197 ("@rawlines" ne "@fixed" ||
6198 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006199 my $newfile = $filename;
6200 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006201 my $linecount = 0;
6202 my $f;
6203
Joe Perchesd752fcc2014-08-06 16:11:05 -07006204 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6205
Joe Perches3705ce52013-07-03 15:05:31 -07006206 open($f, '>', $newfile)
6207 or die "$P: Can't open $newfile for write\n";
6208 foreach my $fixed_line (@fixed) {
6209 $linecount++;
6210 if ($file) {
6211 if ($linecount > 3) {
6212 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006213 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006214 }
6215 } else {
6216 print $f $fixed_line . "\n";
6217 }
6218 }
6219 close($f);
6220
6221 if (!$quiet) {
6222 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006223
Joe Perches3705ce52013-07-03 15:05:31 -07006224Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6225
6226Do _NOT_ trust the results written to this file.
6227Do _NOT_ submit these changes without inspecting them for correctness.
6228
6229This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6230No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006231EOM
6232 }
6233 }
6234
Joe Perchesd8469f12015-06-25 15:03:00 -07006235 if ($quiet == 0) {
6236 print "\n";
6237 if ($clean == 1) {
6238 print "$vname has no obvious style problems and is ready for submission.\n";
6239 } else {
6240 print "$vname has style problems, please review.\n";
6241 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006242 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006243 return $clean;
6244}