blob: 4f53093a1b0bd7f274228901e3889260736fef66 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-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 Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
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 Whitcroft0a920b5b2007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b5b2007-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 Perches0dea9f1e2016-05-20 17:04:19 -070031my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $check = 0;
Joe Perches2ac73b42014-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700182GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700183 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Perches2ac73b42014-06-04 16:12:05 -0700221$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800222
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700233if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700234 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Perchese970b8842013-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|
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +0200338 __bitwise|
Joe Perches03f1df72010-10-26 14:23:16 -0700339 __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],
Joe Perches459cf0a2016-10-11 13:52:19 -0700527 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2],
528 ["IIO_DEV_ATTR_[A-Z_]+", 1],
529 ["SENSOR_(?:DEVICE_|)ATTR_2", 2],
530 ["SENSOR_TEMPLATE(?:_2|)", 3],
531 ["__ATTR", 2],
Joe Perches24358802014-04-03 14:49:13 -0700532);
533
Joe Perches515a2352014-04-03 14:49:24 -0700534#Create a search pattern for all these functions to speed up a loop below
535our $mode_perms_search = "";
536foreach my $entry (@mode_permission_funcs) {
537 $mode_perms_search .= '|' if ($mode_perms_search ne "");
538 $mode_perms_search .= $entry->[0];
539}
540
Joe Perchesb392c642015-04-16 12:44:16 -0700541our $mode_perms_world_writable = qr{
542 S_IWUGO |
543 S_IWOTH |
544 S_IRWXUGO |
545 S_IALLUGO |
546 0[0-7][0-7][2367]
547}x;
548
Joe Perchesf90774e2016-10-11 13:51:47 -0700549our %mode_permission_string_types = (
550 "S_IRWXU" => 0700,
551 "S_IRUSR" => 0400,
552 "S_IWUSR" => 0200,
553 "S_IXUSR" => 0100,
554 "S_IRWXG" => 0070,
555 "S_IRGRP" => 0040,
556 "S_IWGRP" => 0020,
557 "S_IXGRP" => 0010,
558 "S_IRWXO" => 0007,
559 "S_IROTH" => 0004,
560 "S_IWOTH" => 0002,
561 "S_IXOTH" => 0001,
562 "S_IRWXUGO" => 0777,
563 "S_IRUGO" => 0444,
564 "S_IWUGO" => 0222,
565 "S_IXUGO" => 0111,
566);
567
568#Create a search pattern for all these strings to speed up a loop below
569our $mode_perms_string_search = "";
570foreach my $entry (keys %mode_permission_string_types) {
571 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
572 $mode_perms_string_search .= $entry;
573}
574
Wolfram Sang7840a942010-08-09 17:20:57 -0700575our $allowed_asm_includes = qr{(?x:
576 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700577 memory|
578 time|
579 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700580)};
581# memory.h: ARM has a custom one
582
Kees Cook66b47b42014-10-13 15:51:57 -0700583# Load common spelling mistakes and build regular expression list.
584my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700585my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700586
Joe Perches36061e32014-12-10 15:51:43 -0800587if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800588 while (<$spelling>) {
589 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700590
Joe Perches36061e32014-12-10 15:51:43 -0800591 $line =~ s/\s*\n?$//g;
592 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700593
Joe Perches36061e32014-12-10 15:51:43 -0800594 next if ($line =~ m/^\s*#/);
595 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700596
Joe Perches36061e32014-12-10 15:51:43 -0800597 my ($suspect, $fix) = split(/\|\|/, $line);
598
Joe Perches36061e32014-12-10 15:51:43 -0800599 $spelling_fix{$suspect} = $fix;
600 }
601 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800602} else {
603 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700604}
Kees Cook66b47b42014-10-13 15:51:57 -0700605
Joe Perchesebfd7d62015-04-16 12:44:14 -0700606if ($codespell) {
607 if (open(my $spelling, '<', $codespellfile)) {
608 while (<$spelling>) {
609 my $line = $_;
610
611 $line =~ s/\s*\n?$//g;
612 $line =~ s/^\s*//g;
613
614 next if ($line =~ m/^\s*#/);
615 next if ($line =~ m/^\s*$/);
616 next if ($line =~ m/, disabled/i);
617
618 $line =~ s/,.*$//;
619
620 my ($suspect, $fix) = split(/->/, $line);
621
622 $spelling_fix{$suspect} = $fix;
623 }
624 close($spelling);
625 } else {
626 warn "No codespell typos will be found - file '$codespellfile': $!\n";
627 }
628}
629
630$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
631
Joe Perchesbf1fa1d2016-10-11 13:51:56 -0700632my $const_structs = "";
633if (open(my $conststructs, '<', $conststructsfile)) {
634 while (<$conststructs>) {
635 my $line = $_;
636
637 $line =~ s/\s*\n?$//g;
638 $line =~ s/^\s*//g;
639
640 next if ($line =~ m/^\s*#/);
641 next if ($line =~ m/^\s*$/);
642 if ($line =~ /\s/) {
643 print("$conststructsfile: '$line' invalid - ignored\n");
644 next;
645 }
646
647 $const_structs .= '|' if ($const_structs ne "");
648 $const_structs .= $line;
649 }
650 close($conststructsfile);
651} else {
652 warn "No structs that should be const will be found - file '$conststructsfile': $!\n";
653}
654
Andy Whitcroft8905a672007-11-28 16:21:06 -0800655sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700656 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
657 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700658 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700659 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700660 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700661 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700662 (?:$typeTypedefs\b)|
663 (?:${all}\b)
664 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800665 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700666 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800667 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800668 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700669 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700670 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800671 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700672 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800673 }x;
Joe Perches18130872014-08-06 16:11:22 -0700674 $NonptrTypeMisordered = qr{
675 (?:$Modifier\s+|const\s+)*
676 (?:
677 (?:${Misordered}\b)
678 )
679 (?:\s+$Modifier|\s+const)*
680 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700681 $NonptrTypeWithAttr = qr{
682 (?:$Modifier\s+|const\s+)*
683 (?:
684 (?:typeof|__typeof__)\s*\([^\)]*\)|
685 (?:$typeTypedefs\b)|
686 (?:${allWithAttr}\b)
687 )
688 (?:\s+$Modifier|\s+const)*
689 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800690 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700691 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700692 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700693 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800694 }x;
Joe Perches18130872014-08-06 16:11:22 -0700695 $TypeMisordered = qr{
696 $NonptrTypeMisordered
697 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
698 (?:\s+$Inline|\s+$Modifier)*
699 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700700 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700701 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800702}
703build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700704
Joe Perches7d2367a2011-07-25 17:13:22 -0700705our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700706
707# Using $balanced_parens, $LvalOrFunc, or $FuncArg
708# requires at least perl version v5.10.0
709# Any use must be runtime checked with $^V
710
711our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700712our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800713our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700714
Joe Perchesf8422302014-08-06 16:11:31 -0700715our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700716 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700717 (?:$Storage\s+)?LIST_HEAD\s*\(|
718 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
719)};
720
Joe Perches7d2367a2011-07-25 17:13:22 -0700721sub deparenthesize {
722 my ($string) = @_;
723 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700724
725 while ($string =~ /^\s*\(.*\)\s*$/) {
726 $string =~ s@^\s*\(\s*@@;
727 $string =~ s@\s*\)\s*$@@;
728 }
729
Joe Perches7d2367a2011-07-25 17:13:22 -0700730 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700731
Joe Perches7d2367a2011-07-25 17:13:22 -0700732 return $string;
733}
734
Joe Perches34456862013-07-03 15:05:34 -0700735sub seed_camelcase_file {
736 my ($file) = @_;
737
738 return if (!(-f $file));
739
740 local $/;
741
742 open(my $include_file, '<', "$file")
743 or warn "$P: Can't read '$file' $!\n";
744 my $text = <$include_file>;
745 close($include_file);
746
747 my @lines = split('\n', $text);
748
749 foreach my $line (@lines) {
750 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
751 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
752 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800753 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
754 $camelcase{$1} = 1;
755 } 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 -0700756 $camelcase{$1} = 1;
757 }
758 }
759}
760
Joe Perches85b0ee12016-10-11 13:51:44 -0700761sub is_maintained_obsolete {
762 my ($filename) = @_;
763
Jerome Forissierf2c19c22016-12-12 16:46:23 -0800764 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl"));
Joe Perches85b0ee12016-10-11 13:51:44 -0700765
Joe Perches0616efa2016-10-11 13:52:02 -0700766 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 -0700767
768 return $status =~ /obsolete/i;
769}
770
Joe Perches34456862013-07-03 15:05:34 -0700771my $camelcase_seeded = 0;
772sub seed_camelcase_includes {
773 return if ($camelcase_seeded);
774
775 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700776 my $camelcase_cache = "";
777 my @include_files = ();
778
779 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700780
Richard Genoud3645e322014-02-10 14:25:32 -0800781 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700782 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
783 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700784 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700785 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700786 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700787 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700788 @include_files = split('\n', $files);
789 foreach my $file (@include_files) {
790 my $date = POSIX::strftime("%Y%m%d%H%M",
791 localtime((stat $file)[9]));
792 $last_mod_date = $date if ($last_mod_date < $date);
793 }
794 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700795 }
Joe Perchesc707a812013-07-08 16:00:43 -0700796
797 if ($camelcase_cache ne "" && -f $camelcase_cache) {
798 open(my $camelcase_file, '<', "$camelcase_cache")
799 or warn "$P: Can't read '$camelcase_cache' $!\n";
800 while (<$camelcase_file>) {
801 chomp;
802 $camelcase{$_} = 1;
803 }
804 close($camelcase_file);
805
806 return;
807 }
808
Richard Genoud3645e322014-02-10 14:25:32 -0800809 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700810 $files = `git ls-files "include/*.h"`;
811 @include_files = split('\n', $files);
812 }
813
Joe Perches34456862013-07-03 15:05:34 -0700814 foreach my $file (@include_files) {
815 seed_camelcase_file($file);
816 }
Joe Perches351b2a12013-07-03 15:05:36 -0700817
Joe Perchesc707a812013-07-08 16:00:43 -0700818 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700819 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700820 open(my $camelcase_file, '>', "$camelcase_cache")
821 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700822 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
823 print $camelcase_file ("$_\n");
824 }
825 close($camelcase_file);
826 }
Joe Perches34456862013-07-03 15:05:34 -0700827}
828
Joe Perchesd311cd42014-08-06 16:10:57 -0700829sub git_commit_info {
830 my ($commit, $id, $desc) = @_;
831
832 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
833
834 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
835 $output =~ s/^\s*//gm;
836 my @lines = split("\n", $output);
837
Joe Perches0d7835f2015-02-13 14:38:35 -0800838 return ($id, $desc) if ($#lines < 0);
839
Joe Perchesd311cd42014-08-06 16:10:57 -0700840 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
841# Maybe one day convert this block of bash into something that returns
842# all matching commit ids, but it's very slow...
843#
844# echo "checking commits $1..."
845# git rev-list --remotes | grep -i "^$1" |
846# while read line ; do
847# git log --format='%H %s' -1 $line |
848# echo "commit $(cut -c 1-12,41-)"
849# done
850 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
851 } else {
852 $id = substr($lines[0], 0, 12);
853 $desc = substr($lines[0], 41);
854 }
855
856 return ($id, $desc);
857}
858
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700859$chk_signoff = 0 if ($file);
860
Andy Whitcroft00df3442007-06-08 13:47:06 -0700861my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800862my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700863my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700864my @fixed_inserted = ();
865my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700866my $fixlinenr = -1;
867
Du, Changbin4a593c32016-05-20 17:04:16 -0700868# If input is git commits, extract all commits from the commit expressions.
869# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
870die "$P: No git repository found\n" if ($git && !-e ".git");
871
872if ($git) {
873 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700874 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700875 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700876 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
877 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700878 } elsif ($commit_expr =~ m/\.\./) {
879 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700880 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700881 $git_range = "-1 $commit_expr";
882 }
883 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
884 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700885 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
886 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700887 my $sha1 = $1;
888 my $subject = $2;
889 unshift(@commits, $sha1);
890 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700891 }
892 }
893 die "$P: no git commits after extraction!\n" if (@commits == 0);
894 @ARGV = @commits;
895}
896
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800897my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700898for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800899 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700900 if ($git) {
901 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
902 die "$P: $filename: git format-patch failed - $!\n";
903 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800904 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700905 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800906 } elsif ($filename eq '-') {
907 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700908 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800909 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700910 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700911 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800912 if ($filename eq '-') {
913 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700914 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700915 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800916 } else {
917 $vname = $filename;
918 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800919 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700920 chomp;
921 push(@rawlines, $_);
922 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800923 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700924
925 if ($#ARGV > 0 && $quiet == 0) {
926 print '-' x length($vname) . "\n";
927 print "$vname\n";
928 print '-' x length($vname) . "\n";
929 }
930
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800931 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700932 $exit = 1;
933 }
934 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800935 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700936 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700937 @fixed_inserted = ();
938 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700939 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700940 @modifierListFile = ();
941 @typeListFile = ();
942 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700943}
944
Joe Perchesd8469f12015-06-25 15:03:00 -0700945if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700946 hash_show_words(\%use_type, "Used");
947 hash_show_words(\%ignore_type, "Ignored");
948
Joe Perchesd8469f12015-06-25 15:03:00 -0700949 if ($^V lt 5.10.0) {
950 print << "EOM"
951
952NOTE: perl $^V is not modern enough to detect all possible issues.
953 An upgrade to at least perl v5.10.0 is suggested.
954EOM
955 }
956 if ($exit) {
957 print << "EOM"
958
959NOTE: If any of the errors are false positives, please report
960 them to the maintainer, see CHECKPATCH in MAINTAINERS.
961EOM
962 }
963}
964
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700965exit($exit);
966
967sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700968 my ($root) = @_;
969
970 my @tree_check = (
971 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
972 "README", "Documentation", "arch", "include", "drivers",
973 "fs", "init", "ipc", "kernel", "lib", "scripts",
974 );
975
976 foreach my $check (@tree_check) {
977 if (! -e $root . '/' . $check) {
978 return 0;
979 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700980 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700981 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700982}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700983
Joe Perches20112472011-07-25 17:13:23 -0700984sub parse_email {
985 my ($formatted_email) = @_;
986
987 my $name = "";
988 my $address = "";
989 my $comment = "";
990
991 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
992 $name = $1;
993 $address = $2;
994 $comment = $3 if defined $3;
995 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
996 $address = $1;
997 $comment = $2 if defined $2;
998 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
999 $address = $1;
1000 $comment = $2 if defined $2;
1001 $formatted_email =~ s/$address.*$//;
1002 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -07001003 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001004 $name =~ s/^\"|\"$//g;
1005 # If there's a name left after stripping spaces and
1006 # leading quotes, and the address doesn't have both
1007 # leading and trailing angle brackets, the address
1008 # is invalid. ie:
1009 # "joe smith joe@smith.com" bad
1010 # "joe smith <joe@smith.com" bad
1011 if ($name ne "" && $address !~ /^<[^>]+>$/) {
1012 $name = "";
1013 $address = "";
1014 $comment = "";
1015 }
1016 }
1017
Joe Perches3705ce52013-07-03 15:05:31 -07001018 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001019 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001020 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001021 $address =~ s/^\<|\>$//g;
1022
1023 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1024 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1025 $name = "\"$name\"";
1026 }
1027
1028 return ($name, $address, $comment);
1029}
1030
1031sub format_email {
1032 my ($name, $address) = @_;
1033
1034 my $formatted_email;
1035
Joe Perches3705ce52013-07-03 15:05:31 -07001036 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001037 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001038 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001039
1040 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1041 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1042 $name = "\"$name\"";
1043 }
1044
1045 if ("$name" eq "") {
1046 $formatted_email = "$address";
1047 } else {
1048 $formatted_email = "$name <$address>";
1049 }
1050
1051 return $formatted_email;
1052}
1053
Joe Perchesd311cd42014-08-06 16:10:57 -07001054sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001055 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001056
Joe Perchesbd474ca2014-08-06 16:11:10 -07001057 foreach my $path (split(/:/, $ENV{PATH})) {
1058 if (-e "$path/$bin") {
1059 return "$path/$bin";
1060 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001061 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001062
Joe Perchesbd474ca2014-08-06 16:11:10 -07001063 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001064}
1065
Joe Perches000d1cc12011-07-25 17:13:25 -07001066sub which_conf {
1067 my ($conf) = @_;
1068
1069 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1070 if (-e "$path/$conf") {
1071 return "$path/$conf";
1072 }
1073 }
1074
1075 return "";
1076}
1077
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001078sub expand_tabs {
1079 my ($str) = @_;
1080
1081 my $res = '';
1082 my $n = 0;
1083 for my $c (split(//, $str)) {
1084 if ($c eq "\t") {
1085 $res .= ' ';
1086 $n++;
1087 for (; ($n % 8) != 0; $n++) {
1088 $res .= ' ';
1089 }
1090 next;
1091 }
1092 $res .= $c;
1093 $n++;
1094 }
1095
1096 return $res;
1097}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001098sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001099 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001100 return $res;
1101}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001102
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001103sub line_stats {
1104 my ($line) = @_;
1105
1106 # Drop the diff line leader and expand tabs
1107 $line =~ s/^.//;
1108 $line = expand_tabs($line);
1109
1110 # Pick the indent from the front of the line.
1111 my ($white) = ($line =~ /^(\s*)/);
1112
1113 return (length($line), length($white));
1114}
1115
Andy Whitcroft773647a2008-03-28 14:15:58 -07001116my $sanitise_quote = '';
1117
1118sub sanitise_line_reset {
1119 my ($in_comment) = @_;
1120
1121 if ($in_comment) {
1122 $sanitise_quote = '*/';
1123 } else {
1124 $sanitise_quote = '';
1125 }
1126}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001127sub sanitise_line {
1128 my ($line) = @_;
1129
1130 my $res = '';
1131 my $l = '';
1132
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001133 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001134 my $off = 0;
1135 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001136
Andy Whitcroft773647a2008-03-28 14:15:58 -07001137 # Always copy over the diff marker.
1138 $res = substr($line, 0, 1);
1139
1140 for ($off = 1; $off < length($line); $off++) {
1141 $c = substr($line, $off, 1);
1142
1143 # Comments we are wacking completly including the begin
1144 # and end, all to $;.
1145 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1146 $sanitise_quote = '*/';
1147
1148 substr($res, $off, 2, "$;$;");
1149 $off++;
1150 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001151 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001152 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001153 $sanitise_quote = '';
1154 substr($res, $off, 2, "$;$;");
1155 $off++;
1156 next;
1157 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001158 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1159 $sanitise_quote = '//';
1160
1161 substr($res, $off, 2, $sanitise_quote);
1162 $off++;
1163 next;
1164 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001165
1166 # A \ in a string means ignore the next character.
1167 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1168 $c eq "\\") {
1169 substr($res, $off, 2, 'XX');
1170 $off++;
1171 next;
1172 }
1173 # Regular quotes.
1174 if ($c eq "'" || $c eq '"') {
1175 if ($sanitise_quote eq '') {
1176 $sanitise_quote = $c;
1177
1178 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001179 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001180 } elsif ($sanitise_quote eq $c) {
1181 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001182 }
1183 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001184
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001185 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001186 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1187 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001188 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1189 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001190 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1191 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001192 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001193 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001194 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001195 }
1196
Daniel Walker113f04a2009-09-21 17:04:35 -07001197 if ($sanitise_quote eq '//') {
1198 $sanitise_quote = '';
1199 }
1200
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001201 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001202 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001203 my $clean = 'X' x length($1);
1204 $res =~ s@\<.*\>@<$clean>@;
1205
1206 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001207 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001208 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001209 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001210 }
1211
Joe Perchesdadf6802016-08-02 14:04:33 -07001212 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1213 my $match = $1;
1214 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1215 }
1216
Andy Whitcroft00df3442007-06-08 13:47:06 -07001217 return $res;
1218}
1219
Joe Perchesa6962d72013-04-29 16:18:13 -07001220sub get_quoted_string {
1221 my ($line, $rawline) = @_;
1222
Joe Perches33acb542015-06-25 15:02:54 -07001223 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001224 return substr($rawline, $-[0], $+[0] - $-[0]);
1225}
1226
Andy Whitcroft8905a672007-11-28 16:21:06 -08001227sub ctx_statement_block {
1228 my ($linenr, $remain, $off) = @_;
1229 my $line = $linenr - 1;
1230 my $blk = '';
1231 my $soff = $off;
1232 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001233 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001234
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001235 my $loff = 0;
1236
Andy Whitcroft8905a672007-11-28 16:21:06 -08001237 my $type = '';
1238 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001239 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001240 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001241 my $c;
1242 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001243
1244 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001245 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001246 @stack = (['', 0]) if ($#stack == -1);
1247
Andy Whitcroft773647a2008-03-28 14:15:58 -07001248 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001249 # If we are about to drop off the end, pull in more
1250 # context.
1251 if ($off >= $len) {
1252 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001253 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001254 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001255 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001256 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001257 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001258 $len = length($blk);
1259 $line++;
1260 last;
1261 }
1262 # Bail if there is no further context.
1263 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001264 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001265 last;
1266 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001267 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1268 $level++;
1269 $type = '#';
1270 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001271 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001272 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001273 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001274 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001275
Andy Whitcroft773647a2008-03-28 14:15:58 -07001276 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001277
1278 # Handle nested #if/#else.
1279 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1280 push(@stack, [ $type, $level ]);
1281 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1282 ($type, $level) = @{$stack[$#stack - 1]};
1283 } elsif ($remainder =~ /^#\s*endif\b/) {
1284 ($type, $level) = @{pop(@stack)};
1285 }
1286
Andy Whitcroft8905a672007-11-28 16:21:06 -08001287 # Statement ends at the ';' or a close '}' at the
1288 # outermost level.
1289 if ($level == 0 && $c eq ';') {
1290 last;
1291 }
1292
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001293 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001294 if ($level == 0 && $coff_set == 0 &&
1295 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1296 $remainder =~ /^(else)(?:\s|{)/ &&
1297 $remainder !~ /^else\s+if\b/) {
1298 $coff = $off + length($1) - 1;
1299 $coff_set = 1;
1300 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1301 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001302 }
1303
Andy Whitcroft8905a672007-11-28 16:21:06 -08001304 if (($type eq '' || $type eq '(') && $c eq '(') {
1305 $level++;
1306 $type = '(';
1307 }
1308 if ($type eq '(' && $c eq ')') {
1309 $level--;
1310 $type = ($level != 0)? '(' : '';
1311
1312 if ($level == 0 && $coff < $soff) {
1313 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001314 $coff_set = 1;
1315 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001316 }
1317 }
1318 if (($type eq '' || $type eq '{') && $c eq '{') {
1319 $level++;
1320 $type = '{';
1321 }
1322 if ($type eq '{' && $c eq '}') {
1323 $level--;
1324 $type = ($level != 0)? '{' : '';
1325
1326 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001327 if (substr($blk, $off + 1, 1) eq ';') {
1328 $off++;
1329 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001330 last;
1331 }
1332 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001333 # Preprocessor commands end at the newline unless escaped.
1334 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1335 $level--;
1336 $type = '';
1337 $off++;
1338 last;
1339 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001340 $off++;
1341 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001342 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001343 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001344 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001345 $line++;
1346 $remain--;
1347 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001348
1349 my $statement = substr($blk, $soff, $off - $soff + 1);
1350 my $condition = substr($blk, $soff, $coff - $soff + 1);
1351
1352 #warn "STATEMENT<$statement>\n";
1353 #warn "CONDITION<$condition>\n";
1354
Andy Whitcroft773647a2008-03-28 14:15:58 -07001355 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001356
1357 return ($statement, $condition,
1358 $line, $remain + 1, $off - $loff + 1, $level);
1359}
1360
Andy Whitcroftcf655042008-03-04 14:28:20 -08001361sub statement_lines {
1362 my ($stmt) = @_;
1363
1364 # Strip the diff line prefixes and rip blank lines at start and end.
1365 $stmt =~ s/(^|\n)./$1/g;
1366 $stmt =~ s/^\s*//;
1367 $stmt =~ s/\s*$//;
1368
1369 my @stmt_lines = ($stmt =~ /\n/g);
1370
1371 return $#stmt_lines + 2;
1372}
1373
1374sub statement_rawlines {
1375 my ($stmt) = @_;
1376
1377 my @stmt_lines = ($stmt =~ /\n/g);
1378
1379 return $#stmt_lines + 2;
1380}
1381
1382sub statement_block_size {
1383 my ($stmt) = @_;
1384
1385 $stmt =~ s/(^|\n)./$1/g;
1386 $stmt =~ s/^\s*{//;
1387 $stmt =~ s/}\s*$//;
1388 $stmt =~ s/^\s*//;
1389 $stmt =~ s/\s*$//;
1390
1391 my @stmt_lines = ($stmt =~ /\n/g);
1392 my @stmt_statements = ($stmt =~ /;/g);
1393
1394 my $stmt_lines = $#stmt_lines + 2;
1395 my $stmt_statements = $#stmt_statements + 1;
1396
1397 if ($stmt_lines > $stmt_statements) {
1398 return $stmt_lines;
1399 } else {
1400 return $stmt_statements;
1401 }
1402}
1403
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001404sub ctx_statement_full {
1405 my ($linenr, $remain, $off) = @_;
1406 my ($statement, $condition, $level);
1407
1408 my (@chunks);
1409
Andy Whitcroftcf655042008-03-04 14:28:20 -08001410 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001411 ($statement, $condition, $linenr, $remain, $off, $level) =
1412 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001413 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001414 push(@chunks, [ $condition, $statement ]);
1415 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1416 return ($level, $linenr, @chunks);
1417 }
1418
1419 # Pull in the following conditional/block pairs and see if they
1420 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001421 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001422 ($statement, $condition, $linenr, $remain, $off, $level) =
1423 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001424 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001425 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001426 #print "C: push\n";
1427 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001428 }
1429
1430 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001431}
1432
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001433sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001434 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001435 my $line;
1436 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001437 my $blk = '';
1438 my @o;
1439 my @c;
1440 my @res = ();
1441
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001442 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001443 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001444 for ($line = $start; $remain > 0; $line++) {
1445 next if ($rawlines[$line] =~ /^-/);
1446 $remain--;
1447
1448 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001449
1450 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001451 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001452 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001453 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001454 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001455 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001456 $level = pop(@stack);
1457 }
1458
Andy Whitcroft01464f32010-10-26 14:23:19 -07001459 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001460 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1461 if ($off > 0) {
1462 $off--;
1463 next;
1464 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001465
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001466 if ($c eq $close && $level > 0) {
1467 $level--;
1468 last if ($level == 0);
1469 } elsif ($c eq $open) {
1470 $level++;
1471 }
1472 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001473
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001474 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001475 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001476 }
1477
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001478 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001479 }
1480
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001481 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001482}
1483sub ctx_block_outer {
1484 my ($linenr, $remain) = @_;
1485
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001486 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1487 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001488}
1489sub ctx_block {
1490 my ($linenr, $remain) = @_;
1491
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001492 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1493 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001494}
1495sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001496 my ($linenr, $remain, $off) = @_;
1497
1498 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1499 return @r;
1500}
1501sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001502 my ($linenr, $remain) = @_;
1503
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001504 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001505}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001506sub ctx_statement_level {
1507 my ($linenr, $remain, $off) = @_;
1508
1509 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1510}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001511
1512sub ctx_locate_comment {
1513 my ($first_line, $end_line) = @_;
1514
1515 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001516 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001517 return $current_comment if (defined $current_comment);
1518
1519 # Look through the context and try and figure out if there is a
1520 # comment.
1521 my $in_comment = 0;
1522 $current_comment = '';
1523 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001524 my $line = $rawlines[$linenr - 1];
1525 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001526 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1527 $in_comment = 1;
1528 }
1529 if ($line =~ m@/\*@) {
1530 $in_comment = 1;
1531 }
1532 if (!$in_comment && $current_comment ne '') {
1533 $current_comment = '';
1534 }
1535 $current_comment .= $line . "\n" if ($in_comment);
1536 if ($line =~ m@\*/@) {
1537 $in_comment = 0;
1538 }
1539 }
1540
1541 chomp($current_comment);
1542 return($current_comment);
1543}
1544sub ctx_has_comment {
1545 my ($first_line, $end_line) = @_;
1546 my $cmt = ctx_locate_comment($first_line, $end_line);
1547
Andy Whitcroft00df3442007-06-08 13:47:06 -07001548 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001549 ##print "CMMT: $cmt\n";
1550
1551 return ($cmt ne '');
1552}
1553
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001554sub raw_line {
1555 my ($linenr, $cnt) = @_;
1556
1557 my $offset = $linenr - 1;
1558 $cnt++;
1559
1560 my $line;
1561 while ($cnt) {
1562 $line = $rawlines[$offset++];
1563 next if (defined($line) && $line =~ /^-/);
1564 $cnt--;
1565 }
1566
1567 return $line;
1568}
1569
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001570sub cat_vet {
1571 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001572 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001573
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001574 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001575 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1576 $res .= $1;
1577 if ($2 ne '') {
1578 $coded = sprintf("^%c", unpack('C', $2) + 64);
1579 $res .= $coded;
1580 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001581 }
1582 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001583
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001584 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001585}
1586
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001587my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001588my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001589my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001590my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001591
1592sub annotate_reset {
1593 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001594 $av_pending = '_';
1595 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001596 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001597}
1598
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001599sub annotate_values {
1600 my ($stream, $type) = @_;
1601
1602 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001603 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001604 my $cur = $stream;
1605
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001606 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001607
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001608 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001609 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001610 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001611 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001612 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001613 print "WS($1)\n" if ($dbg_values > 1);
1614 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001615 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001616 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001617 }
1618
Florian Micklerc023e4732011-01-12 16:59:58 -08001619 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001620 print "CAST($1)\n" if ($dbg_values > 1);
1621 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001622 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001623
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001624 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001625 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001626 $type = 'T';
1627
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001628 } elsif ($cur =~ /^($Modifier)\s*/) {
1629 print "MODIFIER($1)\n" if ($dbg_values > 1);
1630 $type = 'T';
1631
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001632 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001633 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001634 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001635 push(@av_paren_type, $type);
1636 if ($2 ne '') {
1637 $av_pending = 'N';
1638 }
1639 $type = 'E';
1640
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001641 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001642 print "UNDEF($1)\n" if ($dbg_values > 1);
1643 $av_preprocessor = 1;
1644 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001645
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001646 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001647 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001648 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001649
1650 push(@av_paren_type, $type);
1651 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001652 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001653
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001654 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001655 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1656 $av_preprocessor = 1;
1657
1658 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1659
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001660 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001661
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001662 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001663 print "PRE_END($1)\n" if ($dbg_values > 1);
1664
1665 $av_preprocessor = 1;
1666
1667 # Assume all arms of the conditional end as this
1668 # one does, and continue as if the #endif was not here.
1669 pop(@av_paren_type);
1670 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001671 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001672
1673 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001674 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001675
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001676 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1677 print "ATTR($1)\n" if ($dbg_values > 1);
1678 $av_pending = $type;
1679 $type = 'N';
1680
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001681 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001682 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001683 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001684 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001685 }
1686 $type = 'N';
1687
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001688 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001689 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001690 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001691 $type = 'N';
1692
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001693 } elsif ($cur =~/^(case)/o) {
1694 print "CASE($1)\n" if ($dbg_values > 1);
1695 $av_pend_colon = 'C';
1696 $type = 'N';
1697
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001698 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001699 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001700 $type = 'N';
1701
1702 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001703 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001704 push(@av_paren_type, $av_pending);
1705 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001706 $type = 'N';
1707
1708 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001709 my $new_type = pop(@av_paren_type);
1710 if ($new_type ne '_') {
1711 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001712 print "PAREN('$1') -> $type\n"
1713 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001714 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001715 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001716 }
1717
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001718 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001719 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001720 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001721 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001722
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001723 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1724 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001725 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001726 } elsif ($type eq 'E') {
1727 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001728 }
1729 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1730 $type = 'V';
1731
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001732 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001733 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001734 $type = 'V';
1735
1736 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001737 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001738 $type = 'N';
1739
Andy Whitcroftcf655042008-03-04 14:28:20 -08001740 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001741 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001742 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001743 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001744
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001745 } elsif ($cur =~/^(,)/) {
1746 print "COMMA($1)\n" if ($dbg_values > 1);
1747 $type = 'C';
1748
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001749 } elsif ($cur =~ /^(\?)/o) {
1750 print "QUESTION($1)\n" if ($dbg_values > 1);
1751 $type = 'N';
1752
1753 } elsif ($cur =~ /^(:)/o) {
1754 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1755
1756 substr($var, length($res), 1, $av_pend_colon);
1757 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1758 $type = 'E';
1759 } else {
1760 $type = 'N';
1761 }
1762 $av_pend_colon = 'O';
1763
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001764 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001765 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001766 $type = 'N';
1767
Andy Whitcroft0d413862008-10-15 22:02:16 -07001768 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001769 my $variant;
1770
1771 print "OPV($1)\n" if ($dbg_values > 1);
1772 if ($type eq 'V') {
1773 $variant = 'B';
1774 } else {
1775 $variant = 'U';
1776 }
1777
1778 substr($var, length($res), 1, $variant);
1779 $type = 'N';
1780
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001781 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001782 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001783 if ($1 ne '++' && $1 ne '--') {
1784 $type = 'N';
1785 }
1786
1787 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001788 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001789 }
1790 if (defined $1) {
1791 $cur = substr($cur, length($1));
1792 $res .= $type x length($1);
1793 }
1794 }
1795
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001796 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001797}
1798
Andy Whitcroft8905a672007-11-28 16:21:06 -08001799sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001800 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001801 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001802 ^(?:
1803 $Modifier|
1804 $Storage|
1805 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001806 DEFINE_\S+
1807 )$|
1808 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001809 goto|
1810 return|
1811 case|
1812 else|
1813 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001814 do|
1815 \#|
1816 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001817 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001818 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001819 )}x;
1820 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1821 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001822 # Check for modifiers.
1823 $possible =~ s/\s*$Storage\s*//g;
1824 $possible =~ s/\s*$Sparse\s*//g;
1825 if ($possible =~ /^\s*$/) {
1826
1827 } elsif ($possible =~ /\s/) {
1828 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001829 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001830 if ($modifier !~ $notPermitted) {
1831 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001832 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001833 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001834 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001835
1836 } else {
1837 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001838 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001839 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001840 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001841 } else {
1842 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001843 }
1844}
1845
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001846my $prefix = '';
1847
Joe Perches000d1cc12011-07-25 17:13:25 -07001848sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001849 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001850
Joe Perchescbec18a2014-04-03 14:49:19 -07001851 return defined $use_type{$type} if (scalar keys %use_type > 0);
1852
1853 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001854}
1855
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001856sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001857 my ($level, $type, $msg) = @_;
1858
1859 if (!show_type($type) ||
1860 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001861 return 0;
1862 }
Joe Perches57230292015-06-25 15:03:03 -07001863 my $output = '';
1864 if (-t STDOUT && $color) {
1865 if ($level eq 'ERROR') {
1866 $output .= RED;
1867 } elsif ($level eq 'WARNING') {
1868 $output .= YELLOW;
1869 } else {
1870 $output .= GREEN;
1871 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001872 }
Joe Perches57230292015-06-25 15:03:03 -07001873 $output .= $prefix . $level . ':';
1874 if ($show_types) {
1875 $output .= BLUE if (-t STDOUT && $color);
1876 $output .= "$type:";
1877 }
1878 $output .= RESET if (-t STDOUT && $color);
1879 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001880
1881 if ($showfile) {
1882 my @lines = split("\n", $output, -1);
1883 splice(@lines, 1, 1);
1884 $output = join("\n", @lines);
1885 }
Joe Perches57230292015-06-25 15:03:03 -07001886 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001887
Joe Perches57230292015-06-25 15:03:03 -07001888 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001889
1890 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001891}
Joe Perchescbec18a2014-04-03 14:49:19 -07001892
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001893sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001894 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001895}
Joe Perches000d1cc12011-07-25 17:13:25 -07001896
Joe Perchesd752fcc2014-08-06 16:11:05 -07001897sub fixup_current_range {
1898 my ($lineRef, $offset, $length) = @_;
1899
1900 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1901 my $o = $1;
1902 my $l = $2;
1903 my $no = $o + $offset;
1904 my $nl = $l + $length;
1905 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1906 }
1907}
1908
1909sub fix_inserted_deleted_lines {
1910 my ($linesRef, $insertedRef, $deletedRef) = @_;
1911
1912 my $range_last_linenr = 0;
1913 my $delta_offset = 0;
1914
1915 my $old_linenr = 0;
1916 my $new_linenr = 0;
1917
1918 my $next_insert = 0;
1919 my $next_delete = 0;
1920
1921 my @lines = ();
1922
1923 my $inserted = @{$insertedRef}[$next_insert++];
1924 my $deleted = @{$deletedRef}[$next_delete++];
1925
1926 foreach my $old_line (@{$linesRef}) {
1927 my $save_line = 1;
1928 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001929 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001930 $delta_offset = 0;
1931 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1932 $range_last_linenr = $new_linenr;
1933 fixup_current_range(\$line, $delta_offset, 0);
1934 }
1935
1936 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1937 $deleted = @{$deletedRef}[$next_delete++];
1938 $save_line = 0;
1939 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1940 }
1941
1942 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1943 push(@lines, ${$inserted}{'LINE'});
1944 $inserted = @{$insertedRef}[$next_insert++];
1945 $new_linenr++;
1946 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1947 }
1948
1949 if ($save_line) {
1950 push(@lines, $line);
1951 $new_linenr++;
1952 }
1953
1954 $old_linenr++;
1955 }
1956
1957 return @lines;
1958}
1959
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001960sub fix_insert_line {
1961 my ($linenr, $line) = @_;
1962
1963 my $inserted = {
1964 LINENR => $linenr,
1965 LINE => $line,
1966 };
1967 push(@fixed_inserted, $inserted);
1968}
1969
1970sub fix_delete_line {
1971 my ($linenr, $line) = @_;
1972
1973 my $deleted = {
1974 LINENR => $linenr,
1975 LINE => $line,
1976 };
1977
1978 push(@fixed_deleted, $deleted);
1979}
1980
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001981sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001982 my ($type, $msg) = @_;
1983
1984 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001985 our $clean = 0;
1986 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001987 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001988 }
Joe Perches3705ce52013-07-03 15:05:31 -07001989 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001990}
1991sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001992 my ($type, $msg) = @_;
1993
1994 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001995 our $clean = 0;
1996 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001997 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001998 }
Joe Perches3705ce52013-07-03 15:05:31 -07001999 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002000}
2001sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07002002 my ($type, $msg) = @_;
2003
2004 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002005 our $clean = 0;
2006 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07002007 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002008 }
Joe Perches3705ce52013-07-03 15:05:31 -07002009 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002010}
2011
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002012sub check_absolute_file {
2013 my ($absolute, $herecurr) = @_;
2014 my $file = $absolute;
2015
2016 ##print "absolute<$absolute>\n";
2017
2018 # See if any suffix of this path is a path within the tree.
2019 while ($file =~ s@^[^/]*/@@) {
2020 if (-f "$root/$file") {
2021 ##print "file<$file>\n";
2022 last;
2023 }
2024 }
2025 if (! -f _) {
2026 return 0;
2027 }
2028
2029 # It is, so see if the prefix is acceptable.
2030 my $prefix = $absolute;
2031 substr($prefix, -length($file)) = '';
2032
2033 ##print "prefix<$prefix>\n";
2034 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002035 WARN("USE_RELATIVE_PATH",
2036 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002037 }
2038}
2039
Joe Perches3705ce52013-07-03 15:05:31 -07002040sub trim {
2041 my ($string) = @_;
2042
Joe Perchesb34c6482013-09-11 14:24:01 -07002043 $string =~ s/^\s+|\s+$//g;
2044
2045 return $string;
2046}
2047
2048sub ltrim {
2049 my ($string) = @_;
2050
2051 $string =~ s/^\s+//;
2052
2053 return $string;
2054}
2055
2056sub rtrim {
2057 my ($string) = @_;
2058
2059 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002060
2061 return $string;
2062}
2063
Joe Perches52ea8502013-11-12 15:10:09 -08002064sub string_find_replace {
2065 my ($string, $find, $replace) = @_;
2066
2067 $string =~ s/$find/$replace/g;
2068
2069 return $string;
2070}
2071
Joe Perches3705ce52013-07-03 15:05:31 -07002072sub tabify {
2073 my ($leading) = @_;
2074
2075 my $source_indent = 8;
2076 my $max_spaces_before_tab = $source_indent - 1;
2077 my $spaces_to_tab = " " x $source_indent;
2078
2079 #convert leading spaces to tabs
2080 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2081 #Remove spaces before a tab
2082 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2083
2084 return "$leading";
2085}
2086
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002087sub pos_last_openparen {
2088 my ($line) = @_;
2089
2090 my $pos = 0;
2091
2092 my $opens = $line =~ tr/\(/\(/;
2093 my $closes = $line =~ tr/\)/\)/;
2094
2095 my $last_openparen = 0;
2096
2097 if (($opens == 0) || ($closes >= $opens)) {
2098 return -1;
2099 }
2100
2101 my $len = length($line);
2102
2103 for ($pos = 0; $pos < $len; $pos++) {
2104 my $string = substr($line, $pos);
2105 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2106 $pos += length($1) - 1;
2107 } elsif (substr($line, $pos, 1) eq '(') {
2108 $last_openparen = $pos;
2109 } elsif (index($string, '(') == -1) {
2110 last;
2111 }
2112 }
2113
Joe Perches91cb5192014-04-03 14:49:32 -07002114 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002115}
2116
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002117sub process {
2118 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002119
2120 my $linenr=0;
2121 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002122 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002123 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002124 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002125
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002126 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002127 my $indent;
2128 my $previndent=0;
2129 my $stashindent=0;
2130
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002131 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002132 my $signoff = 0;
2133 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002134 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002135 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002136 my $has_commit_log = 0; #Encountered lines before patch
Joe Perches77cb8542017-02-24 15:01:28 -08002137 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002138 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002139 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002140 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002141 my $non_utf8_charset = 0;
2142
Joe Perches365dd4e2014-08-06 16:10:42 -07002143 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002144 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002145
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002146 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002147 our $cnt_lines = 0;
2148 our $cnt_error = 0;
2149 our $cnt_warn = 0;
2150 our $cnt_chk = 0;
2151
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002152 # Trace the real file/line as we go.
2153 my $realfile = '';
2154 my $realline = 0;
2155 my $realcnt = 0;
2156 my $here = '';
Joe Perches77cb8542017-02-24 15:01:28 -08002157 my $context_function; #undef'd unless there's a known function
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002158 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002159 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002160 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002161 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002162
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002163 my $prev_values = 'E';
2164
2165 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002166 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002167 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002168 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002169 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002170
Joe Perches7e51f192013-09-11 14:23:57 -07002171 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002172
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002173 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002174 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002175 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002176 my @setup_docs = ();
2177 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002178
Joe Perchesd8b07712013-11-12 15:10:06 -08002179 my $camelcase_file_seeded = 0;
2180
Andy Whitcroft773647a2008-03-28 14:15:58 -07002181 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002182 my $line;
2183 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002184 $linenr++;
2185 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002186
Joe Perches3705ce52013-07-03 15:05:31 -07002187 push(@fixed, $rawline) if ($fix);
2188
Andy Whitcroft773647a2008-03-28 14:15:58 -07002189 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002190 $setup_docs = 0;
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02002191 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.rst$@) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002192 $setup_docs = 1;
2193 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002194 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002195 }
Joe Perches77cb8542017-02-24 15:01:28 -08002196 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) {
2197 my $context = $4;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002198 $realline=$1-1;
2199 if (defined $2) {
2200 $realcnt=$3+1;
2201 } else {
2202 $realcnt=1+1;
2203 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002204 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002205
Joe Perches77cb8542017-02-24 15:01:28 -08002206 if ($context =~ /\b(\w+)\s*\(/) {
2207 $context_function = $1;
2208 } else {
2209 undef $context_function;
2210 }
2211
Andy Whitcroft773647a2008-03-28 14:15:58 -07002212 # Guestimate if this is a continuing comment. Run
2213 # the context looking for a comment "edge". If this
2214 # edge is a close comment then we must be in a comment
2215 # at context start.
2216 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002217 my $cnt = $realcnt;
2218 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2219 next if (defined $rawlines[$ln - 1] &&
2220 $rawlines[$ln - 1] =~ /^-/);
2221 $cnt--;
2222 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002223 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002224 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2225 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2226 ($edge) = $1;
2227 last;
2228 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002229 }
2230 if (defined $edge && $edge eq '*/') {
2231 $in_comment = 1;
2232 }
2233
2234 # Guestimate if this is a continuing comment. If this
2235 # is the start of a diff block and this line starts
2236 # ' *' then it is very likely a comment.
2237 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002238 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002239 {
2240 $in_comment = 1;
2241 }
2242
2243 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2244 sanitise_line_reset($in_comment);
2245
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002246 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002247 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002248 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002249 $line = sanitise_line($rawline);
2250 }
2251 push(@lines, $line);
2252
2253 if ($realcnt > 1) {
2254 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2255 } else {
2256 $realcnt = 0;
2257 }
2258
2259 #print "==>$rawline\n";
2260 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002261
2262 if ($setup_docs && $line =~ /^\+/) {
2263 push(@setup_docs, $line);
2264 }
2265 }
2266
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002267 $prefix = '';
2268
Andy Whitcroft773647a2008-03-28 14:15:58 -07002269 $realcnt = 0;
2270 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002271 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002272 foreach my $line (@lines) {
2273 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002274 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002275 my $sline = $line; #copy of $line
2276 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002277
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002278 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002279
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002280#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002281 if (!$in_commit_log &&
2282 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002283 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002284 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002285 $realline=$1-1;
2286 if (defined $2) {
2287 $realcnt=$3+1;
2288 } else {
2289 $realcnt=1+1;
2290 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002291 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002292 $prev_values = 'E';
2293
Andy Whitcroft773647a2008-03-28 14:15:58 -07002294 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002295 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002296 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002297 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002298 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002299
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002300# track the line number as we move through the hunk, note that
2301# new versions of GNU diff omit the leading space on completely
2302# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002303 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002304 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002305 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002306
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002307 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002308 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002309
2310 # Track the previous line.
2311 ($prevline, $stashline) = ($stashline, $line);
2312 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002313 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2314
Andy Whitcroft773647a2008-03-28 14:15:58 -07002315 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002316
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002317 } elsif ($realcnt == 1) {
2318 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002319 }
2320
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002321 my $hunk_line = ($realcnt != 0);
2322
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002323 $here = "#$linenr: " if (!$file);
2324 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002325
Joe Perches2ac73b42014-06-04 16:12:05 -07002326 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002327 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002328 if ($line =~ /^diff --git.*?(\S+)$/) {
2329 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002330 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002331 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002332 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002333 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002334 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002335 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002336 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002337
2338 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002339 if (!$file && $tree && $p1_prefix ne '' &&
2340 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002341 WARN("PATCH_PREFIX",
2342 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002343 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002344
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002345 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002346 ERROR("MODIFIED_INCLUDE_ASM",
2347 "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 -07002348 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002349 $found_file = 1;
2350 }
2351
Joe Perches34d88152015-06-25 15:03:05 -07002352#make up the handle for any error we report on this line
2353 if ($showfile) {
2354 $prefix = "$realfile:$realline: "
2355 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002356 if ($file) {
2357 $prefix = "$filename:$realline: ";
2358 } else {
2359 $prefix = "$filename:$linenr: ";
2360 }
Joe Perches34d88152015-06-25 15:03:05 -07002361 }
2362
Joe Perches2ac73b42014-06-04 16:12:05 -07002363 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002364 if (is_maintained_obsolete($realfile)) {
2365 WARN("OBSOLETE",
2366 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2367 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002368 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002369 $check = 1;
2370 } else {
2371 $check = $check_orig;
2372 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002373 next;
2374 }
2375
Randy Dunlap389834b2007-06-08 13:47:03 -07002376 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002377
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002378 my $hereline = "$here\n$rawline\n";
2379 my $herecurr = "$here\n$rawline\n";
2380 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002381
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002382 $cnt_lines++ if ($realcnt != 0);
2383
Joe Perchese518e9a2015-06-25 15:03:27 -07002384# Check if the commit log has what seems like a diff which can confuse patch
2385 if ($in_commit_log && !$commit_log_has_diff &&
2386 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2387 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2388 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2389 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2390 ERROR("DIFF_IN_COMMIT_MSG",
2391 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2392 $commit_log_has_diff = 1;
2393 }
2394
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002395# Check for incorrect file permissions
2396 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2397 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002398 if ($realfile !~ m@scripts/@ &&
2399 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002400 ERROR("EXECUTE_PERMISSIONS",
2401 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002402 }
2403 }
2404
Joe Perches20112472011-07-25 17:13:23 -07002405# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002406 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002407 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002408 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002409 }
2410
Joe Perchese0d975b2014-12-10 15:51:49 -08002411# Check if MAINTAINERS is being updated. If so, there's probably no need to
2412# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2413 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2414 $reported_maintainer_file = 1;
2415 }
2416
Joe Perches20112472011-07-25 17:13:23 -07002417# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002418 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002419 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002420 my $space_before = $1;
2421 my $sign_off = $2;
2422 my $space_after = $3;
2423 my $email = $4;
2424 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2425
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002426 if ($sign_off !~ /$signature_tags/) {
2427 WARN("BAD_SIGN_OFF",
2428 "Non-standard signature: $sign_off\n" . $herecurr);
2429 }
Joe Perches20112472011-07-25 17:13:23 -07002430 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002431 if (WARN("BAD_SIGN_OFF",
2432 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2433 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002434 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002435 "$ucfirst_sign_off $email";
2436 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002437 }
Joe Perches20112472011-07-25 17:13:23 -07002438 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002439 if (WARN("BAD_SIGN_OFF",
2440 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2441 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002442 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002443 "$ucfirst_sign_off $email";
2444 }
2445
Joe Perches20112472011-07-25 17:13:23 -07002446 }
2447 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002448 if (WARN("BAD_SIGN_OFF",
2449 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2450 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002451 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002452 "$ucfirst_sign_off $email";
2453 }
Joe Perches20112472011-07-25 17:13:23 -07002454 }
2455
2456 my ($email_name, $email_address, $comment) = parse_email($email);
2457 my $suggested_email = format_email(($email_name, $email_address));
2458 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002459 ERROR("BAD_SIGN_OFF",
2460 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002461 } else {
2462 my $dequoted = $suggested_email;
2463 $dequoted =~ s/^"//;
2464 $dequoted =~ s/" </ </;
2465 # Don't force email to have quotes
2466 # Allow just an angle bracketed address
2467 if ("$dequoted$comment" ne $email &&
2468 "<$email_address>$comment" ne $email &&
2469 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002470 WARN("BAD_SIGN_OFF",
2471 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002472 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002473 }
Joe Perches7e51f192013-09-11 14:23:57 -07002474
2475# Check for duplicate signatures
2476 my $sig_nospace = $line;
2477 $sig_nospace =~ s/\s//g;
2478 $sig_nospace = lc($sig_nospace);
2479 if (defined $signatures{$sig_nospace}) {
2480 WARN("BAD_SIGN_OFF",
2481 "Duplicate signature\n" . $herecurr);
2482 } else {
2483 $signatures{$sig_nospace} = 1;
2484 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002485 }
2486
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002487# Check email subject for common tools that don't need to be mentioned
2488 if ($in_header_lines &&
2489 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2490 WARN("EMAIL_SUBJECT",
2491 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2492 }
2493
Joe Perches9b3189e2014-06-04 16:12:10 -07002494# Check for old stable address
2495 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2496 ERROR("STABLE_ADDRESS",
2497 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2498 }
2499
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002500# Check for unwanted Gerrit info
2501 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2502 ERROR("GERRIT_CHANGE_ID",
2503 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2504 }
2505
Joe Perches369c8dd2015-11-06 16:31:34 -08002506# Check if the commit log is in a possible stack dump
2507 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2508 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2509 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2510 # timestamp
2511 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2512 # stack dump address
2513 $commit_log_possible_stack_dump = 1;
2514 }
2515
Joe Perches2a076f42015-04-16 12:44:28 -07002516# Check for line lengths > 75 in commit log, warn once
2517 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002518 length($line) > 75 &&
2519 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2520 # file delta changes
2521 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2522 # filename then :
2523 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2524 # A Fixes: or Link: line
2525 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002526 WARN("COMMIT_LOG_LONG_LINE",
2527 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2528 $commit_log_long_line = 1;
2529 }
2530
Joe Perchesbf4daf12015-09-09 15:37:50 -07002531# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002532 if ($in_commit_log && $commit_log_possible_stack_dump &&
2533 $line =~ /^\s*$/) {
2534 $commit_log_possible_stack_dump = 0;
2535 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002536
Joe Perches0d7835f2015-02-13 14:38:35 -08002537# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002538 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002539 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002540 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002541 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002542 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2543 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002544 my $init_char = "c";
2545 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002546 my $short = 1;
2547 my $long = 0;
2548 my $case = 1;
2549 my $space = 1;
2550 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002551 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002552 my $id = '0123456789ab';
2553 my $orig_desc = "commit description";
2554 my $description = "";
2555
Joe Perchesfe043ea2015-09-09 15:37:25 -07002556 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2557 $init_char = $1;
2558 $orig_commit = lc($2);
2559 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2560 $orig_commit = lc($1);
2561 }
2562
Joe Perches0d7835f2015-02-13 14:38:35 -08002563 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2564 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2565 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2566 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2567 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2568 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002569 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002570 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2571 defined $rawlines[$linenr] &&
2572 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2573 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002574 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002575 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2576 defined $rawlines[$linenr] &&
2577 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2578 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2579 $orig_desc = $1;
2580 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2581 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002582 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002583 }
2584
2585 ($id, $description) = git_commit_info($orig_commit,
2586 $id, $orig_desc);
2587
Joe Perches19c146a2015-02-13 14:39:00 -08002588 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002589 ERROR("GIT_COMMIT_ID",
2590 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2591 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002592 }
2593
Joe Perches13f19372014-08-06 16:10:59 -07002594# Check for added, moved or deleted files
2595 if (!$reported_maintainer_file && !$in_commit_log &&
2596 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2597 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2598 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2599 (defined($1) || defined($2))))) {
Andrew Jefferya82603a2016-12-12 16:46:37 -08002600 $is_patch = 1;
Joe Perches13f19372014-08-06 16:10:59 -07002601 $reported_maintainer_file = 1;
2602 WARN("FILE_PATH_CHANGES",
2603 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2604 }
2605
Andy Whitcroft00df3442007-06-08 13:47:06 -07002606# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002607 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002608 ERROR("CORRUPTED_PATCH",
2609 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002610 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002611 }
2612
2613# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2614 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002615 $rawline !~ m/^$UTF8*$/) {
2616 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2617
2618 my $blank = copy_spacing($rawline);
2619 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2620 my $hereptr = "$hereline$ptr\n";
2621
Joe Perches34d99212011-07-25 17:13:26 -07002622 CHK("INVALID_UTF8",
2623 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002624 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002625
Joe Perches15662b32011-10-31 17:13:12 -07002626# Check if it's the start of a commit log
2627# (not a header line and we haven't seen the patch filename)
2628 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002629 !($rawline =~ /^\s+\S/ ||
2630 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002631 $in_header_lines = 0;
2632 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002633 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002634 }
2635
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002636# Check if there is UTF-8 in a commit log when a mail header has explicitly
2637# declined it, i.e defined some charset where it is missing.
2638 if ($in_header_lines &&
2639 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2640 $1 !~ /utf-8/i) {
2641 $non_utf8_charset = 1;
2642 }
2643
2644 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002645 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002646 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002647 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2648 }
2649
Joe Perchesd6430f72016-12-12 16:46:28 -08002650# Check for absolute kernel paths in commit message
2651 if ($tree && $in_commit_log) {
2652 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2653 my $file = $1;
2654
2655 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2656 check_absolute_file($1, $herecurr)) {
2657 #
2658 } else {
2659 check_absolute_file($file, $herecurr);
2660 }
2661 }
2662 }
2663
Kees Cook66b47b42014-10-13 15:51:57 -07002664# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002665 if (defined($misspellings) &&
2666 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002667 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002668 my $typo = $1;
2669 my $typo_fix = $spelling_fix{lc($typo)};
2670 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2671 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2672 my $msg_type = \&WARN;
2673 $msg_type = \&CHK if ($file);
2674 if (&{$msg_type}("TYPO_SPELLING",
2675 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2676 $fix) {
2677 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2678 }
2679 }
2680 }
2681
Andy Whitcroft306708542008-10-15 22:02:28 -07002682# ignore non-hunk lines and lines being removed
2683 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002684
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002685#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002686 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002687 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002688 if (ERROR("DOS_LINE_ENDINGS",
2689 "DOS line endings\n" . $herevet) &&
2690 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002691 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002692 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002693 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2694 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002695 if (ERROR("TRAILING_WHITESPACE",
2696 "trailing whitespace\n" . $herevet) &&
2697 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002698 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002699 }
2700
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002701 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002702 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002703
Josh Triplett4783f892013-11-12 15:10:12 -08002704# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002705 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002706 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2707 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002708 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2709 my $msg_type = \&ERROR;
2710 $msg_type = \&CHK if ($file);
2711 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002712 "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 -08002713 }
2714
Andi Kleen33549572010-05-24 14:33:29 -07002715# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002716# Only applies when adding the entry originally, after that we do not have
2717# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002718 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002719 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002720 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002721 my $cnt = $realcnt;
2722 my $ln = $linenr + 1;
2723 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002724 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002725 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002726 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002727 $f = $lines[$ln - 1];
2728 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2729 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002730
2731 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002732 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002733
Joe Perches8d73e0e2014-08-06 16:10:46 -07002734 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002735 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002736 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002737 $length = -1;
2738 }
2739
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002740 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002741 $f =~ s/#.*//;
2742 $f =~ s/^\s+//;
2743 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002744 if ($f =~ /^\s*config\s/) {
2745 $is_end = 1;
2746 last;
2747 }
Andi Kleen33549572010-05-24 14:33:29 -07002748 $length++;
2749 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002750 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2751 WARN("CONFIG_DESCRIPTION",
2752 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2753 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002754 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002755 }
2756
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002757# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2758 if ($realfile =~ /Kconfig/ &&
2759 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2760 WARN("CONFIG_EXPERIMENTAL",
2761 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2762 }
2763
Christoph Jaeger327953e2015-02-13 14:38:29 -08002764# discourage the use of boolean for type definition attributes of Kconfig options
2765 if ($realfile =~ /Kconfig/ &&
2766 $line =~ /^\+\s*\bboolean\b/) {
2767 WARN("CONFIG_TYPE_BOOLEAN",
2768 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2769 }
2770
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002771 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2772 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2773 my $flag = $1;
2774 my $replacement = {
2775 'EXTRA_AFLAGS' => 'asflags-y',
2776 'EXTRA_CFLAGS' => 'ccflags-y',
2777 'EXTRA_CPPFLAGS' => 'cppflags-y',
2778 'EXTRA_LDFLAGS' => 'ldflags-y',
2779 };
2780
2781 WARN("DEPRECATED_VARIABLE",
2782 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2783 }
2784
Rob Herringbff5da42014-01-23 15:54:51 -08002785# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002786 if (defined $root &&
2787 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2788 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2789
Rob Herringbff5da42014-01-23 15:54:51 -08002790 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2791
Florian Vaussardcc933192014-04-03 14:49:27 -07002792 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2793 my $vp_file = $dt_path . "vendor-prefixes.txt";
2794
Rob Herringbff5da42014-01-23 15:54:51 -08002795 foreach my $compat (@compats) {
2796 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002797 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2798 my $compat3 = $compat;
2799 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2800 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002801 if ( $? >> 8 ) {
2802 WARN("UNDOCUMENTED_DT_STRING",
2803 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2804 }
2805
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002806 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2807 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002808 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002809 if ( $? >> 8 ) {
2810 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002811 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002812 }
2813 }
2814 }
2815
Andy Whitcroft5368df202008-10-15 22:02:27 -07002816# check we are in a valid source file if not then ignore this hunk
Joe Perchesd6430f72016-12-12 16:46:28 -08002817 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002818
Joe Perches47e0c882015-06-25 15:02:57 -07002819# line length limit (with some exclusions)
2820#
2821# There are a few types of lines that may extend beyond $max_line_length:
2822# logging functions like pr_info that end in a string
2823# lines with a single string
2824# #defines that are a single string
2825#
2826# There are 3 different line length message types:
2827# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2828# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2829# LONG_LINE all other lines longer than $max_line_length
2830#
2831# if LONG_LINE is ignored, the other 2 types are also ignored
2832#
2833
Joe Perchesb4749e92015-07-17 16:24:01 -07002834 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002835 my $msg_type = "LONG_LINE";
2836
2837 # Check the allowed long line types first
2838
2839 # logging functions that end in a string that starts
2840 # before $max_line_length
2841 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2842 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2843 $msg_type = "";
2844
2845 # lines with only strings (w/ possible termination)
2846 # #defines with only strings
2847 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2848 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2849 $msg_type = "";
2850
Joe Perchesd560a5f2016-08-02 14:04:31 -07002851 # EFI_GUID is another special case
2852 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2853 $msg_type = "";
2854
Joe Perches47e0c882015-06-25 15:02:57 -07002855 # Otherwise set the alternate message types
2856
2857 # a comment starts before $max_line_length
2858 } elsif ($line =~ /($;[\s$;]*)$/ &&
2859 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2860 $msg_type = "LONG_LINE_COMMENT"
2861
2862 # a quoted string starts before $max_line_length
2863 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2864 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2865 $msg_type = "LONG_LINE_STRING"
2866 }
2867
2868 if ($msg_type ne "" &&
2869 (show_type("LONG_LINE") || show_type($msg_type))) {
2870 WARN($msg_type,
2871 "line over $max_line_length characters\n" . $herecurr);
2872 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002873 }
2874
Andy Whitcroft8905a672007-11-28 16:21:06 -08002875# check for adding lines without a newline.
2876 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002877 WARN("MISSING_EOF_NEWLINE",
2878 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002879 }
2880
Mike Frysinger42e41c52009-09-21 17:04:40 -07002881# Blackfin: use hi/lo macros
2882 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2883 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2884 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002885 ERROR("LO_MACRO",
2886 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002887 }
2888 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2889 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002890 ERROR("HI_MACRO",
2891 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002892 }
2893 }
2894
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002895# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002896 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002897
2898# at the beginning of a line any tabs must come first and anything
2899# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002900 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2901 $rawline =~ /^\+\s* \s*/) {
2902 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002903 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002904 if (ERROR("CODE_INDENT",
2905 "code indent should use tabs where possible\n" . $herevet) &&
2906 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002907 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002908 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002909 }
2910
Alberto Panizzo08e44362010-03-05 13:43:54 -08002911# check for space before tabs.
2912 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2913 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002914 if (WARN("SPACE_BEFORE_TAB",
2915 "please, no space before tabs\n" . $herevet) &&
2916 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002917 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002918 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002919 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002920 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002921 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002922 }
2923
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002924# check for && or || at the start of a line
2925 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2926 CHK("LOGICAL_CONTINUATIONS",
2927 "Logical continuations should be on the previous line\n" . $hereprev);
2928 }
2929
Joe Perchesa91e8992016-05-20 17:04:05 -07002930# check indentation starts on a tab stop
2931 if ($^V && $^V ge 5.10.0 &&
2932 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2933 my $indent = length($1);
2934 if ($indent % 8) {
2935 if (WARN("TABSTOP",
2936 "Statements should start on a tabstop\n" . $herecurr) &&
2937 $fix) {
2938 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2939 }
2940 }
2941 }
2942
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002943# check multi-line statement indentation matches previous line
2944 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002945 $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 -07002946 $prevline =~ /^\+(\t*)(.*)$/;
2947 my $oldindent = $1;
2948 my $rest = $2;
2949
2950 my $pos = pos_last_openparen($rest);
2951 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002952 $line =~ /^(\+| )([ \t]*)/;
2953 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002954
2955 my $goodtabindent = $oldindent .
2956 "\t" x ($pos / 8) .
2957 " " x ($pos % 8);
2958 my $goodspaceindent = $oldindent . " " x $pos;
2959
2960 if ($newindent ne $goodtabindent &&
2961 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002962
2963 if (CHK("PARENTHESIS_ALIGNMENT",
2964 "Alignment should match open parenthesis\n" . $hereprev) &&
2965 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002966 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002967 s/^\+[ \t]*/\+$goodtabindent/;
2968 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002969 }
2970 }
2971 }
2972
Joe Perches6ab3a972015-04-16 12:44:05 -07002973# check for space after cast like "(int) foo" or "(struct foo) bar"
2974# avoid checking a few false positives:
2975# "sizeof(<type>)" or "__alignof__(<type>)"
2976# function pointer declarations like "(*foo)(int) = bar;"
2977# structure definitions like "(struct foo) { 0 };"
2978# multiline macros that define functions
2979# known attributes or the __attribute__ keyword
2980 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2981 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002982 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002983 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002984 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002985 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002986 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002987 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002988 }
2989
Joe Perches86406b12015-09-09 15:37:41 -07002990# Block comment styles
2991# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002992 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002993 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002994 $rawline =~ /^\+[ \t]*\*/ &&
2995 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002996 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2997 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2998 }
2999
Joe Perches86406b12015-09-09 15:37:41 -07003000# Block comments use * on subsequent lines
3001 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3002 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003003 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003004 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003005 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003006 WARN("BLOCK_COMMENT_STYLE",
3007 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003008 }
3009
Joe Perches86406b12015-09-09 15:37:41 -07003010# Block comments use */ on trailing lines
3011 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003012 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3013 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3014 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003015 WARN("BLOCK_COMMENT_STYLE",
3016 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003017 }
3018
Joe Perches08eb9b82016-10-11 13:51:50 -07003019# Block comment * alignment
3020 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003021 $line =~ /^\+[ \t]*$;/ && #leading comment
3022 $rawline =~ /^\+[ \t]*\*/ && #leading *
3023 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003024 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003025 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3026 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003027 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003028 if (defined($1)) {
3029 $oldindent = expand_tabs($1);
3030 } else {
3031 $prevrawline =~ m@^\+(.*/?)\*@;
3032 $oldindent = expand_tabs($1);
3033 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003034 $rawline =~ m@^\+([ \t]*)\*@;
3035 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003036 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003037 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003038 WARN("BLOCK_COMMENT_STYLE",
3039 "Block comments should align the * on each line\n" . $hereprev);
3040 }
3041 }
3042
Joe Perches7f619192014-08-06 16:10:39 -07003043# check for missing blank lines after struct/union declarations
3044# with exceptions for various attributes and macros
3045 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3046 $line =~ /^\+/ &&
3047 !($line =~ /^\+\s*$/ ||
3048 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3049 $line =~ /^\+\s*MODULE_/i ||
3050 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3051 $line =~ /^\+[a-z_]*init/ ||
3052 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3053 $line =~ /^\+\s*DECLARE/ ||
3054 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003055 if (CHK("LINE_SPACING",
3056 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3057 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003058 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003059 }
Joe Perches7f619192014-08-06 16:10:39 -07003060 }
3061
Joe Perches365dd4e2014-08-06 16:10:42 -07003062# check for multiple consecutive blank lines
3063 if ($prevline =~ /^[\+ ]\s*$/ &&
3064 $line =~ /^\+\s*$/ &&
3065 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003066 if (CHK("LINE_SPACING",
3067 "Please don't use multiple blank lines\n" . $hereprev) &&
3068 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003069 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003070 }
3071
Joe Perches365dd4e2014-08-06 16:10:42 -07003072 $last_blank_line = $linenr;
3073 }
3074
Joe Perches3b617e32014-04-03 14:49:28 -07003075# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003076 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3077 # actual declarations
3078 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003079 # function pointer declarations
3080 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003081 # foo bar; where foo is some local typedef or #define
3082 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3083 # known declaration macros
3084 $prevline =~ /^\+\s+$declaration_macros/) &&
3085 # for "else if" which can look like "$Ident $Ident"
3086 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3087 # other possible extensions of declaration lines
3088 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3089 # not starting a section or a macro "\" extended line
3090 $prevline =~ /(?:\{\s*|\\)$/) &&
3091 # looks like a declaration
3092 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003093 # function pointer declarations
3094 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003095 # foo bar; where foo is some local typedef or #define
3096 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3097 # known declaration macros
3098 $sline =~ /^\+\s+$declaration_macros/ ||
3099 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003100 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003101 # start or end of block or continuation of declaration
3102 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3103 # bitfield continuation
3104 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3105 # other possible extensions of declaration lines
3106 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3107 # indentation of previous and current line are the same
3108 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003109 if (WARN("LINE_SPACING",
3110 "Missing a blank line after declarations\n" . $hereprev) &&
3111 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003112 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003113 }
Joe Perches3b617e32014-04-03 14:49:28 -07003114 }
3115
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003116# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003117# Exceptions:
3118# 1) within comments
3119# 2) indented preprocessor commands
3120# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003121 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003122 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003123 if (WARN("LEADING_SPACE",
3124 "please, no spaces at the start of a line\n" . $herevet) &&
3125 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003126 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003127 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003128 }
3129
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003130# check we are in a valid C source file if not then ignore this hunk
3131 next if ($realfile !~ /\.(h|c)$/);
3132
Joe Perches032a4c02014-08-06 16:10:29 -07003133# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003134# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003135# if the previous line is a break or return and is indented 1 tab more...
3136 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3137 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003138 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3139 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3140 defined $lines[$linenr] &&
3141 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003142 WARN("UNNECESSARY_ELSE",
3143 "else is not generally useful after a break or return\n" . $hereprev);
3144 }
3145 }
3146
Joe Perchesc00df192014-08-06 16:11:01 -07003147# check indentation of a line with a break;
3148# if the previous line is a goto or return and is indented the same # of tabs
3149 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3150 my $tabs = $1;
3151 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3152 WARN("UNNECESSARY_BREAK",
3153 "break is not useful after a goto or return\n" . $hereprev);
3154 }
3155 }
3156
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003157# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3158 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3159 WARN("CONFIG_EXPERIMENTAL",
3160 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3161 }
3162
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003163# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003164 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003165 WARN("CVS_KEYWORD",
3166 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003167 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003168
Mike Frysinger42e41c52009-09-21 17:04:40 -07003169# Blackfin: don't use __builtin_bfin_[cs]sync
3170 if ($line =~ /__builtin_bfin_csync/) {
3171 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003172 ERROR("CSYNC",
3173 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003174 }
3175 if ($line =~ /__builtin_bfin_ssync/) {
3176 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003177 ERROR("SSYNC",
3178 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003179 }
3180
Joe Perches56e77d72013-02-21 16:44:14 -08003181# check for old HOTPLUG __dev<foo> section markings
3182 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3183 WARN("HOTPLUG_SECTION",
3184 "Using $1 is unnecessary\n" . $herecurr);
3185 }
3186
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003187# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003188 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3189 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003190#print "LINE<$line>\n";
3191 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003192 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003193 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003194 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003195 $stat =~ s/\n./\n /g;
3196 $cond =~ s/\n./\n /g;
3197
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003198#print "linenr<$linenr> <$stat>\n";
3199 # If this statement has no statement boundaries within
3200 # it there is no point in retrying a statement scan
3201 # until we hit end of it.
3202 my $frag = $stat; $frag =~ s/;+\s*$//;
3203 if ($frag !~ /(?:{|;)/) {
3204#print "skip<$line_nr_next>\n";
3205 $suppress_statement = $line_nr_next;
3206 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003207
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003208 # Find the real next line.
3209 $realline_next = $line_nr_next;
3210 if (defined $realline_next &&
3211 (!defined $lines[$realline_next - 1] ||
3212 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3213 $realline_next++;
3214 }
3215
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003216 my $s = $stat;
3217 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003218
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003219 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003220 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003221
3222 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003223 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003224
Andy Whitcroft463f2862009-09-21 17:04:34 -07003225 } elsif ($s =~ /^.\s*else\b/s) {
3226
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003227 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003228 } 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 -07003229 my $type = $1;
3230 $type =~ s/\s+/ /g;
3231 possible($type, "A:" . $s);
3232
Andy Whitcroft8905a672007-11-28 16:21:06 -08003233 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003234 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003235 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003236 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003237
3238 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003239 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003240 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003241 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003242
3243 # Check for any sort of function declaration.
3244 # int foo(something bar, other baz);
3245 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003246 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 -08003247 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003248
Andy Whitcroftcf655042008-03-04 14:28:20 -08003249 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003250 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003251 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003252
Andy Whitcroft8905a672007-11-28 16:21:06 -08003253 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003254 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003255
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003256 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003257 }
3258 }
3259 }
3260
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003261 }
3262
Andy Whitcroft653d4872007-06-23 17:16:34 -07003263#
3264# Checks which may be anchored in the context.
3265#
3266
3267# Check for switch () and associated case and default
3268# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003269 if ($line=~/\bswitch\s*\(.*\)/) {
3270 my $err = '';
3271 my $sep = '';
3272 my @ctx = ctx_block_outer($linenr, $realcnt);
3273 shift(@ctx);
3274 for my $ctx (@ctx) {
3275 my ($clen, $cindent) = line_stats($ctx);
3276 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3277 $indent != $cindent) {
3278 $err .= "$sep$ctx\n";
3279 $sep = '';
3280 } else {
3281 $sep = "[...]\n";
3282 }
3283 }
3284 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003285 ERROR("SWITCH_CASE_INDENT_LEVEL",
3286 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003287 }
3288 }
3289
3290# if/while/etc brace do not go on next line, unless defining a do while loop,
3291# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003292 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 -07003293 my $pre_ctx = "$1$2";
3294
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003295 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003296
3297 if ($line =~ /^\+\t{6,}/) {
3298 WARN("DEEP_INDENTATION",
3299 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3300 }
3301
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003302 my $ctx_cnt = $realcnt - $#ctx - 1;
3303 my $ctx = join("\n", @ctx);
3304
Andy Whitcroft548596d2008-07-23 21:29:01 -07003305 my $ctx_ln = $linenr;
3306 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003307
Andy Whitcroft548596d2008-07-23 21:29:01 -07003308 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3309 defined $lines[$ctx_ln - 1] &&
3310 $lines[$ctx_ln - 1] =~ /^-/)) {
3311 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3312 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003313 $ctx_ln++;
3314 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003315
Andy Whitcroft53210162008-07-23 21:29:03 -07003316 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3317 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003318
Joe Perchesd752fcc2014-08-06 16:11:05 -07003319 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003320 ERROR("OPEN_BRACE",
3321 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003322 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003323 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003324 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3325 $ctx =~ /\)\s*\;\s*$/ &&
3326 defined $lines[$ctx_ln - 1])
3327 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003328 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3329 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003330 WARN("TRAILING_SEMICOLON",
3331 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003332 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003333 }
3334 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003335 }
3336
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003337# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003338 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 -08003339 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3340 ctx_statement_block($linenr, $realcnt, 0)
3341 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003342 my ($s, $c) = ($stat, $cond);
3343
3344 substr($s, 0, length($c), '');
3345
Joe Perches9f5af482015-09-09 15:37:30 -07003346 # remove inline comments
3347 $s =~ s/$;/ /g;
3348 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003349
3350 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003351 my @newlines = ($c =~ /\n/gs);
3352 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003353
Joe Perches9f5af482015-09-09 15:37:30 -07003354 # Make sure we remove the line prefixes as we have
3355 # none on the first line, and are going to readd them
3356 # where necessary.
3357 $s =~ s/\n./\n/gs;
3358 while ($s =~ /\n\s+\\\n/) {
3359 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3360 }
3361
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003362 # We want to check the first line inside the block
3363 # starting at the end of the conditional, so remove:
3364 # 1) any blank line termination
3365 # 2) any opening brace { on end of the line
3366 # 3) any do (...) {
3367 my $continuation = 0;
3368 my $check = 0;
3369 $s =~ s/^.*\bdo\b//;
3370 $s =~ s/^\s*{//;
3371 if ($s =~ s/^\s*\\//) {
3372 $continuation = 1;
3373 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003374 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003375 $check = 1;
3376 $cond_lines++;
3377 }
3378
3379 # Also ignore a loop construct at the end of a
3380 # preprocessor statement.
3381 if (($prevline =~ /^.\s*#\s*define\s/ ||
3382 $prevline =~ /\\\s*$/) && $continuation == 0) {
3383 $check = 0;
3384 }
3385
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003386 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003387 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003388 while ($cond_ptr != $cond_lines) {
3389 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003390
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003391 # If we see an #else/#elif then the code
3392 # is not linear.
3393 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3394 $check = 0;
3395 }
3396
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003397 # Ignore:
3398 # 1) blank lines, they should be at 0,
3399 # 2) preprocessor lines, and
3400 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003401 if ($continuation ||
3402 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003403 $s =~ /^\s*#\s*?/ ||
3404 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003405 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003406 if ($s =~ s/^.*?\n//) {
3407 $cond_lines++;
3408 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003409 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003410 }
3411
3412 my (undef, $sindent) = line_stats("+" . $s);
3413 my $stat_real = raw_line($linenr, $cond_lines);
3414
3415 # Check if either of these lines are modified, else
3416 # this is not this patch's fault.
3417 if (!defined($stat_real) ||
3418 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3419 $check = 0;
3420 }
3421 if (defined($stat_real) && $cond_lines > 1) {
3422 $stat_real = "[...]\n$stat_real";
3423 }
3424
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003425 #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 -07003426
Joe Perches9f5af482015-09-09 15:37:30 -07003427 if ($check && $s ne '' &&
3428 (($sindent % 8) != 0 ||
3429 ($sindent < $indent) ||
3430 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003431 WARN("SUSPECT_CODE_INDENT",
3432 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003433 }
3434 }
3435
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003436 # Track the 'values' across context and added lines.
3437 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003438 my ($curr_values, $curr_vars) =
3439 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003440 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003441 if ($dbg_values) {
3442 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003443 print "$linenr > .$outline\n";
3444 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003445 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003446 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003447 $prev_values = substr($curr_values, -1);
3448
Andy Whitcroft00df3442007-06-08 13:47:06 -07003449#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003450 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003451
Joe Perches11ca40a2016-12-12 16:46:31 -08003452# check for dereferences that span multiple lines
3453 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ &&
3454 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) {
3455 $prevline =~ /($Lval\s*(?:\.|->))\s*$/;
3456 my $ref = $1;
3457 $line =~ /^.\s*($Lval)/;
3458 $ref .= $1;
3459 $ref =~ s/\s//g;
3460 WARN("MULTILINE_DEREFERENCE",
3461 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev);
3462 }
3463
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003464# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003465 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 -07003466 my $type = $1;
3467 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003468 $var = "" if (!defined $var);
3469 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003470 my $sign = $1;
3471 my $pointer = $2;
3472
3473 $pointer = "" if (!defined $pointer);
3474
3475 if (WARN("UNSPECIFIED_INT",
3476 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3477 $fix) {
3478 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003479 my $comp_pointer = $pointer;
3480 $comp_pointer =~ s/\s//g;
3481 $decl .= $comp_pointer;
3482 $decl = rtrim($decl) if ($var eq "");
3483 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003484 }
3485 }
3486 }
3487
Andy Whitcroft653d4872007-06-23 17:16:34 -07003488# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003489 if ($dbg_type) {
3490 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003491 ERROR("TEST_TYPE",
3492 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003493 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003494 ERROR("TEST_NOT_TYPE",
3495 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003496 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003497 next;
3498 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003499# TEST: allow direct testing of the attribute matcher.
3500 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003501 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003502 ERROR("TEST_ATTR",
3503 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003504 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003505 ERROR("TEST_NOT_ATTR",
3506 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003507 }
3508 next;
3509 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003510
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003511# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003512 if ($line =~ /^.\s*{/ &&
3513 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003514 if (ERROR("OPEN_BRACE",
3515 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003516 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3517 fix_delete_line($fixlinenr - 1, $prevrawline);
3518 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003519 my $fixedline = $prevrawline;
3520 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003521 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003522 $fixedline = $line;
3523 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003524 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003525 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003526 }
3527
Andy Whitcroft653d4872007-06-23 17:16:34 -07003528#
3529# Checks which are anchored on the added line.
3530#
3531
3532# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003533 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003534 my $path = $1;
3535 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003536 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003537 "malformed #include filename\n" . $herecurr);
3538 }
3539 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3540 ERROR("UAPI_INCLUDE",
3541 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003542 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003543 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003544
3545# no C99 // comments
3546 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003547 if (ERROR("C99_COMMENTS",
3548 "do not use C99 // comments\n" . $herecurr) &&
3549 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003550 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003551 if ($line =~ /\/\/(.*)$/) {
3552 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003553 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003554 }
3555 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003556 }
3557 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003558 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003559 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003560
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003561# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3562# the whole statement.
3563#print "APW <$lines[$realline_next - 1]>\n";
3564 if (defined $realline_next &&
3565 exists $lines[$realline_next - 1] &&
3566 !defined $suppress_export{$realline_next} &&
3567 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3568 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003569 # Handle definitions which produce identifiers with
3570 # a prefix:
3571 # XXX(foo);
3572 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003573 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003574 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003575 $name =~ /^${Ident}_$2/) {
3576#print "FOO C name<$name>\n";
3577 $suppress_export{$realline_next} = 1;
3578
3579 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003580 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003581 ^.DEFINE_$Ident\(\Q$name\E\)|
3582 ^.DECLARE_$Ident\(\Q$name\E\)|
3583 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003584 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3585 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003586 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003587#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3588 $suppress_export{$realline_next} = 2;
3589 } else {
3590 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003591 }
3592 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003593 if (!defined $suppress_export{$linenr} &&
3594 $prevline =~ /^.\s*$/ &&
3595 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3596 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3597#print "FOO B <$lines[$linenr - 1]>\n";
3598 $suppress_export{$linenr} = 2;
3599 }
3600 if (defined $suppress_export{$linenr} &&
3601 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003602 WARN("EXPORT_SYMBOL",
3603 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003604 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003605
Joe Eloff5150bda2010-08-09 17:21:00 -07003606# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003607 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003608 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003609 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003610 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003611 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003612 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003613 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003614# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003615 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003616 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003617 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003618 $herecurr) &&
3619 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003620 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003621 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003622 }
3623
Joe Perches18130872014-08-06 16:11:22 -07003624# check for misordered declarations of char/short/int/long with signed/unsigned
3625 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3626 my $tmp = trim($1);
3627 WARN("MISORDERED_TYPE",
3628 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3629 }
3630
Joe Perchescb710ec2010-10-26 14:23:20 -07003631# check for static const char * arrays.
3632 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003633 WARN("STATIC_CONST_CHAR_ARRAY",
3634 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003635 $herecurr);
3636 }
3637
3638# check for static char foo[] = "bar" declarations.
3639 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003640 WARN("STATIC_CONST_CHAR_ARRAY",
3641 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003642 $herecurr);
3643 }
3644
Joe Perchesab7e23f2015-04-16 12:44:22 -07003645# check for const <foo> const where <foo> is not a pointer or array type
3646 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3647 my $found = $1;
3648 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3649 WARN("CONST_CONST",
3650 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3651 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3652 WARN("CONST_CONST",
3653 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3654 }
3655 }
3656
Joe Perches9b0fa602014-04-03 14:49:18 -07003657# check for non-global char *foo[] = {"bar", ...} declarations.
3658 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3659 WARN("STATIC_CONST_CHAR_ARRAY",
3660 "char * array declaration might be better as static const\n" .
3661 $herecurr);
3662 }
3663
Joe Perchesb598b672015-04-16 12:44:36 -07003664# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3665 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3666 my $array = $1;
3667 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3668 my $array_div = $1;
3669 if (WARN("ARRAY_SIZE",
3670 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3671 $fix) {
3672 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3673 }
3674 }
3675 }
3676
Joe Perchesb36190c2014-01-27 17:07:18 -08003677# check for function declarations without arguments like "int foo()"
3678 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3679 if (ERROR("FUNCTION_WITHOUT_ARGS",
3680 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3681 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003682 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003683 }
3684 }
3685
Andy Whitcroft653d4872007-06-23 17:16:34 -07003686# check for new typedefs, only function parameters and sparse annotations
3687# make sense.
3688 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003689 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003690 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003691 $line !~ /\b$typeTypedefs\b/ &&
Michael S. Tsirkin46d832f2016-12-11 06:29:58 +02003692 $line !~ /\b__bitwise\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003693 WARN("NEW_TYPEDEFS",
3694 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003695 }
3696
3697# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003698 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003699 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3700 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003701 my ($ident, $from, $to) = ($1, $2, $2);
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 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003710
Joe Perches3705ce52013-07-03 15:05:31 -07003711## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003712 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003713 if (ERROR("POINTER_LOCATION",
3714 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3715 $fix) {
3716 my $sub_from = $ident;
3717 my $sub_to = $ident;
3718 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003719 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003720 s@\Q$sub_from\E@$sub_to@;
3721 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003722 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003723 }
3724 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3725 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003726 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003727
Andy Whitcroft65863862009-01-06 14:41:21 -08003728 # Should start with a space.
3729 $to =~ s/^(\S)/ $1/;
3730 # Should not end with a space.
3731 $to =~ s/\s+$//;
3732 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003733 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003734 }
3735 # Modifiers should have spaces.
3736 $to =~ s/(\b$Modifier$)/$1 /;
3737
Joe Perches3705ce52013-07-03 15:05:31 -07003738## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003739 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003740 if (ERROR("POINTER_LOCATION",
3741 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3742 $fix) {
3743
3744 my $sub_from = $match;
3745 my $sub_to = $match;
3746 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003747 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003748 s@\Q$sub_from\E@$sub_to@;
3749 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003750 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003751 }
3752
Joe Perches9d3e3c72015-09-09 15:37:27 -07003753# avoid BUG() or BUG_ON()
3754 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3755 my $msg_type = \&WARN;
3756 $msg_type = \&CHK if ($file);
3757 &{$msg_type}("AVOID_BUG",
3758 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3759 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003760
Joe Perches9d3e3c72015-09-09 15:37:27 -07003761# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003762 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003763 WARN("LINUX_VERSION_CODE",
3764 "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 -08003765 }
3766
Joe Perches17441222011-06-15 15:08:17 -07003767# check for uses of printk_ratelimit
3768 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003769 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003770 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003771 }
3772
Andy Whitcroft00df3442007-06-08 13:47:06 -07003773# printk should use KERN_* levels. Note that follow on printk's on the
3774# same line do not need a level, so we use the current block context
3775# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003776# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003777# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003778 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003779 my $ok = 0;
3780 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3781 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003782 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003783 # with "\n" ignore it, else it is to blame
3784 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3785 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3786 $ok = 1;
3787 }
3788 last;
3789 }
3790 }
3791 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003792 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3793 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003794 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003795 }
3796
Joe Perches243f3802012-05-31 16:26:09 -07003797 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3798 my $orig = $1;
3799 my $level = lc($orig);
3800 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003801 my $level2 = $level;
3802 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003803 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003804 "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 -07003805 }
3806
3807 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003808 if (WARN("PREFER_PR_LEVEL",
3809 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3810 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003811 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003812 s/\bpr_warning\b/pr_warn/;
3813 }
Joe Perches243f3802012-05-31 16:26:09 -07003814 }
3815
Joe Perchesdc139312013-02-21 16:44:13 -08003816 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3817 my $orig = $1;
3818 my $level = lc($orig);
3819 $level = "warn" if ($level eq "warning");
3820 $level = "dbg" if ($level eq "debug");
3821 WARN("PREFER_DEV_LEVEL",
3822 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3823 }
3824
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003825# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3826# number of false positives, but assembly files are not checked, so at
3827# least the arch entry code will not trigger this warning.
3828 if ($line =~ /\bENOSYS\b/) {
3829 WARN("ENOSYS",
3830 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3831 }
3832
Andy Whitcroft653d4872007-06-23 17:16:34 -07003833# function brace can't be on same line, except for #defines of do while,
3834# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003835 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003836 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003837 if (ERROR("OPEN_BRACE",
3838 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3839 $fix) {
3840 fix_delete_line($fixlinenr, $rawline);
3841 my $fixed_line = $rawline;
3842 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3843 my $line1 = $1;
3844 my $line2 = $2;
3845 fix_insert_line($fixlinenr, ltrim($line1));
3846 fix_insert_line($fixlinenr, "\+{");
3847 if ($line2 !~ /^\s*$/) {
3848 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3849 }
3850 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003851 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003852
Andy Whitcroft8905a672007-11-28 16:21:06 -08003853# open braces for enum, union and struct go on the same line.
3854 if ($line =~ /^.\s*{/ &&
3855 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003856 if (ERROR("OPEN_BRACE",
3857 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3858 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3859 fix_delete_line($fixlinenr - 1, $prevrawline);
3860 fix_delete_line($fixlinenr, $rawline);
3861 my $fixedline = rtrim($prevrawline) . " {";
3862 fix_insert_line($fixlinenr, $fixedline);
3863 $fixedline = $rawline;
3864 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3865 if ($fixedline !~ /^\+\s*$/) {
3866 fix_insert_line($fixlinenr, $fixedline);
3867 }
3868 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003869 }
3870
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003871# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003872 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3873 if (WARN("SPACING",
3874 "missing space after $1 definition\n" . $herecurr) &&
3875 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003876 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003877 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3878 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003879 }
3880
Joe Perches31070b52014-01-23 15:54:49 -08003881# Function pointer declarations
3882# check spacing between type, funcptr, and args
3883# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003884 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003885 my $declare = $1;
3886 my $pre_pointer_space = $2;
3887 my $post_pointer_space = $3;
3888 my $funcname = $4;
3889 my $post_funcname_space = $5;
3890 my $pre_args_space = $6;
3891
Joe Perches91f72e92014-04-03 14:49:12 -07003892# the $Declare variable will capture all spaces after the type
3893# so check it for a missing trailing missing space but pointer return types
3894# don't need a space so don't warn for those.
3895 my $post_declare_space = "";
3896 if ($declare =~ /(\s+)$/) {
3897 $post_declare_space = $1;
3898 $declare = rtrim($declare);
3899 }
3900 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003901 WARN("SPACING",
3902 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003903 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003904 }
3905
3906# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003907# This test is not currently implemented because these declarations are
3908# equivalent to
3909# int foo(int bar, ...)
3910# and this is form shouldn't/doesn't generate a checkpatch warning.
3911#
3912# elsif ($declare =~ /\s{2,}$/) {
3913# WARN("SPACING",
3914# "Multiple spaces after return type\n" . $herecurr);
3915# }
Joe Perches31070b52014-01-23 15:54:49 -08003916
3917# unnecessary space "type ( *funcptr)(args...)"
3918 if (defined $pre_pointer_space &&
3919 $pre_pointer_space =~ /^\s/) {
3920 WARN("SPACING",
3921 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3922 }
3923
3924# unnecessary space "type (* funcptr)(args...)"
3925 if (defined $post_pointer_space &&
3926 $post_pointer_space =~ /^\s/) {
3927 WARN("SPACING",
3928 "Unnecessary space before function pointer name\n" . $herecurr);
3929 }
3930
3931# unnecessary space "type (*funcptr )(args...)"
3932 if (defined $post_funcname_space &&
3933 $post_funcname_space =~ /^\s/) {
3934 WARN("SPACING",
3935 "Unnecessary space after function pointer name\n" . $herecurr);
3936 }
3937
3938# unnecessary space "type (*funcptr) (args...)"
3939 if (defined $pre_args_space &&
3940 $pre_args_space =~ /^\s/) {
3941 WARN("SPACING",
3942 "Unnecessary space before function pointer arguments\n" . $herecurr);
3943 }
3944
3945 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003946 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003947 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003948 }
3949 }
3950
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003951# check for spacing round square brackets; allowed:
3952# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003953# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3954# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003955 while ($line =~ /(.*?\s)\[/g) {
3956 my ($where, $prefix) = ($-[1], $1);
3957 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003958 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003959 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003960 if (ERROR("BRACKET_SPACE",
3961 "space prohibited before open square bracket '['\n" . $herecurr) &&
3962 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003963 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003964 s/^(\+.*?)\s+\[/$1\[/;
3965 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003966 }
3967 }
3968
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003969# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003970 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003971 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003972 my $ctx_before = substr($line, 0, $-[1]);
3973 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003974
3975 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003976 if ($name =~ /^(?:
3977 if|for|while|switch|return|case|
3978 volatile|__volatile__|
3979 __attribute__|format|__extension__|
3980 asm|__asm__)$/x)
3981 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003982 # cpp #define statements have non-optional spaces, ie
3983 # if there is a space between the name and the open
3984 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003985 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003986
3987 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003988 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003989
3990 # If this whole things ends with a type its most
3991 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003992 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003993
3994 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003995 if (WARN("SPACING",
3996 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3997 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003998 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003999 s/\b$name\s+\(/$name\(/;
4000 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004001 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004002 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004003
Andy Whitcroft653d4872007-06-23 17:16:34 -07004004# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004005 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004006 my $fixed_line = "";
4007 my $line_fixed = 0;
4008
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004009 my $ops = qr{
4010 <<=|>>=|<=|>=|==|!=|
4011 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4012 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004013 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004014 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004015 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004016 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004017
4018## print("element count: <" . $#elements . ">\n");
4019## foreach my $el (@elements) {
4020## print("el: <$el>\n");
4021## }
4022
4023 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004024 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004025
Joe Perches3705ce52013-07-03 15:05:31 -07004026 foreach my $el (@elements) {
4027 push(@fix_elements, substr($rawline, $off, length($el)));
4028 $off += length($el);
4029 }
4030
4031 $off = 0;
4032
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004033 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004034 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004035
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004036 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004037
4038 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4039
4040## print("n: <$n> good: <$good>\n");
4041
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004042 $off += length($elements[$n]);
4043
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004044 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004045 my $ca = substr($opline, 0, $off);
4046 my $cc = '';
4047 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4048 $cc = substr($opline, $off + length($elements[$n + 1]));
4049 }
4050 my $cb = "$ca$;$cc";
4051
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004052 my $a = '';
4053 $a = 'V' if ($elements[$n] ne '');
4054 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004055 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004056 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4057 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004058 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004059
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004060 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004061
4062 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004063 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004064 $c = 'V' if ($elements[$n + 2] ne '');
4065 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004066 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004067 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4068 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004069 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004070 } else {
4071 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004072 }
4073
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004074 my $ctx = "${a}x${c}";
4075
4076 my $at = "(ctx:$ctx)";
4077
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004078 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004079 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004080
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004081 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004082 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004083
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004084 # Get the full operator variant.
4085 my $opv = $op . substr($curr_vars, $off, 1);
4086
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004087 # Ignore operators passed as parameters.
4088 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004089 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004090
Andy Whitcroftcf655042008-03-04 14:28:20 -08004091# # Ignore comments
4092# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004093
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004094 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004095 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004096 if ($ctx !~ /.x[WEBC]/ &&
4097 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004098 if (ERROR("SPACING",
4099 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004100 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004101 $line_fixed = 1;
4102 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004103 }
4104
4105 # // is a comment
4106 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004107
Joe Perchesb00e4812014-04-03 14:49:33 -07004108 # : when part of a bitfield
4109 } elsif ($opv eq ':B') {
4110 # skip the bitfield test for now
4111
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004112 # No spaces for:
4113 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004114 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004115 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004116 if (ERROR("SPACING",
4117 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004118 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004119 if (defined $fix_elements[$n + 2]) {
4120 $fix_elements[$n + 2] =~ s/^\s+//;
4121 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004122 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004123 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004124 }
4125
Joe Perches23810972014-12-10 15:51:32 -08004126 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004127 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004128 my $rtrim_before = 0;
4129 my $space_after = 0;
4130 if ($ctx =~ /Wx./) {
4131 if (ERROR("SPACING",
4132 "space prohibited before that '$op' $at\n" . $hereptr)) {
4133 $line_fixed = 1;
4134 $rtrim_before = 1;
4135 }
4136 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004137 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004138 if (ERROR("SPACING",
4139 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004140 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004141 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004142 $space_after = 1;
4143 }
4144 }
4145 if ($rtrim_before || $space_after) {
4146 if ($rtrim_before) {
4147 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4148 } else {
4149 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4150 }
4151 if ($space_after) {
4152 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004153 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004154 }
4155
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004156 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004157 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004158 #warn "'*' is part of type\n";
4159
4160 # unary operators should have a space before and
4161 # none after. May be left adjacent to another
4162 # unary operator, or a cast
4163 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004164 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004165 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004166 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004167 if (ERROR("SPACING",
4168 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004169 if ($n != $last_after + 2) {
4170 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4171 $line_fixed = 1;
4172 }
Joe Perches3705ce52013-07-03 15:05:31 -07004173 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004174 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004175 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004176 # A unary '*' may be const
4177
4178 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004179 if (ERROR("SPACING",
4180 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004181 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004182 if (defined $fix_elements[$n + 2]) {
4183 $fix_elements[$n + 2] =~ s/^\s+//;
4184 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004185 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004186 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004187 }
4188
4189 # unary ++ and unary -- are allowed no space on one side.
4190 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004191 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004192 if (ERROR("SPACING",
4193 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004194 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004195 $line_fixed = 1;
4196 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004197 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004198 if ($ctx =~ /Wx[BE]/ ||
4199 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004200 if (ERROR("SPACING",
4201 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004202 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004203 $line_fixed = 1;
4204 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004205 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004206 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004207 if (ERROR("SPACING",
4208 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004209 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004210 if (defined $fix_elements[$n + 2]) {
4211 $fix_elements[$n + 2] =~ s/^\s+//;
4212 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004213 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004214 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004215 }
4216
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004217 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004218 } elsif ($op eq '<<' or $op eq '>>' or
4219 $op eq '&' or $op eq '^' or $op eq '|' or
4220 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004221 $op eq '*' or $op eq '/' or
4222 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004223 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004224 if ($check) {
4225 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4226 if (CHK("SPACING",
4227 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4228 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4229 $fix_elements[$n + 2] =~ s/^\s+//;
4230 $line_fixed = 1;
4231 }
4232 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4233 if (CHK("SPACING",
4234 "space preferred before that '$op' $at\n" . $hereptr)) {
4235 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4236 $line_fixed = 1;
4237 }
4238 }
4239 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004240 if (ERROR("SPACING",
4241 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004242 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4243 if (defined $fix_elements[$n + 2]) {
4244 $fix_elements[$n + 2] =~ s/^\s+//;
4245 }
Joe Perches3705ce52013-07-03 15:05:31 -07004246 $line_fixed = 1;
4247 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004248 }
4249
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004250 # A colon needs no spaces before when it is
4251 # terminating a case value or a label.
4252 } elsif ($opv eq ':C' || $opv eq ':L') {
4253 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004254 if (ERROR("SPACING",
4255 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004256 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004257 $line_fixed = 1;
4258 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004259 }
4260
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004261 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004262 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004263 my $ok = 0;
4264
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004265 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004266 if (($op eq '<' &&
4267 $cc =~ /^\S+\@\S+>/) ||
4268 ($op eq '>' &&
4269 $ca =~ /<\S+\@\S+$/))
4270 {
4271 $ok = 1;
4272 }
4273
Joe Perchese0df7e12015-04-16 12:44:53 -07004274 # for asm volatile statements
4275 # ignore a colon with another
4276 # colon immediately before or after
4277 if (($op eq ':') &&
4278 ($ca =~ /:$/ || $cc =~ /^:/)) {
4279 $ok = 1;
4280 }
4281
Joe Perches84731622013-11-12 15:10:05 -08004282 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004283 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004284 my $msg_type = \&ERROR;
4285 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4286
4287 if (&{$msg_type}("SPACING",
4288 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004289 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4290 if (defined $fix_elements[$n + 2]) {
4291 $fix_elements[$n + 2] =~ s/^\s+//;
4292 }
Joe Perches3705ce52013-07-03 15:05:31 -07004293 $line_fixed = 1;
4294 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004295 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004296 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004297 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004298
4299## print("n: <$n> GOOD: <$good>\n");
4300
4301 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004302 }
Joe Perches3705ce52013-07-03 15:05:31 -07004303
4304 if (($#elements % 2) == 0) {
4305 $fixed_line = $fixed_line . $fix_elements[$#elements];
4306 }
4307
Joe Perches194f66f2014-08-06 16:11:03 -07004308 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4309 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004310 }
4311
4312
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004313 }
4314
Joe Perches786b6322013-07-03 15:05:32 -07004315# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004316 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004317 if (WARN("SPACING",
4318 "space prohibited before semicolon\n" . $herecurr) &&
4319 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004320 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004321 s/^(\+.*\S)\s+;/$1;/;
4322 }
4323 }
4324
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004325# check for multiple assignments
4326 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004327 CHK("MULTIPLE_ASSIGNMENTS",
4328 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004329 }
4330
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004331## # check for multiple declarations, allowing for a function declaration
4332## # continuation.
4333## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4334## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4335##
4336## # Remove any bracketed sections to ensure we do not
4337## # falsly report the parameters of functions.
4338## my $ln = $line;
4339## while ($ln =~ s/\([^\(\)]*\)//g) {
4340## }
4341## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004342## WARN("MULTIPLE_DECLARATION",
4343## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004344## }
4345## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004346
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004347#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004348 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004349 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004350 if (ERROR("SPACING",
4351 "space required before the open brace '{'\n" . $herecurr) &&
4352 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004353 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004354 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004355 }
4356
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004357## # check for blank lines before declarations
4358## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4359## $prevrawline =~ /^.\s*$/) {
4360## WARN("SPACING",
4361## "No blank lines before declarations\n" . $hereprev);
4362## }
4363##
4364
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004365# closing brace should have a space following it when it has anything
4366# on the line
4367 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004368 if (ERROR("SPACING",
4369 "space required after that close brace '}'\n" . $herecurr) &&
4370 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004371 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004372 s/}((?!(?:,|;|\)))\S)/} $1/;
4373 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004374 }
4375
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004376# check spacing on square brackets
4377 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004378 if (ERROR("SPACING",
4379 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4380 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004381 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004382 s/\[\s+/\[/;
4383 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004384 }
4385 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004386 if (ERROR("SPACING",
4387 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4388 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004389 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004390 s/\s+\]/\]/;
4391 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004392 }
4393
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004394# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004395 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4396 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004397 if (ERROR("SPACING",
4398 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4399 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004400 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004401 s/\(\s+/\(/;
4402 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004403 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004404 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004405 $line !~ /for\s*\(.*;\s+\)/ &&
4406 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004407 if (ERROR("SPACING",
4408 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4409 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004410 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004411 s/\s+\)/\)/;
4412 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004413 }
4414
Joe Perchese2826fd2014-08-06 16:10:48 -07004415# check unnecessary parentheses around addressof/dereference single $Lvals
4416# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4417
4418 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004419 my $var = $1;
4420 if (CHK("UNNECESSARY_PARENTHESES",
4421 "Unnecessary parentheses around $var\n" . $herecurr) &&
4422 $fix) {
4423 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4424 }
4425 }
4426
4427# check for unnecessary parentheses around function pointer uses
4428# ie: (foo->bar)(); should be foo->bar();
4429# but not "if (foo->bar) (" to avoid some false positives
4430 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4431 my $var = $2;
4432 if (CHK("UNNECESSARY_PARENTHESES",
4433 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4434 $fix) {
4435 my $var2 = deparenthesize($var);
4436 $var2 =~ s/\s//g;
4437 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4438 }
4439 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004440
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004441#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004442 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004443 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004444 if (WARN("INDENTED_LABEL",
4445 "labels should not be indented\n" . $herecurr) &&
4446 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004447 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004448 s/^(.)\s+/$1/;
4449 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004450 }
4451
Joe Perches5b9553a2014-04-03 14:49:21 -07004452# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004453 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004454 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004455 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004456 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4457 my $value = $1;
4458 $value = deparenthesize($value);
4459 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4460 ERROR("RETURN_PARENTHESES",
4461 "return is not a function, parentheses are not required\n" . $herecurr);
4462 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004463 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004464 ERROR("SPACING",
4465 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004466 }
4467 }
Joe Perches507e5142013-11-12 15:10:13 -08004468
Joe Perchesb43ae212014-06-23 13:22:07 -07004469# unnecessary return in a void function
4470# at end-of-function, with the previous line a single leading tab, then return;
4471# and the line before that not a goto label target like "out:"
4472 if ($sline =~ /^[ \+]}\s*$/ &&
4473 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4474 $linenr >= 3 &&
4475 $lines[$linenr - 3] =~ /^[ +]/ &&
4476 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004477 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004478 "void function return statements are not generally useful\n" . $hereprev);
4479 }
Joe Perches9819cf22014-06-04 16:12:09 -07004480
Joe Perches189248d2014-01-23 15:54:47 -08004481# if statements using unnecessary parentheses - ie: if ((foo == bar))
4482 if ($^V && $^V ge 5.10.0 &&
4483 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4484 my $openparens = $1;
4485 my $count = $openparens =~ tr@\(@\(@;
4486 my $msg = "";
4487 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4488 my $comp = $4; #Not $1 because of $LvalOrFunc
4489 $msg = " - maybe == should be = ?" if ($comp eq "==");
4490 WARN("UNNECESSARY_PARENTHESES",
4491 "Unnecessary parentheses$msg\n" . $herecurr);
4492 }
4493 }
4494
Joe Perchesc5595fa2015-09-09 15:37:58 -07004495# comparisons with a constant or upper case identifier on the left
4496# avoid cases like "foo + BAR < baz"
4497# only fix matches surrounded by parentheses to avoid incorrect
4498# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4499 if ($^V && $^V ge 5.10.0 &&
4500 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4501 my $lead = $1;
4502 my $const = $2;
4503 my $comp = $3;
4504 my $to = $4;
4505 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004506 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004507 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4508 WARN("CONSTANT_COMPARISON",
4509 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4510 $fix) {
4511 if ($comp eq "<") {
4512 $newcomp = ">";
4513 } elsif ($comp eq "<=") {
4514 $newcomp = ">=";
4515 } elsif ($comp eq ">") {
4516 $newcomp = "<";
4517 } elsif ($comp eq ">=") {
4518 $newcomp = "<=";
4519 }
4520 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4521 }
4522 }
4523
Joe Perchesf34e4a42015-04-16 12:44:19 -07004524# Return of what appears to be an errno should normally be negative
4525 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004526 my $name = $1;
4527 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004528 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004529 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004530 }
4531 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004532
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004533# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004534 if ($line =~ /\b(if|while|for|switch)\(/) {
4535 if (ERROR("SPACING",
4536 "space required before the open parenthesis '('\n" . $herecurr) &&
4537 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004538 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004539 s/\b(if|while|for|switch)\(/$1 \(/;
4540 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004541 }
4542
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004543# Check for illegal assignment in if conditional -- and check for trailing
4544# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004545 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004546 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4547 ctx_statement_block($linenr, $realcnt, 0)
4548 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004549 my ($stat_next) = ctx_statement_block($line_nr_next,
4550 $remain_next, $off_next);
4551 $stat_next =~ s/\n./\n /g;
4552 ##print "stat<$stat> stat_next<$stat_next>\n";
4553
4554 if ($stat_next =~ /^\s*while\b/) {
4555 # If the statement carries leading newlines,
4556 # then count those as offsets.
4557 my ($whitespace) =
4558 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4559 my $offset =
4560 statement_rawlines($whitespace) - 1;
4561
4562 $suppress_whiletrailers{$line_nr_next +
4563 $offset} = 1;
4564 }
4565 }
4566 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004567 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004568 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004569 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004570
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004571 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004572 ERROR("ASSIGN_IN_IF",
4573 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004574 }
4575
4576 # Find out what is on the end of the line after the
4577 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004578 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004579 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004580 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004581 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4582 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004583 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004584 # Find out how long the conditional actually is.
4585 my @newlines = ($c =~ /\n/gs);
4586 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004587 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004588
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004589 $stat_real = raw_line($linenr, $cond_lines)
4590 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004591 if (defined($stat_real) && $cond_lines > 1) {
4592 $stat_real = "[...]\n$stat_real";
4593 }
4594
Joe Perches000d1cc12011-07-25 17:13:25 -07004595 ERROR("TRAILING_STATEMENTS",
4596 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004597 }
4598 }
4599
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004600# Check for bitwise tests written as boolean
4601 if ($line =~ /
4602 (?:
4603 (?:\[|\(|\&\&|\|\|)
4604 \s*0[xX][0-9]+\s*
4605 (?:\&\&|\|\|)
4606 |
4607 (?:\&\&|\|\|)
4608 \s*0[xX][0-9]+\s*
4609 (?:\&\&|\|\||\)|\])
4610 )/x)
4611 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004612 WARN("HEXADECIMAL_BOOLEAN_TEST",
4613 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004614 }
4615
Andy Whitcroft8905a672007-11-28 16:21:06 -08004616# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004617 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4618 my $s = $1;
4619 $s =~ s/$;//g; # Remove any comments
4620 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004621 ERROR("TRAILING_STATEMENTS",
4622 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004623 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004624 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004625# if should not continue a brace
4626 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004627 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004628 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004629 $herecurr);
4630 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004631# case and default should not have general statements after them
4632 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4633 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004634 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004635 \s*return\s+
4636 )/xg)
4637 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004638 ERROR("TRAILING_STATEMENTS",
4639 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004640 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004641
4642 # Check for }<nl>else {, these must be at the same
4643 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004644 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4645 $previndent == $indent) {
4646 if (ERROR("ELSE_AFTER_BRACE",
4647 "else should follow close brace '}'\n" . $hereprev) &&
4648 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4649 fix_delete_line($fixlinenr - 1, $prevrawline);
4650 fix_delete_line($fixlinenr, $rawline);
4651 my $fixedline = $prevrawline;
4652 $fixedline =~ s/}\s*$//;
4653 if ($fixedline !~ /^\+\s*$/) {
4654 fix_insert_line($fixlinenr, $fixedline);
4655 }
4656 $fixedline = $rawline;
4657 $fixedline =~ s/^(.\s*)else/$1} else/;
4658 fix_insert_line($fixlinenr, $fixedline);
4659 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004660 }
4661
Joe Perches8b8856f2014-08-06 16:11:14 -07004662 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4663 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004664 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4665
4666 # Find out what is on the end of the line after the
4667 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004668 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004669 $s =~ s/\n.*//g;
4670
4671 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004672 if (ERROR("WHILE_AFTER_BRACE",
4673 "while should follow close brace '}'\n" . $hereprev) &&
4674 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4675 fix_delete_line($fixlinenr - 1, $prevrawline);
4676 fix_delete_line($fixlinenr, $rawline);
4677 my $fixedline = $prevrawline;
4678 my $trailing = $rawline;
4679 $trailing =~ s/^\+//;
4680 $trailing = trim($trailing);
4681 $fixedline =~ s/}\s*$/} $trailing/;
4682 fix_insert_line($fixlinenr, $fixedline);
4683 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004684 }
4685 }
4686
Joe Perches95e2c602013-07-03 15:05:20 -07004687#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004688 while ($line =~ m{($Constant|$Lval)}g) {
4689 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004690
4691#gcc binary extension
4692 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004693 if (WARN("GCC_BINARY_CONSTANT",
4694 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4695 $fix) {
4696 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004697 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004698 s/\b$var\b/$hexval/;
4699 }
Joe Perches95e2c602013-07-03 15:05:20 -07004700 }
4701
4702#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004703 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004704 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004705#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004706 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004707#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004708 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4709#Ignore some three character SI units explicitly, like MiB and KHz
4710 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004711 while ($var =~ m{($Ident)}g) {
4712 my $word = $1;
4713 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004714 if ($check) {
4715 seed_camelcase_includes();
4716 if (!$file && !$camelcase_file_seeded) {
4717 seed_camelcase_file($realfile);
4718 $camelcase_file_seeded = 1;
4719 }
4720 }
Joe Perches7e781f62013-09-11 14:23:55 -07004721 if (!defined $camelcase{$word}) {
4722 $camelcase{$word} = 1;
4723 CHK("CAMELCASE",
4724 "Avoid CamelCase: <$word>\n" . $herecurr);
4725 }
Joe Perches34456862013-07-03 15:05:34 -07004726 }
Joe Perches323c1262012-12-17 16:02:07 -08004727 }
4728 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004729
4730#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004731 if ($line =~ /\#\s*define.*\\\s+$/) {
4732 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4733 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4734 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004735 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004736 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004737 }
4738
Fabian Frederick0e212e02015-04-16 12:44:25 -07004739# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4740# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004741 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004742 my $file = "$1.h";
4743 my $checkfile = "include/linux/$file";
4744 if (-f "$root/$checkfile" &&
4745 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004746 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004747 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004748 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4749 if ($asminclude > 0) {
4750 if ($realfile =~ m{^arch/}) {
4751 CHK("ARCH_INCLUDE_LINUX",
4752 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4753 } else {
4754 WARN("INCLUDE_LINUX",
4755 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4756 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004757 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004758 }
4759 }
4760
Andy Whitcroft653d4872007-06-23 17:16:34 -07004761# multi-statement macros should be enclosed in a do while loop, grab the
4762# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004763# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004764 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4765 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004766 my $ln = $linenr;
4767 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004768 my ($off, $dstat, $dcond, $rest);
4769 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004770 my $has_flow_statement = 0;
4771 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004772 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004773 ctx_statement_block($linenr, $realcnt, 0);
4774 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004775 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004776 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004777
Joe Perches08a28432014-10-13 15:51:55 -07004778 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004779 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004780
Joe Perchesf59b64b2016-10-11 13:52:08 -07004781 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4782 my $define_args = $1;
4783 my $define_stmt = $dstat;
4784 my @def_args = ();
4785
4786 if (defined $define_args && $define_args ne "") {
4787 $define_args = substr($define_args, 1, length($define_args) - 2);
4788 $define_args =~ s/\s*//g;
4789 @def_args = split(",", $define_args);
4790 }
4791
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004792 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004793 $dstat =~ s/\\\n.//g;
4794 $dstat =~ s/^\s*//s;
4795 $dstat =~ s/\s*$//s;
4796
4797 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004798 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4799 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004800 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004801 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004802 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004803
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004804 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004805 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4806 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004807 {
4808 }
4809
Joe Perches42e15292016-03-15 14:58:01 -07004810 # Make asm volatile uses seem like a generic function
4811 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4812
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004813 my $exceptions = qr{
4814 $Declare|
4815 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004816 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004817 DECLARE_PER_CPU|
4818 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004819 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004820 union|
4821 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004822 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004823 ^\"|\"$|
4824 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004825 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004826 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004827
4828 $ctx =~ s/\n*$//;
4829 my $herectx = $here . "\n";
4830 my $stmt_cnt = statement_rawlines($ctx);
4831
4832 for (my $n = 0; $n < $stmt_cnt; $n++) {
4833 $herectx .= raw_line($linenr, $n) . "\n";
4834 }
4835
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004836 if ($dstat ne '' &&
4837 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4838 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004839 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004840 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004841 $dstat !~ /$exceptions/ &&
4842 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004843 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004844 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004845 $dstat !~ /^for\s*$Constant$/ && # for (...)
4846 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4847 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004848 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004849 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004850 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004851
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004852 if ($dstat =~ /;/) {
4853 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4854 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4855 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004856 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004857 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004858 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004859
4860 }
Joe Perches52076492016-10-11 13:52:14 -07004861
4862 # Make $define_stmt single line, comment-free, etc
4863 my @stmt_array = split('\n', $define_stmt);
4864 my $first = 1;
4865 $define_stmt = "";
4866 foreach my $l (@stmt_array) {
4867 $l =~ s/\\$//;
4868 if ($first) {
4869 $define_stmt = $l;
4870 $first = 0;
4871 } elsif ($l =~ /^[\+ ]/) {
4872 $define_stmt .= substr($l, 1);
4873 }
4874 }
4875 $define_stmt =~ s/$;//g;
4876 $define_stmt =~ s/\s+/ /g;
4877 $define_stmt = trim($define_stmt);
4878
Joe Perchesf59b64b2016-10-11 13:52:08 -07004879# check if any macro arguments are reused (ignore '...' and 'type')
4880 foreach my $arg (@def_args) {
4881 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07004882 next if ($arg =~ /^type$/i);
Joe Perchesf59b64b2016-10-11 13:52:08 -07004883 my $tmp = $define_stmt;
4884 $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 -07004885 $tmp =~ s/\#+\s*$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004886 $tmp =~ s/\b$arg\s*\#\#//g;
4887 my $use_cnt = $tmp =~ s/\b$arg\b//g;
4888 if ($use_cnt > 1) {
4889 CHK("MACRO_ARG_REUSE",
4890 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07004891 }
4892# check if any macro arguments may have other precedence issues
4893 if ($define_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
4894 ((defined($1) && $1 ne ',') ||
4895 (defined($2) && $2 ne ','))) {
4896 CHK("MACRO_ARG_PRECEDENCE",
4897 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07004898 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004899 }
Joe Perches5023d342012-12-17 16:01:47 -08004900
Joe Perches08a28432014-10-13 15:51:55 -07004901# check for macros with flow control, but without ## concatenation
4902# ## concatenation is commonly a macro that defines a function so ignore those
4903 if ($has_flow_statement && !$has_arg_concat) {
4904 my $herectx = $here . "\n";
4905 my $cnt = statement_rawlines($ctx);
4906
4907 for (my $n = 0; $n < $cnt; $n++) {
4908 $herectx .= raw_line($linenr, $n) . "\n";
4909 }
4910 WARN("MACRO_WITH_FLOW_CONTROL",
4911 "Macros with flow control statements should be avoided\n" . "$herectx");
4912 }
4913
Joe Perches481eb482012-12-17 16:01:56 -08004914# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004915
4916 } else {
4917 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004918 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4919 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004920 $line =~ /^\+.*\\$/) {
4921 WARN("LINE_CONTINUATIONS",
4922 "Avoid unnecessary line continuations\n" . $herecurr);
4923 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004924 }
4925
Joe Perchesb13edf72012-07-30 14:41:24 -07004926# do {} while (0) macro tests:
4927# single-statement macros do not need to be enclosed in do while (0) loop,
4928# macro should not end with a semicolon
4929 if ($^V && $^V ge 5.10.0 &&
4930 $realfile !~ m@/vmlinux.lds.h$@ &&
4931 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4932 my $ln = $linenr;
4933 my $cnt = $realcnt;
4934 my ($off, $dstat, $dcond, $rest);
4935 my $ctx = '';
4936 ($dstat, $dcond, $ln, $cnt, $off) =
4937 ctx_statement_block($linenr, $realcnt, 0);
4938 $ctx = $dstat;
4939
4940 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004941 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004942
4943 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4944 my $stmts = $2;
4945 my $semis = $3;
4946
4947 $ctx =~ s/\n*$//;
4948 my $cnt = statement_rawlines($ctx);
4949 my $herectx = $here . "\n";
4950
4951 for (my $n = 0; $n < $cnt; $n++) {
4952 $herectx .= raw_line($linenr, $n) . "\n";
4953 }
4954
Joe Perchesac8e97f2012-08-21 16:15:53 -07004955 if (($stmts =~ tr/;/;/) == 1 &&
4956 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004957 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4958 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4959 }
4960 if (defined $semis && $semis ne "") {
4961 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4962 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4963 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004964 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4965 $ctx =~ s/\n*$//;
4966 my $cnt = statement_rawlines($ctx);
4967 my $herectx = $here . "\n";
4968
4969 for (my $n = 0; $n < $cnt; $n++) {
4970 $herectx .= raw_line($linenr, $n) . "\n";
4971 }
4972
4973 WARN("TRAILING_SEMICOLON",
4974 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004975 }
4976 }
4977
Mike Frysinger080ba922009-01-06 14:41:25 -08004978# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4979# all assignments may have only one of the following with an assignment:
4980# .
4981# ALIGN(...)
4982# VMLINUX_SYMBOL(...)
4983 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004984 WARN("MISSING_VMLINUX_SYMBOL",
4985 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004986 }
4987
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004988# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004989 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4990 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004991 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004992 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004993 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4994 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004995 my @allowed = ();
4996 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004997 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004998 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004999 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005000 for my $chunk (@chunks) {
5001 my ($cond, $block) = @{$chunk};
5002
Andy Whitcroft773647a2008-03-28 14:15:58 -07005003 # If the condition carries leading newlines, then count those as offsets.
5004 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5005 my $offset = statement_rawlines($whitespace) - 1;
5006
Joe Perchesaad4f612012-03-23 15:02:19 -07005007 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005008 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5009
5010 # We have looked at and allowed this specific line.
5011 $suppress_ifbraces{$ln + $offset} = 1;
5012
5013 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005014 $ln += statement_rawlines($block) - 1;
5015
Andy Whitcroft773647a2008-03-28 14:15:58 -07005016 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005017
5018 $seen++ if ($block =~ /^\s*{/);
5019
Joe Perchesaad4f612012-03-23 15:02:19 -07005020 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005021 if (statement_lines($cond) > 1) {
5022 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005023 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005024 }
5025 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005026 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005027 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005028 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005029 if (statement_block_size($block) > 1) {
5030 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005031 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005032 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005033 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005034 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005035 if ($seen) {
5036 my $sum_allowed = 0;
5037 foreach (@allowed) {
5038 $sum_allowed += $_;
5039 }
5040 if ($sum_allowed == 0) {
5041 WARN("BRACES",
5042 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5043 } elsif ($sum_allowed != $allow &&
5044 $seen != $allow) {
5045 CHK("BRACES",
5046 "braces {} should be used on all arms of this statement\n" . $herectx);
5047 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005048 }
5049 }
5050 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005051 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005052 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005053 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005054
Andy Whitcroftcf655042008-03-04 14:28:20 -08005055 # Check the pre-context.
5056 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5057 #print "APW: ALLOWED: pre<$1>\n";
5058 $allowed = 1;
5059 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005060
5061 my ($level, $endln, @chunks) =
5062 ctx_statement_full($linenr, $realcnt, $-[0]);
5063
Andy Whitcroftcf655042008-03-04 14:28:20 -08005064 # Check the condition.
5065 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005066 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005067 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005068 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005069 }
5070 if (statement_lines($cond) > 1) {
5071 #print "APW: ALLOWED: cond<$cond>\n";
5072 $allowed = 1;
5073 }
5074 if ($block =~/\b(?:if|for|while)\b/) {
5075 #print "APW: ALLOWED: block<$block>\n";
5076 $allowed = 1;
5077 }
5078 if (statement_block_size($block) > 1) {
5079 #print "APW: ALLOWED: lines block<$block>\n";
5080 $allowed = 1;
5081 }
5082 # Check the post-context.
5083 if (defined $chunks[1]) {
5084 my ($cond, $block) = @{$chunks[1]};
5085 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005086 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005087 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005088 if ($block =~ /^\s*\{/) {
5089 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5090 $allowed = 1;
5091 }
5092 }
5093 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005094 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005095 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005096
Andy Whitcroftf0556632008-10-15 22:02:23 -07005097 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005098 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005099 }
5100
Joe Perches000d1cc12011-07-25 17:13:25 -07005101 WARN("BRACES",
5102 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005103 }
5104 }
5105
Joe Perches0979ae62012-12-17 16:01:59 -08005106# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005107 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005108 if (CHK("BRACES",
5109 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5110 $fix && $prevrawline =~ /^\+/) {
5111 fix_delete_line($fixlinenr - 1, $prevrawline);
5112 }
Joe Perches0979ae62012-12-17 16:01:59 -08005113 }
Joe Perches77b9a532013-07-03 15:05:29 -07005114 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005115 if (CHK("BRACES",
5116 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5117 $fix) {
5118 fix_delete_line($fixlinenr, $rawline);
5119 }
Joe Perches0979ae62012-12-17 16:01:59 -08005120 }
5121
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005122# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005123 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5124 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005125 WARN("VOLATILE",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005126 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005127 }
5128
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005129# Check for user-visible strings broken across lines, which breaks the ability
5130# to grep for the string. Make exceptions when the previous string ends in a
5131# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5132# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005133 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005134 $prevline =~ /"\s*$/ &&
5135 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5136 if (WARN("SPLIT_STRING",
5137 "quoted string split across lines\n" . $hereprev) &&
5138 $fix &&
5139 $prevrawline =~ /^\+.*"\s*$/ &&
5140 $last_coalesced_string_linenr != $linenr - 1) {
5141 my $extracted_string = get_quoted_string($line, $rawline);
5142 my $comma_close = "";
5143 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5144 $comma_close = $1;
5145 }
5146
5147 fix_delete_line($fixlinenr - 1, $prevrawline);
5148 fix_delete_line($fixlinenr, $rawline);
5149 my $fixedline = $prevrawline;
5150 $fixedline =~ s/"\s*$//;
5151 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5152 fix_insert_line($fixlinenr - 1, $fixedline);
5153 $fixedline = $rawline;
5154 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5155 if ($fixedline !~ /\+\s*$/) {
5156 fix_insert_line($fixlinenr, $fixedline);
5157 }
5158 $last_coalesced_string_linenr = $linenr;
5159 }
5160 }
5161
5162# check for missing a space in a string concatenation
5163 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5164 WARN('MISSING_SPACE',
5165 "break quoted strings at a space character\n" . $hereprev);
5166 }
5167
Joe Perches77cb8542017-02-24 15:01:28 -08005168#check for an embedded function name in a string when the function is known
5169# as part of a diff. This does not work for -f --file checking as it
5170#depends on patch context providing the function name
5171 if ($line =~ /^\+.*$String/ &&
5172 defined($context_function) &&
5173 get_quoted_string($line, $rawline) =~ /\b$context_function\b/) {
5174 WARN("EMBEDDED_FUNCTION_NAME",
5175 "Prefer using \"%s\", __func__ to embedded function names\n" . $herecurr);
5176 }
5177
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005178# check for spaces before a quoted newline
5179 if ($rawline =~ /^.*\".*\s\\n/) {
5180 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5181 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5182 $fix) {
5183 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5184 }
5185
5186 }
5187
Joe Perchesf17dba42014-10-13 15:51:51 -07005188# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005189 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005190 CHK("CONCATENATED_STRING",
5191 "Concatenated strings should use spaces between elements\n" . $herecurr);
5192 }
5193
Joe Perches90ad30e2014-12-10 15:51:59 -08005194# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005195 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005196 WARN("STRING_FRAGMENTS",
5197 "Consecutive strings are generally better as a single string\n" . $herecurr);
5198 }
5199
Joe Perches6e300752015-09-09 15:37:47 -07005200# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005201 my $string;
5202 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5203 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5204 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005205 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005206 WARN("PRINTF_L",
5207 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5208 last;
5209 }
Joe Perches6e300752015-09-09 15:37:47 -07005210 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5211 ERROR("PRINTF_0xDECIMAL",
5212 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5213 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005214 }
5215
5216# check for line continuations in quoted strings with odd counts of "
5217 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5218 WARN("LINE_CONTINUATIONS",
5219 "Avoid line continuations in quoted strings\n" . $herecurr);
5220 }
5221
Andy Whitcroft00df3442007-06-08 13:47:06 -07005222# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005223 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005224 CHK("REDUNDANT_CODE",
5225 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005226 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005227 }
5228
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005229# check for needless "if (<foo>) fn(<foo>)" uses
5230 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005231 my $tested = quotemeta($1);
5232 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5233 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5234 my $func = $1;
5235 if (WARN('NEEDLESS_IF',
5236 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5237 $fix) {
5238 my $do_fix = 1;
5239 my $leading_tabs = "";
5240 my $new_leading_tabs = "";
5241 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5242 $leading_tabs = $1;
5243 } else {
5244 $do_fix = 0;
5245 }
5246 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5247 $new_leading_tabs = $1;
5248 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5249 $do_fix = 0;
5250 }
5251 } else {
5252 $do_fix = 0;
5253 }
5254 if ($do_fix) {
5255 fix_delete_line($fixlinenr - 1, $prevrawline);
5256 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5257 }
5258 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005259 }
5260 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005261
Joe Perchesebfdc402014-08-06 16:10:27 -07005262# check for unnecessary "Out of Memory" messages
5263 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5264 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5265 (defined $1 || defined $3) &&
5266 $linenr > 3) {
5267 my $testval = $2;
5268 my $testline = $lines[$linenr - 3];
5269
5270 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5271# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5272
5273 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5274 WARN("OOM_MESSAGE",
5275 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5276 }
5277 }
5278
Joe Perchesf78d98f2014-10-13 15:52:01 -07005279# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005280 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005281 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5282 my $level = $1;
5283 if (WARN("UNNECESSARY_KERN_LEVEL",
5284 "Possible unnecessary $level\n" . $herecurr) &&
5285 $fix) {
5286 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5287 }
5288 }
5289
Joe Perchesabb08a52014-12-10 15:51:46 -08005290# check for mask then right shift without a parentheses
5291 if ($^V && $^V ge 5.10.0 &&
5292 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5293 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5294 WARN("MASK_THEN_SHIFT",
5295 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5296 }
5297
Joe Perchesb75ac612014-12-10 15:52:02 -08005298# check for pointer comparisons to NULL
5299 if ($^V && $^V ge 5.10.0) {
5300 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5301 my $val = $1;
5302 my $equal = "!";
5303 $equal = "" if ($4 eq "!=");
5304 if (CHK("COMPARISON_TO_NULL",
5305 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5306 $fix) {
5307 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5308 }
5309 }
5310 }
5311
Joe Perches8716de32013-09-11 14:24:05 -07005312# check for bad placement of section $InitAttribute (e.g.: __initdata)
5313 if ($line =~ /(\b$InitAttribute\b)/) {
5314 my $attr = $1;
5315 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5316 my $ptr = $1;
5317 my $var = $2;
5318 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5319 ERROR("MISPLACED_INIT",
5320 "$attr should be placed after $var\n" . $herecurr)) ||
5321 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5322 WARN("MISPLACED_INIT",
5323 "$attr should be placed after $var\n" . $herecurr))) &&
5324 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005325 $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 -07005326 }
5327 }
5328 }
5329
Joe Perchese970b8842013-11-12 15:10:10 -08005330# check for $InitAttributeData (ie: __initdata) with const
5331 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5332 my $attr = $1;
5333 $attr =~ /($InitAttributePrefix)(.*)/;
5334 my $attr_prefix = $1;
5335 my $attr_type = $2;
5336 if (ERROR("INIT_ATTRIBUTE",
5337 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5338 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005339 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005340 s/$InitAttributeData/${attr_prefix}initconst/;
5341 }
5342 }
5343
5344# check for $InitAttributeConst (ie: __initconst) without const
5345 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5346 my $attr = $1;
5347 if (ERROR("INIT_ATTRIBUTE",
5348 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5349 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005350 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005351 /(^\+\s*(?:static\s+))/;
5352 $lead = rtrim($1);
5353 $lead = "$lead " if ($lead !~ /^\+$/);
5354 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005355 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005356 }
5357 }
5358
Joe Perchesc17893c2015-04-16 12:44:42 -07005359# check for __read_mostly with const non-pointer (should just be const)
5360 if ($line =~ /\b__read_mostly\b/ &&
5361 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5362 if (ERROR("CONST_READ_MOSTLY",
5363 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5364 $fix) {
5365 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5366 }
5367 }
5368
Joe Perchesfbdb8132014-04-03 14:49:14 -07005369# don't use __constant_<foo> functions outside of include/uapi/
5370 if ($realfile !~ m@^include/uapi/@ &&
5371 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5372 my $constant_func = $1;
5373 my $func = $constant_func;
5374 $func =~ s/^__constant_//;
5375 if (WARN("CONSTANT_CONVERSION",
5376 "$constant_func should be $func\n" . $herecurr) &&
5377 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005378 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005379 }
5380 }
5381
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005382# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005383 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005384 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005385 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005386 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005387 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005388 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5389 }
5390 if ($delay > 2000) {
5391 WARN("LONG_UDELAY",
5392 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005393 }
5394 }
5395
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005396# warn about unexpectedly long msleep's
5397 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5398 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005399 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005400 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005401 }
5402 }
5403
Joe Perches36ec1932013-07-03 15:05:25 -07005404# check for comparisons of jiffies
5405 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5406 WARN("JIFFIES_COMPARISON",
5407 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5408 }
5409
Joe Perches9d7a34a2013-07-03 15:05:26 -07005410# check for comparisons of get_jiffies_64()
5411 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5412 WARN("JIFFIES_COMPARISON",
5413 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5414 }
5415
Andy Whitcroft00df3442007-06-08 13:47:06 -07005416# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005417# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005418# print "#ifdef in C files should be avoided\n";
5419# print "$herecurr";
5420# $clean = 0;
5421# }
5422
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005423# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005424 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005425 if (ERROR("SPACING",
5426 "exactly one space required after that #$1\n" . $herecurr) &&
5427 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005428 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005429 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5430 }
5431
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005432 }
5433
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005434# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005435 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5436 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005437 my $which = $1;
5438 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005439 CHK("UNCOMMENTED_DEFINITION",
5440 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005441 }
5442 }
5443# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005444
5445 my $barriers = qr{
5446 mb|
5447 rmb|
5448 wmb|
5449 read_barrier_depends
5450 }x;
5451 my $barrier_stems = qr{
5452 mb__before_atomic|
5453 mb__after_atomic|
5454 store_release|
5455 load_acquire|
5456 store_mb|
5457 (?:$barriers)
5458 }x;
5459 my $all_barriers = qr{
5460 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005461 smp_(?:$barrier_stems)|
5462 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005463 }x;
5464
5465 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005466 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005467 WARN("MEMORY_BARRIER",
5468 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005469 }
5470 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005471
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005472 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5473
5474 if ($realfile !~ m@^include/asm-generic/@ &&
5475 $realfile !~ m@/barrier\.h$@ &&
5476 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5477 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5478 WARN("MEMORY_BARRIER",
5479 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5480 }
5481
Joe Perchescb426e92015-06-25 15:02:46 -07005482# check for waitqueue_active without a comment.
5483 if ($line =~ /\bwaitqueue_active\s*\(/) {
5484 if (!ctx_has_comment($first_line, $linenr)) {
5485 WARN("WAITQUEUE_ACTIVE",
5486 "waitqueue_active without comment\n" . $herecurr);
5487 }
5488 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005489
5490# Check for expedited grace periods that interrupt non-idle non-nohz
5491# online CPUs. These expedited can therefore degrade real-time response
5492# if used carelessly, and should be avoided where not absolutely
5493# needed. It is always OK to use synchronize_rcu_expedited() and
5494# synchronize_sched_expedited() at boot time (before real-time applications
5495# start) and in error situations where real-time response is compromised in
5496# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5497# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5498# Of course, nothing comes for free, and srcu_read_lock() and
5499# srcu_read_unlock() do contain full memory barriers in payment for
5500# synchronize_srcu_expedited() non-interruption properties.
5501 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5502 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5503 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5504
5505 }
5506
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005507# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005508 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005509 CHK("ARCH_DEFINES",
5510 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005511 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005512
Tobias Klauserd4977c72010-05-24 14:33:30 -07005513# Check that the storage class is at the beginning of a declaration
5514 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005515 WARN("STORAGE_CLASS",
5516 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005517 }
5518
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005519# check the location of the inline attribute, that it is between
5520# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005521 if ($line =~ /\b$Type\s+$Inline\b/ ||
5522 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005523 ERROR("INLINE_LOCATION",
5524 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005525 }
5526
Andy Whitcroft8905a672007-11-28 16:21:06 -08005527# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005528 if ($realfile !~ m@\binclude/uapi/@ &&
5529 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005530 if (WARN("INLINE",
5531 "plain inline is preferred over $1\n" . $herecurr) &&
5532 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005533 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005534
5535 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005536 }
5537
Joe Perches3d130fd2011-01-12 17:00:00 -08005538# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005539 if ($realfile !~ m@\binclude/uapi/@ &&
5540 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005541 WARN("PREFER_PACKED",
5542 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005543 }
5544
Joe Perches39b7e282011-07-25 17:13:24 -07005545# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005546 if ($realfile !~ m@\binclude/uapi/@ &&
5547 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005548 WARN("PREFER_ALIGNED",
5549 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005550 }
5551
Joe Perches5f14d3b2012-01-10 15:09:52 -08005552# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005553 if ($realfile !~ m@\binclude/uapi/@ &&
5554 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005555 if (WARN("PREFER_PRINTF",
5556 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5557 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005558 $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 -07005559
5560 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005561 }
5562
Joe Perches6061d942012-03-23 15:02:16 -07005563# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005564 if ($realfile !~ m@\binclude/uapi/@ &&
5565 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005566 if (WARN("PREFER_SCANF",
5567 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5568 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005569 $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 -07005570 }
Joe Perches6061d942012-03-23 15:02:16 -07005571 }
5572
Joe Perches619a9082014-12-10 15:51:35 -08005573# Check for __attribute__ weak, or __weak declarations (may have link issues)
5574 if ($^V && $^V ge 5.10.0 &&
5575 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5576 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5577 $line =~ /\b__weak\b/)) {
5578 ERROR("WEAK_DECLARATION",
5579 "Using weak declarations can have unintended link defects\n" . $herecurr);
5580 }
5581
Tomas Winklerfd39f902016-12-12 16:46:34 -08005582# check for c99 types like uint8_t used outside of uapi/ and tools/
Joe Perchese6176fa2015-06-25 15:02:49 -07005583 if ($realfile !~ m@\binclude/uapi/@ &&
Tomas Winklerfd39f902016-12-12 16:46:34 -08005584 $realfile !~ m@\btools/@ &&
Joe Perchese6176fa2015-06-25 15:02:49 -07005585 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5586 my $type = $1;
5587 if ($type =~ /\b($typeC99Typedefs)\b/) {
5588 $type = $1;
5589 my $kernel_type = 'u';
5590 $kernel_type = 's' if ($type =~ /^_*[si]/);
5591 $type =~ /(\d+)/;
5592 $kernel_type .= $1;
5593 if (CHK("PREFER_KERNEL_TYPES",
5594 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5595 $fix) {
5596 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5597 }
5598 }
5599 }
5600
Joe Perches938224b2016-01-20 14:59:15 -08005601# check for cast of C90 native int or longer types constants
5602 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5603 my $cast = $1;
5604 my $const = $2;
5605 if (WARN("TYPECAST_INT_CONSTANT",
5606 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5607 $fix) {
5608 my $suffix = "";
5609 my $newconst = $const;
5610 $newconst =~ s/${Int_type}$//;
5611 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5612 if ($cast =~ /\blong\s+long\b/) {
5613 $suffix .= 'LL';
5614 } elsif ($cast =~ /\blong\b/) {
5615 $suffix .= 'L';
5616 }
5617 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5618 }
5619 }
5620
Joe Perches8f53a9b2010-03-05 13:43:48 -08005621# check for sizeof(&)
5622 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005623 WARN("SIZEOF_ADDRESS",
5624 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005625 }
5626
Joe Perches66c80b62012-07-30 14:41:22 -07005627# check for sizeof without parenthesis
5628 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005629 if (WARN("SIZEOF_PARENTHESIS",
5630 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5631 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005632 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005633 }
Joe Perches66c80b62012-07-30 14:41:22 -07005634 }
5635
Joe Perches88982fe2012-12-17 16:02:00 -08005636# check for struct spinlock declarations
5637 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5638 WARN("USE_SPINLOCK_T",
5639 "struct spinlock should be spinlock_t\n" . $herecurr);
5640 }
5641
Joe Perchesa6962d72013-04-29 16:18:13 -07005642# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005643 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005644 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005645 $fmt =~ s/%%//g;
5646 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005647 if (WARN("PREFER_SEQ_PUTS",
5648 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5649 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005650 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005651 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005652 }
5653 }
5654
Andy Whitcroft554e1652012-01-10 15:09:57 -08005655# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005656 if ($^V && $^V ge 5.10.0 &&
5657 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005658 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005659
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005660 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005661 my $ms_val = $7;
5662 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005663
Andy Whitcroft554e1652012-01-10 15:09:57 -08005664 if ($ms_size =~ /^(0x|)0$/i) {
5665 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005666 "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 -08005667 } elsif ($ms_size =~ /^(0x|)1$/i) {
5668 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005669 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5670 }
5671 }
5672
Joe Perches98a9bba2014-01-23 15:54:52 -08005673# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005674# if ($^V && $^V ge 5.10.0 &&
5675# defined $stat &&
5676# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5677# if (WARN("PREFER_ETHER_ADDR_COPY",
5678# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5679# $fix) {
5680# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5681# }
5682# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005683
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005684# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005685# if ($^V && $^V ge 5.10.0 &&
5686# defined $stat &&
5687# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5688# WARN("PREFER_ETHER_ADDR_EQUAL",
5689# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5690# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005691
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005692# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5693# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf3331952016-10-11 13:51:53 -07005694# if ($^V && $^V ge 5.10.0 &&
5695# defined $stat &&
5696# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5697#
5698# my $ms_val = $7;
5699#
5700# if ($ms_val =~ /^(?:0x|)0+$/i) {
5701# if (WARN("PREFER_ETH_ZERO_ADDR",
5702# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5703# $fix) {
5704# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5705# }
5706# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5707# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5708# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5709# $fix) {
5710# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5711# }
5712# }
5713# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005714
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005715# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005716 if ($^V && $^V ge 5.10.0 &&
5717 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005718 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005719 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005720 my $call = $1;
5721 my $cast1 = deparenthesize($2);
5722 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005723 my $cast2 = deparenthesize($7);
5724 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005725 my $cast;
5726
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005727 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005728 $cast = "$cast1 or $cast2";
5729 } elsif ($cast1 ne "") {
5730 $cast = $cast1;
5731 } else {
5732 $cast = $cast2;
5733 }
5734 WARN("MINMAX",
5735 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005736 }
5737 }
5738
Joe Perches4a273192012-07-30 14:41:20 -07005739# check usleep_range arguments
5740 if ($^V && $^V ge 5.10.0 &&
5741 defined $stat &&
5742 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5743 my $min = $1;
5744 my $max = $7;
5745 if ($min eq $max) {
5746 WARN("USLEEP_RANGE",
5747 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5748 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5749 $min > $max) {
5750 WARN("USLEEP_RANGE",
5751 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5752 }
5753 }
5754
Joe Perches823b7942013-11-12 15:10:15 -08005755# check for naked sscanf
5756 if ($^V && $^V ge 5.10.0 &&
5757 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005758 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005759 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5760 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5761 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5762 my $lc = $stat =~ tr@\n@@;
5763 $lc = $lc + $linenr;
5764 my $stat_real = raw_line($linenr, 0);
5765 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5766 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5767 }
5768 WARN("NAKED_SSCANF",
5769 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5770 }
5771
Joe Perchesafc819a2014-06-04 16:12:08 -07005772# check for simple sscanf that should be kstrto<foo>
5773 if ($^V && $^V ge 5.10.0 &&
5774 defined $stat &&
5775 $line =~ /\bsscanf\b/) {
5776 my $lc = $stat =~ tr@\n@@;
5777 $lc = $lc + $linenr;
5778 my $stat_real = raw_line($linenr, 0);
5779 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5780 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5781 }
5782 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5783 my $format = $6;
5784 my $count = $format =~ tr@%@%@;
5785 if ($count == 1 &&
5786 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5787 WARN("SSCANF_TO_KSTRTO",
5788 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5789 }
5790 }
5791 }
5792
Joe Perches70dc8a42013-09-11 14:23:58 -07005793# check for new externs in .h files.
5794 if ($realfile =~ /\.h$/ &&
5795 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005796 if (CHK("AVOID_EXTERNS",
5797 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005798 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005799 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005800 }
5801 }
5802
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005803# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005804 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005805 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005806 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005807 my $function_name = $1;
5808 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005809
5810 my $s = $stat;
5811 if (defined $cond) {
5812 substr($s, 0, length($cond), '');
5813 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005814 if ($s =~ /^\s*;/ &&
5815 $function_name ne 'uninitialized_var')
5816 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005817 WARN("AVOID_EXTERNS",
5818 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005819 }
5820
5821 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005822 WARN("FUNCTION_ARGUMENTS",
5823 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005824 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005825
5826 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5827 $stat =~ /^.\s*extern\s+/)
5828 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005829 WARN("AVOID_EXTERNS",
5830 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005831 }
5832
Joe Perchesca0d8922016-10-11 13:52:16 -07005833 if ($realfile =~ /\.[ch]$/ && defined $stat &&
5834 $stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
5835 $1 ne "void") {
5836 my $args = trim($1);
5837 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5838 my $arg = trim($1);
5839 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5840 WARN("FUNCTION_ARGUMENTS",
5841 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5842 }
5843 }
5844 }
5845
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005846# checks for new __setup's
5847 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5848 my $name = $1;
5849
5850 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005851 CHK("UNDOCUMENTED_SETUP",
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02005852 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005853 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005854 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005855
5856# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005857 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005858 WARN("UNNECESSARY_CASTS",
5859 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005860 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005861
Joe Perchesa640d252013-07-03 15:05:21 -07005862# alloc style
5863# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5864 if ($^V && $^V ge 5.10.0 &&
5865 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5866 CHK("ALLOC_SIZEOF_STRUCT",
5867 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5868 }
5869
Joe Perches60a55362014-06-04 16:12:07 -07005870# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5871 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005872 $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 -07005873 my $oldfunc = $3;
5874 my $a1 = $4;
5875 my $a2 = $10;
5876 my $newfunc = "kmalloc_array";
5877 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005878 my $r1 = $a1;
5879 my $r2 = $a2;
5880 if ($a1 =~ /^sizeof\s*\S/) {
5881 $r1 = $a2;
5882 $r2 = $a1;
5883 }
5884 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5885 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005886 if (WARN("ALLOC_WITH_MULTIPLY",
5887 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5888 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005889 $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 -07005890
5891 }
5892 }
5893 }
5894
Joe Perches972fdea2013-04-29 16:18:12 -07005895# check for krealloc arg reuse
5896 if ($^V && $^V ge 5.10.0 &&
5897 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5898 WARN("KREALLOC_ARG_REUSE",
5899 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5900 }
5901
Joe Perches5ce59ae2013-02-21 16:44:18 -08005902# check for alloc argument mismatch
5903 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5904 WARN("ALLOC_ARRAY_ARGS",
5905 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5906 }
5907
Joe Perchescaf2a542011-01-12 16:59:56 -08005908# check for multiple semicolons
5909 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005910 if (WARN("ONE_SEMICOLON",
5911 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5912 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005913 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005914 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005915 }
5916
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005917# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5918 if ($realfile !~ m@^include/uapi/@ &&
5919 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08005920 my $ull = "";
5921 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5922 if (CHK("BIT_MACRO",
5923 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5924 $fix) {
5925 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5926 }
5927 }
5928
Joe Perches2d632742016-05-20 17:04:00 -07005929# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5930 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5931 my $config = $1;
5932 if (WARN("PREFER_IS_ENABLED",
5933 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5934 $fix) {
5935 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5936 }
5937 }
5938
Joe Perchese81f2392014-08-06 16:11:25 -07005939# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005940 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5941 my $has_break = 0;
5942 my $has_statement = 0;
5943 my $count = 0;
5944 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005945 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005946 $prevline--;
5947 my $rline = $rawlines[$prevline - 1];
5948 my $fline = $lines[$prevline - 1];
5949 last if ($fline =~ /^\@\@/);
5950 next if ($fline =~ /^\-/);
5951 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5952 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5953 next if ($fline =~ /^.[\s$;]*$/);
5954 $has_statement = 1;
5955 $count++;
5956 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5957 }
5958 if (!$has_break && $has_statement) {
5959 WARN("MISSING_BREAK",
Andrew Morton224236d2016-12-12 16:46:26 -08005960 "Possible switch case/default not preceded by break or fallthrough comment\n" . $herecurr);
Joe Perchesc34c09a2014-01-23 15:54:43 -08005961 }
5962 }
5963
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005964# check for switch/default statements without a break;
5965 if ($^V && $^V ge 5.10.0 &&
5966 defined $stat &&
5967 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5968 my $ctx = '';
5969 my $herectx = $here . "\n";
5970 my $cnt = statement_rawlines($stat);
5971 for (my $n = 0; $n < $cnt; $n++) {
5972 $herectx .= raw_line($linenr, $n) . "\n";
5973 }
5974 WARN("DEFAULT_NO_BREAK",
5975 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005976 }
5977
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005978# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005979 if ($line =~ /\b__FUNCTION__\b/) {
5980 if (WARN("USE_FUNC",
5981 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5982 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005983 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005984 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005985 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005986
Joe Perches62ec8182015-02-13 14:38:18 -08005987# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5988 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5989 ERROR("DATE_TIME",
5990 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5991 }
5992
Joe Perches2c924882012-03-23 15:02:20 -07005993# check for use of yield()
5994 if ($line =~ /\byield\s*\(\s*\)/) {
5995 WARN("YIELD",
5996 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5997 }
5998
Joe Perches179f8f42013-07-03 15:05:30 -07005999# check for comparisons against true and false
6000 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6001 my $lead = $1;
6002 my $arg = $2;
6003 my $test = $3;
6004 my $otype = $4;
6005 my $trail = $5;
6006 my $op = "!";
6007
6008 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6009
6010 my $type = lc($otype);
6011 if ($type =~ /^(?:true|false)$/) {
6012 if (("$test" eq "==" && "$type" eq "true") ||
6013 ("$test" eq "!=" && "$type" eq "false")) {
6014 $op = "";
6015 }
6016
6017 CHK("BOOL_COMPARISON",
6018 "Using comparison to $otype is error prone\n" . $herecurr);
6019
6020## maybe suggesting a correct construct would better
6021## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6022
6023 }
6024 }
6025
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006026# check for semaphores initialized locked
6027 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006028 WARN("CONSIDER_COMPLETION",
6029 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006030 }
Joe Perches6712d852012-03-23 15:02:20 -07006031
Joe Perches67d0a072011-10-31 17:13:10 -07006032# recommend kstrto* over simple_strto* and strict_strto*
6033 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006034 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006035 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006036 }
Joe Perches6712d852012-03-23 15:02:20 -07006037
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006038# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006039 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006040 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006041 "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 -07006042 }
Joe Perches6712d852012-03-23 15:02:20 -07006043
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006044# check for various structs that are normally const (ops, kgdb, device_tree)
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006045 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006046 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006047 WARN("CONST_STRUCT",
6048 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006049 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006050 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006051
6052# use of NR_CPUS is usually wrong
6053# ignore definitions of NR_CPUS and usage to define arrays as likely right
6054 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006055 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6056 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006057 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6058 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6059 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006060 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006061 WARN("NR_CPUS",
6062 "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 -07006063 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006064
Joe Perches52ea8502013-11-12 15:10:09 -08006065# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6066 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6067 ERROR("DEFINE_ARCH_HAS",
6068 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6069 }
6070
Joe Perchesacd93622015-02-13 14:38:38 -08006071# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6072 if ($^V && $^V ge 5.10.0 &&
6073 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6074 WARN("LIKELY_MISUSE",
6075 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6076 }
6077
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006078# whine mightly about in_atomic
6079 if ($line =~ /\bin_atomic\s*\(/) {
6080 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006081 ERROR("IN_ATOMIC",
6082 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006083 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006084 WARN("IN_ATOMIC",
6085 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006086 }
6087 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006088
Joe Perches481aea52016-05-20 17:04:08 -07006089# whine about ACCESS_ONCE
6090 if ($^V && $^V ge 5.10.0 &&
6091 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6092 my $par = $1;
6093 my $eq = $2;
6094 my $fun = $3;
6095 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6096 if (defined($eq)) {
6097 if (WARN("PREFER_WRITE_ONCE",
6098 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6099 $fix) {
6100 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6101 }
6102 } else {
6103 if (WARN("PREFER_READ_ONCE",
6104 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6105 $fix) {
6106 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6107 }
6108 }
6109 }
6110
Peter Zijlstra0f5225b2016-10-07 17:43:51 +02006111# check for mutex_trylock_recursive usage
6112 if ($line =~ /mutex_trylock_recursive/) {
6113 ERROR("LOCKING",
6114 "recursive locking is bad, do not use this ever.\n" . $herecurr);
6115 }
6116
Peter Zijlstra1704f472010-03-19 01:37:42 +01006117# check for lockdep_set_novalidate_class
6118 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6119 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6120 if ($realfile !~ m@^kernel/lockdep@ &&
6121 $realfile !~ m@^include/linux/lockdep@ &&
6122 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006123 ERROR("LOCKDEP",
6124 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006125 }
6126 }
Dave Jones88f88312011-01-12 16:59:59 -08006127
Joe Perchesb392c642015-04-16 12:44:16 -07006128 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6129 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006130 WARN("EXPORTED_WORLD_WRITABLE",
6131 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006132 }
Joe Perches24358802014-04-03 14:49:13 -07006133
Joe Perches515a2352014-04-03 14:49:24 -07006134# Mode permission misuses where it seems decimal should be octal
6135# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6136 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006137 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006138 $line =~ /$mode_perms_search/) {
6139 foreach my $entry (@mode_permission_funcs) {
6140 my $func = $entry->[0];
6141 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006142
Joe Perches459cf0a2016-10-11 13:52:19 -07006143 my $lc = $stat =~ tr@\n@@;
6144 $lc = $lc + $linenr;
6145 my $stat_real = raw_line($linenr, 0);
6146 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6147 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6148 }
6149
Joe Perches515a2352014-04-03 14:49:24 -07006150 my $skip_args = "";
6151 if ($arg_pos > 1) {
6152 $arg_pos--;
6153 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6154 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006155 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006156 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006157 my $val = $1;
6158 $val = $6 if ($skip_args ne "");
Joe Perchesf90774e2016-10-11 13:51:47 -07006159 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6160 ($val =~ /^$Octal$/ && length($val) ne 4)) {
Joe Perches515a2352014-04-03 14:49:24 -07006161 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006162 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006163 }
6164 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006165 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006166 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006167 }
Joe Perches24358802014-04-03 14:49:13 -07006168 }
6169 }
6170 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006171
Joe Perches459cf0a2016-10-11 13:52:19 -07006172# check for uses of S_<PERMS> that could be octal for readability
6173 if ($line =~ /\b$mode_perms_string_search\b/) {
6174 my $val = "";
6175 my $oval = "";
6176 my $to = 0;
6177 my $curpos = 0;
6178 my $lastpos = 0;
6179 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6180 $curpos = pos($line);
6181 my $match = $2;
6182 my $omatch = $1;
6183 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6184 $lastpos = $curpos;
6185 $to |= $mode_permission_string_types{$match};
6186 $val .= '\s*\|\s*' if ($val ne "");
6187 $val .= $match;
6188 $oval .= $omatch;
6189 }
6190 $oval =~ s/^\s*\|\s*//;
6191 $oval =~ s/\s*\|\s*$//;
6192 my $octal = sprintf("%04o", $to);
6193 if (WARN("SYMBOLIC_PERMS",
6194 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6195 $fix) {
6196 $fixed[$fixlinenr] =~ s/$val/$octal/;
6197 }
6198 }
6199
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006200# validate content of MODULE_LICENSE against list from include/linux/module.h
6201 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6202 my $extracted_string = get_quoted_string($line, $rawline);
6203 my $valid_licenses = qr{
6204 GPL|
6205 GPL\ v2|
6206 GPL\ and\ additional\ rights|
6207 Dual\ BSD/GPL|
6208 Dual\ MIT/GPL|
6209 Dual\ MPL/GPL|
6210 Proprietary
6211 }x;
6212 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6213 WARN("MODULE_LICENSE",
6214 "unknown module license " . $extracted_string . "\n" . $herecurr);
6215 }
6216 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006217 }
6218
6219 # If we have no input at all, then there is nothing to report on
6220 # so just keep quiet.
6221 if ($#rawlines == -1) {
6222 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006223 }
6224
Andy Whitcroft8905a672007-11-28 16:21:06 -08006225 # In mailback mode only produce a report in the negative, for
6226 # things that appear to be patches.
6227 if ($mailback && ($clean == 1 || !$is_patch)) {
6228 exit(0);
6229 }
6230
6231 # This is not a patch, and we are are in 'no-patch' mode so
6232 # just keep quiet.
6233 if (!$chk_patch && !$is_patch) {
6234 exit(0);
6235 }
6236
Joe Perches06330fc2015-06-25 15:03:11 -07006237 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006238 ERROR("NOT_UNIFIED_DIFF",
6239 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006240 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006241 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006242 ERROR("MISSING_SIGN_OFF",
6243 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006244 }
6245
Andy Whitcroft8905a672007-11-28 16:21:06 -08006246 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006247 if ($summary && !($clean == 1 && $quiet == 1)) {
6248 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006249 print "total: $cnt_error errors, $cnt_warn warnings, " .
6250 (($check)? "$cnt_chk checks, " : "") .
6251 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006252 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006253
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006254 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006255 # If there were any defects found and not already fixing them
6256 if (!$clean and !$fix) {
6257 print << "EOM"
6258
6259NOTE: For some of the reported defects, checkpatch may be able to
6260 mechanically convert to the typical style using --fix or --fix-inplace.
6261EOM
6262 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006263 # If there were whitespace errors which cleanpatch can fix
6264 # then suggest that.
6265 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006266 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006267 print << "EOM"
6268
6269NOTE: Whitespace errors detected.
6270 You may wish to use scripts/cleanpatch or scripts/cleanfile
6271EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006272 }
6273 }
6274
Joe Perchesd752fcc2014-08-06 16:11:05 -07006275 if ($clean == 0 && $fix &&
6276 ("@rawlines" ne "@fixed" ||
6277 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006278 my $newfile = $filename;
6279 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006280 my $linecount = 0;
6281 my $f;
6282
Joe Perchesd752fcc2014-08-06 16:11:05 -07006283 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6284
Joe Perches3705ce52013-07-03 15:05:31 -07006285 open($f, '>', $newfile)
6286 or die "$P: Can't open $newfile for write\n";
6287 foreach my $fixed_line (@fixed) {
6288 $linecount++;
6289 if ($file) {
6290 if ($linecount > 3) {
6291 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006292 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006293 }
6294 } else {
6295 print $f $fixed_line . "\n";
6296 }
6297 }
6298 close($f);
6299
6300 if (!$quiet) {
6301 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006302
Joe Perches3705ce52013-07-03 15:05:31 -07006303Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6304
6305Do _NOT_ trust the results written to this file.
6306Do _NOT_ submit these changes without inspecting them for correctness.
6307
6308This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6309No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006310EOM
6311 }
6312 }
6313
Joe Perchesd8469f12015-06-25 15:03:00 -07006314 if ($quiet == 0) {
6315 print "\n";
6316 if ($clean == 1) {
6317 print "$vname has no obvious style problems and is ready for submission.\n";
6318 } else {
6319 print "$vname has style problems, please review.\n";
6320 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006321 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006322 return $clean;
6323}