blob: f0da53f09c3b0cf97e378a8a93c63f13573792dc [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070030my $git = 0;
Joe Perches0dea9f12016-05-20 17:04:19 -070031my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070033my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080034my $summary = 1;
35my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080036my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070037my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070038my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070039my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080040my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070041my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080042my %debug;
Joe Perches34456862013-07-03 15:05:34 -070043my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070044my %use_type = ();
45my @use = ();
46my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070047my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070048my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070049my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080050my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070051my $ignore_perl_version = 0;
52my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070053my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070054my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070055my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070056my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perchesbf1fa1d2016-10-11 13:51:56 -070057my $conststructsfile = "$D/const_structs.checkpatch";
Joe Perches57230292015-06-25 15:03:03 -070058my $color = 1;
Joe Perchesdadf6802016-08-02 14:04:33 -070059my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070060
61sub help {
62 my ($exitcode) = @_;
63
64 print << "EOM";
65Usage: $P [OPTION]... [FILE]...
66Version: $V
67
68Options:
69 -q, --quiet quiet
70 --no-tree run without a kernel tree
71 --no-signoff do not check for 'Signed-off-by' line
72 --patch treat FILE as patchfile (default)
73 --emacs emacs compile window format
74 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070075 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070076 -g, --git treat FILE as a single commit or git revision range
77 single git commit with:
78 <rev>
79 <rev>^
80 <rev>~n
81 multiple git commits with:
82 <rev1>..<rev2>
83 <rev1>...<rev2>
84 <rev>-<count>
85 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070086 -f, --file treat FILE as regular source file
87 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070088 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070089 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070090 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070091 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080092 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070093 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070094 --root=PATH PATH to the kernel tree root
95 --no-summary suppress the per-file summary
96 --mailback only produce a report in case of warnings/errors
97 --summary-file include the filename in summary
98 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
99 'values', 'possible', 'type', and 'attr' (default
100 is all off)
101 --test-only=WORD report only warnings/errors containing WORD
102 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700103 --fix EXPERIMENTAL - may create horrible results
104 If correctable single-line errors exist, create
105 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
106 with potential errors corrected to the preferred
107 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800108 --fix-inplace EXPERIMENTAL - may create horrible results
109 Is the same as --fix, but overwrites the input
110 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700111 --ignore-perl-version override checking of perl version. expect
112 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700113 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700114 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700115 --codespellfile Use this codespell dictionary
Joe Perches57230292015-06-25 15:03:03 -0700116 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700117 -h, --help, --version display this help and exit
118
119When FILE is - read standard input.
120EOM
121
122 exit($exitcode);
123}
124
Joe Perches3beb42e2016-05-20 17:04:14 -0700125sub uniq {
126 my %seen;
127 return grep { !$seen{$_}++ } @_;
128}
129
130sub list_types {
131 my ($exitcode) = @_;
132
133 my $count = 0;
134
135 local $/ = undef;
136
137 open(my $script, '<', abs_path($P)) or
138 die "$P: Can't read '$P' $!\n";
139
140 my $text = <$script>;
141 close($script);
142
143 my @types = ();
144 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
145 push (@types, $_);
146 }
147 @types = sort(uniq(@types));
148 print("#\tMessage type\n\n");
149 foreach my $type (@types) {
150 print(++$count . "\t" . $type . "\n");
151 }
152
153 exit($exitcode);
154}
155
Joe Perches000d1cc12011-07-25 17:13:25 -0700156my $conf = which_conf($configuration_file);
157if (-f $conf) {
158 my @conf_args;
159 open(my $conffile, '<', "$conf")
160 or warn "$P: Can't find a readable $configuration_file file $!\n";
161
162 while (<$conffile>) {
163 my $line = $_;
164
165 $line =~ s/\s*\n?$//g;
166 $line =~ s/^\s*//g;
167 $line =~ s/\s+/ /g;
168
169 next if ($line =~ m/^\s*#/);
170 next if ($line =~ m/^\s*$/);
171
172 my @words = split(" ", $line);
173 foreach my $word (@words) {
174 last if ($word =~ m/^#/);
175 push (@conf_args, $word);
176 }
177 }
178 close($conffile);
179 unshift(@ARGV, @conf_args) if @conf_args;
180}
181
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700182GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700183 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700184 'tree!' => \$tree,
185 'signoff!' => \$chk_signoff,
186 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700187 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800188 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700189 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700190 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700191 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700192 'subjective!' => \$check,
193 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700194 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700195 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700196 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700197 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800198 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700199 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700200 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800201 'summary!' => \$summary,
202 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800203 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700204 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800205 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700206 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800207 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700208 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700209 'codespell!' => \$codespell,
210 'codespellfile=s' => \$codespellfile,
Joe Perches57230292015-06-25 15:03:03 -0700211 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700212 'h|help' => \$help,
213 'version' => \$help
214) or help(1);
215
216help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700217
Joe Perches3beb42e2016-05-20 17:04:14 -0700218list_types(0) if ($list_types);
219
Joe Perches9624b8d2014-01-23 15:54:44 -0800220$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700221$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800222
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700223my $exit = 0;
224
Dave Hansend62a2012013-09-11 14:23:56 -0700225if ($^V && $^V lt $minimum_perl_version) {
226 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
227 if (!$ignore_perl_version) {
228 exit(1);
229 }
230}
231
Allen Hubbe45107ff2016-08-02 14:04:47 -0700232#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700233if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700234 push(@ARGV, '-');
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700235}
236
Joe Perches91bfe482013-09-11 14:23:59 -0700237sub hash_save_array_words {
238 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700239
Joe Perches91bfe482013-09-11 14:23:59 -0700240 my @array = split(/,/, join(',', @$arrayRef));
241 foreach my $word (@array) {
242 $word =~ s/\s*\n?$//g;
243 $word =~ s/^\s*//g;
244 $word =~ s/\s+/ /g;
245 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700246
Joe Perches91bfe482013-09-11 14:23:59 -0700247 next if ($word =~ m/^\s*#/);
248 next if ($word =~ m/^\s*$/);
249
250 $hashRef->{$word}++;
251 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700252}
253
Joe Perches91bfe482013-09-11 14:23:59 -0700254sub hash_show_words {
255 my ($hashRef, $prefix) = @_;
256
Joe Perches3c816e42015-06-25 15:03:29 -0700257 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700258 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700259 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700260 print " $word";
261 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700262 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700263 }
264}
265
266hash_save_array_words(\%ignore_type, \@ignore);
267hash_save_array_words(\%use_type, \@use);
268
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800269my $dbg_values = 0;
270my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700271my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700272my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800273for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800274 ## no critic
275 eval "\${dbg_$key} = '$debug{$key}';";
276 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800277}
278
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700279my $rpt_cleaners = 0;
280
Andy Whitcroft8905a672007-11-28 16:21:06 -0800281if ($terse) {
282 $emacs = 1;
283 $quiet++;
284}
285
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700286if ($tree) {
287 if (defined $root) {
288 if (!top_of_kernel_tree($root)) {
289 die "$P: $root: --root does not point at a valid tree\n";
290 }
291 } else {
292 if (top_of_kernel_tree('.')) {
293 $root = '.';
294 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
295 top_of_kernel_tree($1)) {
296 $root = $1;
297 }
298 }
299
300 if (!defined $root) {
301 print "Must be run from the top-level dir. of a kernel tree\n";
302 exit(2);
303 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700304}
305
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700306my $emitted_corrupt = 0;
307
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700308our $Ident = qr{
309 [A-Za-z_][A-Za-z\d_]*
310 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
311 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700312our $Storage = qr{extern|static|asmlinkage};
313our $Sparse = qr{
314 __user|
315 __kernel|
316 __force|
317 __iomem|
318 __must_check|
319 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800320 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700321 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800322 __rcu|
323 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700324 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800325our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
326our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
327our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
328our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
329our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700330
Wolfram Sang52131292010-03-05 13:43:51 -0800331# Notes to $Attribute:
332# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700333our $Attribute = qr{
334 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700335 __percpu|
336 __nocast|
337 __safe|
338 __bitwise__|
339 __packed__|
340 __packed2__|
341 __naked|
342 __maybe_unused|
343 __always_unused|
344 __noreturn|
345 __used|
346 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800347 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700348 __noclone|
349 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700350 __read_mostly|
351 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700352 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700353 ____cacheline_aligned|
354 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800355 ____cacheline_internodealigned_in_smp|
356 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700357 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700358our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700359our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700360our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
361our $Lval = qr{$Ident(?:$Member)*};
362
Joe Perches95e2c602013-07-03 15:05:20 -0700363our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
364our $Binary = qr{(?i)0b[01]+$Int_type?};
365our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
366our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700367our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800368our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800369our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
370our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
371our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800372our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700373our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800374our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700375our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700376our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700377our $Operators = qr{
378 <=|>=|==|!=|
379 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700380 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700381 }x;
382
Joe Perches91cb5192014-04-03 14:49:32 -0700383our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
384
Joe Perchesab7e23f2015-04-16 12:44:22 -0700385our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800386our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700387our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700388our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800389our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700390our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800391our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700392our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800393
Joe Perches15662b32011-10-31 17:13:12 -0700394our $NON_ASCII_UTF8 = qr{
395 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700396 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
397 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
398 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
399 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
400 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
401 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
402}x;
403
Joe Perches15662b32011-10-31 17:13:12 -0700404our $UTF8 = qr{
405 [\x09\x0A\x0D\x20-\x7E] # ASCII
406 | $NON_ASCII_UTF8
407}x;
408
Joe Perchese6176fa2015-06-25 15:02:49 -0700409our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800410our $typeOtherOSTypedefs = qr{(?x:
411 u_(?:char|short|int|long) | # bsd
412 u(?:nchar|short|int|long) # sysv
413)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700414our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700415 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700416 atomic_t
417)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700418our $typeTypedefs = qr{(?x:
419 $typeC99Typedefs\b|
420 $typeOtherOSTypedefs\b|
421 $typeKernelTypedefs\b
422)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700423
Joe Perches6d32f7a2015-11-06 16:31:37 -0800424our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
425
Joe Perches691e6692010-03-05 13:43:51 -0800426our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700427 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700428 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700429 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700430 panic|
Joe Perches06668722013-11-12 15:10:07 -0800431 MODULE_[A-Z_]+|
432 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800433)};
434
Joe Perches20112472011-07-25 17:13:23 -0700435our $signature_tags = qr{(?xi:
436 Signed-off-by:|
437 Acked-by:|
438 Tested-by:|
439 Reviewed-by:|
440 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700441 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700442 To:|
443 Cc:
444)};
445
Joe Perches18130872014-08-06 16:11:22 -0700446our @typeListMisordered = (
447 qr{char\s+(?:un)?signed},
448 qr{int\s+(?:(?:un)?signed\s+)?short\s},
449 qr{int\s+short(?:\s+(?:un)?signed)},
450 qr{short\s+int(?:\s+(?:un)?signed)},
451 qr{(?:un)?signed\s+int\s+short},
452 qr{short\s+(?:un)?signed},
453 qr{long\s+int\s+(?:un)?signed},
454 qr{int\s+long\s+(?:un)?signed},
455 qr{long\s+(?:un)?signed\s+int},
456 qr{int\s+(?:un)?signed\s+long},
457 qr{int\s+(?:un)?signed},
458 qr{int\s+long\s+long\s+(?:un)?signed},
459 qr{long\s+long\s+int\s+(?:un)?signed},
460 qr{long\s+long\s+(?:un)?signed\s+int},
461 qr{long\s+long\s+(?:un)?signed},
462 qr{long\s+(?:un)?signed},
463);
464
Andy Whitcroft8905a672007-11-28 16:21:06 -0800465our @typeList = (
466 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700467 qr{(?:(?:un)?signed\s+)?char},
468 qr{(?:(?:un)?signed\s+)?short\s+int},
469 qr{(?:(?:un)?signed\s+)?short},
470 qr{(?:(?:un)?signed\s+)?int},
471 qr{(?:(?:un)?signed\s+)?long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
473 qr{(?:(?:un)?signed\s+)?long\s+long},
474 qr{(?:(?:un)?signed\s+)?long},
475 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800476 qr{float},
477 qr{double},
478 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800479 qr{struct\s+$Ident},
480 qr{union\s+$Ident},
481 qr{enum\s+$Ident},
482 qr{${Ident}_t},
483 qr{${Ident}_handler},
484 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700485 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800486);
Joe Perches938224b2016-01-20 14:59:15 -0800487
488our $C90_int_types = qr{(?x:
489 long\s+long\s+int\s+(?:un)?signed|
490 long\s+long\s+(?:un)?signed\s+int|
491 long\s+long\s+(?:un)?signed|
492 (?:(?:un)?signed\s+)?long\s+long\s+int|
493 (?:(?:un)?signed\s+)?long\s+long|
494 int\s+long\s+long\s+(?:un)?signed|
495 int\s+(?:(?:un)?signed\s+)?long\s+long|
496
497 long\s+int\s+(?:un)?signed|
498 long\s+(?:un)?signed\s+int|
499 long\s+(?:un)?signed|
500 (?:(?:un)?signed\s+)?long\s+int|
501 (?:(?:un)?signed\s+)?long|
502 int\s+long\s+(?:un)?signed|
503 int\s+(?:(?:un)?signed\s+)?long|
504
505 int\s+(?:un)?signed|
506 (?:(?:un)?signed\s+)?int
507)};
508
Alex Dowad485ff232015-06-25 15:02:52 -0700509our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700510our @typeListWithAttr = (
511 @typeList,
512 qr{struct\s+$InitAttribute\s+$Ident},
513 qr{union\s+$InitAttribute\s+$Ident},
514);
515
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700516our @modifierList = (
517 qr{fastcall},
518);
Alex Dowad485ff232015-06-25 15:02:52 -0700519our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800520
Joe Perches24358802014-04-03 14:49:13 -0700521our @mode_permission_funcs = (
522 ["module_param", 3],
523 ["module_param_(?:array|named|string)", 4],
524 ["module_param_array_named", 5],
525 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
526 ["proc_create(?:_data|)", 2],
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
764 return 0 if (!(-e "$root/scripts/get_maintainer.pl"));
765
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 Perches0dea9f12016-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 Perches0dea9f12016-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 Perches0dea9f12016-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 Whitcroft0a920b52007-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 Perches0dea9f12016-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -07001570sub cat_vet {
1571 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001572 my ($res, $coded);
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -07001583
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001584 return $res;
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -07002117sub process {
2118 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002119
2120 my $linenr=0;
2121 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002122 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002123 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002124 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002125
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002126 my $length;
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Perchesbf4daf12015-09-09 15:37:50 -07002137 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 Whitcroft0a920b52007-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 = '';
2157 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002158 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002159 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002160 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002161
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002162 my $prev_values = 'E';
2163
2164 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002165 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002166 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002167 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002168 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002169
Joe Perches7e51f192013-09-11 14:23:57 -07002170 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002171
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002172 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002173 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002174 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002175 my @setup_docs = ();
2176 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002177
Joe Perchesd8b07712013-11-12 15:10:06 -08002178 my $camelcase_file_seeded = 0;
2179
Andy Whitcroft773647a2008-03-28 14:15:58 -07002180 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002181 my $line;
2182 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002183 $linenr++;
2184 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002185
Joe Perches3705ce52013-07-03 15:05:31 -07002186 push(@fixed, $rawline) if ($fix);
2187
Andy Whitcroft773647a2008-03-28 14:15:58 -07002188 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002189 $setup_docs = 0;
2190 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2191 $setup_docs = 1;
2192 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002193 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002194 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002195 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2196 $realline=$1-1;
2197 if (defined $2) {
2198 $realcnt=$3+1;
2199 } else {
2200 $realcnt=1+1;
2201 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002202 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002203
2204 # Guestimate if this is a continuing comment. Run
2205 # the context looking for a comment "edge". If this
2206 # edge is a close comment then we must be in a comment
2207 # at context start.
2208 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002209 my $cnt = $realcnt;
2210 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2211 next if (defined $rawlines[$ln - 1] &&
2212 $rawlines[$ln - 1] =~ /^-/);
2213 $cnt--;
2214 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002215 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002216 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2217 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2218 ($edge) = $1;
2219 last;
2220 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002221 }
2222 if (defined $edge && $edge eq '*/') {
2223 $in_comment = 1;
2224 }
2225
2226 # Guestimate if this is a continuing comment. If this
2227 # is the start of a diff block and this line starts
2228 # ' *' then it is very likely a comment.
2229 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002230 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002231 {
2232 $in_comment = 1;
2233 }
2234
2235 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2236 sanitise_line_reset($in_comment);
2237
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002238 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002239 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002240 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002241 $line = sanitise_line($rawline);
2242 }
2243 push(@lines, $line);
2244
2245 if ($realcnt > 1) {
2246 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2247 } else {
2248 $realcnt = 0;
2249 }
2250
2251 #print "==>$rawline\n";
2252 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002253
2254 if ($setup_docs && $line =~ /^\+/) {
2255 push(@setup_docs, $line);
2256 }
2257 }
2258
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002259 $prefix = '';
2260
Andy Whitcroft773647a2008-03-28 14:15:58 -07002261 $realcnt = 0;
2262 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002263 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002264 foreach my $line (@lines) {
2265 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002266 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002267 my $sline = $line; #copy of $line
2268 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002269
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002270 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002271
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002272#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002273 if (!$in_commit_log &&
2274 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002275 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002276 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002277 $realline=$1-1;
2278 if (defined $2) {
2279 $realcnt=$3+1;
2280 } else {
2281 $realcnt=1+1;
2282 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002283 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002284 $prev_values = 'E';
2285
Andy Whitcroft773647a2008-03-28 14:15:58 -07002286 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002287 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002288 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002289 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002290 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002291
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002292# track the line number as we move through the hunk, note that
2293# new versions of GNU diff omit the leading space on completely
2294# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002295 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002296 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002297 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002298
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002299 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002300 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002301
2302 # Track the previous line.
2303 ($prevline, $stashline) = ($stashline, $line);
2304 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002305 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2306
Andy Whitcroft773647a2008-03-28 14:15:58 -07002307 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002308
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002309 } elsif ($realcnt == 1) {
2310 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002311 }
2312
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002313 my $hunk_line = ($realcnt != 0);
2314
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002315 $here = "#$linenr: " if (!$file);
2316 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002317
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002318 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002319 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002320 if ($line =~ /^diff --git.*?(\S+)$/) {
2321 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002322 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002323 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002324 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002325 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002326 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002327 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002328 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002329
2330 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002331 if (!$file && $tree && $p1_prefix ne '' &&
2332 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002333 WARN("PATCH_PREFIX",
2334 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002335 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002336
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002337 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002338 ERROR("MODIFIED_INCLUDE_ASM",
2339 "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 -07002340 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002341 $found_file = 1;
2342 }
2343
Joe Perches34d88152015-06-25 15:03:05 -07002344#make up the handle for any error we report on this line
2345 if ($showfile) {
2346 $prefix = "$realfile:$realline: "
2347 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002348 if ($file) {
2349 $prefix = "$filename:$realline: ";
2350 } else {
2351 $prefix = "$filename:$linenr: ";
2352 }
Joe Perches34d88152015-06-25 15:03:05 -07002353 }
2354
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002355 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002356 if (is_maintained_obsolete($realfile)) {
2357 WARN("OBSOLETE",
2358 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2359 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002360 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002361 $check = 1;
2362 } else {
2363 $check = $check_orig;
2364 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002365 next;
2366 }
2367
Randy Dunlap389834b2007-06-08 13:47:03 -07002368 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002369
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002370 my $hereline = "$here\n$rawline\n";
2371 my $herecurr = "$here\n$rawline\n";
2372 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002373
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002374 $cnt_lines++ if ($realcnt != 0);
2375
Joe Perchese518e9a2015-06-25 15:03:27 -07002376# Check if the commit log has what seems like a diff which can confuse patch
2377 if ($in_commit_log && !$commit_log_has_diff &&
2378 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2379 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2380 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2381 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2382 ERROR("DIFF_IN_COMMIT_MSG",
2383 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2384 $commit_log_has_diff = 1;
2385 }
2386
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002387# Check for incorrect file permissions
2388 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2389 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002390 if ($realfile !~ m@scripts/@ &&
2391 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002392 ERROR("EXECUTE_PERMISSIONS",
2393 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002394 }
2395 }
2396
Joe Perches20112472011-07-25 17:13:23 -07002397# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002398 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002399 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002400 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002401 }
2402
Joe Perchese0d975b2014-12-10 15:51:49 -08002403# Check if MAINTAINERS is being updated. If so, there's probably no need to
2404# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2405 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2406 $reported_maintainer_file = 1;
2407 }
2408
Joe Perches20112472011-07-25 17:13:23 -07002409# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002410 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002411 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002412 my $space_before = $1;
2413 my $sign_off = $2;
2414 my $space_after = $3;
2415 my $email = $4;
2416 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2417
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002418 if ($sign_off !~ /$signature_tags/) {
2419 WARN("BAD_SIGN_OFF",
2420 "Non-standard signature: $sign_off\n" . $herecurr);
2421 }
Joe Perches20112472011-07-25 17:13:23 -07002422 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002423 if (WARN("BAD_SIGN_OFF",
2424 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2425 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002426 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002427 "$ucfirst_sign_off $email";
2428 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002429 }
Joe Perches20112472011-07-25 17:13:23 -07002430 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002431 if (WARN("BAD_SIGN_OFF",
2432 "'$ucfirst_sign_off' is the preferred signature form\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 }
2437
Joe Perches20112472011-07-25 17:13:23 -07002438 }
2439 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002440 if (WARN("BAD_SIGN_OFF",
2441 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2442 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002443 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002444 "$ucfirst_sign_off $email";
2445 }
Joe Perches20112472011-07-25 17:13:23 -07002446 }
2447
2448 my ($email_name, $email_address, $comment) = parse_email($email);
2449 my $suggested_email = format_email(($email_name, $email_address));
2450 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002451 ERROR("BAD_SIGN_OFF",
2452 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002453 } else {
2454 my $dequoted = $suggested_email;
2455 $dequoted =~ s/^"//;
2456 $dequoted =~ s/" </ </;
2457 # Don't force email to have quotes
2458 # Allow just an angle bracketed address
2459 if ("$dequoted$comment" ne $email &&
2460 "<$email_address>$comment" ne $email &&
2461 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002462 WARN("BAD_SIGN_OFF",
2463 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002464 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002465 }
Joe Perches7e51f192013-09-11 14:23:57 -07002466
2467# Check for duplicate signatures
2468 my $sig_nospace = $line;
2469 $sig_nospace =~ s/\s//g;
2470 $sig_nospace = lc($sig_nospace);
2471 if (defined $signatures{$sig_nospace}) {
2472 WARN("BAD_SIGN_OFF",
2473 "Duplicate signature\n" . $herecurr);
2474 } else {
2475 $signatures{$sig_nospace} = 1;
2476 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002477 }
2478
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002479# Check email subject for common tools that don't need to be mentioned
2480 if ($in_header_lines &&
2481 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2482 WARN("EMAIL_SUBJECT",
2483 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2484 }
2485
Joe Perches9b3189e2014-06-04 16:12:10 -07002486# Check for old stable address
2487 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2488 ERROR("STABLE_ADDRESS",
2489 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2490 }
2491
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002492# Check for unwanted Gerrit info
2493 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2494 ERROR("GERRIT_CHANGE_ID",
2495 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2496 }
2497
Joe Perches369c8dd2015-11-06 16:31:34 -08002498# Check if the commit log is in a possible stack dump
2499 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2500 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2501 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2502 # timestamp
2503 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2504 # stack dump address
2505 $commit_log_possible_stack_dump = 1;
2506 }
2507
Joe Perches2a076f42015-04-16 12:44:28 -07002508# Check for line lengths > 75 in commit log, warn once
2509 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002510 length($line) > 75 &&
2511 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2512 # file delta changes
2513 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2514 # filename then :
2515 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2516 # A Fixes: or Link: line
2517 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002518 WARN("COMMIT_LOG_LONG_LINE",
2519 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2520 $commit_log_long_line = 1;
2521 }
2522
Joe Perchesbf4daf12015-09-09 15:37:50 -07002523# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002524 if ($in_commit_log && $commit_log_possible_stack_dump &&
2525 $line =~ /^\s*$/) {
2526 $commit_log_possible_stack_dump = 0;
2527 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002528
Joe Perches0d7835f2015-02-13 14:38:35 -08002529# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002530 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002531 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Wei Wang5b101522017-04-07 15:22:19 -07002532 $line !~ /^This reverts commit [0-9a-f]{7,40}/ &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002533 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002534 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002535 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2536 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002537 my $init_char = "c";
2538 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002539 my $short = 1;
2540 my $long = 0;
2541 my $case = 1;
2542 my $space = 1;
2543 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002544 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002545 my $id = '0123456789ab';
2546 my $orig_desc = "commit description";
2547 my $description = "";
2548
Joe Perchesfe043ea2015-09-09 15:37:25 -07002549 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2550 $init_char = $1;
2551 $orig_commit = lc($2);
2552 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2553 $orig_commit = lc($1);
2554 }
2555
Joe Perches0d7835f2015-02-13 14:38:35 -08002556 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2557 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2558 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2559 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2560 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2561 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002562 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002563 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2564 defined $rawlines[$linenr] &&
2565 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2566 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002567 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002568 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2569 defined $rawlines[$linenr] &&
2570 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2571 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2572 $orig_desc = $1;
2573 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2574 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002575 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002576 }
2577
2578 ($id, $description) = git_commit_info($orig_commit,
2579 $id, $orig_desc);
2580
Joe Perches19c146a2015-02-13 14:39:00 -08002581 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002582 ERROR("GIT_COMMIT_ID",
2583 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2584 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002585 }
2586
Joe Perches13f19372014-08-06 16:10:59 -07002587# Check for added, moved or deleted files
2588 if (!$reported_maintainer_file && !$in_commit_log &&
2589 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2590 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2591 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2592 (defined($1) || defined($2))))) {
2593 $reported_maintainer_file = 1;
2594 WARN("FILE_PATH_CHANGES",
2595 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2596 }
2597
Andy Whitcroft00df3442007-06-08 13:47:06 -07002598# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002599 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002600 ERROR("CORRUPTED_PATCH",
2601 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002602 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002603 }
2604
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002605# Check for absolute kernel paths.
2606 if ($tree) {
2607 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2608 my $file = $1;
2609
2610 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2611 check_absolute_file($1, $herecurr)) {
2612 #
2613 } else {
2614 check_absolute_file($file, $herecurr);
2615 }
2616 }
2617 }
2618
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002619# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2620 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002621 $rawline !~ m/^$UTF8*$/) {
2622 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2623
2624 my $blank = copy_spacing($rawline);
2625 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2626 my $hereptr = "$hereline$ptr\n";
2627
Joe Perches34d99212011-07-25 17:13:26 -07002628 CHK("INVALID_UTF8",
2629 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002630 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002631
Joe Perches15662b32011-10-31 17:13:12 -07002632# Check if it's the start of a commit log
2633# (not a header line and we haven't seen the patch filename)
2634 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002635 !($rawline =~ /^\s+\S/ ||
2636 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002637 $in_header_lines = 0;
2638 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002639 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002640 }
2641
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002642# Check if there is UTF-8 in a commit log when a mail header has explicitly
2643# declined it, i.e defined some charset where it is missing.
2644 if ($in_header_lines &&
2645 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2646 $1 !~ /utf-8/i) {
2647 $non_utf8_charset = 1;
2648 }
2649
2650 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002651 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002652 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002653 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2654 }
2655
Kees Cook66b47b42014-10-13 15:51:57 -07002656# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002657 if (defined($misspellings) &&
2658 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002659 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002660 my $typo = $1;
2661 my $typo_fix = $spelling_fix{lc($typo)};
2662 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2663 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2664 my $msg_type = \&WARN;
2665 $msg_type = \&CHK if ($file);
2666 if (&{$msg_type}("TYPO_SPELLING",
2667 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2668 $fix) {
2669 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2670 }
2671 }
2672 }
2673
Andy Whitcroft306708542008-10-15 22:02:28 -07002674# ignore non-hunk lines and lines being removed
2675 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002676
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002677#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002678 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002679 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002680 if (ERROR("DOS_LINE_ENDINGS",
2681 "DOS line endings\n" . $herevet) &&
2682 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002683 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002684 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002685 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2686 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002687 if (ERROR("TRAILING_WHITESPACE",
2688 "trailing whitespace\n" . $herevet) &&
2689 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002690 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002691 }
2692
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002693 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002694 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002695
Josh Triplett4783f892013-11-12 15:10:12 -08002696# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002697 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002698 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2699 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002700 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2701 my $msg_type = \&ERROR;
2702 $msg_type = \&CHK if ($file);
2703 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002704 "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 -08002705 }
2706
Andi Kleen33549572010-05-24 14:33:29 -07002707# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002708# Only applies when adding the entry originally, after that we do not have
2709# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002710 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002711 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002712 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002713 my $cnt = $realcnt;
2714 my $ln = $linenr + 1;
2715 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002716 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002717 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002718 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002719 $f = $lines[$ln - 1];
2720 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2721 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002722
2723 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002724 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002725
Joe Perches8d73e0e2014-08-06 16:10:46 -07002726 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002727 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002728 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002729 $length = -1;
2730 }
2731
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002732 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002733 $f =~ s/#.*//;
2734 $f =~ s/^\s+//;
2735 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002736 if ($f =~ /^\s*config\s/) {
2737 $is_end = 1;
2738 last;
2739 }
Andi Kleen33549572010-05-24 14:33:29 -07002740 $length++;
2741 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002742 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2743 WARN("CONFIG_DESCRIPTION",
2744 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2745 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002746 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002747 }
2748
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002749# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2750 if ($realfile =~ /Kconfig/ &&
2751 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2752 WARN("CONFIG_EXPERIMENTAL",
2753 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2754 }
2755
Christoph Jaeger327953e2015-02-13 14:38:29 -08002756# discourage the use of boolean for type definition attributes of Kconfig options
2757 if ($realfile =~ /Kconfig/ &&
2758 $line =~ /^\+\s*\bboolean\b/) {
2759 WARN("CONFIG_TYPE_BOOLEAN",
2760 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2761 }
2762
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002763 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2764 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2765 my $flag = $1;
2766 my $replacement = {
2767 'EXTRA_AFLAGS' => 'asflags-y',
2768 'EXTRA_CFLAGS' => 'ccflags-y',
2769 'EXTRA_CPPFLAGS' => 'cppflags-y',
2770 'EXTRA_LDFLAGS' => 'ldflags-y',
2771 };
2772
2773 WARN("DEPRECATED_VARIABLE",
2774 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2775 }
2776
Rob Herringbff5da42014-01-23 15:54:51 -08002777# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002778 if (defined $root &&
2779 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2780 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2781
Rob Herringbff5da42014-01-23 15:54:51 -08002782 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2783
Florian Vaussardcc933192014-04-03 14:49:27 -07002784 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2785 my $vp_file = $dt_path . "vendor-prefixes.txt";
2786
Rob Herringbff5da42014-01-23 15:54:51 -08002787 foreach my $compat (@compats) {
2788 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002789 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2790 my $compat3 = $compat;
2791 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2792 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002793 if ( $? >> 8 ) {
2794 WARN("UNDOCUMENTED_DT_STRING",
2795 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2796 }
2797
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002798 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2799 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002800 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002801 if ( $? >> 8 ) {
2802 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002803 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002804 }
2805 }
2806 }
2807
Andy Whitcroft5368df22008-10-15 22:02:27 -07002808# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002809 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002810
Joe Perches47e0c882015-06-25 15:02:57 -07002811# line length limit (with some exclusions)
2812#
2813# There are a few types of lines that may extend beyond $max_line_length:
2814# logging functions like pr_info that end in a string
2815# lines with a single string
2816# #defines that are a single string
2817#
2818# There are 3 different line length message types:
2819# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2820# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2821# LONG_LINE all other lines longer than $max_line_length
2822#
2823# if LONG_LINE is ignored, the other 2 types are also ignored
2824#
2825
Joe Perchesb4749e92015-07-17 16:24:01 -07002826 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002827 my $msg_type = "LONG_LINE";
2828
2829 # Check the allowed long line types first
2830
2831 # logging functions that end in a string that starts
2832 # before $max_line_length
2833 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2834 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2835 $msg_type = "";
2836
2837 # lines with only strings (w/ possible termination)
2838 # #defines with only strings
2839 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2840 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2841 $msg_type = "";
2842
Joe Perchesd560a5f2016-08-02 14:04:31 -07002843 # EFI_GUID is another special case
2844 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2845 $msg_type = "";
2846
Joe Perches47e0c882015-06-25 15:02:57 -07002847 # Otherwise set the alternate message types
2848
2849 # a comment starts before $max_line_length
2850 } elsif ($line =~ /($;[\s$;]*)$/ &&
2851 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2852 $msg_type = "LONG_LINE_COMMENT"
2853
2854 # a quoted string starts before $max_line_length
2855 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2856 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2857 $msg_type = "LONG_LINE_STRING"
2858 }
2859
2860 if ($msg_type ne "" &&
2861 (show_type("LONG_LINE") || show_type($msg_type))) {
2862 WARN($msg_type,
2863 "line over $max_line_length characters\n" . $herecurr);
2864 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002865 }
2866
Andy Whitcroft8905a672007-11-28 16:21:06 -08002867# check for adding lines without a newline.
2868 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002869 WARN("MISSING_EOF_NEWLINE",
2870 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002871 }
2872
Mike Frysinger42e41c52009-09-21 17:04:40 -07002873# Blackfin: use hi/lo macros
2874 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2875 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2876 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002877 ERROR("LO_MACRO",
2878 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002879 }
2880 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2881 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002882 ERROR("HI_MACRO",
2883 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002884 }
2885 }
2886
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002887# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002888 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002889
2890# at the beginning of a line any tabs must come first and anything
2891# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002892 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2893 $rawline =~ /^\+\s* \s*/) {
2894 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002895 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002896 if (ERROR("CODE_INDENT",
2897 "code indent should use tabs where possible\n" . $herevet) &&
2898 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002899 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002900 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002901 }
2902
Alberto Panizzo08e44362010-03-05 13:43:54 -08002903# check for space before tabs.
2904 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2905 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002906 if (WARN("SPACE_BEFORE_TAB",
2907 "please, no space before tabs\n" . $herevet) &&
2908 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002909 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002910 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002911 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002912 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002913 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002914 }
2915
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002916# check for && or || at the start of a line
2917 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2918 CHK("LOGICAL_CONTINUATIONS",
2919 "Logical continuations should be on the previous line\n" . $hereprev);
2920 }
2921
Joe Perchesa91e8992016-05-20 17:04:05 -07002922# check indentation starts on a tab stop
2923 if ($^V && $^V ge 5.10.0 &&
2924 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2925 my $indent = length($1);
2926 if ($indent % 8) {
2927 if (WARN("TABSTOP",
2928 "Statements should start on a tabstop\n" . $herecurr) &&
2929 $fix) {
2930 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2931 }
2932 }
2933 }
2934
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002935# check multi-line statement indentation matches previous line
2936 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002937 $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 -07002938 $prevline =~ /^\+(\t*)(.*)$/;
2939 my $oldindent = $1;
2940 my $rest = $2;
2941
2942 my $pos = pos_last_openparen($rest);
2943 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002944 $line =~ /^(\+| )([ \t]*)/;
2945 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002946
2947 my $goodtabindent = $oldindent .
2948 "\t" x ($pos / 8) .
2949 " " x ($pos % 8);
2950 my $goodspaceindent = $oldindent . " " x $pos;
2951
2952 if ($newindent ne $goodtabindent &&
2953 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002954
2955 if (CHK("PARENTHESIS_ALIGNMENT",
2956 "Alignment should match open parenthesis\n" . $hereprev) &&
2957 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002958 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002959 s/^\+[ \t]*/\+$goodtabindent/;
2960 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002961 }
2962 }
2963 }
2964
Joe Perches6ab3a972015-04-16 12:44:05 -07002965# check for space after cast like "(int) foo" or "(struct foo) bar"
2966# avoid checking a few false positives:
2967# "sizeof(<type>)" or "__alignof__(<type>)"
2968# function pointer declarations like "(*foo)(int) = bar;"
2969# structure definitions like "(struct foo) { 0 };"
2970# multiline macros that define functions
2971# known attributes or the __attribute__ keyword
2972 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2973 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002974 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002975 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002976 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002977 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002978 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002979 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002980 }
2981
Joe Perches86406b12015-09-09 15:37:41 -07002982# Block comment styles
2983# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002984 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002985 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002986 $rawline =~ /^\+[ \t]*\*/ &&
2987 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002988 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2989 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2990 }
2991
Joe Perches86406b12015-09-09 15:37:41 -07002992# Block comments use * on subsequent lines
2993 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2994 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002995 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002996 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002997 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002998 WARN("BLOCK_COMMENT_STYLE",
2999 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003000 }
3001
Joe Perches86406b12015-09-09 15:37:41 -07003002# Block comments use */ on trailing lines
3003 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003004 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3005 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3006 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003007 WARN("BLOCK_COMMENT_STYLE",
3008 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003009 }
3010
Joe Perches08eb9b82016-10-11 13:51:50 -07003011# Block comment * alignment
3012 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
Joe Perchesaf207522016-10-11 13:52:05 -07003013 $line =~ /^\+[ \t]*$;/ && #leading comment
3014 $rawline =~ /^\+[ \t]*\*/ && #leading *
3015 (($prevrawline =~ /^\+.*?\/\*/ && #leading /*
Joe Perches08eb9b82016-10-11 13:51:50 -07003016 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
Joe Perchesaf207522016-10-11 13:52:05 -07003017 $prevrawline =~ /^\+[ \t]*\*/)) { #leading *
3018 my $oldindent;
Joe Perches08eb9b82016-10-11 13:51:50 -07003019 $prevrawline =~ m@^\+([ \t]*/?)\*@;
Joe Perchesaf207522016-10-11 13:52:05 -07003020 if (defined($1)) {
3021 $oldindent = expand_tabs($1);
3022 } else {
3023 $prevrawline =~ m@^\+(.*/?)\*@;
3024 $oldindent = expand_tabs($1);
3025 }
Joe Perches08eb9b82016-10-11 13:51:50 -07003026 $rawline =~ m@^\+([ \t]*)\*@;
3027 my $newindent = $1;
Joe Perches08eb9b82016-10-11 13:51:50 -07003028 $newindent = expand_tabs($newindent);
Joe Perchesaf207522016-10-11 13:52:05 -07003029 if (length($oldindent) ne length($newindent)) {
Joe Perches08eb9b82016-10-11 13:51:50 -07003030 WARN("BLOCK_COMMENT_STYLE",
3031 "Block comments should align the * on each line\n" . $hereprev);
3032 }
3033 }
3034
Joe Perches7f619192014-08-06 16:10:39 -07003035# check for missing blank lines after struct/union declarations
3036# with exceptions for various attributes and macros
3037 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3038 $line =~ /^\+/ &&
3039 !($line =~ /^\+\s*$/ ||
3040 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3041 $line =~ /^\+\s*MODULE_/i ||
3042 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3043 $line =~ /^\+[a-z_]*init/ ||
3044 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3045 $line =~ /^\+\s*DECLARE/ ||
3046 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003047 if (CHK("LINE_SPACING",
3048 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3049 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003050 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003051 }
Joe Perches7f619192014-08-06 16:10:39 -07003052 }
3053
Joe Perches365dd4e2014-08-06 16:10:42 -07003054# check for multiple consecutive blank lines
3055 if ($prevline =~ /^[\+ ]\s*$/ &&
3056 $line =~ /^\+\s*$/ &&
3057 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003058 if (CHK("LINE_SPACING",
3059 "Please don't use multiple blank lines\n" . $hereprev) &&
3060 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003061 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003062 }
3063
Joe Perches365dd4e2014-08-06 16:10:42 -07003064 $last_blank_line = $linenr;
3065 }
3066
Joe Perches3b617e32014-04-03 14:49:28 -07003067# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003068 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3069 # actual declarations
3070 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003071 # function pointer declarations
3072 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003073 # foo bar; where foo is some local typedef or #define
3074 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3075 # known declaration macros
3076 $prevline =~ /^\+\s+$declaration_macros/) &&
3077 # for "else if" which can look like "$Ident $Ident"
3078 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3079 # other possible extensions of declaration lines
3080 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3081 # not starting a section or a macro "\" extended line
3082 $prevline =~ /(?:\{\s*|\\)$/) &&
3083 # looks like a declaration
3084 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003085 # function pointer declarations
3086 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003087 # foo bar; where foo is some local typedef or #define
3088 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3089 # known declaration macros
3090 $sline =~ /^\+\s+$declaration_macros/ ||
3091 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003092 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003093 # start or end of block or continuation of declaration
3094 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3095 # bitfield continuation
3096 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3097 # other possible extensions of declaration lines
3098 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3099 # indentation of previous and current line are the same
3100 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003101 if (WARN("LINE_SPACING",
3102 "Missing a blank line after declarations\n" . $hereprev) &&
3103 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003104 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003105 }
Joe Perches3b617e32014-04-03 14:49:28 -07003106 }
3107
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003108# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003109# Exceptions:
3110# 1) within comments
3111# 2) indented preprocessor commands
3112# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003113 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003114 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003115 if (WARN("LEADING_SPACE",
3116 "please, no spaces at the start of a line\n" . $herevet) &&
3117 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003118 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003119 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003120 }
3121
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003122# check we are in a valid C source file if not then ignore this hunk
3123 next if ($realfile !~ /\.(h|c)$/);
3124
Joe Perches032a4c02014-08-06 16:10:29 -07003125# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003126# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003127# if the previous line is a break or return and is indented 1 tab more...
3128 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3129 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003130 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3131 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3132 defined $lines[$linenr] &&
3133 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003134 WARN("UNNECESSARY_ELSE",
3135 "else is not generally useful after a break or return\n" . $hereprev);
3136 }
3137 }
3138
Joe Perchesc00df192014-08-06 16:11:01 -07003139# check indentation of a line with a break;
3140# if the previous line is a goto or return and is indented the same # of tabs
3141 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3142 my $tabs = $1;
3143 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3144 WARN("UNNECESSARY_BREAK",
3145 "break is not useful after a goto or return\n" . $hereprev);
3146 }
3147 }
3148
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003149# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3150 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3151 WARN("CONFIG_EXPERIMENTAL",
3152 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3153 }
3154
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003155# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003156 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003157 WARN("CVS_KEYWORD",
3158 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003159 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003160
Mike Frysinger42e41c52009-09-21 17:04:40 -07003161# Blackfin: don't use __builtin_bfin_[cs]sync
3162 if ($line =~ /__builtin_bfin_csync/) {
3163 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003164 ERROR("CSYNC",
3165 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003166 }
3167 if ($line =~ /__builtin_bfin_ssync/) {
3168 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003169 ERROR("SSYNC",
3170 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003171 }
3172
Joe Perches56e77d72013-02-21 16:44:14 -08003173# check for old HOTPLUG __dev<foo> section markings
3174 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3175 WARN("HOTPLUG_SECTION",
3176 "Using $1 is unnecessary\n" . $herecurr);
3177 }
3178
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003179# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003180 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3181 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003182#print "LINE<$line>\n";
3183 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003184 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003185 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003186 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003187 $stat =~ s/\n./\n /g;
3188 $cond =~ s/\n./\n /g;
3189
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003190#print "linenr<$linenr> <$stat>\n";
3191 # If this statement has no statement boundaries within
3192 # it there is no point in retrying a statement scan
3193 # until we hit end of it.
3194 my $frag = $stat; $frag =~ s/;+\s*$//;
3195 if ($frag !~ /(?:{|;)/) {
3196#print "skip<$line_nr_next>\n";
3197 $suppress_statement = $line_nr_next;
3198 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003199
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003200 # Find the real next line.
3201 $realline_next = $line_nr_next;
3202 if (defined $realline_next &&
3203 (!defined $lines[$realline_next - 1] ||
3204 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3205 $realline_next++;
3206 }
3207
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003208 my $s = $stat;
3209 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003210
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003211 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003212 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003213
3214 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003215 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003216
Andy Whitcroft463f2862009-09-21 17:04:34 -07003217 } elsif ($s =~ /^.\s*else\b/s) {
3218
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003219 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003220 } 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 -07003221 my $type = $1;
3222 $type =~ s/\s+/ /g;
3223 possible($type, "A:" . $s);
3224
Andy Whitcroft8905a672007-11-28 16:21:06 -08003225 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003226 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003227 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003228 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003229
3230 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003231 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003232 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003233 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003234
3235 # Check for any sort of function declaration.
3236 # int foo(something bar, other baz);
3237 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003238 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 -08003239 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003240
Andy Whitcroftcf655042008-03-04 14:28:20 -08003241 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003242 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003243 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003244
Andy Whitcroft8905a672007-11-28 16:21:06 -08003245 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003246 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003247
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003248 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003249 }
3250 }
3251 }
3252
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003253 }
3254
Andy Whitcroft653d4872007-06-23 17:16:34 -07003255#
3256# Checks which may be anchored in the context.
3257#
3258
3259# Check for switch () and associated case and default
3260# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003261 if ($line=~/\bswitch\s*\(.*\)/) {
3262 my $err = '';
3263 my $sep = '';
3264 my @ctx = ctx_block_outer($linenr, $realcnt);
3265 shift(@ctx);
3266 for my $ctx (@ctx) {
3267 my ($clen, $cindent) = line_stats($ctx);
3268 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3269 $indent != $cindent) {
3270 $err .= "$sep$ctx\n";
3271 $sep = '';
3272 } else {
3273 $sep = "[...]\n";
3274 }
3275 }
3276 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003277 ERROR("SWITCH_CASE_INDENT_LEVEL",
3278 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003279 }
3280 }
3281
3282# if/while/etc brace do not go on next line, unless defining a do while loop,
3283# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003284 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 -07003285 my $pre_ctx = "$1$2";
3286
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003287 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003288
3289 if ($line =~ /^\+\t{6,}/) {
3290 WARN("DEEP_INDENTATION",
3291 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3292 }
3293
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003294 my $ctx_cnt = $realcnt - $#ctx - 1;
3295 my $ctx = join("\n", @ctx);
3296
Andy Whitcroft548596d2008-07-23 21:29:01 -07003297 my $ctx_ln = $linenr;
3298 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003299
Andy Whitcroft548596d2008-07-23 21:29:01 -07003300 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3301 defined $lines[$ctx_ln - 1] &&
3302 $lines[$ctx_ln - 1] =~ /^-/)) {
3303 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3304 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003305 $ctx_ln++;
3306 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003307
Andy Whitcroft53210162008-07-23 21:29:03 -07003308 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3309 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003310
Joe Perchesd752fcc2014-08-06 16:11:05 -07003311 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003312 ERROR("OPEN_BRACE",
3313 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003314 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003315 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003316 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3317 $ctx =~ /\)\s*\;\s*$/ &&
3318 defined $lines[$ctx_ln - 1])
3319 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003320 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3321 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003322 WARN("TRAILING_SEMICOLON",
3323 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003324 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003325 }
3326 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003327 }
3328
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003329# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003330 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 -08003331 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3332 ctx_statement_block($linenr, $realcnt, 0)
3333 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003334 my ($s, $c) = ($stat, $cond);
3335
3336 substr($s, 0, length($c), '');
3337
Joe Perches9f5af482015-09-09 15:37:30 -07003338 # remove inline comments
3339 $s =~ s/$;/ /g;
3340 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003341
3342 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003343 my @newlines = ($c =~ /\n/gs);
3344 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003345
Joe Perches9f5af482015-09-09 15:37:30 -07003346 # Make sure we remove the line prefixes as we have
3347 # none on the first line, and are going to readd them
3348 # where necessary.
3349 $s =~ s/\n./\n/gs;
3350 while ($s =~ /\n\s+\\\n/) {
3351 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3352 }
3353
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003354 # We want to check the first line inside the block
3355 # starting at the end of the conditional, so remove:
3356 # 1) any blank line termination
3357 # 2) any opening brace { on end of the line
3358 # 3) any do (...) {
3359 my $continuation = 0;
3360 my $check = 0;
3361 $s =~ s/^.*\bdo\b//;
3362 $s =~ s/^\s*{//;
3363 if ($s =~ s/^\s*\\//) {
3364 $continuation = 1;
3365 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003366 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003367 $check = 1;
3368 $cond_lines++;
3369 }
3370
3371 # Also ignore a loop construct at the end of a
3372 # preprocessor statement.
3373 if (($prevline =~ /^.\s*#\s*define\s/ ||
3374 $prevline =~ /\\\s*$/) && $continuation == 0) {
3375 $check = 0;
3376 }
3377
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003378 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003379 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003380 while ($cond_ptr != $cond_lines) {
3381 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003382
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003383 # If we see an #else/#elif then the code
3384 # is not linear.
3385 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3386 $check = 0;
3387 }
3388
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003389 # Ignore:
3390 # 1) blank lines, they should be at 0,
3391 # 2) preprocessor lines, and
3392 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003393 if ($continuation ||
3394 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003395 $s =~ /^\s*#\s*?/ ||
3396 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003397 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003398 if ($s =~ s/^.*?\n//) {
3399 $cond_lines++;
3400 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003401 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003402 }
3403
3404 my (undef, $sindent) = line_stats("+" . $s);
3405 my $stat_real = raw_line($linenr, $cond_lines);
3406
3407 # Check if either of these lines are modified, else
3408 # this is not this patch's fault.
3409 if (!defined($stat_real) ||
3410 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3411 $check = 0;
3412 }
3413 if (defined($stat_real) && $cond_lines > 1) {
3414 $stat_real = "[...]\n$stat_real";
3415 }
3416
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003417 #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 -07003418
Joe Perches9f5af482015-09-09 15:37:30 -07003419 if ($check && $s ne '' &&
3420 (($sindent % 8) != 0 ||
3421 ($sindent < $indent) ||
3422 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003423 WARN("SUSPECT_CODE_INDENT",
3424 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003425 }
3426 }
3427
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003428 # Track the 'values' across context and added lines.
3429 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003430 my ($curr_values, $curr_vars) =
3431 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003432 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003433 if ($dbg_values) {
3434 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003435 print "$linenr > .$outline\n";
3436 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003437 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003438 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003439 $prev_values = substr($curr_values, -1);
3440
Andy Whitcroft00df3442007-06-08 13:47:06 -07003441#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003442 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003443
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003444# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003445 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 -07003446 my $type = $1;
3447 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003448 $var = "" if (!defined $var);
3449 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003450 my $sign = $1;
3451 my $pointer = $2;
3452
3453 $pointer = "" if (!defined $pointer);
3454
3455 if (WARN("UNSPECIFIED_INT",
3456 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3457 $fix) {
3458 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003459 my $comp_pointer = $pointer;
3460 $comp_pointer =~ s/\s//g;
3461 $decl .= $comp_pointer;
3462 $decl = rtrim($decl) if ($var eq "");
3463 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003464 }
3465 }
3466 }
3467
Andy Whitcroft653d4872007-06-23 17:16:34 -07003468# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003469 if ($dbg_type) {
3470 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003471 ERROR("TEST_TYPE",
3472 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003473 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003474 ERROR("TEST_NOT_TYPE",
3475 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003476 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003477 next;
3478 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003479# TEST: allow direct testing of the attribute matcher.
3480 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003481 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003482 ERROR("TEST_ATTR",
3483 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003484 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003485 ERROR("TEST_NOT_ATTR",
3486 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003487 }
3488 next;
3489 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003490
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003491# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003492 if ($line =~ /^.\s*{/ &&
3493 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003494 if (ERROR("OPEN_BRACE",
3495 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003496 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3497 fix_delete_line($fixlinenr - 1, $prevrawline);
3498 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003499 my $fixedline = $prevrawline;
3500 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003501 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003502 $fixedline = $line;
Cyril Bur93eae952017-07-10 15:52:21 -07003503 $fixedline =~ s/^(.\s*)\{\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003504 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003505 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003506 }
3507
Andy Whitcroft653d4872007-06-23 17:16:34 -07003508#
3509# Checks which are anchored on the added line.
3510#
3511
3512# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003513 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003514 my $path = $1;
3515 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003516 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003517 "malformed #include filename\n" . $herecurr);
3518 }
3519 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3520 ERROR("UAPI_INCLUDE",
3521 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003522 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003523 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003524
3525# no C99 // comments
3526 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003527 if (ERROR("C99_COMMENTS",
3528 "do not use C99 // comments\n" . $herecurr) &&
3529 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003530 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003531 if ($line =~ /\/\/(.*)$/) {
3532 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003533 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003534 }
3535 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003536 }
3537 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003538 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003539 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003540
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003541# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3542# the whole statement.
3543#print "APW <$lines[$realline_next - 1]>\n";
3544 if (defined $realline_next &&
3545 exists $lines[$realline_next - 1] &&
3546 !defined $suppress_export{$realline_next} &&
3547 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3548 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003549 # Handle definitions which produce identifiers with
3550 # a prefix:
3551 # XXX(foo);
3552 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003553 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003554 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003555 $name =~ /^${Ident}_$2/) {
3556#print "FOO C name<$name>\n";
3557 $suppress_export{$realline_next} = 1;
3558
3559 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003560 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003561 ^.DEFINE_$Ident\(\Q$name\E\)|
3562 ^.DECLARE_$Ident\(\Q$name\E\)|
3563 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003564 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3565 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003566 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003567#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3568 $suppress_export{$realline_next} = 2;
3569 } else {
3570 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003571 }
3572 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003573 if (!defined $suppress_export{$linenr} &&
3574 $prevline =~ /^.\s*$/ &&
3575 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3576 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3577#print "FOO B <$lines[$linenr - 1]>\n";
3578 $suppress_export{$linenr} = 2;
3579 }
3580 if (defined $suppress_export{$linenr} &&
3581 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003582 WARN("EXPORT_SYMBOL",
3583 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003584 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003585
Joe Eloff5150bda2010-08-09 17:21:00 -07003586# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003587 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003588 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003589 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003590 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003591 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003592 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003593 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003594# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003595 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003596 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003597 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003598 $herecurr) &&
3599 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003600 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003601 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003602 }
3603
Joe Perches18130872014-08-06 16:11:22 -07003604# check for misordered declarations of char/short/int/long with signed/unsigned
3605 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3606 my $tmp = trim($1);
3607 WARN("MISORDERED_TYPE",
3608 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3609 }
3610
Joe Perchescb710ec2010-10-26 14:23:20 -07003611# check for static const char * arrays.
3612 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003613 WARN("STATIC_CONST_CHAR_ARRAY",
3614 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003615 $herecurr);
3616 }
3617
3618# check for static char foo[] = "bar" declarations.
3619 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003620 WARN("STATIC_CONST_CHAR_ARRAY",
3621 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003622 $herecurr);
3623 }
3624
Joe Perchesab7e23f2015-04-16 12:44:22 -07003625# check for const <foo> const where <foo> is not a pointer or array type
3626 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3627 my $found = $1;
3628 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3629 WARN("CONST_CONST",
3630 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3631 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3632 WARN("CONST_CONST",
3633 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3634 }
3635 }
3636
Joe Perches9b0fa602014-04-03 14:49:18 -07003637# check for non-global char *foo[] = {"bar", ...} declarations.
3638 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3639 WARN("STATIC_CONST_CHAR_ARRAY",
3640 "char * array declaration might be better as static const\n" .
3641 $herecurr);
3642 }
3643
Joe Perchesb598b672015-04-16 12:44:36 -07003644# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3645 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3646 my $array = $1;
3647 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3648 my $array_div = $1;
3649 if (WARN("ARRAY_SIZE",
3650 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3651 $fix) {
3652 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3653 }
3654 }
3655 }
3656
Joe Perchesb36190c2014-01-27 17:07:18 -08003657# check for function declarations without arguments like "int foo()"
3658 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3659 if (ERROR("FUNCTION_WITHOUT_ARGS",
3660 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3661 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003662 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003663 }
3664 }
3665
Andy Whitcroft653d4872007-06-23 17:16:34 -07003666# check for new typedefs, only function parameters and sparse annotations
3667# make sense.
3668 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003669 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003670 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003671 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003672 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003673 WARN("NEW_TYPEDEFS",
3674 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003675 }
3676
3677# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003678 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003679 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3680 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003681 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003682
Andy Whitcroft65863862009-01-06 14:41:21 -08003683 # Should start with a space.
3684 $to =~ s/^(\S)/ $1/;
3685 # Should not end with a space.
3686 $to =~ s/\s+$//;
3687 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003688 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003689 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003690
Joe Perches3705ce52013-07-03 15:05:31 -07003691## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003692 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003693 if (ERROR("POINTER_LOCATION",
3694 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3695 $fix) {
3696 my $sub_from = $ident;
3697 my $sub_to = $ident;
3698 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003699 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003700 s@\Q$sub_from\E@$sub_to@;
3701 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003702 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003703 }
3704 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3705 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003706 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003707
Andy Whitcroft65863862009-01-06 14:41:21 -08003708 # Should start with a space.
3709 $to =~ s/^(\S)/ $1/;
3710 # Should not end with a space.
3711 $to =~ s/\s+$//;
3712 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003713 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003714 }
3715 # Modifiers should have spaces.
3716 $to =~ s/(\b$Modifier$)/$1 /;
3717
Joe Perches3705ce52013-07-03 15:05:31 -07003718## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003719 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003720 if (ERROR("POINTER_LOCATION",
3721 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3722 $fix) {
3723
3724 my $sub_from = $match;
3725 my $sub_to = $match;
3726 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003727 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003728 s@\Q$sub_from\E@$sub_to@;
3729 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003730 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003731 }
3732
Joe Perches9d3e3c72015-09-09 15:37:27 -07003733# avoid BUG() or BUG_ON()
3734 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3735 my $msg_type = \&WARN;
3736 $msg_type = \&CHK if ($file);
3737 &{$msg_type}("AVOID_BUG",
3738 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3739 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003740
Joe Perches9d3e3c72015-09-09 15:37:27 -07003741# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003742 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003743 WARN("LINUX_VERSION_CODE",
3744 "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 -08003745 }
3746
Joe Perches17441222011-06-15 15:08:17 -07003747# check for uses of printk_ratelimit
3748 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003749 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003750 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003751 }
3752
Andy Whitcroft00df3442007-06-08 13:47:06 -07003753# printk should use KERN_* levels. Note that follow on printk's on the
3754# same line do not need a level, so we use the current block context
3755# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003756# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003757# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003758 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003759 my $ok = 0;
3760 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3761 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003762 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003763 # with "\n" ignore it, else it is to blame
3764 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3765 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3766 $ok = 1;
3767 }
3768 last;
3769 }
3770 }
3771 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003772 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3773 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003774 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003775 }
3776
Joe Perches243f3802012-05-31 16:26:09 -07003777 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3778 my $orig = $1;
3779 my $level = lc($orig);
3780 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003781 my $level2 = $level;
3782 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003783 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003784 "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 -07003785 }
3786
3787 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003788 if (WARN("PREFER_PR_LEVEL",
3789 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3790 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003791 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003792 s/\bpr_warning\b/pr_warn/;
3793 }
Joe Perches243f3802012-05-31 16:26:09 -07003794 }
3795
Joe Perchesdc139312013-02-21 16:44:13 -08003796 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3797 my $orig = $1;
3798 my $level = lc($orig);
3799 $level = "warn" if ($level eq "warning");
3800 $level = "dbg" if ($level eq "debug");
3801 WARN("PREFER_DEV_LEVEL",
3802 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3803 }
3804
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003805# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3806# number of false positives, but assembly files are not checked, so at
3807# least the arch entry code will not trigger this warning.
3808 if ($line =~ /\bENOSYS\b/) {
3809 WARN("ENOSYS",
3810 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3811 }
3812
Andy Whitcroft653d4872007-06-23 17:16:34 -07003813# function brace can't be on same line, except for #defines of do while,
3814# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003815 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003816 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003817 if (ERROR("OPEN_BRACE",
3818 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3819 $fix) {
3820 fix_delete_line($fixlinenr, $rawline);
3821 my $fixed_line = $rawline;
3822 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3823 my $line1 = $1;
3824 my $line2 = $2;
3825 fix_insert_line($fixlinenr, ltrim($line1));
3826 fix_insert_line($fixlinenr, "\+{");
3827 if ($line2 !~ /^\s*$/) {
3828 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3829 }
3830 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003831 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003832
Andy Whitcroft8905a672007-11-28 16:21:06 -08003833# open braces for enum, union and struct go on the same line.
3834 if ($line =~ /^.\s*{/ &&
3835 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003836 if (ERROR("OPEN_BRACE",
3837 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3838 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3839 fix_delete_line($fixlinenr - 1, $prevrawline);
3840 fix_delete_line($fixlinenr, $rawline);
3841 my $fixedline = rtrim($prevrawline) . " {";
3842 fix_insert_line($fixlinenr, $fixedline);
3843 $fixedline = $rawline;
Cyril Bur93eae952017-07-10 15:52:21 -07003844 $fixedline =~ s/^(.\s*)\{\s*/$1\t/;
Joe Perches8d182472014-08-06 16:11:12 -07003845 if ($fixedline !~ /^\+\s*$/) {
3846 fix_insert_line($fixlinenr, $fixedline);
3847 }
3848 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003849 }
3850
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003851# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003852 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3853 if (WARN("SPACING",
3854 "missing space after $1 definition\n" . $herecurr) &&
3855 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003856 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003857 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3858 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003859 }
3860
Joe Perches31070b52014-01-23 15:54:49 -08003861# Function pointer declarations
3862# check spacing between type, funcptr, and args
3863# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003864 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003865 my $declare = $1;
3866 my $pre_pointer_space = $2;
3867 my $post_pointer_space = $3;
3868 my $funcname = $4;
3869 my $post_funcname_space = $5;
3870 my $pre_args_space = $6;
3871
Joe Perches91f72e92014-04-03 14:49:12 -07003872# the $Declare variable will capture all spaces after the type
3873# so check it for a missing trailing missing space but pointer return types
3874# don't need a space so don't warn for those.
3875 my $post_declare_space = "";
3876 if ($declare =~ /(\s+)$/) {
3877 $post_declare_space = $1;
3878 $declare = rtrim($declare);
3879 }
3880 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003881 WARN("SPACING",
3882 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003883 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003884 }
3885
3886# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003887# This test is not currently implemented because these declarations are
3888# equivalent to
3889# int foo(int bar, ...)
3890# and this is form shouldn't/doesn't generate a checkpatch warning.
3891#
3892# elsif ($declare =~ /\s{2,}$/) {
3893# WARN("SPACING",
3894# "Multiple spaces after return type\n" . $herecurr);
3895# }
Joe Perches31070b52014-01-23 15:54:49 -08003896
3897# unnecessary space "type ( *funcptr)(args...)"
3898 if (defined $pre_pointer_space &&
3899 $pre_pointer_space =~ /^\s/) {
3900 WARN("SPACING",
3901 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3902 }
3903
3904# unnecessary space "type (* funcptr)(args...)"
3905 if (defined $post_pointer_space &&
3906 $post_pointer_space =~ /^\s/) {
3907 WARN("SPACING",
3908 "Unnecessary space before function pointer name\n" . $herecurr);
3909 }
3910
3911# unnecessary space "type (*funcptr )(args...)"
3912 if (defined $post_funcname_space &&
3913 $post_funcname_space =~ /^\s/) {
3914 WARN("SPACING",
3915 "Unnecessary space after function pointer name\n" . $herecurr);
3916 }
3917
3918# unnecessary space "type (*funcptr) (args...)"
3919 if (defined $pre_args_space &&
3920 $pre_args_space =~ /^\s/) {
3921 WARN("SPACING",
3922 "Unnecessary space before function pointer arguments\n" . $herecurr);
3923 }
3924
3925 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003926 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003927 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003928 }
3929 }
3930
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003931# check for spacing round square brackets; allowed:
3932# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003933# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3934# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003935 while ($line =~ /(.*?\s)\[/g) {
3936 my ($where, $prefix) = ($-[1], $1);
3937 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003938 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003939 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003940 if (ERROR("BRACKET_SPACE",
3941 "space prohibited before open square bracket '['\n" . $herecurr) &&
3942 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003943 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003944 s/^(\+.*?)\s+\[/$1\[/;
3945 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003946 }
3947 }
3948
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003949# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003950 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003951 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003952 my $ctx_before = substr($line, 0, $-[1]);
3953 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003954
3955 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003956 if ($name =~ /^(?:
3957 if|for|while|switch|return|case|
3958 volatile|__volatile__|
3959 __attribute__|format|__extension__|
3960 asm|__asm__)$/x)
3961 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003962 # cpp #define statements have non-optional spaces, ie
3963 # if there is a space between the name and the open
3964 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003965 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003966
3967 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003968 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003969
3970 # If this whole things ends with a type its most
3971 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003972 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003973
3974 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003975 if (WARN("SPACING",
3976 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3977 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003978 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003979 s/\b$name\s+\(/$name\(/;
3980 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003981 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003982 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003983
Andy Whitcroft653d4872007-06-23 17:16:34 -07003984# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003985 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003986 my $fixed_line = "";
3987 my $line_fixed = 0;
3988
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003989 my $ops = qr{
3990 <<=|>>=|<=|>=|==|!=|
3991 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3992 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003993 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003994 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003995 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003996 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003997
3998## print("element count: <" . $#elements . ">\n");
3999## foreach my $el (@elements) {
4000## print("el: <$el>\n");
4001## }
4002
4003 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004004 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004005
Joe Perches3705ce52013-07-03 15:05:31 -07004006 foreach my $el (@elements) {
4007 push(@fix_elements, substr($rawline, $off, length($el)));
4008 $off += length($el);
4009 }
4010
4011 $off = 0;
4012
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004013 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004014 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004015
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004016 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004017
4018 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4019
4020## print("n: <$n> good: <$good>\n");
4021
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004022 $off += length($elements[$n]);
4023
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004024 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004025 my $ca = substr($opline, 0, $off);
4026 my $cc = '';
4027 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4028 $cc = substr($opline, $off + length($elements[$n + 1]));
4029 }
4030 my $cb = "$ca$;$cc";
4031
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004032 my $a = '';
4033 $a = 'V' if ($elements[$n] ne '');
4034 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004035 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004036 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4037 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004038 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004039
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004040 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004041
4042 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004043 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004044 $c = 'V' if ($elements[$n + 2] ne '');
4045 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004046 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004047 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4048 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004049 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004050 } else {
4051 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004052 }
4053
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004054 my $ctx = "${a}x${c}";
4055
4056 my $at = "(ctx:$ctx)";
4057
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004058 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004059 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004060
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004061 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004062 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004063
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004064 # Get the full operator variant.
4065 my $opv = $op . substr($curr_vars, $off, 1);
4066
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004067 # Ignore operators passed as parameters.
4068 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004069 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004070
Andy Whitcroftcf655042008-03-04 14:28:20 -08004071# # Ignore comments
4072# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004073
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004074 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004075 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004076 if ($ctx !~ /.x[WEBC]/ &&
4077 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004078 if (ERROR("SPACING",
4079 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004080 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004081 $line_fixed = 1;
4082 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004083 }
4084
4085 # // is a comment
4086 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004087
Joe Perchesb00e4812014-04-03 14:49:33 -07004088 # : when part of a bitfield
4089 } elsif ($opv eq ':B') {
4090 # skip the bitfield test for now
4091
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004092 # No spaces for:
4093 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004094 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004095 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004096 if (ERROR("SPACING",
4097 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004098 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004099 if (defined $fix_elements[$n + 2]) {
4100 $fix_elements[$n + 2] =~ s/^\s+//;
4101 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004102 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004103 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004104 }
4105
Joe Perches23810972014-12-10 15:51:32 -08004106 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004107 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004108 my $rtrim_before = 0;
4109 my $space_after = 0;
4110 if ($ctx =~ /Wx./) {
4111 if (ERROR("SPACING",
4112 "space prohibited before that '$op' $at\n" . $hereptr)) {
4113 $line_fixed = 1;
4114 $rtrim_before = 1;
4115 }
4116 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004117 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004118 if (ERROR("SPACING",
4119 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004120 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004121 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004122 $space_after = 1;
4123 }
4124 }
4125 if ($rtrim_before || $space_after) {
4126 if ($rtrim_before) {
4127 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4128 } else {
4129 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4130 }
4131 if ($space_after) {
4132 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004133 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004134 }
4135
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004136 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004137 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004138 #warn "'*' is part of type\n";
4139
4140 # unary operators should have a space before and
4141 # none after. May be left adjacent to another
4142 # unary operator, or a cast
4143 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004144 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004145 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004146 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004147 if (ERROR("SPACING",
4148 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004149 if ($n != $last_after + 2) {
4150 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4151 $line_fixed = 1;
4152 }
Joe Perches3705ce52013-07-03 15:05:31 -07004153 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004154 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004155 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004156 # A unary '*' may be const
4157
4158 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004159 if (ERROR("SPACING",
4160 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004161 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004162 if (defined $fix_elements[$n + 2]) {
4163 $fix_elements[$n + 2] =~ s/^\s+//;
4164 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004165 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004166 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004167 }
4168
4169 # unary ++ and unary -- are allowed no space on one side.
4170 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004171 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004172 if (ERROR("SPACING",
4173 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004174 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004175 $line_fixed = 1;
4176 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004177 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004178 if ($ctx =~ /Wx[BE]/ ||
4179 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004180 if (ERROR("SPACING",
4181 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004182 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004183 $line_fixed = 1;
4184 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004185 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004186 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004187 if (ERROR("SPACING",
4188 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004189 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004190 if (defined $fix_elements[$n + 2]) {
4191 $fix_elements[$n + 2] =~ s/^\s+//;
4192 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004193 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004194 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004195 }
4196
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004197 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004198 } elsif ($op eq '<<' or $op eq '>>' or
4199 $op eq '&' or $op eq '^' or $op eq '|' or
4200 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004201 $op eq '*' or $op eq '/' or
4202 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004203 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004204 if ($check) {
4205 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4206 if (CHK("SPACING",
4207 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4208 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4209 $fix_elements[$n + 2] =~ s/^\s+//;
4210 $line_fixed = 1;
4211 }
4212 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4213 if (CHK("SPACING",
4214 "space preferred before that '$op' $at\n" . $hereptr)) {
4215 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4216 $line_fixed = 1;
4217 }
4218 }
4219 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004220 if (ERROR("SPACING",
4221 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004222 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4223 if (defined $fix_elements[$n + 2]) {
4224 $fix_elements[$n + 2] =~ s/^\s+//;
4225 }
Joe Perches3705ce52013-07-03 15:05:31 -07004226 $line_fixed = 1;
4227 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004228 }
4229
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004230 # A colon needs no spaces before when it is
4231 # terminating a case value or a label.
4232 } elsif ($opv eq ':C' || $opv eq ':L') {
4233 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004234 if (ERROR("SPACING",
4235 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004236 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004237 $line_fixed = 1;
4238 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004239 }
4240
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004241 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004242 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004243 my $ok = 0;
4244
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004245 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004246 if (($op eq '<' &&
4247 $cc =~ /^\S+\@\S+>/) ||
4248 ($op eq '>' &&
4249 $ca =~ /<\S+\@\S+$/))
4250 {
4251 $ok = 1;
4252 }
4253
Joe Perchese0df7e12015-04-16 12:44:53 -07004254 # for asm volatile statements
4255 # ignore a colon with another
4256 # colon immediately before or after
4257 if (($op eq ':') &&
4258 ($ca =~ /:$/ || $cc =~ /^:/)) {
4259 $ok = 1;
4260 }
4261
Joe Perches84731622013-11-12 15:10:05 -08004262 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004263 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004264 my $msg_type = \&ERROR;
4265 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4266
4267 if (&{$msg_type}("SPACING",
4268 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004269 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4270 if (defined $fix_elements[$n + 2]) {
4271 $fix_elements[$n + 2] =~ s/^\s+//;
4272 }
Joe Perches3705ce52013-07-03 15:05:31 -07004273 $line_fixed = 1;
4274 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004275 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004276 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004277 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004278
4279## print("n: <$n> GOOD: <$good>\n");
4280
4281 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004282 }
Joe Perches3705ce52013-07-03 15:05:31 -07004283
4284 if (($#elements % 2) == 0) {
4285 $fixed_line = $fixed_line . $fix_elements[$#elements];
4286 }
4287
Joe Perches194f66f2014-08-06 16:11:03 -07004288 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4289 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004290 }
4291
4292
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004293 }
4294
Joe Perches786b6322013-07-03 15:05:32 -07004295# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004296 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004297 if (WARN("SPACING",
4298 "space prohibited before semicolon\n" . $herecurr) &&
4299 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004300 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004301 s/^(\+.*\S)\s+;/$1;/;
4302 }
4303 }
4304
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004305# check for multiple assignments
4306 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004307 CHK("MULTIPLE_ASSIGNMENTS",
4308 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004309 }
4310
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004311## # check for multiple declarations, allowing for a function declaration
4312## # continuation.
4313## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4314## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4315##
4316## # Remove any bracketed sections to ensure we do not
4317## # falsly report the parameters of functions.
4318## my $ln = $line;
4319## while ($ln =~ s/\([^\(\)]*\)//g) {
4320## }
4321## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004322## WARN("MULTIPLE_DECLARATION",
4323## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004324## }
4325## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004326
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004327#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004328 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004329 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004330 if (ERROR("SPACING",
4331 "space required before the open brace '{'\n" . $herecurr) &&
4332 $fix) {
Cyril Bur93eae952017-07-10 15:52:21 -07004333 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\)))\{/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004334 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004335 }
4336
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004337## # check for blank lines before declarations
4338## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4339## $prevrawline =~ /^.\s*$/) {
4340## WARN("SPACING",
4341## "No blank lines before declarations\n" . $hereprev);
4342## }
4343##
4344
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004345# closing brace should have a space following it when it has anything
4346# on the line
4347 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004348 if (ERROR("SPACING",
4349 "space required after that close brace '}'\n" . $herecurr) &&
4350 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004351 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004352 s/}((?!(?:,|;|\)))\S)/} $1/;
4353 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004354 }
4355
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004356# check spacing on square brackets
4357 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004358 if (ERROR("SPACING",
4359 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4360 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004361 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004362 s/\[\s+/\[/;
4363 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004364 }
4365 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004366 if (ERROR("SPACING",
4367 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4368 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004369 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004370 s/\s+\]/\]/;
4371 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004372 }
4373
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004374# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004375 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4376 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004377 if (ERROR("SPACING",
4378 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4379 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004380 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004381 s/\(\s+/\(/;
4382 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004383 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004384 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004385 $line !~ /for\s*\(.*;\s+\)/ &&
4386 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004387 if (ERROR("SPACING",
4388 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4389 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004390 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004391 s/\s+\)/\)/;
4392 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004393 }
4394
Joe Perchese2826fd2014-08-06 16:10:48 -07004395# check unnecessary parentheses around addressof/dereference single $Lvals
4396# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4397
4398 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004399 my $var = $1;
4400 if (CHK("UNNECESSARY_PARENTHESES",
4401 "Unnecessary parentheses around $var\n" . $herecurr) &&
4402 $fix) {
4403 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4404 }
4405 }
4406
4407# check for unnecessary parentheses around function pointer uses
4408# ie: (foo->bar)(); should be foo->bar();
4409# but not "if (foo->bar) (" to avoid some false positives
4410 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4411 my $var = $2;
4412 if (CHK("UNNECESSARY_PARENTHESES",
4413 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4414 $fix) {
4415 my $var2 = deparenthesize($var);
4416 $var2 =~ s/\s//g;
4417 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4418 }
4419 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004420
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004421#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004422 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004423 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004424 if (WARN("INDENTED_LABEL",
4425 "labels should not be indented\n" . $herecurr) &&
4426 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004427 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004428 s/^(.)\s+/$1/;
4429 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004430 }
4431
Joe Perches5b9553a2014-04-03 14:49:21 -07004432# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004433 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004434 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004435 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004436 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4437 my $value = $1;
4438 $value = deparenthesize($value);
4439 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4440 ERROR("RETURN_PARENTHESES",
4441 "return is not a function, parentheses are not required\n" . $herecurr);
4442 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004443 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004444 ERROR("SPACING",
4445 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004446 }
4447 }
Joe Perches507e5142013-11-12 15:10:13 -08004448
Joe Perchesb43ae212014-06-23 13:22:07 -07004449# unnecessary return in a void function
4450# at end-of-function, with the previous line a single leading tab, then return;
4451# and the line before that not a goto label target like "out:"
4452 if ($sline =~ /^[ \+]}\s*$/ &&
4453 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4454 $linenr >= 3 &&
4455 $lines[$linenr - 3] =~ /^[ +]/ &&
4456 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004457 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004458 "void function return statements are not generally useful\n" . $hereprev);
4459 }
Joe Perches9819cf22014-06-04 16:12:09 -07004460
Joe Perches189248d2014-01-23 15:54:47 -08004461# if statements using unnecessary parentheses - ie: if ((foo == bar))
4462 if ($^V && $^V ge 5.10.0 &&
4463 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4464 my $openparens = $1;
4465 my $count = $openparens =~ tr@\(@\(@;
4466 my $msg = "";
4467 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4468 my $comp = $4; #Not $1 because of $LvalOrFunc
4469 $msg = " - maybe == should be = ?" if ($comp eq "==");
4470 WARN("UNNECESSARY_PARENTHESES",
4471 "Unnecessary parentheses$msg\n" . $herecurr);
4472 }
4473 }
4474
Joe Perchesc5595fa2015-09-09 15:37:58 -07004475# comparisons with a constant or upper case identifier on the left
4476# avoid cases like "foo + BAR < baz"
4477# only fix matches surrounded by parentheses to avoid incorrect
4478# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4479 if ($^V && $^V ge 5.10.0 &&
4480 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4481 my $lead = $1;
4482 my $const = $2;
4483 my $comp = $3;
4484 my $to = $4;
4485 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004486 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004487 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4488 WARN("CONSTANT_COMPARISON",
4489 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4490 $fix) {
4491 if ($comp eq "<") {
4492 $newcomp = ">";
4493 } elsif ($comp eq "<=") {
4494 $newcomp = ">=";
4495 } elsif ($comp eq ">") {
4496 $newcomp = "<";
4497 } elsif ($comp eq ">=") {
4498 $newcomp = "<=";
4499 }
4500 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4501 }
4502 }
4503
Joe Perchesf34e4a42015-04-16 12:44:19 -07004504# Return of what appears to be an errno should normally be negative
4505 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004506 my $name = $1;
4507 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004508 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004509 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004510 }
4511 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004512
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004513# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004514 if ($line =~ /\b(if|while|for|switch)\(/) {
4515 if (ERROR("SPACING",
4516 "space required before the open parenthesis '('\n" . $herecurr) &&
4517 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004518 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004519 s/\b(if|while|for|switch)\(/$1 \(/;
4520 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004521 }
4522
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004523# Check for illegal assignment in if conditional -- and check for trailing
4524# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004525 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004526 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4527 ctx_statement_block($linenr, $realcnt, 0)
4528 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004529 my ($stat_next) = ctx_statement_block($line_nr_next,
4530 $remain_next, $off_next);
4531 $stat_next =~ s/\n./\n /g;
4532 ##print "stat<$stat> stat_next<$stat_next>\n";
4533
4534 if ($stat_next =~ /^\s*while\b/) {
4535 # If the statement carries leading newlines,
4536 # then count those as offsets.
4537 my ($whitespace) =
4538 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4539 my $offset =
4540 statement_rawlines($whitespace) - 1;
4541
4542 $suppress_whiletrailers{$line_nr_next +
4543 $offset} = 1;
4544 }
4545 }
4546 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004547 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004548 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004549 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004550
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004551 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004552 ERROR("ASSIGN_IN_IF",
4553 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004554 }
4555
4556 # Find out what is on the end of the line after the
4557 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004558 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004559 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004560 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004561 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4562 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004563 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004564 # Find out how long the conditional actually is.
4565 my @newlines = ($c =~ /\n/gs);
4566 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004567 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004568
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004569 $stat_real = raw_line($linenr, $cond_lines)
4570 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004571 if (defined($stat_real) && $cond_lines > 1) {
4572 $stat_real = "[...]\n$stat_real";
4573 }
4574
Joe Perches000d1cc12011-07-25 17:13:25 -07004575 ERROR("TRAILING_STATEMENTS",
4576 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004577 }
4578 }
4579
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004580# Check for bitwise tests written as boolean
4581 if ($line =~ /
4582 (?:
4583 (?:\[|\(|\&\&|\|\|)
4584 \s*0[xX][0-9]+\s*
4585 (?:\&\&|\|\|)
4586 |
4587 (?:\&\&|\|\|)
4588 \s*0[xX][0-9]+\s*
4589 (?:\&\&|\|\||\)|\])
4590 )/x)
4591 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004592 WARN("HEXADECIMAL_BOOLEAN_TEST",
4593 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004594 }
4595
Andy Whitcroft8905a672007-11-28 16:21:06 -08004596# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004597 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4598 my $s = $1;
4599 $s =~ s/$;//g; # Remove any comments
4600 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004601 ERROR("TRAILING_STATEMENTS",
4602 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004603 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004604 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004605# if should not continue a brace
4606 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004607 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004608 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004609 $herecurr);
4610 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004611# case and default should not have general statements after them
4612 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4613 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004614 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004615 \s*return\s+
4616 )/xg)
4617 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004618 ERROR("TRAILING_STATEMENTS",
4619 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004620 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004621
4622 # Check for }<nl>else {, these must be at the same
4623 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004624 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4625 $previndent == $indent) {
4626 if (ERROR("ELSE_AFTER_BRACE",
4627 "else should follow close brace '}'\n" . $hereprev) &&
4628 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4629 fix_delete_line($fixlinenr - 1, $prevrawline);
4630 fix_delete_line($fixlinenr, $rawline);
4631 my $fixedline = $prevrawline;
4632 $fixedline =~ s/}\s*$//;
4633 if ($fixedline !~ /^\+\s*$/) {
4634 fix_insert_line($fixlinenr, $fixedline);
4635 }
4636 $fixedline = $rawline;
4637 $fixedline =~ s/^(.\s*)else/$1} else/;
4638 fix_insert_line($fixlinenr, $fixedline);
4639 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004640 }
4641
Joe Perches8b8856f2014-08-06 16:11:14 -07004642 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4643 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004644 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4645
4646 # Find out what is on the end of the line after the
4647 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004648 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004649 $s =~ s/\n.*//g;
4650
4651 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004652 if (ERROR("WHILE_AFTER_BRACE",
4653 "while should follow close brace '}'\n" . $hereprev) &&
4654 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4655 fix_delete_line($fixlinenr - 1, $prevrawline);
4656 fix_delete_line($fixlinenr, $rawline);
4657 my $fixedline = $prevrawline;
4658 my $trailing = $rawline;
4659 $trailing =~ s/^\+//;
4660 $trailing = trim($trailing);
4661 $fixedline =~ s/}\s*$/} $trailing/;
4662 fix_insert_line($fixlinenr, $fixedline);
4663 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004664 }
4665 }
4666
Joe Perches95e2c602013-07-03 15:05:20 -07004667#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004668 while ($line =~ m{($Constant|$Lval)}g) {
4669 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004670
4671#gcc binary extension
4672 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004673 if (WARN("GCC_BINARY_CONSTANT",
4674 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4675 $fix) {
4676 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004677 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004678 s/\b$var\b/$hexval/;
4679 }
Joe Perches95e2c602013-07-03 15:05:20 -07004680 }
4681
4682#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004683 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004684 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004685#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004686 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004687#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004688 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4689#Ignore some three character SI units explicitly, like MiB and KHz
4690 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004691 while ($var =~ m{($Ident)}g) {
4692 my $word = $1;
4693 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004694 if ($check) {
4695 seed_camelcase_includes();
4696 if (!$file && !$camelcase_file_seeded) {
4697 seed_camelcase_file($realfile);
4698 $camelcase_file_seeded = 1;
4699 }
4700 }
Joe Perches7e781f62013-09-11 14:23:55 -07004701 if (!defined $camelcase{$word}) {
4702 $camelcase{$word} = 1;
4703 CHK("CAMELCASE",
4704 "Avoid CamelCase: <$word>\n" . $herecurr);
4705 }
Joe Perches34456862013-07-03 15:05:34 -07004706 }
Joe Perches323c1262012-12-17 16:02:07 -08004707 }
4708 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004709
4710#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004711 if ($line =~ /\#\s*define.*\\\s+$/) {
4712 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4713 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4714 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004715 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004716 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004717 }
4718
Fabian Frederick0e212e02015-04-16 12:44:25 -07004719# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4720# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004721 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004722 my $file = "$1.h";
4723 my $checkfile = "include/linux/$file";
4724 if (-f "$root/$checkfile" &&
4725 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004726 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004727 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004728 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4729 if ($asminclude > 0) {
4730 if ($realfile =~ m{^arch/}) {
4731 CHK("ARCH_INCLUDE_LINUX",
4732 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4733 } else {
4734 WARN("INCLUDE_LINUX",
4735 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4736 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004737 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004738 }
4739 }
4740
Andy Whitcroft653d4872007-06-23 17:16:34 -07004741# multi-statement macros should be enclosed in a do while loop, grab the
4742# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004743# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004744 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4745 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004746 my $ln = $linenr;
4747 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004748 my ($off, $dstat, $dcond, $rest);
4749 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004750 my $has_flow_statement = 0;
4751 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004752 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004753 ctx_statement_block($linenr, $realcnt, 0);
4754 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004755 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004756 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004757
Joe Perches08a28432014-10-13 15:51:55 -07004758 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004759 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004760
Joe Perchesf59b64b2016-10-11 13:52:08 -07004761 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//;
4762 my $define_args = $1;
4763 my $define_stmt = $dstat;
4764 my @def_args = ();
4765
4766 if (defined $define_args && $define_args ne "") {
4767 $define_args = substr($define_args, 1, length($define_args) - 2);
4768 $define_args =~ s/\s*//g;
4769 @def_args = split(",", $define_args);
4770 }
4771
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004772 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004773 $dstat =~ s/\\\n.//g;
4774 $dstat =~ s/^\s*//s;
4775 $dstat =~ s/\s*$//s;
4776
4777 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004778 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4779 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004780 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004781 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004782 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004783
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004784 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004785 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4786 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004787 {
4788 }
4789
Joe Perches42e15292016-03-15 14:58:01 -07004790 # Make asm volatile uses seem like a generic function
4791 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4792
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004793 my $exceptions = qr{
4794 $Declare|
4795 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004796 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004797 DECLARE_PER_CPU|
4798 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004799 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004800 union|
4801 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004802 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004803 ^\"|\"$|
4804 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004805 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004806 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Joe Perchesf59b64b2016-10-11 13:52:08 -07004807
4808 $ctx =~ s/\n*$//;
4809 my $herectx = $here . "\n";
4810 my $stmt_cnt = statement_rawlines($ctx);
4811
4812 for (my $n = 0; $n < $stmt_cnt; $n++) {
4813 $herectx .= raw_line($linenr, $n) . "\n";
4814 }
4815
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004816 if ($dstat ne '' &&
4817 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4818 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004819 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004820 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004821 $dstat !~ /$exceptions/ &&
4822 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004823 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004824 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004825 $dstat !~ /^for\s*$Constant$/ && # for (...)
4826 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4827 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004828 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004829 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004830 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004831
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004832 if ($dstat =~ /;/) {
4833 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4834 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4835 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004836 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004837 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004838 }
Joe Perchesf59b64b2016-10-11 13:52:08 -07004839
4840 }
Joe Perches52076492016-10-11 13:52:14 -07004841
4842 # Make $define_stmt single line, comment-free, etc
4843 my @stmt_array = split('\n', $define_stmt);
4844 my $first = 1;
4845 $define_stmt = "";
4846 foreach my $l (@stmt_array) {
4847 $l =~ s/\\$//;
4848 if ($first) {
4849 $define_stmt = $l;
4850 $first = 0;
4851 } elsif ($l =~ /^[\+ ]/) {
4852 $define_stmt .= substr($l, 1);
4853 }
4854 }
4855 $define_stmt =~ s/$;//g;
4856 $define_stmt =~ s/\s+/ /g;
4857 $define_stmt = trim($define_stmt);
4858
Joe Perchesf59b64b2016-10-11 13:52:08 -07004859# check if any macro arguments are reused (ignore '...' and 'type')
4860 foreach my $arg (@def_args) {
4861 next if ($arg =~ /\.\.\./);
Joe Perches9192d412016-10-11 13:52:11 -07004862 next if ($arg =~ /^type$/i);
Joe Perchesf59b64b2016-10-11 13:52:08 -07004863 my $tmp = $define_stmt;
4864 $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 -07004865 $tmp =~ s/\#+\s*$arg\b//g;
Joe Perchesf59b64b2016-10-11 13:52:08 -07004866 $tmp =~ s/\b$arg\s*\#\#//g;
4867 my $use_cnt = $tmp =~ s/\b$arg\b//g;
4868 if ($use_cnt > 1) {
4869 CHK("MACRO_ARG_REUSE",
4870 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx");
Joe Perches9192d412016-10-11 13:52:11 -07004871 }
4872# check if any macro arguments may have other precedence issues
4873 if ($define_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m &&
4874 ((defined($1) && $1 ne ',') ||
4875 (defined($2) && $2 ne ','))) {
4876 CHK("MACRO_ARG_PRECEDENCE",
4877 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx");
Joe Perchesf59b64b2016-10-11 13:52:08 -07004878 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004879 }
Joe Perches5023d342012-12-17 16:01:47 -08004880
Joe Perches08a28432014-10-13 15:51:55 -07004881# check for macros with flow control, but without ## concatenation
4882# ## concatenation is commonly a macro that defines a function so ignore those
4883 if ($has_flow_statement && !$has_arg_concat) {
4884 my $herectx = $here . "\n";
4885 my $cnt = statement_rawlines($ctx);
4886
4887 for (my $n = 0; $n < $cnt; $n++) {
4888 $herectx .= raw_line($linenr, $n) . "\n";
4889 }
4890 WARN("MACRO_WITH_FLOW_CONTROL",
4891 "Macros with flow control statements should be avoided\n" . "$herectx");
4892 }
4893
Joe Perches481eb482012-12-17 16:01:56 -08004894# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004895
4896 } else {
4897 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004898 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4899 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004900 $line =~ /^\+.*\\$/) {
4901 WARN("LINE_CONTINUATIONS",
4902 "Avoid unnecessary line continuations\n" . $herecurr);
4903 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004904 }
4905
Joe Perchesb13edf72012-07-30 14:41:24 -07004906# do {} while (0) macro tests:
4907# single-statement macros do not need to be enclosed in do while (0) loop,
4908# macro should not end with a semicolon
4909 if ($^V && $^V ge 5.10.0 &&
4910 $realfile !~ m@/vmlinux.lds.h$@ &&
4911 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4912 my $ln = $linenr;
4913 my $cnt = $realcnt;
4914 my ($off, $dstat, $dcond, $rest);
4915 my $ctx = '';
4916 ($dstat, $dcond, $ln, $cnt, $off) =
4917 ctx_statement_block($linenr, $realcnt, 0);
4918 $ctx = $dstat;
4919
4920 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004921 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004922
4923 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4924 my $stmts = $2;
4925 my $semis = $3;
4926
4927 $ctx =~ s/\n*$//;
4928 my $cnt = statement_rawlines($ctx);
4929 my $herectx = $here . "\n";
4930
4931 for (my $n = 0; $n < $cnt; $n++) {
4932 $herectx .= raw_line($linenr, $n) . "\n";
4933 }
4934
Joe Perchesac8e97f2012-08-21 16:15:53 -07004935 if (($stmts =~ tr/;/;/) == 1 &&
4936 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004937 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4938 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4939 }
4940 if (defined $semis && $semis ne "") {
4941 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4942 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4943 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004944 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4945 $ctx =~ s/\n*$//;
4946 my $cnt = statement_rawlines($ctx);
4947 my $herectx = $here . "\n";
4948
4949 for (my $n = 0; $n < $cnt; $n++) {
4950 $herectx .= raw_line($linenr, $n) . "\n";
4951 }
4952
4953 WARN("TRAILING_SEMICOLON",
4954 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004955 }
4956 }
4957
Mike Frysinger080ba922009-01-06 14:41:25 -08004958# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4959# all assignments may have only one of the following with an assignment:
4960# .
4961# ALIGN(...)
4962# VMLINUX_SYMBOL(...)
4963 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004964 WARN("MISSING_VMLINUX_SYMBOL",
4965 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004966 }
4967
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004968# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004969 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4970 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004971 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004972 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004973 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4974 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004975 my @allowed = ();
4976 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004977 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004978 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004979 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004980 for my $chunk (@chunks) {
4981 my ($cond, $block) = @{$chunk};
4982
Andy Whitcroft773647a2008-03-28 14:15:58 -07004983 # If the condition carries leading newlines, then count those as offsets.
4984 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4985 my $offset = statement_rawlines($whitespace) - 1;
4986
Joe Perchesaad4f612012-03-23 15:02:19 -07004987 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004988 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4989
4990 # We have looked at and allowed this specific line.
4991 $suppress_ifbraces{$ln + $offset} = 1;
4992
4993 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004994 $ln += statement_rawlines($block) - 1;
4995
Andy Whitcroft773647a2008-03-28 14:15:58 -07004996 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004997
4998 $seen++ if ($block =~ /^\s*{/);
4999
Joe Perchesaad4f612012-03-23 15:02:19 -07005000 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005001 if (statement_lines($cond) > 1) {
5002 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005003 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005004 }
5005 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005006 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005007 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005008 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005009 if (statement_block_size($block) > 1) {
5010 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005011 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005012 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005013 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005014 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005015 if ($seen) {
5016 my $sum_allowed = 0;
5017 foreach (@allowed) {
5018 $sum_allowed += $_;
5019 }
5020 if ($sum_allowed == 0) {
5021 WARN("BRACES",
5022 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5023 } elsif ($sum_allowed != $allow &&
5024 $seen != $allow) {
5025 CHK("BRACES",
5026 "braces {} should be used on all arms of this statement\n" . $herectx);
5027 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005028 }
5029 }
5030 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005031 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005032 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005033 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005034
Andy Whitcroftcf655042008-03-04 14:28:20 -08005035 # Check the pre-context.
5036 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5037 #print "APW: ALLOWED: pre<$1>\n";
5038 $allowed = 1;
5039 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005040
5041 my ($level, $endln, @chunks) =
5042 ctx_statement_full($linenr, $realcnt, $-[0]);
5043
Andy Whitcroftcf655042008-03-04 14:28:20 -08005044 # Check the condition.
5045 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005046 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005047 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005048 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005049 }
5050 if (statement_lines($cond) > 1) {
5051 #print "APW: ALLOWED: cond<$cond>\n";
5052 $allowed = 1;
5053 }
5054 if ($block =~/\b(?:if|for|while)\b/) {
5055 #print "APW: ALLOWED: block<$block>\n";
5056 $allowed = 1;
5057 }
5058 if (statement_block_size($block) > 1) {
5059 #print "APW: ALLOWED: lines block<$block>\n";
5060 $allowed = 1;
5061 }
5062 # Check the post-context.
5063 if (defined $chunks[1]) {
5064 my ($cond, $block) = @{$chunks[1]};
5065 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005066 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005067 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005068 if ($block =~ /^\s*\{/) {
5069 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5070 $allowed = 1;
5071 }
5072 }
5073 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005074 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005075 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005076
Andy Whitcroftf0556632008-10-15 22:02:23 -07005077 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005078 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005079 }
5080
Joe Perches000d1cc12011-07-25 17:13:25 -07005081 WARN("BRACES",
5082 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005083 }
5084 }
5085
Joe Perches0979ae62012-12-17 16:01:59 -08005086# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005087 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005088 if (CHK("BRACES",
5089 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5090 $fix && $prevrawline =~ /^\+/) {
5091 fix_delete_line($fixlinenr - 1, $prevrawline);
5092 }
Joe Perches0979ae62012-12-17 16:01:59 -08005093 }
Joe Perches77b9a532013-07-03 15:05:29 -07005094 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005095 if (CHK("BRACES",
5096 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5097 $fix) {
5098 fix_delete_line($fixlinenr, $rawline);
5099 }
Joe Perches0979ae62012-12-17 16:01:59 -08005100 }
5101
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005102# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005103 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5104 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005105 WARN("VOLATILE",
5106 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005107 }
5108
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005109# Check for user-visible strings broken across lines, which breaks the ability
5110# to grep for the string. Make exceptions when the previous string ends in a
5111# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5112# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005113 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005114 $prevline =~ /"\s*$/ &&
5115 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5116 if (WARN("SPLIT_STRING",
5117 "quoted string split across lines\n" . $hereprev) &&
5118 $fix &&
5119 $prevrawline =~ /^\+.*"\s*$/ &&
5120 $last_coalesced_string_linenr != $linenr - 1) {
5121 my $extracted_string = get_quoted_string($line, $rawline);
5122 my $comma_close = "";
5123 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5124 $comma_close = $1;
5125 }
5126
5127 fix_delete_line($fixlinenr - 1, $prevrawline);
5128 fix_delete_line($fixlinenr, $rawline);
5129 my $fixedline = $prevrawline;
5130 $fixedline =~ s/"\s*$//;
5131 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5132 fix_insert_line($fixlinenr - 1, $fixedline);
5133 $fixedline = $rawline;
5134 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5135 if ($fixedline !~ /\+\s*$/) {
5136 fix_insert_line($fixlinenr, $fixedline);
5137 }
5138 $last_coalesced_string_linenr = $linenr;
5139 }
5140 }
5141
5142# check for missing a space in a string concatenation
5143 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5144 WARN('MISSING_SPACE',
5145 "break quoted strings at a space character\n" . $hereprev);
5146 }
5147
5148# check for spaces before a quoted newline
5149 if ($rawline =~ /^.*\".*\s\\n/) {
5150 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5151 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5152 $fix) {
5153 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5154 }
5155
5156 }
5157
Joe Perchesf17dba42014-10-13 15:51:51 -07005158# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005159 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005160 CHK("CONCATENATED_STRING",
5161 "Concatenated strings should use spaces between elements\n" . $herecurr);
5162 }
5163
Joe Perches90ad30e2014-12-10 15:51:59 -08005164# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005165 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005166 WARN("STRING_FRAGMENTS",
5167 "Consecutive strings are generally better as a single string\n" . $herecurr);
5168 }
5169
Joe Perches6e300752015-09-09 15:37:47 -07005170# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005171 my $string;
5172 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5173 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5174 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005175 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005176 WARN("PRINTF_L",
5177 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5178 last;
5179 }
Joe Perches6e300752015-09-09 15:37:47 -07005180 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5181 ERROR("PRINTF_0xDECIMAL",
5182 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5183 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005184 }
5185
5186# check for line continuations in quoted strings with odd counts of "
5187 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5188 WARN("LINE_CONTINUATIONS",
5189 "Avoid line continuations in quoted strings\n" . $herecurr);
5190 }
5191
Andy Whitcroft00df3442007-06-08 13:47:06 -07005192# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005193 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005194 CHK("REDUNDANT_CODE",
5195 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005196 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005197 }
5198
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005199# check for needless "if (<foo>) fn(<foo>)" uses
5200 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005201 my $tested = quotemeta($1);
5202 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5203 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5204 my $func = $1;
5205 if (WARN('NEEDLESS_IF',
5206 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5207 $fix) {
5208 my $do_fix = 1;
5209 my $leading_tabs = "";
5210 my $new_leading_tabs = "";
5211 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5212 $leading_tabs = $1;
5213 } else {
5214 $do_fix = 0;
5215 }
5216 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5217 $new_leading_tabs = $1;
5218 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5219 $do_fix = 0;
5220 }
5221 } else {
5222 $do_fix = 0;
5223 }
5224 if ($do_fix) {
5225 fix_delete_line($fixlinenr - 1, $prevrawline);
5226 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5227 }
5228 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005229 }
5230 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005231
Joe Perchesebfdc402014-08-06 16:10:27 -07005232# check for unnecessary "Out of Memory" messages
5233 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5234 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5235 (defined $1 || defined $3) &&
5236 $linenr > 3) {
5237 my $testval = $2;
5238 my $testline = $lines[$linenr - 3];
5239
5240 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5241# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5242
5243 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5244 WARN("OOM_MESSAGE",
5245 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5246 }
5247 }
5248
Joe Perchesf78d98f2014-10-13 15:52:01 -07005249# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005250 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005251 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5252 my $level = $1;
5253 if (WARN("UNNECESSARY_KERN_LEVEL",
5254 "Possible unnecessary $level\n" . $herecurr) &&
5255 $fix) {
5256 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5257 }
5258 }
5259
Joe Perchesabb08a52014-12-10 15:51:46 -08005260# check for mask then right shift without a parentheses
5261 if ($^V && $^V ge 5.10.0 &&
5262 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5263 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5264 WARN("MASK_THEN_SHIFT",
5265 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5266 }
5267
Joe Perchesb75ac612014-12-10 15:52:02 -08005268# check for pointer comparisons to NULL
5269 if ($^V && $^V ge 5.10.0) {
5270 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5271 my $val = $1;
5272 my $equal = "!";
5273 $equal = "" if ($4 eq "!=");
5274 if (CHK("COMPARISON_TO_NULL",
5275 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5276 $fix) {
5277 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5278 }
5279 }
5280 }
5281
Joe Perches8716de32013-09-11 14:24:05 -07005282# check for bad placement of section $InitAttribute (e.g.: __initdata)
5283 if ($line =~ /(\b$InitAttribute\b)/) {
5284 my $attr = $1;
5285 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5286 my $ptr = $1;
5287 my $var = $2;
5288 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5289 ERROR("MISPLACED_INIT",
5290 "$attr should be placed after $var\n" . $herecurr)) ||
5291 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5292 WARN("MISPLACED_INIT",
5293 "$attr should be placed after $var\n" . $herecurr))) &&
5294 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005295 $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 -07005296 }
5297 }
5298 }
5299
Joe Perchese970b882013-11-12 15:10:10 -08005300# check for $InitAttributeData (ie: __initdata) with const
5301 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5302 my $attr = $1;
5303 $attr =~ /($InitAttributePrefix)(.*)/;
5304 my $attr_prefix = $1;
5305 my $attr_type = $2;
5306 if (ERROR("INIT_ATTRIBUTE",
5307 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5308 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005309 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005310 s/$InitAttributeData/${attr_prefix}initconst/;
5311 }
5312 }
5313
5314# check for $InitAttributeConst (ie: __initconst) without const
5315 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5316 my $attr = $1;
5317 if (ERROR("INIT_ATTRIBUTE",
5318 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5319 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005320 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005321 /(^\+\s*(?:static\s+))/;
5322 $lead = rtrim($1);
5323 $lead = "$lead " if ($lead !~ /^\+$/);
5324 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005325 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08005326 }
5327 }
5328
Joe Perchesc17893c2015-04-16 12:44:42 -07005329# check for __read_mostly with const non-pointer (should just be const)
5330 if ($line =~ /\b__read_mostly\b/ &&
5331 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5332 if (ERROR("CONST_READ_MOSTLY",
5333 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5334 $fix) {
5335 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5336 }
5337 }
5338
Joe Perchesfbdb8132014-04-03 14:49:14 -07005339# don't use __constant_<foo> functions outside of include/uapi/
5340 if ($realfile !~ m@^include/uapi/@ &&
5341 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5342 my $constant_func = $1;
5343 my $func = $constant_func;
5344 $func =~ s/^__constant_//;
5345 if (WARN("CONSTANT_CONVERSION",
5346 "$constant_func should be $func\n" . $herecurr) &&
5347 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005348 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005349 }
5350 }
5351
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005352# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005353 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005354 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005355 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005356 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005357 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005358 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5359 }
5360 if ($delay > 2000) {
5361 WARN("LONG_UDELAY",
5362 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005363 }
5364 }
5365
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005366# warn about unexpectedly long msleep's
5367 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5368 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005369 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005370 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005371 }
5372 }
5373
Joe Perches36ec1932013-07-03 15:05:25 -07005374# check for comparisons of jiffies
5375 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5376 WARN("JIFFIES_COMPARISON",
5377 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5378 }
5379
Joe Perches9d7a34a2013-07-03 15:05:26 -07005380# check for comparisons of get_jiffies_64()
5381 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5382 WARN("JIFFIES_COMPARISON",
5383 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5384 }
5385
Andy Whitcroft00df3442007-06-08 13:47:06 -07005386# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005387# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005388# print "#ifdef in C files should be avoided\n";
5389# print "$herecurr";
5390# $clean = 0;
5391# }
5392
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005393# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005394 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005395 if (ERROR("SPACING",
5396 "exactly one space required after that #$1\n" . $herecurr) &&
5397 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005398 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005399 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5400 }
5401
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005402 }
5403
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005404# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005405 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5406 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005407 my $which = $1;
5408 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005409 CHK("UNCOMMENTED_DEFINITION",
5410 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005411 }
5412 }
5413# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005414
5415 my $barriers = qr{
5416 mb|
5417 rmb|
5418 wmb|
5419 read_barrier_depends
5420 }x;
5421 my $barrier_stems = qr{
5422 mb__before_atomic|
5423 mb__after_atomic|
5424 store_release|
5425 load_acquire|
5426 store_mb|
5427 (?:$barriers)
5428 }x;
5429 my $all_barriers = qr{
5430 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005431 smp_(?:$barrier_stems)|
5432 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005433 }x;
5434
5435 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005436 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005437 WARN("MEMORY_BARRIER",
5438 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005439 }
5440 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005441
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005442 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5443
5444 if ($realfile !~ m@^include/asm-generic/@ &&
5445 $realfile !~ m@/barrier\.h$@ &&
5446 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5447 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5448 WARN("MEMORY_BARRIER",
5449 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5450 }
5451
Joe Perchescb426e92015-06-25 15:02:46 -07005452# check for waitqueue_active without a comment.
5453 if ($line =~ /\bwaitqueue_active\s*\(/) {
5454 if (!ctx_has_comment($first_line, $linenr)) {
5455 WARN("WAITQUEUE_ACTIVE",
5456 "waitqueue_active without comment\n" . $herecurr);
5457 }
5458 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005459
5460# Check for expedited grace periods that interrupt non-idle non-nohz
5461# online CPUs. These expedited can therefore degrade real-time response
5462# if used carelessly, and should be avoided where not absolutely
5463# needed. It is always OK to use synchronize_rcu_expedited() and
5464# synchronize_sched_expedited() at boot time (before real-time applications
5465# start) and in error situations where real-time response is compromised in
5466# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5467# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5468# Of course, nothing comes for free, and srcu_read_lock() and
5469# srcu_read_unlock() do contain full memory barriers in payment for
5470# synchronize_srcu_expedited() non-interruption properties.
5471 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5472 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5473 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5474
5475 }
5476
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005477# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005478 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005479 CHK("ARCH_DEFINES",
5480 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005481 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005482
Tobias Klauserd4977c72010-05-24 14:33:30 -07005483# Check that the storage class is at the beginning of a declaration
5484 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005485 WARN("STORAGE_CLASS",
5486 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005487 }
5488
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005489# check the location of the inline attribute, that it is between
5490# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005491 if ($line =~ /\b$Type\s+$Inline\b/ ||
5492 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005493 ERROR("INLINE_LOCATION",
5494 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005495 }
5496
Andy Whitcroft8905a672007-11-28 16:21:06 -08005497# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005498 if ($realfile !~ m@\binclude/uapi/@ &&
5499 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005500 if (WARN("INLINE",
5501 "plain inline is preferred over $1\n" . $herecurr) &&
5502 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005503 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005504
5505 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005506 }
5507
Joe Perches3d130fd2011-01-12 17:00:00 -08005508# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005509 if ($realfile !~ m@\binclude/uapi/@ &&
5510 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005511 WARN("PREFER_PACKED",
5512 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005513 }
5514
Joe Perches39b7e282011-07-25 17:13:24 -07005515# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005516 if ($realfile !~ m@\binclude/uapi/@ &&
5517 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005518 WARN("PREFER_ALIGNED",
5519 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005520 }
5521
Joe Perches5f14d3b2012-01-10 15:09:52 -08005522# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005523 if ($realfile !~ m@\binclude/uapi/@ &&
5524 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005525 if (WARN("PREFER_PRINTF",
5526 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5527 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005528 $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 -07005529
5530 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005531 }
5532
Joe Perches6061d942012-03-23 15:02:16 -07005533# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005534 if ($realfile !~ m@\binclude/uapi/@ &&
5535 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005536 if (WARN("PREFER_SCANF",
5537 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5538 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005539 $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 -07005540 }
Joe Perches6061d942012-03-23 15:02:16 -07005541 }
5542
Joe Perches619a9082014-12-10 15:51:35 -08005543# Check for __attribute__ weak, or __weak declarations (may have link issues)
5544 if ($^V && $^V ge 5.10.0 &&
5545 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5546 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5547 $line =~ /\b__weak\b/)) {
5548 ERROR("WEAK_DECLARATION",
5549 "Using weak declarations can have unintended link defects\n" . $herecurr);
5550 }
5551
Joe Perchese6176fa2015-06-25 15:02:49 -07005552# check for c99 types like uint8_t used outside of uapi/
5553 if ($realfile !~ m@\binclude/uapi/@ &&
5554 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5555 my $type = $1;
5556 if ($type =~ /\b($typeC99Typedefs)\b/) {
5557 $type = $1;
5558 my $kernel_type = 'u';
5559 $kernel_type = 's' if ($type =~ /^_*[si]/);
5560 $type =~ /(\d+)/;
5561 $kernel_type .= $1;
5562 if (CHK("PREFER_KERNEL_TYPES",
5563 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5564 $fix) {
5565 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5566 }
5567 }
5568 }
5569
Joe Perches938224b2016-01-20 14:59:15 -08005570# check for cast of C90 native int or longer types constants
5571 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5572 my $cast = $1;
5573 my $const = $2;
5574 if (WARN("TYPECAST_INT_CONSTANT",
5575 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5576 $fix) {
5577 my $suffix = "";
5578 my $newconst = $const;
5579 $newconst =~ s/${Int_type}$//;
5580 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5581 if ($cast =~ /\blong\s+long\b/) {
5582 $suffix .= 'LL';
5583 } elsif ($cast =~ /\blong\b/) {
5584 $suffix .= 'L';
5585 }
5586 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5587 }
5588 }
5589
Joe Perches8f53a9b2010-03-05 13:43:48 -08005590# check for sizeof(&)
5591 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005592 WARN("SIZEOF_ADDRESS",
5593 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005594 }
5595
Joe Perches66c80b62012-07-30 14:41:22 -07005596# check for sizeof without parenthesis
5597 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005598 if (WARN("SIZEOF_PARENTHESIS",
5599 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5600 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005601 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005602 }
Joe Perches66c80b62012-07-30 14:41:22 -07005603 }
5604
Joe Perches88982fe2012-12-17 16:02:00 -08005605# check for struct spinlock declarations
5606 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5607 WARN("USE_SPINLOCK_T",
5608 "struct spinlock should be spinlock_t\n" . $herecurr);
5609 }
5610
Joe Perchesa6962d72013-04-29 16:18:13 -07005611# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005612 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005613 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005614 $fmt =~ s/%%//g;
5615 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005616 if (WARN("PREFER_SEQ_PUTS",
5617 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5618 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005619 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005620 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005621 }
5622 }
5623
Tobin C. Harding5c145bd2017-11-23 10:59:45 +11005624 # check for vsprintf extension %p<foo> misuses
5625 if ($^V && $^V ge 5.10.0 &&
5626 defined $stat &&
5627 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s &&
5628 $1 !~ /^_*volatile_*$/) {
5629 my $bad_extension = "";
5630 my $lc = $stat =~ tr@\n@@;
5631 $lc = $lc + $linenr;
5632 for (my $count = $linenr; $count <= $lc; $count++) {
5633 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0));
5634 $fmt =~ s/%%//g;
5635 if ($fmt =~ /(\%[\*\d\.]*p(?![\WFfSsBKRraEhMmIiUDdgVCbGNOx]).)/) {
5636 $bad_extension = $1;
5637 last;
5638 }
5639 }
5640 if ($bad_extension ne "") {
5641 my $stat_real = raw_line($linenr, 0);
5642 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5643 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5644 }
5645 WARN("VSPRINTF_POINTER_EXTENSION",
5646 "Invalid vsprintf pointer extension '$bad_extension'\n" . "$here\n$stat_real\n");
5647 }
5648 }
5649
Andy Whitcroft554e1652012-01-10 15:09:57 -08005650# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005651 if ($^V && $^V ge 5.10.0 &&
5652 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005653 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005654
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005655 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005656 my $ms_val = $7;
5657 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005658
Andy Whitcroft554e1652012-01-10 15:09:57 -08005659 if ($ms_size =~ /^(0x|)0$/i) {
5660 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005661 "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 -08005662 } elsif ($ms_size =~ /^(0x|)1$/i) {
5663 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005664 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5665 }
5666 }
5667
Joe Perches98a9bba2014-01-23 15:54:52 -08005668# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005669# if ($^V && $^V ge 5.10.0 &&
5670# defined $stat &&
5671# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5672# if (WARN("PREFER_ETHER_ADDR_COPY",
5673# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5674# $fix) {
5675# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5676# }
5677# }
Joe Perches98a9bba2014-01-23 15:54:52 -08005678
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005679# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
Joe Perchesf3331952016-10-11 13:51:53 -07005680# if ($^V && $^V ge 5.10.0 &&
5681# defined $stat &&
5682# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5683# WARN("PREFER_ETHER_ADDR_EQUAL",
5684# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5685# }
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005686
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005687# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5688# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
Joe Perchesf3331952016-10-11 13:51:53 -07005689# if ($^V && $^V ge 5.10.0 &&
5690# defined $stat &&
5691# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5692#
5693# my $ms_val = $7;
5694#
5695# if ($ms_val =~ /^(?:0x|)0+$/i) {
5696# if (WARN("PREFER_ETH_ZERO_ADDR",
5697# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5698# $fix) {
5699# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5700# }
5701# } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5702# if (WARN("PREFER_ETH_BROADCAST_ADDR",
5703# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5704# $fix) {
5705# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5706# }
5707# }
5708# }
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005709
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005710# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005711 if ($^V && $^V ge 5.10.0 &&
5712 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005713 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005714 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005715 my $call = $1;
5716 my $cast1 = deparenthesize($2);
5717 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005718 my $cast2 = deparenthesize($7);
5719 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005720 my $cast;
5721
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005722 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005723 $cast = "$cast1 or $cast2";
5724 } elsif ($cast1 ne "") {
5725 $cast = $cast1;
5726 } else {
5727 $cast = $cast2;
5728 }
5729 WARN("MINMAX",
5730 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005731 }
5732 }
5733
Joe Perches4a273192012-07-30 14:41:20 -07005734# check usleep_range arguments
5735 if ($^V && $^V ge 5.10.0 &&
5736 defined $stat &&
5737 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5738 my $min = $1;
5739 my $max = $7;
5740 if ($min eq $max) {
5741 WARN("USLEEP_RANGE",
5742 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5743 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5744 $min > $max) {
5745 WARN("USLEEP_RANGE",
5746 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5747 }
5748 }
5749
Joe Perches823b7942013-11-12 15:10:15 -08005750# check for naked sscanf
5751 if ($^V && $^V ge 5.10.0 &&
5752 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005753 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005754 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5755 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5756 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5757 my $lc = $stat =~ tr@\n@@;
5758 $lc = $lc + $linenr;
5759 my $stat_real = raw_line($linenr, 0);
5760 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5761 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5762 }
5763 WARN("NAKED_SSCANF",
5764 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5765 }
5766
Joe Perchesafc819a2014-06-04 16:12:08 -07005767# check for simple sscanf that should be kstrto<foo>
5768 if ($^V && $^V ge 5.10.0 &&
5769 defined $stat &&
5770 $line =~ /\bsscanf\b/) {
5771 my $lc = $stat =~ tr@\n@@;
5772 $lc = $lc + $linenr;
5773 my $stat_real = raw_line($linenr, 0);
5774 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5775 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5776 }
5777 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5778 my $format = $6;
5779 my $count = $format =~ tr@%@%@;
5780 if ($count == 1 &&
5781 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5782 WARN("SSCANF_TO_KSTRTO",
5783 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5784 }
5785 }
5786 }
5787
Joe Perches70dc8a42013-09-11 14:23:58 -07005788# check for new externs in .h files.
5789 if ($realfile =~ /\.h$/ &&
5790 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005791 if (CHK("AVOID_EXTERNS",
5792 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005793 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005794 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005795 }
5796 }
5797
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005798# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005799 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005800 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005801 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005802 my $function_name = $1;
5803 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005804
5805 my $s = $stat;
5806 if (defined $cond) {
5807 substr($s, 0, length($cond), '');
5808 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005809 if ($s =~ /^\s*;/ &&
5810 $function_name ne 'uninitialized_var')
5811 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005812 WARN("AVOID_EXTERNS",
5813 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005814 }
5815
5816 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005817 WARN("FUNCTION_ARGUMENTS",
5818 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005819 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005820
5821 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5822 $stat =~ /^.\s*extern\s+/)
5823 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005824 WARN("AVOID_EXTERNS",
5825 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005826 }
5827
Joe Perchesca0d8922016-10-11 13:52:16 -07005828 if ($realfile =~ /\.[ch]$/ && defined $stat &&
5829 $stat =~ /^.\s*(?:extern\s+)?$Type\s*$Ident\s*\(\s*([^{]+)\s*\)\s*;/s &&
5830 $1 ne "void") {
5831 my $args = trim($1);
5832 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) {
5833 my $arg = trim($1);
5834 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) {
5835 WARN("FUNCTION_ARGUMENTS",
5836 "function definition argument '$arg' should also have an identifier name\n" . $herecurr);
5837 }
5838 }
5839 }
5840
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005841# checks for new __setup's
5842 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5843 my $name = $1;
5844
5845 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005846 CHK("UNDOCUMENTED_SETUP",
5847 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005848 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005849 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005850
5851# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005852 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005853 WARN("UNNECESSARY_CASTS",
5854 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005855 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005856
Joe Perchesa640d252013-07-03 15:05:21 -07005857# alloc style
5858# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5859 if ($^V && $^V ge 5.10.0 &&
5860 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5861 CHK("ALLOC_SIZEOF_STRUCT",
5862 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5863 }
5864
Joe Perches60a55362014-06-04 16:12:07 -07005865# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5866 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005867 $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 -07005868 my $oldfunc = $3;
5869 my $a1 = $4;
5870 my $a2 = $10;
5871 my $newfunc = "kmalloc_array";
5872 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005873 my $r1 = $a1;
5874 my $r2 = $a2;
5875 if ($a1 =~ /^sizeof\s*\S/) {
5876 $r1 = $a2;
5877 $r2 = $a1;
5878 }
5879 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5880 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005881 if (WARN("ALLOC_WITH_MULTIPLY",
5882 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5883 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005884 $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 -07005885
5886 }
5887 }
5888 }
5889
Joe Perches972fdea2013-04-29 16:18:12 -07005890# check for krealloc arg reuse
5891 if ($^V && $^V ge 5.10.0 &&
5892 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5893 WARN("KREALLOC_ARG_REUSE",
5894 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5895 }
5896
Joe Perches5ce59ae2013-02-21 16:44:18 -08005897# check for alloc argument mismatch
5898 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5899 WARN("ALLOC_ARRAY_ARGS",
5900 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5901 }
5902
Joe Perchescaf2a542011-01-12 16:59:56 -08005903# check for multiple semicolons
5904 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005905 if (WARN("ONE_SEMICOLON",
5906 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5907 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005908 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005909 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005910 }
5911
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005912# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5913 if ($realfile !~ m@^include/uapi/@ &&
5914 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08005915 my $ull = "";
5916 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5917 if (CHK("BIT_MACRO",
5918 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5919 $fix) {
5920 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5921 }
5922 }
5923
Joe Perches2d632742016-05-20 17:04:00 -07005924# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5925 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5926 my $config = $1;
5927 if (WARN("PREFER_IS_ENABLED",
5928 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5929 $fix) {
5930 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5931 }
5932 }
5933
Joe Perchese81f2392014-08-06 16:11:25 -07005934# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005935 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5936 my $has_break = 0;
5937 my $has_statement = 0;
5938 my $count = 0;
5939 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005940 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005941 $prevline--;
5942 my $rline = $rawlines[$prevline - 1];
5943 my $fline = $lines[$prevline - 1];
5944 last if ($fline =~ /^\@\@/);
5945 next if ($fline =~ /^\-/);
5946 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5947 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5948 next if ($fline =~ /^.[\s$;]*$/);
5949 $has_statement = 1;
5950 $count++;
5951 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5952 }
5953 if (!$has_break && $has_statement) {
5954 WARN("MISSING_BREAK",
5955 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5956 }
5957 }
5958
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005959# check for switch/default statements without a break;
5960 if ($^V && $^V ge 5.10.0 &&
5961 defined $stat &&
5962 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5963 my $ctx = '';
5964 my $herectx = $here . "\n";
5965 my $cnt = statement_rawlines($stat);
5966 for (my $n = 0; $n < $cnt; $n++) {
5967 $herectx .= raw_line($linenr, $n) . "\n";
5968 }
5969 WARN("DEFAULT_NO_BREAK",
5970 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005971 }
5972
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005973# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005974 if ($line =~ /\b__FUNCTION__\b/) {
5975 if (WARN("USE_FUNC",
5976 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5977 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005978 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005979 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005980 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005981
Joe Perches62ec8182015-02-13 14:38:18 -08005982# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5983 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5984 ERROR("DATE_TIME",
5985 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5986 }
5987
Joe Perches2c924882012-03-23 15:02:20 -07005988# check for use of yield()
5989 if ($line =~ /\byield\s*\(\s*\)/) {
5990 WARN("YIELD",
5991 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5992 }
5993
Joe Perches179f8f42013-07-03 15:05:30 -07005994# check for comparisons against true and false
5995 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5996 my $lead = $1;
5997 my $arg = $2;
5998 my $test = $3;
5999 my $otype = $4;
6000 my $trail = $5;
6001 my $op = "!";
6002
6003 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6004
6005 my $type = lc($otype);
6006 if ($type =~ /^(?:true|false)$/) {
6007 if (("$test" eq "==" && "$type" eq "true") ||
6008 ("$test" eq "!=" && "$type" eq "false")) {
6009 $op = "";
6010 }
6011
6012 CHK("BOOL_COMPARISON",
6013 "Using comparison to $otype is error prone\n" . $herecurr);
6014
6015## maybe suggesting a correct construct would better
6016## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6017
6018 }
6019 }
6020
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006021# check for semaphores initialized locked
6022 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006023 WARN("CONSIDER_COMPLETION",
6024 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006025 }
Joe Perches6712d852012-03-23 15:02:20 -07006026
Joe Perches67d0a072011-10-31 17:13:10 -07006027# recommend kstrto* over simple_strto* and strict_strto*
6028 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006029 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006030 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006031 }
Joe Perches6712d852012-03-23 15:02:20 -07006032
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006033# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006034 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006035 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006036 "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 -07006037 }
Joe Perches6712d852012-03-23 15:02:20 -07006038
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006039# check for various structs that are normally const (ops, kgdb, device_tree)
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006040 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006041 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006042 WARN("CONST_STRUCT",
6043 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006044 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006045 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006046
6047# use of NR_CPUS is usually wrong
6048# ignore definitions of NR_CPUS and usage to define arrays as likely right
6049 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006050 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6051 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006052 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6053 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6054 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006055 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006056 WARN("NR_CPUS",
6057 "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 -07006058 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006059
Joe Perches52ea8502013-11-12 15:10:09 -08006060# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6061 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6062 ERROR("DEFINE_ARCH_HAS",
6063 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6064 }
6065
Joe Perchesacd93622015-02-13 14:38:38 -08006066# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6067 if ($^V && $^V ge 5.10.0 &&
6068 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6069 WARN("LIKELY_MISUSE",
6070 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6071 }
6072
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006073# whine mightly about in_atomic
6074 if ($line =~ /\bin_atomic\s*\(/) {
6075 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006076 ERROR("IN_ATOMIC",
6077 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006078 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006079 WARN("IN_ATOMIC",
6080 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006081 }
6082 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006083
Joe Perches481aea52016-05-20 17:04:08 -07006084# whine about ACCESS_ONCE
6085 if ($^V && $^V ge 5.10.0 &&
6086 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6087 my $par = $1;
6088 my $eq = $2;
6089 my $fun = $3;
6090 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6091 if (defined($eq)) {
6092 if (WARN("PREFER_WRITE_ONCE",
6093 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6094 $fix) {
6095 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6096 }
6097 } else {
6098 if (WARN("PREFER_READ_ONCE",
6099 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6100 $fix) {
6101 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6102 }
6103 }
6104 }
6105
Peter Zijlstra1704f472010-03-19 01:37:42 +01006106# check for lockdep_set_novalidate_class
6107 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6108 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6109 if ($realfile !~ m@^kernel/lockdep@ &&
6110 $realfile !~ m@^include/linux/lockdep@ &&
6111 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006112 ERROR("LOCKDEP",
6113 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006114 }
6115 }
Dave Jones88f88312011-01-12 16:59:59 -08006116
Joe Perchesb392c642015-04-16 12:44:16 -07006117 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6118 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006119 WARN("EXPORTED_WORLD_WRITABLE",
6120 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006121 }
Joe Perches24358802014-04-03 14:49:13 -07006122
Joe Perches515a2352014-04-03 14:49:24 -07006123# Mode permission misuses where it seems decimal should be octal
6124# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6125 if ($^V && $^V ge 5.10.0 &&
Joe Perches459cf0a2016-10-11 13:52:19 -07006126 defined $stat &&
Joe Perches515a2352014-04-03 14:49:24 -07006127 $line =~ /$mode_perms_search/) {
6128 foreach my $entry (@mode_permission_funcs) {
6129 my $func = $entry->[0];
6130 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006131
Joe Perches459cf0a2016-10-11 13:52:19 -07006132 my $lc = $stat =~ tr@\n@@;
6133 $lc = $lc + $linenr;
6134 my $stat_real = raw_line($linenr, 0);
6135 for (my $count = $linenr + 1; $count <= $lc; $count++) {
6136 $stat_real = $stat_real . "\n" . raw_line($count, 0);
6137 }
6138
Joe Perches515a2352014-04-03 14:49:24 -07006139 my $skip_args = "";
6140 if ($arg_pos > 1) {
6141 $arg_pos--;
6142 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6143 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006144 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches459cf0a2016-10-11 13:52:19 -07006145 if ($stat =~ /$test/) {
Joe Perches515a2352014-04-03 14:49:24 -07006146 my $val = $1;
6147 $val = $6 if ($skip_args ne "");
Joe Perchesf90774e2016-10-11 13:51:47 -07006148 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6149 ($val =~ /^$Octal$/ && length($val) ne 4)) {
Joe Perches515a2352014-04-03 14:49:24 -07006150 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches459cf0a2016-10-11 13:52:19 -07006151 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006152 }
6153 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006154 ERROR("EXPORTED_WORLD_WRITABLE",
Joe Perches459cf0a2016-10-11 13:52:19 -07006155 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
Joe Perchesf90774e2016-10-11 13:51:47 -07006156 }
Joe Perches24358802014-04-03 14:49:13 -07006157 }
6158 }
6159 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006160
Joe Perches459cf0a2016-10-11 13:52:19 -07006161# check for uses of S_<PERMS> that could be octal for readability
6162 if ($line =~ /\b$mode_perms_string_search\b/) {
6163 my $val = "";
6164 my $oval = "";
6165 my $to = 0;
6166 my $curpos = 0;
6167 my $lastpos = 0;
6168 while ($line =~ /\b(($mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) {
6169 $curpos = pos($line);
6170 my $match = $2;
6171 my $omatch = $1;
6172 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos));
6173 $lastpos = $curpos;
6174 $to |= $mode_permission_string_types{$match};
6175 $val .= '\s*\|\s*' if ($val ne "");
6176 $val .= $match;
6177 $oval .= $omatch;
6178 }
6179 $oval =~ s/^\s*\|\s*//;
6180 $oval =~ s/\s*\|\s*$//;
6181 my $octal = sprintf("%04o", $to);
6182 if (WARN("SYMBOLIC_PERMS",
6183 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6184 $fix) {
6185 $fixed[$fixlinenr] =~ s/$val/$octal/;
6186 }
6187 }
6188
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006189# validate content of MODULE_LICENSE against list from include/linux/module.h
6190 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6191 my $extracted_string = get_quoted_string($line, $rawline);
6192 my $valid_licenses = qr{
6193 GPL|
6194 GPL\ v2|
6195 GPL\ and\ additional\ rights|
6196 Dual\ BSD/GPL|
6197 Dual\ MIT/GPL|
6198 Dual\ MPL/GPL|
6199 Proprietary
6200 }x;
6201 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6202 WARN("MODULE_LICENSE",
6203 "unknown module license " . $extracted_string . "\n" . $herecurr);
6204 }
6205 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006206 }
6207
6208 # If we have no input at all, then there is nothing to report on
6209 # so just keep quiet.
6210 if ($#rawlines == -1) {
6211 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006212 }
6213
Andy Whitcroft8905a672007-11-28 16:21:06 -08006214 # In mailback mode only produce a report in the negative, for
6215 # things that appear to be patches.
6216 if ($mailback && ($clean == 1 || !$is_patch)) {
6217 exit(0);
6218 }
6219
6220 # This is not a patch, and we are are in 'no-patch' mode so
6221 # just keep quiet.
6222 if (!$chk_patch && !$is_patch) {
6223 exit(0);
6224 }
6225
Joe Perches06330fc2015-06-25 15:03:11 -07006226 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006227 ERROR("NOT_UNIFIED_DIFF",
6228 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006229 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006230 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006231 ERROR("MISSING_SIGN_OFF",
6232 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006233 }
6234
Andy Whitcroft8905a672007-11-28 16:21:06 -08006235 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006236 if ($summary && !($clean == 1 && $quiet == 1)) {
6237 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006238 print "total: $cnt_error errors, $cnt_warn warnings, " .
6239 (($check)? "$cnt_chk checks, " : "") .
6240 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006241 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006242
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006243 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006244 # If there were any defects found and not already fixing them
6245 if (!$clean and !$fix) {
6246 print << "EOM"
6247
6248NOTE: For some of the reported defects, checkpatch may be able to
6249 mechanically convert to the typical style using --fix or --fix-inplace.
6250EOM
6251 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006252 # If there were whitespace errors which cleanpatch can fix
6253 # then suggest that.
6254 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006255 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006256 print << "EOM"
6257
6258NOTE: Whitespace errors detected.
6259 You may wish to use scripts/cleanpatch or scripts/cleanfile
6260EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006261 }
6262 }
6263
Joe Perchesd752fcc2014-08-06 16:11:05 -07006264 if ($clean == 0 && $fix &&
6265 ("@rawlines" ne "@fixed" ||
6266 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006267 my $newfile = $filename;
6268 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006269 my $linecount = 0;
6270 my $f;
6271
Joe Perchesd752fcc2014-08-06 16:11:05 -07006272 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6273
Joe Perches3705ce52013-07-03 15:05:31 -07006274 open($f, '>', $newfile)
6275 or die "$P: Can't open $newfile for write\n";
6276 foreach my $fixed_line (@fixed) {
6277 $linecount++;
6278 if ($file) {
6279 if ($linecount > 3) {
6280 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006281 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006282 }
6283 } else {
6284 print $f $fixed_line . "\n";
6285 }
6286 }
6287 close($f);
6288
6289 if (!$quiet) {
6290 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006291
Joe Perches3705ce52013-07-03 15:05:31 -07006292Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6293
6294Do _NOT_ trust the results written to this file.
6295Do _NOT_ submit these changes without inspecting them for correctness.
6296
6297This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6298No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006299EOM
6300 }
6301 }
6302
Joe Perchesd8469f12015-06-25 15:03:00 -07006303 if ($quiet == 0) {
6304 print "\n";
6305 if ($clean == 1) {
6306 print "$vname has no obvious style problems and is ready for submission.\n";
6307 } else {
6308 print "$vname has style problems, please review.\n";
6309 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006310 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006311 return $clean;
6312}