blob: 4904ced676d40289356aa3358f894fa7efa4b5c0 [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 Perches2ac73b42014-06-04 16:12:05 -070033my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080034my $summary = 1;
35my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080036my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070037my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070038my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070039my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080040my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070041my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080042my %debug;
Joe Perches34456862013-07-03 15:05:34 -070043my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070044my %use_type = ();
45my @use = ();
46my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070047my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070048my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070049my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080050my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070051my $ignore_perl_version = 0;
52my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070053my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070054my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070055my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070056my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perches57230292015-06-25 15:03:03 -070057my $color = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070058
59sub help {
60 my ($exitcode) = @_;
61
62 print << "EOM";
63Usage: $P [OPTION]... [FILE]...
64Version: $V
65
66Options:
67 -q, --quiet quiet
68 --no-tree run without a kernel tree
69 --no-signoff do not check for 'Signed-off-by' line
70 --patch treat FILE as patchfile (default)
71 --emacs emacs compile window format
72 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070073 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070074 -g, --git treat FILE as a single commit or git revision range
75 single git commit with:
76 <rev>
77 <rev>^
78 <rev>~n
79 multiple git commits with:
80 <rev1>..<rev2>
81 <rev1>...<rev2>
82 <rev>-<count>
83 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070084 -f, --file treat FILE as regular source file
85 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070086 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070087 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070088 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070089 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080090 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070091 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070092 --root=PATH PATH to the kernel tree root
93 --no-summary suppress the per-file summary
94 --mailback only produce a report in case of warnings/errors
95 --summary-file include the filename in summary
96 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
97 'values', 'possible', 'type', and 'attr' (default
98 is all off)
99 --test-only=WORD report only warnings/errors containing WORD
100 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700101 --fix EXPERIMENTAL - may create horrible results
102 If correctable single-line errors exist, create
103 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
104 with potential errors corrected to the preferred
105 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800106 --fix-inplace EXPERIMENTAL - may create horrible results
107 Is the same as --fix, but overwrites the input
108 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700109 --ignore-perl-version override checking of perl version. expect
110 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700111 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700112 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700113 --codespellfile Use this codespell dictionary
Joe Perches57230292015-06-25 15:03:03 -0700114 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700115 -h, --help, --version display this help and exit
116
117When FILE is - read standard input.
118EOM
119
120 exit($exitcode);
121}
122
Joe Perches3beb42e2016-05-20 17:04:14 -0700123sub uniq {
124 my %seen;
125 return grep { !$seen{$_}++ } @_;
126}
127
128sub list_types {
129 my ($exitcode) = @_;
130
131 my $count = 0;
132
133 local $/ = undef;
134
135 open(my $script, '<', abs_path($P)) or
136 die "$P: Can't read '$P' $!\n";
137
138 my $text = <$script>;
139 close($script);
140
141 my @types = ();
142 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
143 push (@types, $_);
144 }
145 @types = sort(uniq(@types));
146 print("#\tMessage type\n\n");
147 foreach my $type (@types) {
148 print(++$count . "\t" . $type . "\n");
149 }
150
151 exit($exitcode);
152}
153
Joe Perches000d1cc12011-07-25 17:13:25 -0700154my $conf = which_conf($configuration_file);
155if (-f $conf) {
156 my @conf_args;
157 open(my $conffile, '<', "$conf")
158 or warn "$P: Can't find a readable $configuration_file file $!\n";
159
160 while (<$conffile>) {
161 my $line = $_;
162
163 $line =~ s/\s*\n?$//g;
164 $line =~ s/^\s*//g;
165 $line =~ s/\s+/ /g;
166
167 next if ($line =~ m/^\s*#/);
168 next if ($line =~ m/^\s*$/);
169
170 my @words = split(" ", $line);
171 foreach my $word (@words) {
172 last if ($word =~ m/^#/);
173 push (@conf_args, $word);
174 }
175 }
176 close($conffile);
177 unshift(@ARGV, @conf_args) if @conf_args;
178}
179
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700180GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700181 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700182 'tree!' => \$tree,
183 'signoff!' => \$chk_signoff,
184 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700185 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800186 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700187 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700188 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700189 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700190 'subjective!' => \$check,
191 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700192 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700193 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700194 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700195 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800196 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700197 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700198 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800199 'summary!' => \$summary,
200 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800201 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700202 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800203 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700204 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800205 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700206 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700207 'codespell!' => \$codespell,
208 'codespellfile=s' => \$codespellfile,
Joe Perches57230292015-06-25 15:03:03 -0700209 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700210 'h|help' => \$help,
211 'version' => \$help
212) or help(1);
213
214help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700215
Joe Perches3beb42e2016-05-20 17:04:14 -0700216list_types(0) if ($list_types);
217
Joe Perches9624b8d2014-01-23 15:54:44 -0800218$fix = 1 if ($fix_inplace);
Joe Perches2ac73b42014-06-04 16:12:05 -0700219$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800220
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700221my $exit = 0;
222
Dave Hansend62a2012013-09-11 14:23:56 -0700223if ($^V && $^V lt $minimum_perl_version) {
224 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
225 if (!$ignore_perl_version) {
226 exit(1);
227 }
228}
229
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700230if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700231 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700232 exit(1);
233}
234
Joe Perches91bfe482013-09-11 14:23:59 -0700235sub hash_save_array_words {
236 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700237
Joe Perches91bfe482013-09-11 14:23:59 -0700238 my @array = split(/,/, join(',', @$arrayRef));
239 foreach my $word (@array) {
240 $word =~ s/\s*\n?$//g;
241 $word =~ s/^\s*//g;
242 $word =~ s/\s+/ /g;
243 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700244
Joe Perches91bfe482013-09-11 14:23:59 -0700245 next if ($word =~ m/^\s*#/);
246 next if ($word =~ m/^\s*$/);
247
248 $hashRef->{$word}++;
249 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700250}
251
Joe Perches91bfe482013-09-11 14:23:59 -0700252sub hash_show_words {
253 my ($hashRef, $prefix) = @_;
254
Joe Perches3c816e42015-06-25 15:03:29 -0700255 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700256 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700257 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700258 print " $word";
259 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700260 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700261 }
262}
263
264hash_save_array_words(\%ignore_type, \@ignore);
265hash_save_array_words(\%use_type, \@use);
266
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800267my $dbg_values = 0;
268my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700269my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700270my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800271for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800272 ## no critic
273 eval "\${dbg_$key} = '$debug{$key}';";
274 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800275}
276
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700277my $rpt_cleaners = 0;
278
Andy Whitcroft8905a672007-11-28 16:21:06 -0800279if ($terse) {
280 $emacs = 1;
281 $quiet++;
282}
283
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284if ($tree) {
285 if (defined $root) {
286 if (!top_of_kernel_tree($root)) {
287 die "$P: $root: --root does not point at a valid tree\n";
288 }
289 } else {
290 if (top_of_kernel_tree('.')) {
291 $root = '.';
292 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
293 top_of_kernel_tree($1)) {
294 $root = $1;
295 }
296 }
297
298 if (!defined $root) {
299 print "Must be run from the top-level dir. of a kernel tree\n";
300 exit(2);
301 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700302}
303
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700304my $emitted_corrupt = 0;
305
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700306our $Ident = qr{
307 [A-Za-z_][A-Za-z\d_]*
308 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
309 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700310our $Storage = qr{extern|static|asmlinkage};
311our $Sparse = qr{
312 __user|
313 __kernel|
314 __force|
315 __iomem|
Joe Perches54507b52015-09-09 15:37:55 -0700316 __pmem|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700317 __must_check|
318 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800319 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700320 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800321 __rcu|
322 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700323 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800324our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
325our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
326our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
327our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
328our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700329
Wolfram Sang52131292010-03-05 13:43:51 -0800330# Notes to $Attribute:
331# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700332our $Attribute = qr{
333 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700334 __percpu|
335 __nocast|
336 __safe|
337 __bitwise__|
338 __packed__|
339 __packed2__|
340 __naked|
341 __maybe_unused|
342 __always_unused|
343 __noreturn|
344 __used|
345 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800346 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700347 __noclone|
348 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700349 __read_mostly|
350 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700351 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700352 ____cacheline_aligned|
353 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800354 ____cacheline_internodealigned_in_smp|
355 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700356 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700357our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700358our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700359our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
360our $Lval = qr{$Ident(?:$Member)*};
361
Joe Perches95e2c602013-07-03 15:05:20 -0700362our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
363our $Binary = qr{(?i)0b[01]+$Int_type?};
364our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
365our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700366our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800367our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800368our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
369our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
370our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800371our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700372our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800373our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700374our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700375our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700376our $Operators = qr{
377 <=|>=|==|!=|
378 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700379 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700380 }x;
381
Joe Perches91cb5192014-04-03 14:49:32 -0700382our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
383
Joe Perchesab7e23f2015-04-16 12:44:22 -0700384our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700386our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700387our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700389our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800390our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700391our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392
Joe Perches15662b32011-10-31 17:13:12 -0700393our $NON_ASCII_UTF8 = qr{
394 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700395 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
396 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
397 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
398 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
399 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
400 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
401}x;
402
Joe Perches15662b32011-10-31 17:13:12 -0700403our $UTF8 = qr{
404 [\x09\x0A\x0D\x20-\x7E] # ASCII
405 | $NON_ASCII_UTF8
406}x;
407
Joe Perchese6176fa2015-06-25 15:02:49 -0700408our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800409our $typeOtherOSTypedefs = qr{(?x:
410 u_(?:char|short|int|long) | # bsd
411 u(?:nchar|short|int|long) # sysv
412)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700413our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700414 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700415 atomic_t
416)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700417our $typeTypedefs = qr{(?x:
418 $typeC99Typedefs\b|
419 $typeOtherOSTypedefs\b|
420 $typeKernelTypedefs\b
421)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700422
Joe Perches6d32f7a2015-11-06 16:31:37 -0800423our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
424
Joe Perches691e6692010-03-05 13:43:51 -0800425our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700426 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700427 (?:[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 -0700428 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700429 panic|
Joe Perches06668722013-11-12 15:10:07 -0800430 MODULE_[A-Z_]+|
431 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800432)};
433
Joe Perches20112472011-07-25 17:13:23 -0700434our $signature_tags = qr{(?xi:
435 Signed-off-by:|
436 Acked-by:|
437 Tested-by:|
438 Reviewed-by:|
439 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700440 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700441 To:|
442 Cc:
443)};
444
Joe Perches18130872014-08-06 16:11:22 -0700445our @typeListMisordered = (
446 qr{char\s+(?:un)?signed},
447 qr{int\s+(?:(?:un)?signed\s+)?short\s},
448 qr{int\s+short(?:\s+(?:un)?signed)},
449 qr{short\s+int(?:\s+(?:un)?signed)},
450 qr{(?:un)?signed\s+int\s+short},
451 qr{short\s+(?:un)?signed},
452 qr{long\s+int\s+(?:un)?signed},
453 qr{int\s+long\s+(?:un)?signed},
454 qr{long\s+(?:un)?signed\s+int},
455 qr{int\s+(?:un)?signed\s+long},
456 qr{int\s+(?:un)?signed},
457 qr{int\s+long\s+long\s+(?:un)?signed},
458 qr{long\s+long\s+int\s+(?:un)?signed},
459 qr{long\s+long\s+(?:un)?signed\s+int},
460 qr{long\s+long\s+(?:un)?signed},
461 qr{long\s+(?:un)?signed},
462);
463
Andy Whitcroft8905a672007-11-28 16:21:06 -0800464our @typeList = (
465 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700466 qr{(?:(?:un)?signed\s+)?char},
467 qr{(?:(?:un)?signed\s+)?short\s+int},
468 qr{(?:(?:un)?signed\s+)?short},
469 qr{(?:(?:un)?signed\s+)?int},
470 qr{(?:(?:un)?signed\s+)?long\s+int},
471 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long},
473 qr{(?:(?:un)?signed\s+)?long},
474 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800475 qr{float},
476 qr{double},
477 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800478 qr{struct\s+$Ident},
479 qr{union\s+$Ident},
480 qr{enum\s+$Ident},
481 qr{${Ident}_t},
482 qr{${Ident}_handler},
483 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700484 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800485);
Joe Perches938224b2016-01-20 14:59:15 -0800486
487our $C90_int_types = qr{(?x:
488 long\s+long\s+int\s+(?:un)?signed|
489 long\s+long\s+(?:un)?signed\s+int|
490 long\s+long\s+(?:un)?signed|
491 (?:(?:un)?signed\s+)?long\s+long\s+int|
492 (?:(?:un)?signed\s+)?long\s+long|
493 int\s+long\s+long\s+(?:un)?signed|
494 int\s+(?:(?:un)?signed\s+)?long\s+long|
495
496 long\s+int\s+(?:un)?signed|
497 long\s+(?:un)?signed\s+int|
498 long\s+(?:un)?signed|
499 (?:(?:un)?signed\s+)?long\s+int|
500 (?:(?:un)?signed\s+)?long|
501 int\s+long\s+(?:un)?signed|
502 int\s+(?:(?:un)?signed\s+)?long|
503
504 int\s+(?:un)?signed|
505 (?:(?:un)?signed\s+)?int
506)};
507
Alex Dowad485ff232015-06-25 15:02:52 -0700508our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700509our @typeListWithAttr = (
510 @typeList,
511 qr{struct\s+$InitAttribute\s+$Ident},
512 qr{union\s+$InitAttribute\s+$Ident},
513);
514
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700515our @modifierList = (
516 qr{fastcall},
517);
Alex Dowad485ff232015-06-25 15:02:52 -0700518our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800519
Joe Perches24358802014-04-03 14:49:13 -0700520our @mode_permission_funcs = (
521 ["module_param", 3],
522 ["module_param_(?:array|named|string)", 4],
523 ["module_param_array_named", 5],
524 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
525 ["proc_create(?:_data|)", 2],
526 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
527);
528
Joe Perches515a2352014-04-03 14:49:24 -0700529#Create a search pattern for all these functions to speed up a loop below
530our $mode_perms_search = "";
531foreach my $entry (@mode_permission_funcs) {
532 $mode_perms_search .= '|' if ($mode_perms_search ne "");
533 $mode_perms_search .= $entry->[0];
534}
535
Joe Perchesb392c642015-04-16 12:44:16 -0700536our $mode_perms_world_writable = qr{
537 S_IWUGO |
538 S_IWOTH |
539 S_IRWXUGO |
540 S_IALLUGO |
541 0[0-7][0-7][2367]
542}x;
543
Wolfram Sang7840a942010-08-09 17:20:57 -0700544our $allowed_asm_includes = qr{(?x:
545 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700546 memory|
547 time|
548 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700549)};
550# memory.h: ARM has a custom one
551
Kees Cook66b47b42014-10-13 15:51:57 -0700552# Load common spelling mistakes and build regular expression list.
553my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700554my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700555
Joe Perches36061e32014-12-10 15:51:43 -0800556if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800557 while (<$spelling>) {
558 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700559
Joe Perches36061e32014-12-10 15:51:43 -0800560 $line =~ s/\s*\n?$//g;
561 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700562
Joe Perches36061e32014-12-10 15:51:43 -0800563 next if ($line =~ m/^\s*#/);
564 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700565
Joe Perches36061e32014-12-10 15:51:43 -0800566 my ($suspect, $fix) = split(/\|\|/, $line);
567
Joe Perches36061e32014-12-10 15:51:43 -0800568 $spelling_fix{$suspect} = $fix;
569 }
570 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800571} else {
572 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700573}
Kees Cook66b47b42014-10-13 15:51:57 -0700574
Joe Perchesebfd7d62015-04-16 12:44:14 -0700575if ($codespell) {
576 if (open(my $spelling, '<', $codespellfile)) {
577 while (<$spelling>) {
578 my $line = $_;
579
580 $line =~ s/\s*\n?$//g;
581 $line =~ s/^\s*//g;
582
583 next if ($line =~ m/^\s*#/);
584 next if ($line =~ m/^\s*$/);
585 next if ($line =~ m/, disabled/i);
586
587 $line =~ s/,.*$//;
588
589 my ($suspect, $fix) = split(/->/, $line);
590
591 $spelling_fix{$suspect} = $fix;
592 }
593 close($spelling);
594 } else {
595 warn "No codespell typos will be found - file '$codespellfile': $!\n";
596 }
597}
598
599$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
600
Andy Whitcroft8905a672007-11-28 16:21:06 -0800601sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700602 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
603 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700604 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700605 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700606 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700607 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700608 (?:$typeTypedefs\b)|
609 (?:${all}\b)
610 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800611 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700612 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800613 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800614 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700615 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700616 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800617 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700618 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800619 }x;
Joe Perches18130872014-08-06 16:11:22 -0700620 $NonptrTypeMisordered = qr{
621 (?:$Modifier\s+|const\s+)*
622 (?:
623 (?:${Misordered}\b)
624 )
625 (?:\s+$Modifier|\s+const)*
626 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700627 $NonptrTypeWithAttr = qr{
628 (?:$Modifier\s+|const\s+)*
629 (?:
630 (?:typeof|__typeof__)\s*\([^\)]*\)|
631 (?:$typeTypedefs\b)|
632 (?:${allWithAttr}\b)
633 )
634 (?:\s+$Modifier|\s+const)*
635 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800636 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700637 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700638 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700639 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800640 }x;
Joe Perches18130872014-08-06 16:11:22 -0700641 $TypeMisordered = qr{
642 $NonptrTypeMisordered
643 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
644 (?:\s+$Inline|\s+$Modifier)*
645 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700646 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700647 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800648}
649build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700650
Joe Perches7d2367a2011-07-25 17:13:22 -0700651our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700652
653# Using $balanced_parens, $LvalOrFunc, or $FuncArg
654# requires at least perl version v5.10.0
655# Any use must be runtime checked with $^V
656
657our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700658our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800659our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700660
Joe Perchesf8422302014-08-06 16:11:31 -0700661our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700662 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700663 (?:$Storage\s+)?LIST_HEAD\s*\(|
664 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
665)};
666
Joe Perches7d2367a2011-07-25 17:13:22 -0700667sub deparenthesize {
668 my ($string) = @_;
669 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700670
671 while ($string =~ /^\s*\(.*\)\s*$/) {
672 $string =~ s@^\s*\(\s*@@;
673 $string =~ s@\s*\)\s*$@@;
674 }
675
Joe Perches7d2367a2011-07-25 17:13:22 -0700676 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700677
Joe Perches7d2367a2011-07-25 17:13:22 -0700678 return $string;
679}
680
Joe Perches34456862013-07-03 15:05:34 -0700681sub seed_camelcase_file {
682 my ($file) = @_;
683
684 return if (!(-f $file));
685
686 local $/;
687
688 open(my $include_file, '<', "$file")
689 or warn "$P: Can't read '$file' $!\n";
690 my $text = <$include_file>;
691 close($include_file);
692
693 my @lines = split('\n', $text);
694
695 foreach my $line (@lines) {
696 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
697 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
698 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800699 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
700 $camelcase{$1} = 1;
701 } 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 -0700702 $camelcase{$1} = 1;
703 }
704 }
705}
706
707my $camelcase_seeded = 0;
708sub seed_camelcase_includes {
709 return if ($camelcase_seeded);
710
711 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700712 my $camelcase_cache = "";
713 my @include_files = ();
714
715 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700716
Richard Genoud3645e322014-02-10 14:25:32 -0800717 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700718 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
719 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700720 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700721 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700722 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700723 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700724 @include_files = split('\n', $files);
725 foreach my $file (@include_files) {
726 my $date = POSIX::strftime("%Y%m%d%H%M",
727 localtime((stat $file)[9]));
728 $last_mod_date = $date if ($last_mod_date < $date);
729 }
730 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700731 }
Joe Perchesc707a812013-07-08 16:00:43 -0700732
733 if ($camelcase_cache ne "" && -f $camelcase_cache) {
734 open(my $camelcase_file, '<', "$camelcase_cache")
735 or warn "$P: Can't read '$camelcase_cache' $!\n";
736 while (<$camelcase_file>) {
737 chomp;
738 $camelcase{$_} = 1;
739 }
740 close($camelcase_file);
741
742 return;
743 }
744
Richard Genoud3645e322014-02-10 14:25:32 -0800745 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700746 $files = `git ls-files "include/*.h"`;
747 @include_files = split('\n', $files);
748 }
749
Joe Perches34456862013-07-03 15:05:34 -0700750 foreach my $file (@include_files) {
751 seed_camelcase_file($file);
752 }
Joe Perches351b2a12013-07-03 15:05:36 -0700753
Joe Perchesc707a812013-07-08 16:00:43 -0700754 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700755 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700756 open(my $camelcase_file, '>', "$camelcase_cache")
757 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700758 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
759 print $camelcase_file ("$_\n");
760 }
761 close($camelcase_file);
762 }
Joe Perches34456862013-07-03 15:05:34 -0700763}
764
Joe Perchesd311cd42014-08-06 16:10:57 -0700765sub git_commit_info {
766 my ($commit, $id, $desc) = @_;
767
768 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
769
770 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
771 $output =~ s/^\s*//gm;
772 my @lines = split("\n", $output);
773
Joe Perches0d7835f2015-02-13 14:38:35 -0800774 return ($id, $desc) if ($#lines < 0);
775
Joe Perchesd311cd42014-08-06 16:10:57 -0700776 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
777# Maybe one day convert this block of bash into something that returns
778# all matching commit ids, but it's very slow...
779#
780# echo "checking commits $1..."
781# git rev-list --remotes | grep -i "^$1" |
782# while read line ; do
783# git log --format='%H %s' -1 $line |
784# echo "commit $(cut -c 1-12,41-)"
785# done
786 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
787 } else {
788 $id = substr($lines[0], 0, 12);
789 $desc = substr($lines[0], 41);
790 }
791
792 return ($id, $desc);
793}
794
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700795$chk_signoff = 0 if ($file);
796
Andy Whitcroft00df3442007-06-08 13:47:06 -0700797my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800798my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700799my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700800my @fixed_inserted = ();
801my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700802my $fixlinenr = -1;
803
Du, Changbin4a593c32016-05-20 17:04:16 -0700804# If input is git commits, extract all commits from the commit expressions.
805# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
806die "$P: No git repository found\n" if ($git && !-e ".git");
807
808if ($git) {
809 my @commits = ();
Joe Perches0dea9f12016-05-20 17:04:19 -0700810 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700811 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700812 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
813 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700814 } elsif ($commit_expr =~ m/\.\./) {
815 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700816 } else {
Joe Perches0dea9f12016-05-20 17:04:19 -0700817 $git_range = "-1 $commit_expr";
818 }
819 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
820 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700821 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
822 next if (!defined($1) || !defined($2));
Joe Perches0dea9f12016-05-20 17:04:19 -0700823 my $sha1 = $1;
824 my $subject = $2;
825 unshift(@commits, $sha1);
826 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700827 }
828 }
829 die "$P: no git commits after extraction!\n" if (@commits == 0);
830 @ARGV = @commits;
831}
832
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700834for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800835 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700836 if ($git) {
837 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
838 die "$P: $filename: git format-patch failed - $!\n";
839 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800840 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700841 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800842 } elsif ($filename eq '-') {
843 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700844 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800845 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700846 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700847 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800848 if ($filename eq '-') {
849 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700850 } elsif ($git) {
Joe Perches0dea9f12016-05-20 17:04:19 -0700851 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800852 } else {
853 $vname = $filename;
854 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800855 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 chomp;
857 push(@rawlines, $_);
858 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800859 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700860
861 if ($#ARGV > 0 && $quiet == 0) {
862 print '-' x length($vname) . "\n";
863 print "$vname\n";
864 print '-' x length($vname) . "\n";
865 }
866
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800867 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700868 $exit = 1;
869 }
870 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800871 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700872 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700873 @fixed_inserted = ();
874 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700875 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700876 @modifierListFile = ();
877 @typeListFile = ();
878 build_types();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700879}
880
Joe Perchesd8469f12015-06-25 15:03:00 -0700881if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700882 hash_show_words(\%use_type, "Used");
883 hash_show_words(\%ignore_type, "Ignored");
884
Joe Perchesd8469f12015-06-25 15:03:00 -0700885 if ($^V lt 5.10.0) {
886 print << "EOM"
887
888NOTE: perl $^V is not modern enough to detect all possible issues.
889 An upgrade to at least perl v5.10.0 is suggested.
890EOM
891 }
892 if ($exit) {
893 print << "EOM"
894
895NOTE: If any of the errors are false positives, please report
896 them to the maintainer, see CHECKPATCH in MAINTAINERS.
897EOM
898 }
899}
900
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700901exit($exit);
902
903sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904 my ($root) = @_;
905
906 my @tree_check = (
907 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
908 "README", "Documentation", "arch", "include", "drivers",
909 "fs", "init", "ipc", "kernel", "lib", "scripts",
910 );
911
912 foreach my $check (@tree_check) {
913 if (! -e $root . '/' . $check) {
914 return 0;
915 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700916 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700917 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700918}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700919
Joe Perches20112472011-07-25 17:13:23 -0700920sub parse_email {
921 my ($formatted_email) = @_;
922
923 my $name = "";
924 my $address = "";
925 my $comment = "";
926
927 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
928 $name = $1;
929 $address = $2;
930 $comment = $3 if defined $3;
931 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
932 $address = $1;
933 $comment = $2 if defined $2;
934 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
935 $address = $1;
936 $comment = $2 if defined $2;
937 $formatted_email =~ s/$address.*$//;
938 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700939 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700940 $name =~ s/^\"|\"$//g;
941 # If there's a name left after stripping spaces and
942 # leading quotes, and the address doesn't have both
943 # leading and trailing angle brackets, the address
944 # is invalid. ie:
945 # "joe smith joe@smith.com" bad
946 # "joe smith <joe@smith.com" bad
947 if ($name ne "" && $address !~ /^<[^>]+>$/) {
948 $name = "";
949 $address = "";
950 $comment = "";
951 }
952 }
953
Joe Perches3705ce52013-07-03 15:05:31 -0700954 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700955 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700956 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700957 $address =~ s/^\<|\>$//g;
958
959 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
960 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
961 $name = "\"$name\"";
962 }
963
964 return ($name, $address, $comment);
965}
966
967sub format_email {
968 my ($name, $address) = @_;
969
970 my $formatted_email;
971
Joe Perches3705ce52013-07-03 15:05:31 -0700972 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700973 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700974 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700975
976 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
977 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
978 $name = "\"$name\"";
979 }
980
981 if ("$name" eq "") {
982 $formatted_email = "$address";
983 } else {
984 $formatted_email = "$name <$address>";
985 }
986
987 return $formatted_email;
988}
989
Joe Perchesd311cd42014-08-06 16:10:57 -0700990sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700991 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700992
Joe Perchesbd474ca2014-08-06 16:11:10 -0700993 foreach my $path (split(/:/, $ENV{PATH})) {
994 if (-e "$path/$bin") {
995 return "$path/$bin";
996 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700997 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700998
Joe Perchesbd474ca2014-08-06 16:11:10 -0700999 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001000}
1001
Joe Perches000d1cc12011-07-25 17:13:25 -07001002sub which_conf {
1003 my ($conf) = @_;
1004
1005 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1006 if (-e "$path/$conf") {
1007 return "$path/$conf";
1008 }
1009 }
1010
1011 return "";
1012}
1013
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001014sub expand_tabs {
1015 my ($str) = @_;
1016
1017 my $res = '';
1018 my $n = 0;
1019 for my $c (split(//, $str)) {
1020 if ($c eq "\t") {
1021 $res .= ' ';
1022 $n++;
1023 for (; ($n % 8) != 0; $n++) {
1024 $res .= ' ';
1025 }
1026 next;
1027 }
1028 $res .= $c;
1029 $n++;
1030 }
1031
1032 return $res;
1033}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001034sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001035 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001036 return $res;
1037}
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001038
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001039sub line_stats {
1040 my ($line) = @_;
1041
1042 # Drop the diff line leader and expand tabs
1043 $line =~ s/^.//;
1044 $line = expand_tabs($line);
1045
1046 # Pick the indent from the front of the line.
1047 my ($white) = ($line =~ /^(\s*)/);
1048
1049 return (length($line), length($white));
1050}
1051
Andy Whitcroft773647a2008-03-28 14:15:58 -07001052my $sanitise_quote = '';
1053
1054sub sanitise_line_reset {
1055 my ($in_comment) = @_;
1056
1057 if ($in_comment) {
1058 $sanitise_quote = '*/';
1059 } else {
1060 $sanitise_quote = '';
1061 }
1062}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001063sub sanitise_line {
1064 my ($line) = @_;
1065
1066 my $res = '';
1067 my $l = '';
1068
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001069 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001070 my $off = 0;
1071 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001072
Andy Whitcroft773647a2008-03-28 14:15:58 -07001073 # Always copy over the diff marker.
1074 $res = substr($line, 0, 1);
1075
1076 for ($off = 1; $off < length($line); $off++) {
1077 $c = substr($line, $off, 1);
1078
1079 # Comments we are wacking completly including the begin
1080 # and end, all to $;.
1081 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1082 $sanitise_quote = '*/';
1083
1084 substr($res, $off, 2, "$;$;");
1085 $off++;
1086 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001087 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001088 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001089 $sanitise_quote = '';
1090 substr($res, $off, 2, "$;$;");
1091 $off++;
1092 next;
1093 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001094 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1095 $sanitise_quote = '//';
1096
1097 substr($res, $off, 2, $sanitise_quote);
1098 $off++;
1099 next;
1100 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001101
1102 # A \ in a string means ignore the next character.
1103 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1104 $c eq "\\") {
1105 substr($res, $off, 2, 'XX');
1106 $off++;
1107 next;
1108 }
1109 # Regular quotes.
1110 if ($c eq "'" || $c eq '"') {
1111 if ($sanitise_quote eq '') {
1112 $sanitise_quote = $c;
1113
1114 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001115 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001116 } elsif ($sanitise_quote eq $c) {
1117 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001118 }
1119 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001120
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001121 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001122 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1123 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001124 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1125 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001126 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1127 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001128 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001129 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001130 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001131 }
1132
Daniel Walker113f04a2009-09-21 17:04:35 -07001133 if ($sanitise_quote eq '//') {
1134 $sanitise_quote = '';
1135 }
1136
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001137 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001138 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001139 my $clean = 'X' x length($1);
1140 $res =~ s@\<.*\>@<$clean>@;
1141
1142 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001143 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001144 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001145 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001146 }
1147
Andy Whitcroft00df3442007-06-08 13:47:06 -07001148 return $res;
1149}
1150
Joe Perchesa6962d72013-04-29 16:18:13 -07001151sub get_quoted_string {
1152 my ($line, $rawline) = @_;
1153
Joe Perches33acb542015-06-25 15:02:54 -07001154 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001155 return substr($rawline, $-[0], $+[0] - $-[0]);
1156}
1157
Andy Whitcroft8905a672007-11-28 16:21:06 -08001158sub ctx_statement_block {
1159 my ($linenr, $remain, $off) = @_;
1160 my $line = $linenr - 1;
1161 my $blk = '';
1162 my $soff = $off;
1163 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001164 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001165
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001166 my $loff = 0;
1167
Andy Whitcroft8905a672007-11-28 16:21:06 -08001168 my $type = '';
1169 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001170 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001171 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001172 my $c;
1173 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001174
1175 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001176 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001177 @stack = (['', 0]) if ($#stack == -1);
1178
Andy Whitcroft773647a2008-03-28 14:15:58 -07001179 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001180 # If we are about to drop off the end, pull in more
1181 # context.
1182 if ($off >= $len) {
1183 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001184 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001185 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001186 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001187 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001188 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001189 $len = length($blk);
1190 $line++;
1191 last;
1192 }
1193 # Bail if there is no further context.
1194 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001195 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001196 last;
1197 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001198 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1199 $level++;
1200 $type = '#';
1201 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001202 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001203 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001204 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001205 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001206
Andy Whitcroft773647a2008-03-28 14:15:58 -07001207 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001208
1209 # Handle nested #if/#else.
1210 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1211 push(@stack, [ $type, $level ]);
1212 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1213 ($type, $level) = @{$stack[$#stack - 1]};
1214 } elsif ($remainder =~ /^#\s*endif\b/) {
1215 ($type, $level) = @{pop(@stack)};
1216 }
1217
Andy Whitcroft8905a672007-11-28 16:21:06 -08001218 # Statement ends at the ';' or a close '}' at the
1219 # outermost level.
1220 if ($level == 0 && $c eq ';') {
1221 last;
1222 }
1223
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001224 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001225 if ($level == 0 && $coff_set == 0 &&
1226 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1227 $remainder =~ /^(else)(?:\s|{)/ &&
1228 $remainder !~ /^else\s+if\b/) {
1229 $coff = $off + length($1) - 1;
1230 $coff_set = 1;
1231 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1232 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001233 }
1234
Andy Whitcroft8905a672007-11-28 16:21:06 -08001235 if (($type eq '' || $type eq '(') && $c eq '(') {
1236 $level++;
1237 $type = '(';
1238 }
1239 if ($type eq '(' && $c eq ')') {
1240 $level--;
1241 $type = ($level != 0)? '(' : '';
1242
1243 if ($level == 0 && $coff < $soff) {
1244 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001245 $coff_set = 1;
1246 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001247 }
1248 }
1249 if (($type eq '' || $type eq '{') && $c eq '{') {
1250 $level++;
1251 $type = '{';
1252 }
1253 if ($type eq '{' && $c eq '}') {
1254 $level--;
1255 $type = ($level != 0)? '{' : '';
1256
1257 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001258 if (substr($blk, $off + 1, 1) eq ';') {
1259 $off++;
1260 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001261 last;
1262 }
1263 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001264 # Preprocessor commands end at the newline unless escaped.
1265 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1266 $level--;
1267 $type = '';
1268 $off++;
1269 last;
1270 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001271 $off++;
1272 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001273 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001274 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001275 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001276 $line++;
1277 $remain--;
1278 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001279
1280 my $statement = substr($blk, $soff, $off - $soff + 1);
1281 my $condition = substr($blk, $soff, $coff - $soff + 1);
1282
1283 #warn "STATEMENT<$statement>\n";
1284 #warn "CONDITION<$condition>\n";
1285
Andy Whitcroft773647a2008-03-28 14:15:58 -07001286 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001287
1288 return ($statement, $condition,
1289 $line, $remain + 1, $off - $loff + 1, $level);
1290}
1291
Andy Whitcroftcf655042008-03-04 14:28:20 -08001292sub statement_lines {
1293 my ($stmt) = @_;
1294
1295 # Strip the diff line prefixes and rip blank lines at start and end.
1296 $stmt =~ s/(^|\n)./$1/g;
1297 $stmt =~ s/^\s*//;
1298 $stmt =~ s/\s*$//;
1299
1300 my @stmt_lines = ($stmt =~ /\n/g);
1301
1302 return $#stmt_lines + 2;
1303}
1304
1305sub statement_rawlines {
1306 my ($stmt) = @_;
1307
1308 my @stmt_lines = ($stmt =~ /\n/g);
1309
1310 return $#stmt_lines + 2;
1311}
1312
1313sub statement_block_size {
1314 my ($stmt) = @_;
1315
1316 $stmt =~ s/(^|\n)./$1/g;
1317 $stmt =~ s/^\s*{//;
1318 $stmt =~ s/}\s*$//;
1319 $stmt =~ s/^\s*//;
1320 $stmt =~ s/\s*$//;
1321
1322 my @stmt_lines = ($stmt =~ /\n/g);
1323 my @stmt_statements = ($stmt =~ /;/g);
1324
1325 my $stmt_lines = $#stmt_lines + 2;
1326 my $stmt_statements = $#stmt_statements + 1;
1327
1328 if ($stmt_lines > $stmt_statements) {
1329 return $stmt_lines;
1330 } else {
1331 return $stmt_statements;
1332 }
1333}
1334
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001335sub ctx_statement_full {
1336 my ($linenr, $remain, $off) = @_;
1337 my ($statement, $condition, $level);
1338
1339 my (@chunks);
1340
Andy Whitcroftcf655042008-03-04 14:28:20 -08001341 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001342 ($statement, $condition, $linenr, $remain, $off, $level) =
1343 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001344 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001345 push(@chunks, [ $condition, $statement ]);
1346 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1347 return ($level, $linenr, @chunks);
1348 }
1349
1350 # Pull in the following conditional/block pairs and see if they
1351 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001352 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001353 ($statement, $condition, $linenr, $remain, $off, $level) =
1354 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001355 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001356 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001357 #print "C: push\n";
1358 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001359 }
1360
1361 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001362}
1363
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001364sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001365 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001366 my $line;
1367 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001368 my $blk = '';
1369 my @o;
1370 my @c;
1371 my @res = ();
1372
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001373 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001374 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001375 for ($line = $start; $remain > 0; $line++) {
1376 next if ($rawlines[$line] =~ /^-/);
1377 $remain--;
1378
1379 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001380
1381 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001382 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001383 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001384 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001385 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001386 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001387 $level = pop(@stack);
1388 }
1389
Andy Whitcroft01464f32010-10-26 14:23:19 -07001390 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001391 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1392 if ($off > 0) {
1393 $off--;
1394 next;
1395 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001396
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001397 if ($c eq $close && $level > 0) {
1398 $level--;
1399 last if ($level == 0);
1400 } elsif ($c eq $open) {
1401 $level++;
1402 }
1403 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001404
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001405 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001406 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001407 }
1408
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001409 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001410 }
1411
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001412 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001413}
1414sub ctx_block_outer {
1415 my ($linenr, $remain) = @_;
1416
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001417 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1418 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001419}
1420sub ctx_block {
1421 my ($linenr, $remain) = @_;
1422
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001423 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1424 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001425}
1426sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001427 my ($linenr, $remain, $off) = @_;
1428
1429 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1430 return @r;
1431}
1432sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001433 my ($linenr, $remain) = @_;
1434
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001435 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001436}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001437sub ctx_statement_level {
1438 my ($linenr, $remain, $off) = @_;
1439
1440 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1441}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001442
1443sub ctx_locate_comment {
1444 my ($first_line, $end_line) = @_;
1445
1446 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001447 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001448 return $current_comment if (defined $current_comment);
1449
1450 # Look through the context and try and figure out if there is a
1451 # comment.
1452 my $in_comment = 0;
1453 $current_comment = '';
1454 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001455 my $line = $rawlines[$linenr - 1];
1456 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001457 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1458 $in_comment = 1;
1459 }
1460 if ($line =~ m@/\*@) {
1461 $in_comment = 1;
1462 }
1463 if (!$in_comment && $current_comment ne '') {
1464 $current_comment = '';
1465 }
1466 $current_comment .= $line . "\n" if ($in_comment);
1467 if ($line =~ m@\*/@) {
1468 $in_comment = 0;
1469 }
1470 }
1471
1472 chomp($current_comment);
1473 return($current_comment);
1474}
1475sub ctx_has_comment {
1476 my ($first_line, $end_line) = @_;
1477 my $cmt = ctx_locate_comment($first_line, $end_line);
1478
Andy Whitcroft00df3442007-06-08 13:47:06 -07001479 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001480 ##print "CMMT: $cmt\n";
1481
1482 return ($cmt ne '');
1483}
1484
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001485sub raw_line {
1486 my ($linenr, $cnt) = @_;
1487
1488 my $offset = $linenr - 1;
1489 $cnt++;
1490
1491 my $line;
1492 while ($cnt) {
1493 $line = $rawlines[$offset++];
1494 next if (defined($line) && $line =~ /^-/);
1495 $cnt--;
1496 }
1497
1498 return $line;
1499}
1500
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001501sub cat_vet {
1502 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001503 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001504
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001505 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001506 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1507 $res .= $1;
1508 if ($2 ne '') {
1509 $coded = sprintf("^%c", unpack('C', $2) + 64);
1510 $res .= $coded;
1511 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001512 }
1513 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001514
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001515 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001516}
1517
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001518my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001519my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001520my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001521my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001522
1523sub annotate_reset {
1524 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001525 $av_pending = '_';
1526 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001527 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001528}
1529
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001530sub annotate_values {
1531 my ($stream, $type) = @_;
1532
1533 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001534 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001535 my $cur = $stream;
1536
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001537 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001538
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001539 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001540 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001541 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001542 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001543 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001544 print "WS($1)\n" if ($dbg_values > 1);
1545 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001546 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001547 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001548 }
1549
Florian Micklerc023e4732011-01-12 16:59:58 -08001550 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001551 print "CAST($1)\n" if ($dbg_values > 1);
1552 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001553 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001554
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001555 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001556 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001557 $type = 'T';
1558
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001559 } elsif ($cur =~ /^($Modifier)\s*/) {
1560 print "MODIFIER($1)\n" if ($dbg_values > 1);
1561 $type = 'T';
1562
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001563 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001564 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001565 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001566 push(@av_paren_type, $type);
1567 if ($2 ne '') {
1568 $av_pending = 'N';
1569 }
1570 $type = 'E';
1571
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001572 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001573 print "UNDEF($1)\n" if ($dbg_values > 1);
1574 $av_preprocessor = 1;
1575 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001576
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001577 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001578 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001579 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001580
1581 push(@av_paren_type, $type);
1582 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001583 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001584
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001585 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001586 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1587 $av_preprocessor = 1;
1588
1589 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1590
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001591 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001592
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001593 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001594 print "PRE_END($1)\n" if ($dbg_values > 1);
1595
1596 $av_preprocessor = 1;
1597
1598 # Assume all arms of the conditional end as this
1599 # one does, and continue as if the #endif was not here.
1600 pop(@av_paren_type);
1601 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001602 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001603
1604 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001605 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001606
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001607 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1608 print "ATTR($1)\n" if ($dbg_values > 1);
1609 $av_pending = $type;
1610 $type = 'N';
1611
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001612 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001613 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001614 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001615 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001616 }
1617 $type = 'N';
1618
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001619 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001620 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001621 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001622 $type = 'N';
1623
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001624 } elsif ($cur =~/^(case)/o) {
1625 print "CASE($1)\n" if ($dbg_values > 1);
1626 $av_pend_colon = 'C';
1627 $type = 'N';
1628
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001629 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001630 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001631 $type = 'N';
1632
1633 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001634 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001635 push(@av_paren_type, $av_pending);
1636 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001637 $type = 'N';
1638
1639 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001640 my $new_type = pop(@av_paren_type);
1641 if ($new_type ne '_') {
1642 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001643 print "PAREN('$1') -> $type\n"
1644 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001645 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001646 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001647 }
1648
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001649 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001650 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001651 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001652 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001653
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001654 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1655 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001656 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001657 } elsif ($type eq 'E') {
1658 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001659 }
1660 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1661 $type = 'V';
1662
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001663 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001664 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001665 $type = 'V';
1666
1667 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001668 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001669 $type = 'N';
1670
Andy Whitcroftcf655042008-03-04 14:28:20 -08001671 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001672 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001673 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001674 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001675
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001676 } elsif ($cur =~/^(,)/) {
1677 print "COMMA($1)\n" if ($dbg_values > 1);
1678 $type = 'C';
1679
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001680 } elsif ($cur =~ /^(\?)/o) {
1681 print "QUESTION($1)\n" if ($dbg_values > 1);
1682 $type = 'N';
1683
1684 } elsif ($cur =~ /^(:)/o) {
1685 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1686
1687 substr($var, length($res), 1, $av_pend_colon);
1688 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1689 $type = 'E';
1690 } else {
1691 $type = 'N';
1692 }
1693 $av_pend_colon = 'O';
1694
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001695 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001696 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001697 $type = 'N';
1698
Andy Whitcroft0d413862008-10-15 22:02:16 -07001699 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001700 my $variant;
1701
1702 print "OPV($1)\n" if ($dbg_values > 1);
1703 if ($type eq 'V') {
1704 $variant = 'B';
1705 } else {
1706 $variant = 'U';
1707 }
1708
1709 substr($var, length($res), 1, $variant);
1710 $type = 'N';
1711
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001712 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001713 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001714 if ($1 ne '++' && $1 ne '--') {
1715 $type = 'N';
1716 }
1717
1718 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001719 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001720 }
1721 if (defined $1) {
1722 $cur = substr($cur, length($1));
1723 $res .= $type x length($1);
1724 }
1725 }
1726
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001727 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001728}
1729
Andy Whitcroft8905a672007-11-28 16:21:06 -08001730sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001731 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001732 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001733 ^(?:
1734 $Modifier|
1735 $Storage|
1736 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001737 DEFINE_\S+
1738 )$|
1739 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001740 goto|
1741 return|
1742 case|
1743 else|
1744 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001745 do|
1746 \#|
1747 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001748 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001749 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001750 )}x;
1751 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1752 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001753 # Check for modifiers.
1754 $possible =~ s/\s*$Storage\s*//g;
1755 $possible =~ s/\s*$Sparse\s*//g;
1756 if ($possible =~ /^\s*$/) {
1757
1758 } elsif ($possible =~ /\s/) {
1759 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001760 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001761 if ($modifier !~ $notPermitted) {
1762 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001763 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001764 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001765 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001766
1767 } else {
1768 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001769 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001770 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001771 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001772 } else {
1773 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001774 }
1775}
1776
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001777my $prefix = '';
1778
Joe Perches000d1cc12011-07-25 17:13:25 -07001779sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001780 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001781
Joe Perchescbec18a2014-04-03 14:49:19 -07001782 return defined $use_type{$type} if (scalar keys %use_type > 0);
1783
1784 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001785}
1786
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001787sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001788 my ($level, $type, $msg) = @_;
1789
1790 if (!show_type($type) ||
1791 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001792 return 0;
1793 }
Joe Perches57230292015-06-25 15:03:03 -07001794 my $output = '';
1795 if (-t STDOUT && $color) {
1796 if ($level eq 'ERROR') {
1797 $output .= RED;
1798 } elsif ($level eq 'WARNING') {
1799 $output .= YELLOW;
1800 } else {
1801 $output .= GREEN;
1802 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001803 }
Joe Perches57230292015-06-25 15:03:03 -07001804 $output .= $prefix . $level . ':';
1805 if ($show_types) {
1806 $output .= BLUE if (-t STDOUT && $color);
1807 $output .= "$type:";
1808 }
1809 $output .= RESET if (-t STDOUT && $color);
1810 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001811
1812 if ($showfile) {
1813 my @lines = split("\n", $output, -1);
1814 splice(@lines, 1, 1);
1815 $output = join("\n", @lines);
1816 }
Joe Perches57230292015-06-25 15:03:03 -07001817 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001818
Joe Perches57230292015-06-25 15:03:03 -07001819 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001820
1821 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001822}
Joe Perchescbec18a2014-04-03 14:49:19 -07001823
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001824sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001825 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001826}
Joe Perches000d1cc12011-07-25 17:13:25 -07001827
Joe Perchesd752fcc2014-08-06 16:11:05 -07001828sub fixup_current_range {
1829 my ($lineRef, $offset, $length) = @_;
1830
1831 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1832 my $o = $1;
1833 my $l = $2;
1834 my $no = $o + $offset;
1835 my $nl = $l + $length;
1836 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1837 }
1838}
1839
1840sub fix_inserted_deleted_lines {
1841 my ($linesRef, $insertedRef, $deletedRef) = @_;
1842
1843 my $range_last_linenr = 0;
1844 my $delta_offset = 0;
1845
1846 my $old_linenr = 0;
1847 my $new_linenr = 0;
1848
1849 my $next_insert = 0;
1850 my $next_delete = 0;
1851
1852 my @lines = ();
1853
1854 my $inserted = @{$insertedRef}[$next_insert++];
1855 my $deleted = @{$deletedRef}[$next_delete++];
1856
1857 foreach my $old_line (@{$linesRef}) {
1858 my $save_line = 1;
1859 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001860 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001861 $delta_offset = 0;
1862 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1863 $range_last_linenr = $new_linenr;
1864 fixup_current_range(\$line, $delta_offset, 0);
1865 }
1866
1867 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1868 $deleted = @{$deletedRef}[$next_delete++];
1869 $save_line = 0;
1870 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1871 }
1872
1873 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1874 push(@lines, ${$inserted}{'LINE'});
1875 $inserted = @{$insertedRef}[$next_insert++];
1876 $new_linenr++;
1877 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1878 }
1879
1880 if ($save_line) {
1881 push(@lines, $line);
1882 $new_linenr++;
1883 }
1884
1885 $old_linenr++;
1886 }
1887
1888 return @lines;
1889}
1890
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001891sub fix_insert_line {
1892 my ($linenr, $line) = @_;
1893
1894 my $inserted = {
1895 LINENR => $linenr,
1896 LINE => $line,
1897 };
1898 push(@fixed_inserted, $inserted);
1899}
1900
1901sub fix_delete_line {
1902 my ($linenr, $line) = @_;
1903
1904 my $deleted = {
1905 LINENR => $linenr,
1906 LINE => $line,
1907 };
1908
1909 push(@fixed_deleted, $deleted);
1910}
1911
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001912sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001913 my ($type, $msg) = @_;
1914
1915 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001916 our $clean = 0;
1917 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001918 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001919 }
Joe Perches3705ce52013-07-03 15:05:31 -07001920 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001921}
1922sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001923 my ($type, $msg) = @_;
1924
1925 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001926 our $clean = 0;
1927 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001928 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001929 }
Joe Perches3705ce52013-07-03 15:05:31 -07001930 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001931}
1932sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001933 my ($type, $msg) = @_;
1934
1935 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001936 our $clean = 0;
1937 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001938 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001939 }
Joe Perches3705ce52013-07-03 15:05:31 -07001940 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001941}
1942
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001943sub check_absolute_file {
1944 my ($absolute, $herecurr) = @_;
1945 my $file = $absolute;
1946
1947 ##print "absolute<$absolute>\n";
1948
1949 # See if any suffix of this path is a path within the tree.
1950 while ($file =~ s@^[^/]*/@@) {
1951 if (-f "$root/$file") {
1952 ##print "file<$file>\n";
1953 last;
1954 }
1955 }
1956 if (! -f _) {
1957 return 0;
1958 }
1959
1960 # It is, so see if the prefix is acceptable.
1961 my $prefix = $absolute;
1962 substr($prefix, -length($file)) = '';
1963
1964 ##print "prefix<$prefix>\n";
1965 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001966 WARN("USE_RELATIVE_PATH",
1967 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001968 }
1969}
1970
Joe Perches3705ce52013-07-03 15:05:31 -07001971sub trim {
1972 my ($string) = @_;
1973
Joe Perchesb34c6482013-09-11 14:24:01 -07001974 $string =~ s/^\s+|\s+$//g;
1975
1976 return $string;
1977}
1978
1979sub ltrim {
1980 my ($string) = @_;
1981
1982 $string =~ s/^\s+//;
1983
1984 return $string;
1985}
1986
1987sub rtrim {
1988 my ($string) = @_;
1989
1990 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001991
1992 return $string;
1993}
1994
Joe Perches52ea8502013-11-12 15:10:09 -08001995sub string_find_replace {
1996 my ($string, $find, $replace) = @_;
1997
1998 $string =~ s/$find/$replace/g;
1999
2000 return $string;
2001}
2002
Joe Perches3705ce52013-07-03 15:05:31 -07002003sub tabify {
2004 my ($leading) = @_;
2005
2006 my $source_indent = 8;
2007 my $max_spaces_before_tab = $source_indent - 1;
2008 my $spaces_to_tab = " " x $source_indent;
2009
2010 #convert leading spaces to tabs
2011 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2012 #Remove spaces before a tab
2013 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2014
2015 return "$leading";
2016}
2017
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002018sub pos_last_openparen {
2019 my ($line) = @_;
2020
2021 my $pos = 0;
2022
2023 my $opens = $line =~ tr/\(/\(/;
2024 my $closes = $line =~ tr/\)/\)/;
2025
2026 my $last_openparen = 0;
2027
2028 if (($opens == 0) || ($closes >= $opens)) {
2029 return -1;
2030 }
2031
2032 my $len = length($line);
2033
2034 for ($pos = 0; $pos < $len; $pos++) {
2035 my $string = substr($line, $pos);
2036 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2037 $pos += length($1) - 1;
2038 } elsif (substr($line, $pos, 1) eq '(') {
2039 $last_openparen = $pos;
2040 } elsif (index($string, '(') == -1) {
2041 last;
2042 }
2043 }
2044
Joe Perches91cb5192014-04-03 14:49:32 -07002045 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002046}
2047
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002048sub process {
2049 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002050
2051 my $linenr=0;
2052 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002053 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002054 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002055 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002056
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002057 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002058 my $indent;
2059 my $previndent=0;
2060 my $stashindent=0;
2061
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002062 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002063 my $signoff = 0;
2064 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002065 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002066 my $in_commit_log = 0; #Scanning lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002067 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002068 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002069 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002070 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002071 my $non_utf8_charset = 0;
2072
Joe Perches365dd4e2014-08-06 16:10:42 -07002073 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002074 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002075
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002076 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002077 our $cnt_lines = 0;
2078 our $cnt_error = 0;
2079 our $cnt_warn = 0;
2080 our $cnt_chk = 0;
2081
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002082 # Trace the real file/line as we go.
2083 my $realfile = '';
2084 my $realline = 0;
2085 my $realcnt = 0;
2086 my $here = '';
2087 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002088 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002089 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002090 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002091
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002092 my $prev_values = 'E';
2093
2094 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002095 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002096 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002097 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002098 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002099
Joe Perches7e51f192013-09-11 14:23:57 -07002100 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002101
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002102 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002103 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002104 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002105 my @setup_docs = ();
2106 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002107
Joe Perchesd8b07712013-11-12 15:10:06 -08002108 my $camelcase_file_seeded = 0;
2109
Andy Whitcroft773647a2008-03-28 14:15:58 -07002110 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002111 my $line;
2112 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002113 $linenr++;
2114 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002115
Joe Perches3705ce52013-07-03 15:05:31 -07002116 push(@fixed, $rawline) if ($fix);
2117
Andy Whitcroft773647a2008-03-28 14:15:58 -07002118 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002119 $setup_docs = 0;
2120 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2121 $setup_docs = 1;
2122 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002123 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002124 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002125 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2126 $realline=$1-1;
2127 if (defined $2) {
2128 $realcnt=$3+1;
2129 } else {
2130 $realcnt=1+1;
2131 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002132 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002133
2134 # Guestimate if this is a continuing comment. Run
2135 # the context looking for a comment "edge". If this
2136 # edge is a close comment then we must be in a comment
2137 # at context start.
2138 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002139 my $cnt = $realcnt;
2140 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2141 next if (defined $rawlines[$ln - 1] &&
2142 $rawlines[$ln - 1] =~ /^-/);
2143 $cnt--;
2144 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002145 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002146 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2147 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2148 ($edge) = $1;
2149 last;
2150 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002151 }
2152 if (defined $edge && $edge eq '*/') {
2153 $in_comment = 1;
2154 }
2155
2156 # Guestimate if this is a continuing comment. If this
2157 # is the start of a diff block and this line starts
2158 # ' *' then it is very likely a comment.
2159 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002160 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002161 {
2162 $in_comment = 1;
2163 }
2164
2165 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2166 sanitise_line_reset($in_comment);
2167
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002168 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002169 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002170 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002171 $line = sanitise_line($rawline);
2172 }
2173 push(@lines, $line);
2174
2175 if ($realcnt > 1) {
2176 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2177 } else {
2178 $realcnt = 0;
2179 }
2180
2181 #print "==>$rawline\n";
2182 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002183
2184 if ($setup_docs && $line =~ /^\+/) {
2185 push(@setup_docs, $line);
2186 }
2187 }
2188
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002189 $prefix = '';
2190
Andy Whitcroft773647a2008-03-28 14:15:58 -07002191 $realcnt = 0;
2192 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002193 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002194 foreach my $line (@lines) {
2195 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002196 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002197 my $sline = $line; #copy of $line
2198 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002199
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002200 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002201
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002202#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002203 if (!$in_commit_log &&
2204 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002205 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002206 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002207 $realline=$1-1;
2208 if (defined $2) {
2209 $realcnt=$3+1;
2210 } else {
2211 $realcnt=1+1;
2212 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002213 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002214 $prev_values = 'E';
2215
Andy Whitcroft773647a2008-03-28 14:15:58 -07002216 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002217 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002218 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002219 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002220 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002221
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002222# track the line number as we move through the hunk, note that
2223# new versions of GNU diff omit the leading space on completely
2224# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002225 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002226 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002227 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002228
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002229 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002230 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002231
2232 # Track the previous line.
2233 ($prevline, $stashline) = ($stashline, $line);
2234 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002235 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2236
Andy Whitcroft773647a2008-03-28 14:15:58 -07002237 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002238
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002239 } elsif ($realcnt == 1) {
2240 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002241 }
2242
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002243 my $hunk_line = ($realcnt != 0);
2244
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002245 $here = "#$linenr: " if (!$file);
2246 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002247
Joe Perches2ac73b42014-06-04 16:12:05 -07002248 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002249 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002250 if ($line =~ /^diff --git.*?(\S+)$/) {
2251 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002252 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002253 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002254 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002255 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002256 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002257 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002258 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002259
2260 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002261 if (!$file && $tree && $p1_prefix ne '' &&
2262 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002263 WARN("PATCH_PREFIX",
2264 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002265 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002266
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002267 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002268 ERROR("MODIFIED_INCLUDE_ASM",
2269 "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 -07002270 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002271 $found_file = 1;
2272 }
2273
Joe Perches34d88152015-06-25 15:03:05 -07002274#make up the handle for any error we report on this line
2275 if ($showfile) {
2276 $prefix = "$realfile:$realline: "
2277 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002278 if ($file) {
2279 $prefix = "$filename:$realline: ";
2280 } else {
2281 $prefix = "$filename:$linenr: ";
2282 }
Joe Perches34d88152015-06-25 15:03:05 -07002283 }
2284
Joe Perches2ac73b42014-06-04 16:12:05 -07002285 if ($found_file) {
Joe Perches7bd7e482015-09-09 15:37:44 -07002286 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002287 $check = 1;
2288 } else {
2289 $check = $check_orig;
2290 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002291 next;
2292 }
2293
Randy Dunlap389834b2007-06-08 13:47:03 -07002294 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002295
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002296 my $hereline = "$here\n$rawline\n";
2297 my $herecurr = "$here\n$rawline\n";
2298 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002299
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002300 $cnt_lines++ if ($realcnt != 0);
2301
Joe Perchese518e9a2015-06-25 15:03:27 -07002302# Check if the commit log has what seems like a diff which can confuse patch
2303 if ($in_commit_log && !$commit_log_has_diff &&
2304 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2305 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2306 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2307 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2308 ERROR("DIFF_IN_COMMIT_MSG",
2309 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2310 $commit_log_has_diff = 1;
2311 }
2312
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002313# Check for incorrect file permissions
2314 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2315 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002316 if ($realfile !~ m@scripts/@ &&
2317 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002318 ERROR("EXECUTE_PERMISSIONS",
2319 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002320 }
2321 }
2322
Joe Perches20112472011-07-25 17:13:23 -07002323# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002324 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002325 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002326 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002327 }
2328
Joe Perchese0d975b2014-12-10 15:51:49 -08002329# Check if MAINTAINERS is being updated. If so, there's probably no need to
2330# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2331 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2332 $reported_maintainer_file = 1;
2333 }
2334
Joe Perches20112472011-07-25 17:13:23 -07002335# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002336 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002337 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002338 my $space_before = $1;
2339 my $sign_off = $2;
2340 my $space_after = $3;
2341 my $email = $4;
2342 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2343
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002344 if ($sign_off !~ /$signature_tags/) {
2345 WARN("BAD_SIGN_OFF",
2346 "Non-standard signature: $sign_off\n" . $herecurr);
2347 }
Joe Perches20112472011-07-25 17:13:23 -07002348 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002349 if (WARN("BAD_SIGN_OFF",
2350 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2351 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002352 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002353 "$ucfirst_sign_off $email";
2354 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002355 }
Joe Perches20112472011-07-25 17:13:23 -07002356 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002357 if (WARN("BAD_SIGN_OFF",
2358 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2359 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002360 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002361 "$ucfirst_sign_off $email";
2362 }
2363
Joe Perches20112472011-07-25 17:13:23 -07002364 }
2365 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002366 if (WARN("BAD_SIGN_OFF",
2367 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2368 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002369 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002370 "$ucfirst_sign_off $email";
2371 }
Joe Perches20112472011-07-25 17:13:23 -07002372 }
2373
2374 my ($email_name, $email_address, $comment) = parse_email($email);
2375 my $suggested_email = format_email(($email_name, $email_address));
2376 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002377 ERROR("BAD_SIGN_OFF",
2378 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002379 } else {
2380 my $dequoted = $suggested_email;
2381 $dequoted =~ s/^"//;
2382 $dequoted =~ s/" </ </;
2383 # Don't force email to have quotes
2384 # Allow just an angle bracketed address
2385 if ("$dequoted$comment" ne $email &&
2386 "<$email_address>$comment" ne $email &&
2387 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002388 WARN("BAD_SIGN_OFF",
2389 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002390 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002391 }
Joe Perches7e51f192013-09-11 14:23:57 -07002392
2393# Check for duplicate signatures
2394 my $sig_nospace = $line;
2395 $sig_nospace =~ s/\s//g;
2396 $sig_nospace = lc($sig_nospace);
2397 if (defined $signatures{$sig_nospace}) {
2398 WARN("BAD_SIGN_OFF",
2399 "Duplicate signature\n" . $herecurr);
2400 } else {
2401 $signatures{$sig_nospace} = 1;
2402 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002403 }
2404
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002405# Check email subject for common tools that don't need to be mentioned
2406 if ($in_header_lines &&
2407 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2408 WARN("EMAIL_SUBJECT",
2409 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2410 }
2411
Joe Perches9b3189e2014-06-04 16:12:10 -07002412# Check for old stable address
2413 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2414 ERROR("STABLE_ADDRESS",
2415 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2416 }
2417
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002418# Check for unwanted Gerrit info
2419 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2420 ERROR("GERRIT_CHANGE_ID",
2421 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2422 }
2423
Joe Perches369c8dd2015-11-06 16:31:34 -08002424# Check if the commit log is in a possible stack dump
2425 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2426 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2427 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2428 # timestamp
2429 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2430 # stack dump address
2431 $commit_log_possible_stack_dump = 1;
2432 }
2433
Joe Perches2a076f42015-04-16 12:44:28 -07002434# Check for line lengths > 75 in commit log, warn once
2435 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002436 length($line) > 75 &&
2437 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2438 # file delta changes
2439 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2440 # filename then :
2441 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2442 # A Fixes: or Link: line
2443 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002444 WARN("COMMIT_LOG_LONG_LINE",
2445 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2446 $commit_log_long_line = 1;
2447 }
2448
Joe Perchesbf4daf12015-09-09 15:37:50 -07002449# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002450 if ($in_commit_log && $commit_log_possible_stack_dump &&
2451 $line =~ /^\s*$/) {
2452 $commit_log_possible_stack_dump = 0;
2453 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002454
Joe Perches0d7835f2015-02-13 14:38:35 -08002455# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002456 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perches879be4f2016-06-03 14:55:49 -07002457 $line !~ /^\s*(?:Link|Patchwork|http|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002458 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perches369c8dd2015-11-06 16:31:34 -08002459 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2460 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2461 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002462 my $init_char = "c";
2463 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002464 my $short = 1;
2465 my $long = 0;
2466 my $case = 1;
2467 my $space = 1;
2468 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002469 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002470 my $id = '0123456789ab';
2471 my $orig_desc = "commit description";
2472 my $description = "";
2473
Joe Perchesfe043ea2015-09-09 15:37:25 -07002474 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2475 $init_char = $1;
2476 $orig_commit = lc($2);
2477 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2478 $orig_commit = lc($1);
2479 }
2480
Joe Perches0d7835f2015-02-13 14:38:35 -08002481 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2482 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2483 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2484 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2485 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2486 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002487 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002488 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2489 defined $rawlines[$linenr] &&
2490 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2491 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002492 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002493 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2494 defined $rawlines[$linenr] &&
2495 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2496 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2497 $orig_desc = $1;
2498 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2499 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002500 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002501 }
2502
2503 ($id, $description) = git_commit_info($orig_commit,
2504 $id, $orig_desc);
2505
Joe Perches19c146a2015-02-13 14:39:00 -08002506 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002507 ERROR("GIT_COMMIT_ID",
2508 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2509 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002510 }
2511
Joe Perches13f19372014-08-06 16:10:59 -07002512# Check for added, moved or deleted files
2513 if (!$reported_maintainer_file && !$in_commit_log &&
2514 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2515 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2516 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2517 (defined($1) || defined($2))))) {
2518 $reported_maintainer_file = 1;
2519 WARN("FILE_PATH_CHANGES",
2520 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2521 }
2522
Andy Whitcroft00df3442007-06-08 13:47:06 -07002523# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002524 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002525 ERROR("CORRUPTED_PATCH",
2526 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002527 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002528 }
2529
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002530# Check for absolute kernel paths.
2531 if ($tree) {
2532 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2533 my $file = $1;
2534
2535 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2536 check_absolute_file($1, $herecurr)) {
2537 #
2538 } else {
2539 check_absolute_file($file, $herecurr);
2540 }
2541 }
2542 }
2543
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002544# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2545 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002546 $rawline !~ m/^$UTF8*$/) {
2547 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2548
2549 my $blank = copy_spacing($rawline);
2550 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2551 my $hereptr = "$hereline$ptr\n";
2552
Joe Perches34d99212011-07-25 17:13:26 -07002553 CHK("INVALID_UTF8",
2554 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002555 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002556
Joe Perches15662b32011-10-31 17:13:12 -07002557# Check if it's the start of a commit log
2558# (not a header line and we haven't seen the patch filename)
2559 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002560 !($rawline =~ /^\s+\S/ ||
2561 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002562 $in_header_lines = 0;
2563 $in_commit_log = 1;
2564 }
2565
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002566# Check if there is UTF-8 in a commit log when a mail header has explicitly
2567# declined it, i.e defined some charset where it is missing.
2568 if ($in_header_lines &&
2569 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2570 $1 !~ /utf-8/i) {
2571 $non_utf8_charset = 1;
2572 }
2573
2574 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002575 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002576 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002577 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2578 }
2579
Kees Cook66b47b42014-10-13 15:51:57 -07002580# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002581 if (defined($misspellings) &&
2582 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002583 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002584 my $typo = $1;
2585 my $typo_fix = $spelling_fix{lc($typo)};
2586 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2587 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2588 my $msg_type = \&WARN;
2589 $msg_type = \&CHK if ($file);
2590 if (&{$msg_type}("TYPO_SPELLING",
2591 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2592 $fix) {
2593 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2594 }
2595 }
2596 }
2597
Andy Whitcroft306708542008-10-15 22:02:28 -07002598# ignore non-hunk lines and lines being removed
2599 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002600
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002601#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002602 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002603 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002604 if (ERROR("DOS_LINE_ENDINGS",
2605 "DOS line endings\n" . $herevet) &&
2606 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002607 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002608 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002609 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2610 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002611 if (ERROR("TRAILING_WHITESPACE",
2612 "trailing whitespace\n" . $herevet) &&
2613 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002614 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002615 }
2616
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002617 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002618 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002619
Josh Triplett4783f892013-11-12 15:10:12 -08002620# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002621 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002622 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2623 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002624 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2625 my $msg_type = \&ERROR;
2626 $msg_type = \&CHK if ($file);
2627 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002628 "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 -08002629 }
2630
Andi Kleen33549572010-05-24 14:33:29 -07002631# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002632# Only applies when adding the entry originally, after that we do not have
2633# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002634 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002635 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002636 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002637 my $cnt = $realcnt;
2638 my $ln = $linenr + 1;
2639 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002640 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002641 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002642 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002643 $f = $lines[$ln - 1];
2644 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2645 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002646
2647 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002648 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002649
Joe Perches8d73e0e2014-08-06 16:10:46 -07002650 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002651 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002652 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002653 $length = -1;
2654 }
2655
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002656 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002657 $f =~ s/#.*//;
2658 $f =~ s/^\s+//;
2659 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002660 if ($f =~ /^\s*config\s/) {
2661 $is_end = 1;
2662 last;
2663 }
Andi Kleen33549572010-05-24 14:33:29 -07002664 $length++;
2665 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002666 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2667 WARN("CONFIG_DESCRIPTION",
2668 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2669 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002670 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002671 }
2672
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002673# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2674 if ($realfile =~ /Kconfig/ &&
2675 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2676 WARN("CONFIG_EXPERIMENTAL",
2677 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2678 }
2679
Christoph Jaeger327953e2015-02-13 14:38:29 -08002680# discourage the use of boolean for type definition attributes of Kconfig options
2681 if ($realfile =~ /Kconfig/ &&
2682 $line =~ /^\+\s*\bboolean\b/) {
2683 WARN("CONFIG_TYPE_BOOLEAN",
2684 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2685 }
2686
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002687 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2688 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2689 my $flag = $1;
2690 my $replacement = {
2691 'EXTRA_AFLAGS' => 'asflags-y',
2692 'EXTRA_CFLAGS' => 'ccflags-y',
2693 'EXTRA_CPPFLAGS' => 'cppflags-y',
2694 'EXTRA_LDFLAGS' => 'ldflags-y',
2695 };
2696
2697 WARN("DEPRECATED_VARIABLE",
2698 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2699 }
2700
Rob Herringbff5da42014-01-23 15:54:51 -08002701# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002702 if (defined $root &&
2703 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2704 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2705
Rob Herringbff5da42014-01-23 15:54:51 -08002706 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2707
Florian Vaussardcc933192014-04-03 14:49:27 -07002708 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2709 my $vp_file = $dt_path . "vendor-prefixes.txt";
2710
Rob Herringbff5da42014-01-23 15:54:51 -08002711 foreach my $compat (@compats) {
2712 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002713 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2714 my $compat3 = $compat;
2715 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2716 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002717 if ( $? >> 8 ) {
2718 WARN("UNDOCUMENTED_DT_STRING",
2719 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2720 }
2721
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002722 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2723 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002724 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002725 if ( $? >> 8 ) {
2726 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002727 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002728 }
2729 }
2730 }
2731
Andy Whitcroft5368df22008-10-15 22:02:27 -07002732# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002733 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002734
Joe Perches47e0c882015-06-25 15:02:57 -07002735# line length limit (with some exclusions)
2736#
2737# There are a few types of lines that may extend beyond $max_line_length:
2738# logging functions like pr_info that end in a string
2739# lines with a single string
2740# #defines that are a single string
2741#
2742# There are 3 different line length message types:
2743# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2744# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2745# LONG_LINE all other lines longer than $max_line_length
2746#
2747# if LONG_LINE is ignored, the other 2 types are also ignored
2748#
2749
Joe Perchesb4749e92015-07-17 16:24:01 -07002750 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002751 my $msg_type = "LONG_LINE";
2752
2753 # Check the allowed long line types first
2754
2755 # logging functions that end in a string that starts
2756 # before $max_line_length
2757 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2758 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2759 $msg_type = "";
2760
2761 # lines with only strings (w/ possible termination)
2762 # #defines with only strings
2763 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2764 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2765 $msg_type = "";
2766
2767 # Otherwise set the alternate message types
2768
2769 # a comment starts before $max_line_length
2770 } elsif ($line =~ /($;[\s$;]*)$/ &&
2771 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2772 $msg_type = "LONG_LINE_COMMENT"
2773
2774 # a quoted string starts before $max_line_length
2775 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2776 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2777 $msg_type = "LONG_LINE_STRING"
2778 }
2779
2780 if ($msg_type ne "" &&
2781 (show_type("LONG_LINE") || show_type($msg_type))) {
2782 WARN($msg_type,
2783 "line over $max_line_length characters\n" . $herecurr);
2784 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002785 }
2786
Andy Whitcroft8905a672007-11-28 16:21:06 -08002787# check for adding lines without a newline.
2788 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002789 WARN("MISSING_EOF_NEWLINE",
2790 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002791 }
2792
Mike Frysinger42e41c52009-09-21 17:04:40 -07002793# Blackfin: use hi/lo macros
2794 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2795 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2796 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002797 ERROR("LO_MACRO",
2798 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002799 }
2800 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2801 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002802 ERROR("HI_MACRO",
2803 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002804 }
2805 }
2806
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002807# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002808 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002809
2810# at the beginning of a line any tabs must come first and anything
2811# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002812 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2813 $rawline =~ /^\+\s* \s*/) {
2814 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002815 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002816 if (ERROR("CODE_INDENT",
2817 "code indent should use tabs where possible\n" . $herevet) &&
2818 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002819 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002820 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002821 }
2822
Alberto Panizzo08e44362010-03-05 13:43:54 -08002823# check for space before tabs.
2824 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2825 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002826 if (WARN("SPACE_BEFORE_TAB",
2827 "please, no space before tabs\n" . $herevet) &&
2828 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002829 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002830 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002831 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002832 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002833 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002834 }
2835
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002836# check for && or || at the start of a line
2837 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2838 CHK("LOGICAL_CONTINUATIONS",
2839 "Logical continuations should be on the previous line\n" . $hereprev);
2840 }
2841
Joe Perchesa91e8992016-05-20 17:04:05 -07002842# check indentation starts on a tab stop
2843 if ($^V && $^V ge 5.10.0 &&
2844 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2845 my $indent = length($1);
2846 if ($indent % 8) {
2847 if (WARN("TABSTOP",
2848 "Statements should start on a tabstop\n" . $herecurr) &&
2849 $fix) {
2850 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2851 }
2852 }
2853 }
2854
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002855# check multi-line statement indentation matches previous line
2856 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002857 $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 -07002858 $prevline =~ /^\+(\t*)(.*)$/;
2859 my $oldindent = $1;
2860 my $rest = $2;
2861
2862 my $pos = pos_last_openparen($rest);
2863 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002864 $line =~ /^(\+| )([ \t]*)/;
2865 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002866
2867 my $goodtabindent = $oldindent .
2868 "\t" x ($pos / 8) .
2869 " " x ($pos % 8);
2870 my $goodspaceindent = $oldindent . " " x $pos;
2871
2872 if ($newindent ne $goodtabindent &&
2873 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002874
2875 if (CHK("PARENTHESIS_ALIGNMENT",
2876 "Alignment should match open parenthesis\n" . $hereprev) &&
2877 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002878 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002879 s/^\+[ \t]*/\+$goodtabindent/;
2880 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002881 }
2882 }
2883 }
2884
Joe Perches6ab3a972015-04-16 12:44:05 -07002885# check for space after cast like "(int) foo" or "(struct foo) bar"
2886# avoid checking a few false positives:
2887# "sizeof(<type>)" or "__alignof__(<type>)"
2888# function pointer declarations like "(*foo)(int) = bar;"
2889# structure definitions like "(struct foo) { 0 };"
2890# multiline macros that define functions
2891# known attributes or the __attribute__ keyword
2892 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2893 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002894 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002895 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002896 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002897 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002898 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002899 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002900 }
2901
Joe Perches86406b12015-09-09 15:37:41 -07002902# Block comment styles
2903# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002904 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002905 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002906 $rawline =~ /^\+[ \t]*\*/ &&
2907 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002908 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2909 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2910 }
2911
Joe Perches86406b12015-09-09 15:37:41 -07002912# Block comments use * on subsequent lines
2913 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2914 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002915 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002916 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002917 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002918 WARN("BLOCK_COMMENT_STYLE",
2919 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002920 }
2921
Joe Perches86406b12015-09-09 15:37:41 -07002922# Block comments use */ on trailing lines
2923 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002924 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2925 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2926 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002927 WARN("BLOCK_COMMENT_STYLE",
2928 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002929 }
2930
Joe Perches7f619192014-08-06 16:10:39 -07002931# check for missing blank lines after struct/union declarations
2932# with exceptions for various attributes and macros
2933 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2934 $line =~ /^\+/ &&
2935 !($line =~ /^\+\s*$/ ||
2936 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2937 $line =~ /^\+\s*MODULE_/i ||
2938 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2939 $line =~ /^\+[a-z_]*init/ ||
2940 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2941 $line =~ /^\+\s*DECLARE/ ||
2942 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002943 if (CHK("LINE_SPACING",
2944 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2945 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002946 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002947 }
Joe Perches7f619192014-08-06 16:10:39 -07002948 }
2949
Joe Perches365dd4e2014-08-06 16:10:42 -07002950# check for multiple consecutive blank lines
2951 if ($prevline =~ /^[\+ ]\s*$/ &&
2952 $line =~ /^\+\s*$/ &&
2953 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002954 if (CHK("LINE_SPACING",
2955 "Please don't use multiple blank lines\n" . $hereprev) &&
2956 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002957 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002958 }
2959
Joe Perches365dd4e2014-08-06 16:10:42 -07002960 $last_blank_line = $linenr;
2961 }
2962
Joe Perches3b617e32014-04-03 14:49:28 -07002963# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002964 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2965 # actual declarations
2966 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002967 # function pointer declarations
2968 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002969 # foo bar; where foo is some local typedef or #define
2970 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2971 # known declaration macros
2972 $prevline =~ /^\+\s+$declaration_macros/) &&
2973 # for "else if" which can look like "$Ident $Ident"
2974 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2975 # other possible extensions of declaration lines
2976 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2977 # not starting a section or a macro "\" extended line
2978 $prevline =~ /(?:\{\s*|\\)$/) &&
2979 # looks like a declaration
2980 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002981 # function pointer declarations
2982 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002983 # foo bar; where foo is some local typedef or #define
2984 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2985 # known declaration macros
2986 $sline =~ /^\+\s+$declaration_macros/ ||
2987 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002988 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002989 # start or end of block or continuation of declaration
2990 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2991 # bitfield continuation
2992 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2993 # other possible extensions of declaration lines
2994 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2995 # indentation of previous and current line are the same
2996 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002997 if (WARN("LINE_SPACING",
2998 "Missing a blank line after declarations\n" . $hereprev) &&
2999 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003000 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003001 }
Joe Perches3b617e32014-04-03 14:49:28 -07003002 }
3003
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003004# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003005# Exceptions:
3006# 1) within comments
3007# 2) indented preprocessor commands
3008# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003009 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003010 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003011 if (WARN("LEADING_SPACE",
3012 "please, no spaces at the start of a line\n" . $herevet) &&
3013 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003014 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003015 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003016 }
3017
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003018# check we are in a valid C source file if not then ignore this hunk
3019 next if ($realfile !~ /\.(h|c)$/);
3020
Joe Perches032a4c02014-08-06 16:10:29 -07003021# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003022# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003023# if the previous line is a break or return and is indented 1 tab more...
3024 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3025 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003026 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3027 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3028 defined $lines[$linenr] &&
3029 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003030 WARN("UNNECESSARY_ELSE",
3031 "else is not generally useful after a break or return\n" . $hereprev);
3032 }
3033 }
3034
Joe Perchesc00df192014-08-06 16:11:01 -07003035# check indentation of a line with a break;
3036# if the previous line is a goto or return and is indented the same # of tabs
3037 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3038 my $tabs = $1;
3039 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3040 WARN("UNNECESSARY_BREAK",
3041 "break is not useful after a goto or return\n" . $hereprev);
3042 }
3043 }
3044
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003045# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3046 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3047 WARN("CONFIG_EXPERIMENTAL",
3048 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3049 }
3050
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003051# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003052 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003053 WARN("CVS_KEYWORD",
3054 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003055 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003056
Mike Frysinger42e41c52009-09-21 17:04:40 -07003057# Blackfin: don't use __builtin_bfin_[cs]sync
3058 if ($line =~ /__builtin_bfin_csync/) {
3059 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003060 ERROR("CSYNC",
3061 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003062 }
3063 if ($line =~ /__builtin_bfin_ssync/) {
3064 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003065 ERROR("SSYNC",
3066 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003067 }
3068
Joe Perches56e77d72013-02-21 16:44:14 -08003069# check for old HOTPLUG __dev<foo> section markings
3070 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3071 WARN("HOTPLUG_SECTION",
3072 "Using $1 is unnecessary\n" . $herecurr);
3073 }
3074
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003075# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003076 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3077 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003078#print "LINE<$line>\n";
3079 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003080 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003081 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003082 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003083 $stat =~ s/\n./\n /g;
3084 $cond =~ s/\n./\n /g;
3085
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003086#print "linenr<$linenr> <$stat>\n";
3087 # If this statement has no statement boundaries within
3088 # it there is no point in retrying a statement scan
3089 # until we hit end of it.
3090 my $frag = $stat; $frag =~ s/;+\s*$//;
3091 if ($frag !~ /(?:{|;)/) {
3092#print "skip<$line_nr_next>\n";
3093 $suppress_statement = $line_nr_next;
3094 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003095
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003096 # Find the real next line.
3097 $realline_next = $line_nr_next;
3098 if (defined $realline_next &&
3099 (!defined $lines[$realline_next - 1] ||
3100 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3101 $realline_next++;
3102 }
3103
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003104 my $s = $stat;
3105 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003106
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003107 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003108 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003109
3110 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003111 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003112
Andy Whitcroft463f2862009-09-21 17:04:34 -07003113 } elsif ($s =~ /^.\s*else\b/s) {
3114
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003115 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003116 } 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 -07003117 my $type = $1;
3118 $type =~ s/\s+/ /g;
3119 possible($type, "A:" . $s);
3120
Andy Whitcroft8905a672007-11-28 16:21:06 -08003121 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003122 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003123 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003124 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003125
3126 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003127 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003128 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003129 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003130
3131 # Check for any sort of function declaration.
3132 # int foo(something bar, other baz);
3133 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003134 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 -08003135 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003136
Andy Whitcroftcf655042008-03-04 14:28:20 -08003137 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003138 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003139 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003140
Andy Whitcroft8905a672007-11-28 16:21:06 -08003141 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003142 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003143
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003144 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003145 }
3146 }
3147 }
3148
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003149 }
3150
Andy Whitcroft653d4872007-06-23 17:16:34 -07003151#
3152# Checks which may be anchored in the context.
3153#
3154
3155# Check for switch () and associated case and default
3156# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003157 if ($line=~/\bswitch\s*\(.*\)/) {
3158 my $err = '';
3159 my $sep = '';
3160 my @ctx = ctx_block_outer($linenr, $realcnt);
3161 shift(@ctx);
3162 for my $ctx (@ctx) {
3163 my ($clen, $cindent) = line_stats($ctx);
3164 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3165 $indent != $cindent) {
3166 $err .= "$sep$ctx\n";
3167 $sep = '';
3168 } else {
3169 $sep = "[...]\n";
3170 }
3171 }
3172 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003173 ERROR("SWITCH_CASE_INDENT_LEVEL",
3174 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003175 }
3176 }
3177
3178# if/while/etc brace do not go on next line, unless defining a do while loop,
3179# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003180 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 -07003181 my $pre_ctx = "$1$2";
3182
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003183 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003184
3185 if ($line =~ /^\+\t{6,}/) {
3186 WARN("DEEP_INDENTATION",
3187 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3188 }
3189
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003190 my $ctx_cnt = $realcnt - $#ctx - 1;
3191 my $ctx = join("\n", @ctx);
3192
Andy Whitcroft548596d2008-07-23 21:29:01 -07003193 my $ctx_ln = $linenr;
3194 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003195
Andy Whitcroft548596d2008-07-23 21:29:01 -07003196 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3197 defined $lines[$ctx_ln - 1] &&
3198 $lines[$ctx_ln - 1] =~ /^-/)) {
3199 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3200 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003201 $ctx_ln++;
3202 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003203
Andy Whitcroft53210162008-07-23 21:29:03 -07003204 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3205 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003206
Joe Perchesd752fcc2014-08-06 16:11:05 -07003207 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003208 ERROR("OPEN_BRACE",
3209 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003210 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003211 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003212 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3213 $ctx =~ /\)\s*\;\s*$/ &&
3214 defined $lines[$ctx_ln - 1])
3215 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003216 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3217 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003218 WARN("TRAILING_SEMICOLON",
3219 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003220 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003221 }
3222 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003223 }
3224
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003225# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003226 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 -08003227 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3228 ctx_statement_block($linenr, $realcnt, 0)
3229 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003230 my ($s, $c) = ($stat, $cond);
3231
3232 substr($s, 0, length($c), '');
3233
Joe Perches9f5af482015-09-09 15:37:30 -07003234 # remove inline comments
3235 $s =~ s/$;/ /g;
3236 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003237
3238 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003239 my @newlines = ($c =~ /\n/gs);
3240 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003241
Joe Perches9f5af482015-09-09 15:37:30 -07003242 # Make sure we remove the line prefixes as we have
3243 # none on the first line, and are going to readd them
3244 # where necessary.
3245 $s =~ s/\n./\n/gs;
3246 while ($s =~ /\n\s+\\\n/) {
3247 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3248 }
3249
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003250 # We want to check the first line inside the block
3251 # starting at the end of the conditional, so remove:
3252 # 1) any blank line termination
3253 # 2) any opening brace { on end of the line
3254 # 3) any do (...) {
3255 my $continuation = 0;
3256 my $check = 0;
3257 $s =~ s/^.*\bdo\b//;
3258 $s =~ s/^\s*{//;
3259 if ($s =~ s/^\s*\\//) {
3260 $continuation = 1;
3261 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003262 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003263 $check = 1;
3264 $cond_lines++;
3265 }
3266
3267 # Also ignore a loop construct at the end of a
3268 # preprocessor statement.
3269 if (($prevline =~ /^.\s*#\s*define\s/ ||
3270 $prevline =~ /\\\s*$/) && $continuation == 0) {
3271 $check = 0;
3272 }
3273
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003274 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003275 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003276 while ($cond_ptr != $cond_lines) {
3277 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003278
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003279 # If we see an #else/#elif then the code
3280 # is not linear.
3281 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3282 $check = 0;
3283 }
3284
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003285 # Ignore:
3286 # 1) blank lines, they should be at 0,
3287 # 2) preprocessor lines, and
3288 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003289 if ($continuation ||
3290 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003291 $s =~ /^\s*#\s*?/ ||
3292 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003293 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003294 if ($s =~ s/^.*?\n//) {
3295 $cond_lines++;
3296 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003297 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003298 }
3299
3300 my (undef, $sindent) = line_stats("+" . $s);
3301 my $stat_real = raw_line($linenr, $cond_lines);
3302
3303 # Check if either of these lines are modified, else
3304 # this is not this patch's fault.
3305 if (!defined($stat_real) ||
3306 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3307 $check = 0;
3308 }
3309 if (defined($stat_real) && $cond_lines > 1) {
3310 $stat_real = "[...]\n$stat_real";
3311 }
3312
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003313 #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 -07003314
Joe Perches9f5af482015-09-09 15:37:30 -07003315 if ($check && $s ne '' &&
3316 (($sindent % 8) != 0 ||
3317 ($sindent < $indent) ||
3318 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003319 WARN("SUSPECT_CODE_INDENT",
3320 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003321 }
3322 }
3323
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003324 # Track the 'values' across context and added lines.
3325 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003326 my ($curr_values, $curr_vars) =
3327 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003328 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003329 if ($dbg_values) {
3330 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003331 print "$linenr > .$outline\n";
3332 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003333 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003334 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003335 $prev_values = substr($curr_values, -1);
3336
Andy Whitcroft00df3442007-06-08 13:47:06 -07003337#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003338 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003339
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003340# check for declarations of signed or unsigned without int
Joe Perches207a8e82016-03-15 14:58:06 -07003341 while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003342 my $type = $1;
3343 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003344 $var = "" if (!defined $var);
3345 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003346 my $sign = $1;
3347 my $pointer = $2;
3348
3349 $pointer = "" if (!defined $pointer);
3350
3351 if (WARN("UNSPECIFIED_INT",
3352 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3353 $fix) {
3354 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003355 my $comp_pointer = $pointer;
3356 $comp_pointer =~ s/\s//g;
3357 $decl .= $comp_pointer;
3358 $decl = rtrim($decl) if ($var eq "");
3359 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003360 }
3361 }
3362 }
3363
Andy Whitcroft653d4872007-06-23 17:16:34 -07003364# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003365 if ($dbg_type) {
3366 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003367 ERROR("TEST_TYPE",
3368 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003369 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003370 ERROR("TEST_NOT_TYPE",
3371 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003372 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003373 next;
3374 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003375# TEST: allow direct testing of the attribute matcher.
3376 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003377 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003378 ERROR("TEST_ATTR",
3379 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003380 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003381 ERROR("TEST_NOT_ATTR",
3382 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003383 }
3384 next;
3385 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003386
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003387# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003388 if ($line =~ /^.\s*{/ &&
3389 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003390 if (ERROR("OPEN_BRACE",
3391 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003392 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3393 fix_delete_line($fixlinenr - 1, $prevrawline);
3394 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003395 my $fixedline = $prevrawline;
3396 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003397 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003398 $fixedline = $line;
3399 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003400 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003401 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003402 }
3403
Andy Whitcroft653d4872007-06-23 17:16:34 -07003404#
3405# Checks which are anchored on the added line.
3406#
3407
3408# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003409 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003410 my $path = $1;
3411 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003412 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003413 "malformed #include filename\n" . $herecurr);
3414 }
3415 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3416 ERROR("UAPI_INCLUDE",
3417 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003418 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003419 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003420
3421# no C99 // comments
3422 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003423 if (ERROR("C99_COMMENTS",
3424 "do not use C99 // comments\n" . $herecurr) &&
3425 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003426 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003427 if ($line =~ /\/\/(.*)$/) {
3428 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003429 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003430 }
3431 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003432 }
3433 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003434 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003435 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003436
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003437# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3438# the whole statement.
3439#print "APW <$lines[$realline_next - 1]>\n";
3440 if (defined $realline_next &&
3441 exists $lines[$realline_next - 1] &&
3442 !defined $suppress_export{$realline_next} &&
3443 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3444 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003445 # Handle definitions which produce identifiers with
3446 # a prefix:
3447 # XXX(foo);
3448 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003449 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003450 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003451 $name =~ /^${Ident}_$2/) {
3452#print "FOO C name<$name>\n";
3453 $suppress_export{$realline_next} = 1;
3454
3455 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003456 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003457 ^.DEFINE_$Ident\(\Q$name\E\)|
3458 ^.DECLARE_$Ident\(\Q$name\E\)|
3459 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003460 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3461 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003462 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003463#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3464 $suppress_export{$realline_next} = 2;
3465 } else {
3466 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003467 }
3468 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003469 if (!defined $suppress_export{$linenr} &&
3470 $prevline =~ /^.\s*$/ &&
3471 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3472 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3473#print "FOO B <$lines[$linenr - 1]>\n";
3474 $suppress_export{$linenr} = 2;
3475 }
3476 if (defined $suppress_export{$linenr} &&
3477 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003478 WARN("EXPORT_SYMBOL",
3479 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003480 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003481
Joe Eloff5150bda2010-08-09 17:21:00 -07003482# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003483 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003484 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003485 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003486 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003487 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003488 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003489 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003490# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003491 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003492 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003493 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003494 $herecurr) &&
3495 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003496 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003497 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003498 }
3499
Joe Perches18130872014-08-06 16:11:22 -07003500# check for misordered declarations of char/short/int/long with signed/unsigned
3501 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3502 my $tmp = trim($1);
3503 WARN("MISORDERED_TYPE",
3504 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3505 }
3506
Joe Perchescb710ec2010-10-26 14:23:20 -07003507# check for static const char * arrays.
3508 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003509 WARN("STATIC_CONST_CHAR_ARRAY",
3510 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003511 $herecurr);
3512 }
3513
3514# check for static char foo[] = "bar" declarations.
3515 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003516 WARN("STATIC_CONST_CHAR_ARRAY",
3517 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003518 $herecurr);
3519 }
3520
Joe Perchesab7e23f2015-04-16 12:44:22 -07003521# check for const <foo> const where <foo> is not a pointer or array type
3522 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3523 my $found = $1;
3524 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3525 WARN("CONST_CONST",
3526 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3527 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3528 WARN("CONST_CONST",
3529 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3530 }
3531 }
3532
Joe Perches9b0fa602014-04-03 14:49:18 -07003533# check for non-global char *foo[] = {"bar", ...} declarations.
3534 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3535 WARN("STATIC_CONST_CHAR_ARRAY",
3536 "char * array declaration might be better as static const\n" .
3537 $herecurr);
3538 }
3539
Joe Perchesb598b672015-04-16 12:44:36 -07003540# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3541 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3542 my $array = $1;
3543 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3544 my $array_div = $1;
3545 if (WARN("ARRAY_SIZE",
3546 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3547 $fix) {
3548 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3549 }
3550 }
3551 }
3552
Joe Perchesb36190c2014-01-27 17:07:18 -08003553# check for function declarations without arguments like "int foo()"
3554 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3555 if (ERROR("FUNCTION_WITHOUT_ARGS",
3556 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3557 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003558 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003559 }
3560 }
3561
Joe Perches92e112f2013-12-13 11:36:22 -07003562# check for uses of DEFINE_PCI_DEVICE_TABLE
3563 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3564 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3565 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3566 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003567 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
Joe Perches92e112f2013-12-13 11:36:22 -07003568 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003569 }
3570
Andy Whitcroft653d4872007-06-23 17:16:34 -07003571# check for new typedefs, only function parameters and sparse annotations
3572# make sense.
3573 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003574 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003575 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003576 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003577 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003578 WARN("NEW_TYPEDEFS",
3579 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003580 }
3581
3582# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003583 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003584 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3585 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003586 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003587
Andy Whitcroft65863862009-01-06 14:41:21 -08003588 # Should start with a space.
3589 $to =~ s/^(\S)/ $1/;
3590 # Should not end with a space.
3591 $to =~ s/\s+$//;
3592 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003593 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003594 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003595
Joe Perches3705ce52013-07-03 15:05:31 -07003596## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003597 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003598 if (ERROR("POINTER_LOCATION",
3599 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3600 $fix) {
3601 my $sub_from = $ident;
3602 my $sub_to = $ident;
3603 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003604 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003605 s@\Q$sub_from\E@$sub_to@;
3606 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003607 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003608 }
3609 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3610 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003611 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003612
Andy Whitcroft65863862009-01-06 14:41:21 -08003613 # Should start with a space.
3614 $to =~ s/^(\S)/ $1/;
3615 # Should not end with a space.
3616 $to =~ s/\s+$//;
3617 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003618 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003619 }
3620 # Modifiers should have spaces.
3621 $to =~ s/(\b$Modifier$)/$1 /;
3622
Joe Perches3705ce52013-07-03 15:05:31 -07003623## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003624 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003625 if (ERROR("POINTER_LOCATION",
3626 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3627 $fix) {
3628
3629 my $sub_from = $match;
3630 my $sub_to = $match;
3631 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003632 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003633 s@\Q$sub_from\E@$sub_to@;
3634 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003635 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003636 }
3637
Joe Perches9d3e3c72015-09-09 15:37:27 -07003638# avoid BUG() or BUG_ON()
3639 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3640 my $msg_type = \&WARN;
3641 $msg_type = \&CHK if ($file);
3642 &{$msg_type}("AVOID_BUG",
3643 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3644 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003645
Joe Perches9d3e3c72015-09-09 15:37:27 -07003646# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003647 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003648 WARN("LINUX_VERSION_CODE",
3649 "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 -08003650 }
3651
Joe Perches17441222011-06-15 15:08:17 -07003652# check for uses of printk_ratelimit
3653 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003654 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003655 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003656 }
3657
Andy Whitcroft00df3442007-06-08 13:47:06 -07003658# printk should use KERN_* levels. Note that follow on printk's on the
3659# same line do not need a level, so we use the current block context
3660# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003661# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003662# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003663 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003664 my $ok = 0;
3665 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3666 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003667 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003668 # with "\n" ignore it, else it is to blame
3669 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3670 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3671 $ok = 1;
3672 }
3673 last;
3674 }
3675 }
3676 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003677 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3678 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003679 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003680 }
3681
Joe Perches243f3802012-05-31 16:26:09 -07003682 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3683 my $orig = $1;
3684 my $level = lc($orig);
3685 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003686 my $level2 = $level;
3687 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003688 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003689 "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 -07003690 }
3691
3692 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003693 if (WARN("PREFER_PR_LEVEL",
3694 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3695 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003696 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003697 s/\bpr_warning\b/pr_warn/;
3698 }
Joe Perches243f3802012-05-31 16:26:09 -07003699 }
3700
Joe Perchesdc139312013-02-21 16:44:13 -08003701 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3702 my $orig = $1;
3703 my $level = lc($orig);
3704 $level = "warn" if ($level eq "warning");
3705 $level = "dbg" if ($level eq "debug");
3706 WARN("PREFER_DEV_LEVEL",
3707 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3708 }
3709
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003710# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3711# number of false positives, but assembly files are not checked, so at
3712# least the arch entry code will not trigger this warning.
3713 if ($line =~ /\bENOSYS\b/) {
3714 WARN("ENOSYS",
3715 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3716 }
3717
Andy Whitcroft653d4872007-06-23 17:16:34 -07003718# function brace can't be on same line, except for #defines of do while,
3719# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003720 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003721 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003722 if (ERROR("OPEN_BRACE",
3723 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3724 $fix) {
3725 fix_delete_line($fixlinenr, $rawline);
3726 my $fixed_line = $rawline;
3727 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3728 my $line1 = $1;
3729 my $line2 = $2;
3730 fix_insert_line($fixlinenr, ltrim($line1));
3731 fix_insert_line($fixlinenr, "\+{");
3732 if ($line2 !~ /^\s*$/) {
3733 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3734 }
3735 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003736 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003737
Andy Whitcroft8905a672007-11-28 16:21:06 -08003738# open braces for enum, union and struct go on the same line.
3739 if ($line =~ /^.\s*{/ &&
3740 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003741 if (ERROR("OPEN_BRACE",
3742 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3743 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3744 fix_delete_line($fixlinenr - 1, $prevrawline);
3745 fix_delete_line($fixlinenr, $rawline);
3746 my $fixedline = rtrim($prevrawline) . " {";
3747 fix_insert_line($fixlinenr, $fixedline);
3748 $fixedline = $rawline;
3749 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3750 if ($fixedline !~ /^\+\s*$/) {
3751 fix_insert_line($fixlinenr, $fixedline);
3752 }
3753 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003754 }
3755
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003756# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003757 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3758 if (WARN("SPACING",
3759 "missing space after $1 definition\n" . $herecurr) &&
3760 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003761 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003762 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3763 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003764 }
3765
Joe Perches31070b52014-01-23 15:54:49 -08003766# Function pointer declarations
3767# check spacing between type, funcptr, and args
3768# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003769 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003770 my $declare = $1;
3771 my $pre_pointer_space = $2;
3772 my $post_pointer_space = $3;
3773 my $funcname = $4;
3774 my $post_funcname_space = $5;
3775 my $pre_args_space = $6;
3776
Joe Perches91f72e92014-04-03 14:49:12 -07003777# the $Declare variable will capture all spaces after the type
3778# so check it for a missing trailing missing space but pointer return types
3779# don't need a space so don't warn for those.
3780 my $post_declare_space = "";
3781 if ($declare =~ /(\s+)$/) {
3782 $post_declare_space = $1;
3783 $declare = rtrim($declare);
3784 }
3785 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003786 WARN("SPACING",
3787 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003788 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003789 }
3790
3791# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003792# This test is not currently implemented because these declarations are
3793# equivalent to
3794# int foo(int bar, ...)
3795# and this is form shouldn't/doesn't generate a checkpatch warning.
3796#
3797# elsif ($declare =~ /\s{2,}$/) {
3798# WARN("SPACING",
3799# "Multiple spaces after return type\n" . $herecurr);
3800# }
Joe Perches31070b52014-01-23 15:54:49 -08003801
3802# unnecessary space "type ( *funcptr)(args...)"
3803 if (defined $pre_pointer_space &&
3804 $pre_pointer_space =~ /^\s/) {
3805 WARN("SPACING",
3806 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3807 }
3808
3809# unnecessary space "type (* funcptr)(args...)"
3810 if (defined $post_pointer_space &&
3811 $post_pointer_space =~ /^\s/) {
3812 WARN("SPACING",
3813 "Unnecessary space before function pointer name\n" . $herecurr);
3814 }
3815
3816# unnecessary space "type (*funcptr )(args...)"
3817 if (defined $post_funcname_space &&
3818 $post_funcname_space =~ /^\s/) {
3819 WARN("SPACING",
3820 "Unnecessary space after function pointer name\n" . $herecurr);
3821 }
3822
3823# unnecessary space "type (*funcptr) (args...)"
3824 if (defined $pre_args_space &&
3825 $pre_args_space =~ /^\s/) {
3826 WARN("SPACING",
3827 "Unnecessary space before function pointer arguments\n" . $herecurr);
3828 }
3829
3830 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003831 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003832 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003833 }
3834 }
3835
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003836# check for spacing round square brackets; allowed:
3837# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003838# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3839# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003840 while ($line =~ /(.*?\s)\[/g) {
3841 my ($where, $prefix) = ($-[1], $1);
3842 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003843 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003844 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003845 if (ERROR("BRACKET_SPACE",
3846 "space prohibited before open square bracket '['\n" . $herecurr) &&
3847 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003848 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003849 s/^(\+.*?)\s+\[/$1\[/;
3850 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003851 }
3852 }
3853
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003854# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003855 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003856 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003857 my $ctx_before = substr($line, 0, $-[1]);
3858 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003859
3860 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003861 if ($name =~ /^(?:
3862 if|for|while|switch|return|case|
3863 volatile|__volatile__|
3864 __attribute__|format|__extension__|
3865 asm|__asm__)$/x)
3866 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003867 # cpp #define statements have non-optional spaces, ie
3868 # if there is a space between the name and the open
3869 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003870 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003871
3872 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003873 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003874
3875 # If this whole things ends with a type its most
3876 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003877 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003878
3879 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003880 if (WARN("SPACING",
3881 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3882 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003883 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003884 s/\b$name\s+\(/$name\(/;
3885 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003886 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003887 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003888
Andy Whitcroft653d4872007-06-23 17:16:34 -07003889# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003890 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003891 my $fixed_line = "";
3892 my $line_fixed = 0;
3893
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003894 my $ops = qr{
3895 <<=|>>=|<=|>=|==|!=|
3896 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3897 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003898 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003899 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003900 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003901 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003902
3903## print("element count: <" . $#elements . ">\n");
3904## foreach my $el (@elements) {
3905## print("el: <$el>\n");
3906## }
3907
3908 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003909 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003910
Joe Perches3705ce52013-07-03 15:05:31 -07003911 foreach my $el (@elements) {
3912 push(@fix_elements, substr($rawline, $off, length($el)));
3913 $off += length($el);
3914 }
3915
3916 $off = 0;
3917
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003918 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003919 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003920
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003921 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003922
3923 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3924
3925## print("n: <$n> good: <$good>\n");
3926
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003927 $off += length($elements[$n]);
3928
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003929 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003930 my $ca = substr($opline, 0, $off);
3931 my $cc = '';
3932 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3933 $cc = substr($opline, $off + length($elements[$n + 1]));
3934 }
3935 my $cb = "$ca$;$cc";
3936
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003937 my $a = '';
3938 $a = 'V' if ($elements[$n] ne '');
3939 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003940 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003941 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3942 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003943 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003944
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003945 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003946
3947 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003948 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003949 $c = 'V' if ($elements[$n + 2] ne '');
3950 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003951 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003952 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3953 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003954 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003955 } else {
3956 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003957 }
3958
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003959 my $ctx = "${a}x${c}";
3960
3961 my $at = "(ctx:$ctx)";
3962
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003963 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003964 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003965
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003966 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003967 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003968
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003969 # Get the full operator variant.
3970 my $opv = $op . substr($curr_vars, $off, 1);
3971
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003972 # Ignore operators passed as parameters.
3973 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003974 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003975
Andy Whitcroftcf655042008-03-04 14:28:20 -08003976# # Ignore comments
3977# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003978
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003979 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003980 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003981 if ($ctx !~ /.x[WEBC]/ &&
3982 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003983 if (ERROR("SPACING",
3984 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003985 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003986 $line_fixed = 1;
3987 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003988 }
3989
3990 # // is a comment
3991 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003992
Joe Perchesb00e4812014-04-03 14:49:33 -07003993 # : when part of a bitfield
3994 } elsif ($opv eq ':B') {
3995 # skip the bitfield test for now
3996
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003997 # No spaces for:
3998 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003999 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004000 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004001 if (ERROR("SPACING",
4002 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004003 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004004 if (defined $fix_elements[$n + 2]) {
4005 $fix_elements[$n + 2] =~ s/^\s+//;
4006 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004007 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004008 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004009 }
4010
Joe Perches23810972014-12-10 15:51:32 -08004011 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004012 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004013 my $rtrim_before = 0;
4014 my $space_after = 0;
4015 if ($ctx =~ /Wx./) {
4016 if (ERROR("SPACING",
4017 "space prohibited before that '$op' $at\n" . $hereptr)) {
4018 $line_fixed = 1;
4019 $rtrim_before = 1;
4020 }
4021 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004022 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004023 if (ERROR("SPACING",
4024 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004025 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004026 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004027 $space_after = 1;
4028 }
4029 }
4030 if ($rtrim_before || $space_after) {
4031 if ($rtrim_before) {
4032 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4033 } else {
4034 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4035 }
4036 if ($space_after) {
4037 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004038 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004039 }
4040
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004041 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004042 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004043 #warn "'*' is part of type\n";
4044
4045 # unary operators should have a space before and
4046 # none after. May be left adjacent to another
4047 # unary operator, or a cast
4048 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004049 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004050 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004051 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004052 if (ERROR("SPACING",
4053 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004054 if ($n != $last_after + 2) {
4055 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4056 $line_fixed = 1;
4057 }
Joe Perches3705ce52013-07-03 15:05:31 -07004058 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004059 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004060 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004061 # A unary '*' may be const
4062
4063 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004064 if (ERROR("SPACING",
4065 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004066 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004067 if (defined $fix_elements[$n + 2]) {
4068 $fix_elements[$n + 2] =~ s/^\s+//;
4069 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004070 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004071 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004072 }
4073
4074 # unary ++ and unary -- are allowed no space on one side.
4075 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004076 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004077 if (ERROR("SPACING",
4078 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004079 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004080 $line_fixed = 1;
4081 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004082 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004083 if ($ctx =~ /Wx[BE]/ ||
4084 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004085 if (ERROR("SPACING",
4086 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004087 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004088 $line_fixed = 1;
4089 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004090 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004091 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004092 if (ERROR("SPACING",
4093 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004094 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004095 if (defined $fix_elements[$n + 2]) {
4096 $fix_elements[$n + 2] =~ s/^\s+//;
4097 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004098 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004099 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004100 }
4101
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004102 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004103 } elsif ($op eq '<<' or $op eq '>>' or
4104 $op eq '&' or $op eq '^' or $op eq '|' or
4105 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004106 $op eq '*' or $op eq '/' or
4107 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004108 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004109 if ($check) {
4110 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4111 if (CHK("SPACING",
4112 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4113 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4114 $fix_elements[$n + 2] =~ s/^\s+//;
4115 $line_fixed = 1;
4116 }
4117 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4118 if (CHK("SPACING",
4119 "space preferred before that '$op' $at\n" . $hereptr)) {
4120 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4121 $line_fixed = 1;
4122 }
4123 }
4124 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004125 if (ERROR("SPACING",
4126 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004127 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4128 if (defined $fix_elements[$n + 2]) {
4129 $fix_elements[$n + 2] =~ s/^\s+//;
4130 }
Joe Perches3705ce52013-07-03 15:05:31 -07004131 $line_fixed = 1;
4132 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004133 }
4134
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004135 # A colon needs no spaces before when it is
4136 # terminating a case value or a label.
4137 } elsif ($opv eq ':C' || $opv eq ':L') {
4138 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004139 if (ERROR("SPACING",
4140 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004141 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004142 $line_fixed = 1;
4143 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004144 }
4145
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004146 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004147 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004148 my $ok = 0;
4149
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004150 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004151 if (($op eq '<' &&
4152 $cc =~ /^\S+\@\S+>/) ||
4153 ($op eq '>' &&
4154 $ca =~ /<\S+\@\S+$/))
4155 {
4156 $ok = 1;
4157 }
4158
Joe Perchese0df7e12015-04-16 12:44:53 -07004159 # for asm volatile statements
4160 # ignore a colon with another
4161 # colon immediately before or after
4162 if (($op eq ':') &&
4163 ($ca =~ /:$/ || $cc =~ /^:/)) {
4164 $ok = 1;
4165 }
4166
Joe Perches84731622013-11-12 15:10:05 -08004167 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004168 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004169 my $msg_type = \&ERROR;
4170 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4171
4172 if (&{$msg_type}("SPACING",
4173 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004174 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4175 if (defined $fix_elements[$n + 2]) {
4176 $fix_elements[$n + 2] =~ s/^\s+//;
4177 }
Joe Perches3705ce52013-07-03 15:05:31 -07004178 $line_fixed = 1;
4179 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004180 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004181 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004182 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004183
4184## print("n: <$n> GOOD: <$good>\n");
4185
4186 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004187 }
Joe Perches3705ce52013-07-03 15:05:31 -07004188
4189 if (($#elements % 2) == 0) {
4190 $fixed_line = $fixed_line . $fix_elements[$#elements];
4191 }
4192
Joe Perches194f66f2014-08-06 16:11:03 -07004193 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4194 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004195 }
4196
4197
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004198 }
4199
Joe Perches786b6322013-07-03 15:05:32 -07004200# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004201 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004202 if (WARN("SPACING",
4203 "space prohibited before semicolon\n" . $herecurr) &&
4204 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004205 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004206 s/^(\+.*\S)\s+;/$1;/;
4207 }
4208 }
4209
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004210# check for multiple assignments
4211 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004212 CHK("MULTIPLE_ASSIGNMENTS",
4213 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004214 }
4215
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004216## # check for multiple declarations, allowing for a function declaration
4217## # continuation.
4218## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4219## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4220##
4221## # Remove any bracketed sections to ensure we do not
4222## # falsly report the parameters of functions.
4223## my $ln = $line;
4224## while ($ln =~ s/\([^\(\)]*\)//g) {
4225## }
4226## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004227## WARN("MULTIPLE_DECLARATION",
4228## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004229## }
4230## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004231
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004232#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004233 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004234 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004235 if (ERROR("SPACING",
4236 "space required before the open brace '{'\n" . $herecurr) &&
4237 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004238 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004239 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004240 }
4241
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004242## # check for blank lines before declarations
4243## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4244## $prevrawline =~ /^.\s*$/) {
4245## WARN("SPACING",
4246## "No blank lines before declarations\n" . $hereprev);
4247## }
4248##
4249
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004250# closing brace should have a space following it when it has anything
4251# on the line
4252 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004253 if (ERROR("SPACING",
4254 "space required after that close brace '}'\n" . $herecurr) &&
4255 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004256 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004257 s/}((?!(?:,|;|\)))\S)/} $1/;
4258 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004259 }
4260
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004261# check spacing on square brackets
4262 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004263 if (ERROR("SPACING",
4264 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4265 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004266 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004267 s/\[\s+/\[/;
4268 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004269 }
4270 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004271 if (ERROR("SPACING",
4272 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4273 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004274 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004275 s/\s+\]/\]/;
4276 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004277 }
4278
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004279# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004280 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4281 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004282 if (ERROR("SPACING",
4283 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4284 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004285 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004286 s/\(\s+/\(/;
4287 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004288 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004289 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004290 $line !~ /for\s*\(.*;\s+\)/ &&
4291 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004292 if (ERROR("SPACING",
4293 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4294 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004295 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004296 s/\s+\)/\)/;
4297 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004298 }
4299
Joe Perchese2826fd2014-08-06 16:10:48 -07004300# check unnecessary parentheses around addressof/dereference single $Lvals
4301# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4302
4303 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004304 my $var = $1;
4305 if (CHK("UNNECESSARY_PARENTHESES",
4306 "Unnecessary parentheses around $var\n" . $herecurr) &&
4307 $fix) {
4308 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4309 }
4310 }
4311
4312# check for unnecessary parentheses around function pointer uses
4313# ie: (foo->bar)(); should be foo->bar();
4314# but not "if (foo->bar) (" to avoid some false positives
4315 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4316 my $var = $2;
4317 if (CHK("UNNECESSARY_PARENTHESES",
4318 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4319 $fix) {
4320 my $var2 = deparenthesize($var);
4321 $var2 =~ s/\s//g;
4322 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4323 }
4324 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004325
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004326#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004327 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004328 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004329 if (WARN("INDENTED_LABEL",
4330 "labels should not be indented\n" . $herecurr) &&
4331 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004332 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004333 s/^(.)\s+/$1/;
4334 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004335 }
4336
Joe Perches5b9553a2014-04-03 14:49:21 -07004337# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004338 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004339 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004340 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004341 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4342 my $value = $1;
4343 $value = deparenthesize($value);
4344 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4345 ERROR("RETURN_PARENTHESES",
4346 "return is not a function, parentheses are not required\n" . $herecurr);
4347 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004348 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004349 ERROR("SPACING",
4350 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004351 }
4352 }
Joe Perches507e5142013-11-12 15:10:13 -08004353
Joe Perchesb43ae212014-06-23 13:22:07 -07004354# unnecessary return in a void function
4355# at end-of-function, with the previous line a single leading tab, then return;
4356# and the line before that not a goto label target like "out:"
4357 if ($sline =~ /^[ \+]}\s*$/ &&
4358 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4359 $linenr >= 3 &&
4360 $lines[$linenr - 3] =~ /^[ +]/ &&
4361 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004362 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004363 "void function return statements are not generally useful\n" . $hereprev);
4364 }
Joe Perches9819cf22014-06-04 16:12:09 -07004365
Joe Perches189248d2014-01-23 15:54:47 -08004366# if statements using unnecessary parentheses - ie: if ((foo == bar))
4367 if ($^V && $^V ge 5.10.0 &&
4368 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4369 my $openparens = $1;
4370 my $count = $openparens =~ tr@\(@\(@;
4371 my $msg = "";
4372 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4373 my $comp = $4; #Not $1 because of $LvalOrFunc
4374 $msg = " - maybe == should be = ?" if ($comp eq "==");
4375 WARN("UNNECESSARY_PARENTHESES",
4376 "Unnecessary parentheses$msg\n" . $herecurr);
4377 }
4378 }
4379
Joe Perchesc5595fa2015-09-09 15:37:58 -07004380# comparisons with a constant or upper case identifier on the left
4381# avoid cases like "foo + BAR < baz"
4382# only fix matches surrounded by parentheses to avoid incorrect
4383# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4384 if ($^V && $^V ge 5.10.0 &&
4385 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4386 my $lead = $1;
4387 my $const = $2;
4388 my $comp = $3;
4389 my $to = $4;
4390 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004391 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004392 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4393 WARN("CONSTANT_COMPARISON",
4394 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4395 $fix) {
4396 if ($comp eq "<") {
4397 $newcomp = ">";
4398 } elsif ($comp eq "<=") {
4399 $newcomp = ">=";
4400 } elsif ($comp eq ">") {
4401 $newcomp = "<";
4402 } elsif ($comp eq ">=") {
4403 $newcomp = "<=";
4404 }
4405 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4406 }
4407 }
4408
Joe Perchesf34e4a42015-04-16 12:44:19 -07004409# Return of what appears to be an errno should normally be negative
4410 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004411 my $name = $1;
4412 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004413 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004414 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004415 }
4416 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004417
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004418# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004419 if ($line =~ /\b(if|while|for|switch)\(/) {
4420 if (ERROR("SPACING",
4421 "space required before the open parenthesis '('\n" . $herecurr) &&
4422 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004423 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004424 s/\b(if|while|for|switch)\(/$1 \(/;
4425 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004426 }
4427
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004428# Check for illegal assignment in if conditional -- and check for trailing
4429# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004430 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004431 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4432 ctx_statement_block($linenr, $realcnt, 0)
4433 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004434 my ($stat_next) = ctx_statement_block($line_nr_next,
4435 $remain_next, $off_next);
4436 $stat_next =~ s/\n./\n /g;
4437 ##print "stat<$stat> stat_next<$stat_next>\n";
4438
4439 if ($stat_next =~ /^\s*while\b/) {
4440 # If the statement carries leading newlines,
4441 # then count those as offsets.
4442 my ($whitespace) =
4443 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4444 my $offset =
4445 statement_rawlines($whitespace) - 1;
4446
4447 $suppress_whiletrailers{$line_nr_next +
4448 $offset} = 1;
4449 }
4450 }
4451 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004452 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004453 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004454 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004455
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004456 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004457 ERROR("ASSIGN_IN_IF",
4458 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004459 }
4460
4461 # Find out what is on the end of the line after the
4462 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004463 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004464 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004465 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004466 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4467 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004468 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004469 # Find out how long the conditional actually is.
4470 my @newlines = ($c =~ /\n/gs);
4471 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004472 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004473
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004474 $stat_real = raw_line($linenr, $cond_lines)
4475 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004476 if (defined($stat_real) && $cond_lines > 1) {
4477 $stat_real = "[...]\n$stat_real";
4478 }
4479
Joe Perches000d1cc12011-07-25 17:13:25 -07004480 ERROR("TRAILING_STATEMENTS",
4481 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004482 }
4483 }
4484
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004485# Check for bitwise tests written as boolean
4486 if ($line =~ /
4487 (?:
4488 (?:\[|\(|\&\&|\|\|)
4489 \s*0[xX][0-9]+\s*
4490 (?:\&\&|\|\|)
4491 |
4492 (?:\&\&|\|\|)
4493 \s*0[xX][0-9]+\s*
4494 (?:\&\&|\|\||\)|\])
4495 )/x)
4496 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004497 WARN("HEXADECIMAL_BOOLEAN_TEST",
4498 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004499 }
4500
Andy Whitcroft8905a672007-11-28 16:21:06 -08004501# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004502 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4503 my $s = $1;
4504 $s =~ s/$;//g; # Remove any comments
4505 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004506 ERROR("TRAILING_STATEMENTS",
4507 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004508 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004509 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004510# if should not continue a brace
4511 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004512 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004513 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004514 $herecurr);
4515 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004516# case and default should not have general statements after them
4517 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4518 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004519 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004520 \s*return\s+
4521 )/xg)
4522 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004523 ERROR("TRAILING_STATEMENTS",
4524 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004525 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004526
4527 # Check for }<nl>else {, these must be at the same
4528 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004529 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4530 $previndent == $indent) {
4531 if (ERROR("ELSE_AFTER_BRACE",
4532 "else should follow close brace '}'\n" . $hereprev) &&
4533 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4534 fix_delete_line($fixlinenr - 1, $prevrawline);
4535 fix_delete_line($fixlinenr, $rawline);
4536 my $fixedline = $prevrawline;
4537 $fixedline =~ s/}\s*$//;
4538 if ($fixedline !~ /^\+\s*$/) {
4539 fix_insert_line($fixlinenr, $fixedline);
4540 }
4541 $fixedline = $rawline;
4542 $fixedline =~ s/^(.\s*)else/$1} else/;
4543 fix_insert_line($fixlinenr, $fixedline);
4544 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004545 }
4546
Joe Perches8b8856f2014-08-06 16:11:14 -07004547 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4548 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004549 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4550
4551 # Find out what is on the end of the line after the
4552 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004553 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004554 $s =~ s/\n.*//g;
4555
4556 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004557 if (ERROR("WHILE_AFTER_BRACE",
4558 "while should follow close brace '}'\n" . $hereprev) &&
4559 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4560 fix_delete_line($fixlinenr - 1, $prevrawline);
4561 fix_delete_line($fixlinenr, $rawline);
4562 my $fixedline = $prevrawline;
4563 my $trailing = $rawline;
4564 $trailing =~ s/^\+//;
4565 $trailing = trim($trailing);
4566 $fixedline =~ s/}\s*$/} $trailing/;
4567 fix_insert_line($fixlinenr, $fixedline);
4568 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004569 }
4570 }
4571
Joe Perches95e2c602013-07-03 15:05:20 -07004572#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004573 while ($line =~ m{($Constant|$Lval)}g) {
4574 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004575
4576#gcc binary extension
4577 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004578 if (WARN("GCC_BINARY_CONSTANT",
4579 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4580 $fix) {
4581 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004582 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004583 s/\b$var\b/$hexval/;
4584 }
Joe Perches95e2c602013-07-03 15:05:20 -07004585 }
4586
4587#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004588 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004589 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004590#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004591 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004592#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004593 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4594#Ignore some three character SI units explicitly, like MiB and KHz
4595 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004596 while ($var =~ m{($Ident)}g) {
4597 my $word = $1;
4598 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004599 if ($check) {
4600 seed_camelcase_includes();
4601 if (!$file && !$camelcase_file_seeded) {
4602 seed_camelcase_file($realfile);
4603 $camelcase_file_seeded = 1;
4604 }
4605 }
Joe Perches7e781f62013-09-11 14:23:55 -07004606 if (!defined $camelcase{$word}) {
4607 $camelcase{$word} = 1;
4608 CHK("CAMELCASE",
4609 "Avoid CamelCase: <$word>\n" . $herecurr);
4610 }
Joe Perches34456862013-07-03 15:05:34 -07004611 }
Joe Perches323c1262012-12-17 16:02:07 -08004612 }
4613 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004614
4615#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004616 if ($line =~ /\#\s*define.*\\\s+$/) {
4617 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4618 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4619 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004620 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004621 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004622 }
4623
Fabian Frederick0e212e02015-04-16 12:44:25 -07004624# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4625# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004626 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004627 my $file = "$1.h";
4628 my $checkfile = "include/linux/$file";
4629 if (-f "$root/$checkfile" &&
4630 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004631 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004632 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004633 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4634 if ($asminclude > 0) {
4635 if ($realfile =~ m{^arch/}) {
4636 CHK("ARCH_INCLUDE_LINUX",
4637 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4638 } else {
4639 WARN("INCLUDE_LINUX",
4640 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4641 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004642 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004643 }
4644 }
4645
Andy Whitcroft653d4872007-06-23 17:16:34 -07004646# multi-statement macros should be enclosed in a do while loop, grab the
4647# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004648# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004649 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4650 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004651 my $ln = $linenr;
4652 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004653 my ($off, $dstat, $dcond, $rest);
4654 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004655 my $has_flow_statement = 0;
4656 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004657 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004658 ctx_statement_block($linenr, $realcnt, 0);
4659 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004660 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004661 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004662
Joe Perches08a28432014-10-13 15:51:55 -07004663 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004664 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004665
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004666 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004667 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004668 $dstat =~ s/\\\n.//g;
4669 $dstat =~ s/^\s*//s;
4670 $dstat =~ s/\s*$//s;
4671
4672 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004673 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4674 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004675 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004676 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004677 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004678
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004679 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004680 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4681 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004682 {
4683 }
4684
Joe Perches42e15292016-03-15 14:58:01 -07004685 # Make asm volatile uses seem like a generic function
4686 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4687
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004688 my $exceptions = qr{
4689 $Declare|
4690 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004691 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004692 DECLARE_PER_CPU|
4693 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004694 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004695 union|
4696 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004697 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004698 ^\"|\"$|
4699 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004700 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004701 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004702 if ($dstat ne '' &&
4703 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4704 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004705 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004706 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004707 $dstat !~ /$exceptions/ &&
4708 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004709 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004710 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004711 $dstat !~ /^for\s*$Constant$/ && # for (...)
4712 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4713 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004714 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004715 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004716 {
4717 $ctx =~ s/\n*$//;
4718 my $herectx = $here . "\n";
4719 my $cnt = statement_rawlines($ctx);
4720
4721 for (my $n = 0; $n < $cnt; $n++) {
4722 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004723 }
4724
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004725 if ($dstat =~ /;/) {
4726 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4727 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4728 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004729 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004730 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004731 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004732 }
Joe Perches5023d342012-12-17 16:01:47 -08004733
Joe Perches08a28432014-10-13 15:51:55 -07004734# check for macros with flow control, but without ## concatenation
4735# ## concatenation is commonly a macro that defines a function so ignore those
4736 if ($has_flow_statement && !$has_arg_concat) {
4737 my $herectx = $here . "\n";
4738 my $cnt = statement_rawlines($ctx);
4739
4740 for (my $n = 0; $n < $cnt; $n++) {
4741 $herectx .= raw_line($linenr, $n) . "\n";
4742 }
4743 WARN("MACRO_WITH_FLOW_CONTROL",
4744 "Macros with flow control statements should be avoided\n" . "$herectx");
4745 }
4746
Joe Perches481eb482012-12-17 16:01:56 -08004747# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004748
4749 } else {
4750 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004751 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4752 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004753 $line =~ /^\+.*\\$/) {
4754 WARN("LINE_CONTINUATIONS",
4755 "Avoid unnecessary line continuations\n" . $herecurr);
4756 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004757 }
4758
Joe Perchesb13edf72012-07-30 14:41:24 -07004759# do {} while (0) macro tests:
4760# single-statement macros do not need to be enclosed in do while (0) loop,
4761# macro should not end with a semicolon
4762 if ($^V && $^V ge 5.10.0 &&
4763 $realfile !~ m@/vmlinux.lds.h$@ &&
4764 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4765 my $ln = $linenr;
4766 my $cnt = $realcnt;
4767 my ($off, $dstat, $dcond, $rest);
4768 my $ctx = '';
4769 ($dstat, $dcond, $ln, $cnt, $off) =
4770 ctx_statement_block($linenr, $realcnt, 0);
4771 $ctx = $dstat;
4772
4773 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004774 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004775
4776 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4777 my $stmts = $2;
4778 my $semis = $3;
4779
4780 $ctx =~ s/\n*$//;
4781 my $cnt = statement_rawlines($ctx);
4782 my $herectx = $here . "\n";
4783
4784 for (my $n = 0; $n < $cnt; $n++) {
4785 $herectx .= raw_line($linenr, $n) . "\n";
4786 }
4787
Joe Perchesac8e97f2012-08-21 16:15:53 -07004788 if (($stmts =~ tr/;/;/) == 1 &&
4789 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004790 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4791 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4792 }
4793 if (defined $semis && $semis ne "") {
4794 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4795 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4796 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004797 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4798 $ctx =~ s/\n*$//;
4799 my $cnt = statement_rawlines($ctx);
4800 my $herectx = $here . "\n";
4801
4802 for (my $n = 0; $n < $cnt; $n++) {
4803 $herectx .= raw_line($linenr, $n) . "\n";
4804 }
4805
4806 WARN("TRAILING_SEMICOLON",
4807 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004808 }
4809 }
4810
Mike Frysinger080ba922009-01-06 14:41:25 -08004811# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4812# all assignments may have only one of the following with an assignment:
4813# .
4814# ALIGN(...)
4815# VMLINUX_SYMBOL(...)
4816 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004817 WARN("MISSING_VMLINUX_SYMBOL",
4818 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004819 }
4820
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004821# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004822 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4823 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004824 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004825 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004826 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4827 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004828 my @allowed = ();
4829 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004830 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004831 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004832 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004833 for my $chunk (@chunks) {
4834 my ($cond, $block) = @{$chunk};
4835
Andy Whitcroft773647a2008-03-28 14:15:58 -07004836 # If the condition carries leading newlines, then count those as offsets.
4837 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4838 my $offset = statement_rawlines($whitespace) - 1;
4839
Joe Perchesaad4f612012-03-23 15:02:19 -07004840 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004841 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4842
4843 # We have looked at and allowed this specific line.
4844 $suppress_ifbraces{$ln + $offset} = 1;
4845
4846 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004847 $ln += statement_rawlines($block) - 1;
4848
Andy Whitcroft773647a2008-03-28 14:15:58 -07004849 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004850
4851 $seen++ if ($block =~ /^\s*{/);
4852
Joe Perchesaad4f612012-03-23 15:02:19 -07004853 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004854 if (statement_lines($cond) > 1) {
4855 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004856 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004857 }
4858 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004859 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004860 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004861 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004862 if (statement_block_size($block) > 1) {
4863 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004864 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004865 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004866 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004867 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004868 if ($seen) {
4869 my $sum_allowed = 0;
4870 foreach (@allowed) {
4871 $sum_allowed += $_;
4872 }
4873 if ($sum_allowed == 0) {
4874 WARN("BRACES",
4875 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4876 } elsif ($sum_allowed != $allow &&
4877 $seen != $allow) {
4878 CHK("BRACES",
4879 "braces {} should be used on all arms of this statement\n" . $herectx);
4880 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004881 }
4882 }
4883 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004884 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004885 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004886 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004887
Andy Whitcroftcf655042008-03-04 14:28:20 -08004888 # Check the pre-context.
4889 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4890 #print "APW: ALLOWED: pre<$1>\n";
4891 $allowed = 1;
4892 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004893
4894 my ($level, $endln, @chunks) =
4895 ctx_statement_full($linenr, $realcnt, $-[0]);
4896
Andy Whitcroftcf655042008-03-04 14:28:20 -08004897 # Check the condition.
4898 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004899 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004900 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004901 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004902 }
4903 if (statement_lines($cond) > 1) {
4904 #print "APW: ALLOWED: cond<$cond>\n";
4905 $allowed = 1;
4906 }
4907 if ($block =~/\b(?:if|for|while)\b/) {
4908 #print "APW: ALLOWED: block<$block>\n";
4909 $allowed = 1;
4910 }
4911 if (statement_block_size($block) > 1) {
4912 #print "APW: ALLOWED: lines block<$block>\n";
4913 $allowed = 1;
4914 }
4915 # Check the post-context.
4916 if (defined $chunks[1]) {
4917 my ($cond, $block) = @{$chunks[1]};
4918 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004919 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004920 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004921 if ($block =~ /^\s*\{/) {
4922 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4923 $allowed = 1;
4924 }
4925 }
4926 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004927 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004928 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004929
Andy Whitcroftf0556632008-10-15 22:02:23 -07004930 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004931 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004932 }
4933
Joe Perches000d1cc12011-07-25 17:13:25 -07004934 WARN("BRACES",
4935 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004936 }
4937 }
4938
Joe Perches0979ae62012-12-17 16:01:59 -08004939# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004940 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004941 if (CHK("BRACES",
4942 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4943 $fix && $prevrawline =~ /^\+/) {
4944 fix_delete_line($fixlinenr - 1, $prevrawline);
4945 }
Joe Perches0979ae62012-12-17 16:01:59 -08004946 }
Joe Perches77b9a532013-07-03 15:05:29 -07004947 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004948 if (CHK("BRACES",
4949 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4950 $fix) {
4951 fix_delete_line($fixlinenr, $rawline);
4952 }
Joe Perches0979ae62012-12-17 16:01:59 -08004953 }
4954
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004955# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004956 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4957 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004958 WARN("VOLATILE",
4959 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004960 }
4961
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004962# Check for user-visible strings broken across lines, which breaks the ability
4963# to grep for the string. Make exceptions when the previous string ends in a
4964# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4965# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004966 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004967 $prevline =~ /"\s*$/ &&
4968 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4969 if (WARN("SPLIT_STRING",
4970 "quoted string split across lines\n" . $hereprev) &&
4971 $fix &&
4972 $prevrawline =~ /^\+.*"\s*$/ &&
4973 $last_coalesced_string_linenr != $linenr - 1) {
4974 my $extracted_string = get_quoted_string($line, $rawline);
4975 my $comma_close = "";
4976 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4977 $comma_close = $1;
4978 }
4979
4980 fix_delete_line($fixlinenr - 1, $prevrawline);
4981 fix_delete_line($fixlinenr, $rawline);
4982 my $fixedline = $prevrawline;
4983 $fixedline =~ s/"\s*$//;
4984 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4985 fix_insert_line($fixlinenr - 1, $fixedline);
4986 $fixedline = $rawline;
4987 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4988 if ($fixedline !~ /\+\s*$/) {
4989 fix_insert_line($fixlinenr, $fixedline);
4990 }
4991 $last_coalesced_string_linenr = $linenr;
4992 }
4993 }
4994
4995# check for missing a space in a string concatenation
4996 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4997 WARN('MISSING_SPACE',
4998 "break quoted strings at a space character\n" . $hereprev);
4999 }
5000
5001# check for spaces before a quoted newline
5002 if ($rawline =~ /^.*\".*\s\\n/) {
5003 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5004 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5005 $fix) {
5006 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5007 }
5008
5009 }
5010
Joe Perchesf17dba42014-10-13 15:51:51 -07005011# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005012 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005013 CHK("CONCATENATED_STRING",
5014 "Concatenated strings should use spaces between elements\n" . $herecurr);
5015 }
5016
Joe Perches90ad30e2014-12-10 15:51:59 -08005017# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005018 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005019 WARN("STRING_FRAGMENTS",
5020 "Consecutive strings are generally better as a single string\n" . $herecurr);
5021 }
5022
Joe Perches6e300752015-09-09 15:37:47 -07005023# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005024 my $string;
5025 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5026 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5027 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005028 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005029 WARN("PRINTF_L",
5030 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5031 last;
5032 }
Joe Perches6e300752015-09-09 15:37:47 -07005033 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5034 ERROR("PRINTF_0xDECIMAL",
5035 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5036 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005037 }
5038
5039# check for line continuations in quoted strings with odd counts of "
5040 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5041 WARN("LINE_CONTINUATIONS",
5042 "Avoid line continuations in quoted strings\n" . $herecurr);
5043 }
5044
Andy Whitcroft00df3442007-06-08 13:47:06 -07005045# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005046 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005047 CHK("REDUNDANT_CODE",
5048 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005049 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005050 }
5051
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005052# check for needless "if (<foo>) fn(<foo>)" uses
5053 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005054 my $tested = quotemeta($1);
5055 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5056 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5057 my $func = $1;
5058 if (WARN('NEEDLESS_IF',
5059 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5060 $fix) {
5061 my $do_fix = 1;
5062 my $leading_tabs = "";
5063 my $new_leading_tabs = "";
5064 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5065 $leading_tabs = $1;
5066 } else {
5067 $do_fix = 0;
5068 }
5069 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5070 $new_leading_tabs = $1;
5071 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5072 $do_fix = 0;
5073 }
5074 } else {
5075 $do_fix = 0;
5076 }
5077 if ($do_fix) {
5078 fix_delete_line($fixlinenr - 1, $prevrawline);
5079 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5080 }
5081 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005082 }
5083 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005084
Joe Perchesebfdc402014-08-06 16:10:27 -07005085# check for unnecessary "Out of Memory" messages
5086 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5087 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5088 (defined $1 || defined $3) &&
5089 $linenr > 3) {
5090 my $testval = $2;
5091 my $testline = $lines[$linenr - 3];
5092
5093 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5094# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5095
5096 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5097 WARN("OOM_MESSAGE",
5098 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5099 }
5100 }
5101
Joe Perchesf78d98f2014-10-13 15:52:01 -07005102# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005103 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005104 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5105 my $level = $1;
5106 if (WARN("UNNECESSARY_KERN_LEVEL",
5107 "Possible unnecessary $level\n" . $herecurr) &&
5108 $fix) {
5109 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5110 }
5111 }
5112
Joe Perchesabb08a52014-12-10 15:51:46 -08005113# check for mask then right shift without a parentheses
5114 if ($^V && $^V ge 5.10.0 &&
5115 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5116 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5117 WARN("MASK_THEN_SHIFT",
5118 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5119 }
5120
Joe Perchesb75ac612014-12-10 15:52:02 -08005121# check for pointer comparisons to NULL
5122 if ($^V && $^V ge 5.10.0) {
5123 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5124 my $val = $1;
5125 my $equal = "!";
5126 $equal = "" if ($4 eq "!=");
5127 if (CHK("COMPARISON_TO_NULL",
5128 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5129 $fix) {
5130 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5131 }
5132 }
5133 }
5134
Joe Perches8716de32013-09-11 14:24:05 -07005135# check for bad placement of section $InitAttribute (e.g.: __initdata)
5136 if ($line =~ /(\b$InitAttribute\b)/) {
5137 my $attr = $1;
5138 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5139 my $ptr = $1;
5140 my $var = $2;
5141 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5142 ERROR("MISPLACED_INIT",
5143 "$attr should be placed after $var\n" . $herecurr)) ||
5144 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5145 WARN("MISPLACED_INIT",
5146 "$attr should be placed after $var\n" . $herecurr))) &&
5147 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005148 $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 -07005149 }
5150 }
5151 }
5152
Joe Perchese970b8842013-11-12 15:10:10 -08005153# check for $InitAttributeData (ie: __initdata) with const
5154 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5155 my $attr = $1;
5156 $attr =~ /($InitAttributePrefix)(.*)/;
5157 my $attr_prefix = $1;
5158 my $attr_type = $2;
5159 if (ERROR("INIT_ATTRIBUTE",
5160 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5161 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005162 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005163 s/$InitAttributeData/${attr_prefix}initconst/;
5164 }
5165 }
5166
5167# check for $InitAttributeConst (ie: __initconst) without const
5168 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5169 my $attr = $1;
5170 if (ERROR("INIT_ATTRIBUTE",
5171 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5172 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005173 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005174 /(^\+\s*(?:static\s+))/;
5175 $lead = rtrim($1);
5176 $lead = "$lead " if ($lead !~ /^\+$/);
5177 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005178 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005179 }
5180 }
5181
Joe Perchesc17893c2015-04-16 12:44:42 -07005182# check for __read_mostly with const non-pointer (should just be const)
5183 if ($line =~ /\b__read_mostly\b/ &&
5184 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5185 if (ERROR("CONST_READ_MOSTLY",
5186 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5187 $fix) {
5188 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5189 }
5190 }
5191
Joe Perchesfbdb8132014-04-03 14:49:14 -07005192# don't use __constant_<foo> functions outside of include/uapi/
5193 if ($realfile !~ m@^include/uapi/@ &&
5194 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5195 my $constant_func = $1;
5196 my $func = $constant_func;
5197 $func =~ s/^__constant_//;
5198 if (WARN("CONSTANT_CONVERSION",
5199 "$constant_func should be $func\n" . $herecurr) &&
5200 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005201 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005202 }
5203 }
5204
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005205# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005206 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005207 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005208 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005209 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005210 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005211 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5212 }
5213 if ($delay > 2000) {
5214 WARN("LONG_UDELAY",
5215 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005216 }
5217 }
5218
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005219# warn about unexpectedly long msleep's
5220 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5221 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005222 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005223 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005224 }
5225 }
5226
Joe Perches36ec1932013-07-03 15:05:25 -07005227# check for comparisons of jiffies
5228 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5229 WARN("JIFFIES_COMPARISON",
5230 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5231 }
5232
Joe Perches9d7a34a2013-07-03 15:05:26 -07005233# check for comparisons of get_jiffies_64()
5234 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5235 WARN("JIFFIES_COMPARISON",
5236 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5237 }
5238
Andy Whitcroft00df3442007-06-08 13:47:06 -07005239# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005240# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005241# print "#ifdef in C files should be avoided\n";
5242# print "$herecurr";
5243# $clean = 0;
5244# }
5245
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005246# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005247 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005248 if (ERROR("SPACING",
5249 "exactly one space required after that #$1\n" . $herecurr) &&
5250 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005251 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005252 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5253 }
5254
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005255 }
5256
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005257# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005258 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5259 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005260 my $which = $1;
5261 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005262 CHK("UNCOMMENTED_DEFINITION",
5263 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005264 }
5265 }
5266# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005267
5268 my $barriers = qr{
5269 mb|
5270 rmb|
5271 wmb|
5272 read_barrier_depends
5273 }x;
5274 my $barrier_stems = qr{
5275 mb__before_atomic|
5276 mb__after_atomic|
5277 store_release|
5278 load_acquire|
5279 store_mb|
5280 (?:$barriers)
5281 }x;
5282 my $all_barriers = qr{
5283 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005284 smp_(?:$barrier_stems)|
5285 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005286 }x;
5287
5288 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005289 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005290 WARN("MEMORY_BARRIER",
5291 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005292 }
5293 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005294
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005295 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5296
5297 if ($realfile !~ m@^include/asm-generic/@ &&
5298 $realfile !~ m@/barrier\.h$@ &&
5299 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5300 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5301 WARN("MEMORY_BARRIER",
5302 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5303 }
5304
Joe Perchescb426e92015-06-25 15:02:46 -07005305# check for waitqueue_active without a comment.
5306 if ($line =~ /\bwaitqueue_active\s*\(/) {
5307 if (!ctx_has_comment($first_line, $linenr)) {
5308 WARN("WAITQUEUE_ACTIVE",
5309 "waitqueue_active without comment\n" . $herecurr);
5310 }
5311 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005312
5313# Check for expedited grace periods that interrupt non-idle non-nohz
5314# online CPUs. These expedited can therefore degrade real-time response
5315# if used carelessly, and should be avoided where not absolutely
5316# needed. It is always OK to use synchronize_rcu_expedited() and
5317# synchronize_sched_expedited() at boot time (before real-time applications
5318# start) and in error situations where real-time response is compromised in
5319# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5320# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5321# Of course, nothing comes for free, and srcu_read_lock() and
5322# srcu_read_unlock() do contain full memory barriers in payment for
5323# synchronize_srcu_expedited() non-interruption properties.
5324 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5325 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5326 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5327
5328 }
5329
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005330# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005331 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005332 CHK("ARCH_DEFINES",
5333 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005334 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005335
Tobias Klauserd4977c72010-05-24 14:33:30 -07005336# Check that the storage class is at the beginning of a declaration
5337 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005338 WARN("STORAGE_CLASS",
5339 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005340 }
5341
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005342# check the location of the inline attribute, that it is between
5343# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005344 if ($line =~ /\b$Type\s+$Inline\b/ ||
5345 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005346 ERROR("INLINE_LOCATION",
5347 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005348 }
5349
Andy Whitcroft8905a672007-11-28 16:21:06 -08005350# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005351 if ($realfile !~ m@\binclude/uapi/@ &&
5352 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005353 if (WARN("INLINE",
5354 "plain inline is preferred over $1\n" . $herecurr) &&
5355 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005356 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005357
5358 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005359 }
5360
Joe Perches3d130fd2011-01-12 17:00:00 -08005361# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005362 if ($realfile !~ m@\binclude/uapi/@ &&
5363 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005364 WARN("PREFER_PACKED",
5365 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005366 }
5367
Joe Perches39b7e282011-07-25 17:13:24 -07005368# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005369 if ($realfile !~ m@\binclude/uapi/@ &&
5370 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005371 WARN("PREFER_ALIGNED",
5372 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005373 }
5374
Joe Perches5f14d3b2012-01-10 15:09:52 -08005375# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005376 if ($realfile !~ m@\binclude/uapi/@ &&
5377 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005378 if (WARN("PREFER_PRINTF",
5379 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5380 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005381 $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 -07005382
5383 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005384 }
5385
Joe Perches6061d942012-03-23 15:02:16 -07005386# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005387 if ($realfile !~ m@\binclude/uapi/@ &&
5388 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005389 if (WARN("PREFER_SCANF",
5390 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5391 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005392 $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 -07005393 }
Joe Perches6061d942012-03-23 15:02:16 -07005394 }
5395
Joe Perches619a9082014-12-10 15:51:35 -08005396# Check for __attribute__ weak, or __weak declarations (may have link issues)
5397 if ($^V && $^V ge 5.10.0 &&
5398 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5399 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5400 $line =~ /\b__weak\b/)) {
5401 ERROR("WEAK_DECLARATION",
5402 "Using weak declarations can have unintended link defects\n" . $herecurr);
5403 }
5404
Joe Perchese6176fa2015-06-25 15:02:49 -07005405# check for c99 types like uint8_t used outside of uapi/
5406 if ($realfile !~ m@\binclude/uapi/@ &&
5407 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5408 my $type = $1;
5409 if ($type =~ /\b($typeC99Typedefs)\b/) {
5410 $type = $1;
5411 my $kernel_type = 'u';
5412 $kernel_type = 's' if ($type =~ /^_*[si]/);
5413 $type =~ /(\d+)/;
5414 $kernel_type .= $1;
5415 if (CHK("PREFER_KERNEL_TYPES",
5416 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5417 $fix) {
5418 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5419 }
5420 }
5421 }
5422
Joe Perches938224b2016-01-20 14:59:15 -08005423# check for cast of C90 native int or longer types constants
5424 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5425 my $cast = $1;
5426 my $const = $2;
5427 if (WARN("TYPECAST_INT_CONSTANT",
5428 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5429 $fix) {
5430 my $suffix = "";
5431 my $newconst = $const;
5432 $newconst =~ s/${Int_type}$//;
5433 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5434 if ($cast =~ /\blong\s+long\b/) {
5435 $suffix .= 'LL';
5436 } elsif ($cast =~ /\blong\b/) {
5437 $suffix .= 'L';
5438 }
5439 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5440 }
5441 }
5442
Joe Perches8f53a9b2010-03-05 13:43:48 -08005443# check for sizeof(&)
5444 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005445 WARN("SIZEOF_ADDRESS",
5446 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005447 }
5448
Joe Perches66c80b62012-07-30 14:41:22 -07005449# check for sizeof without parenthesis
5450 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005451 if (WARN("SIZEOF_PARENTHESIS",
5452 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5453 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005454 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005455 }
Joe Perches66c80b62012-07-30 14:41:22 -07005456 }
5457
Joe Perches88982fe2012-12-17 16:02:00 -08005458# check for struct spinlock declarations
5459 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5460 WARN("USE_SPINLOCK_T",
5461 "struct spinlock should be spinlock_t\n" . $herecurr);
5462 }
5463
Joe Perchesa6962d72013-04-29 16:18:13 -07005464# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005465 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005466 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005467 $fmt =~ s/%%//g;
5468 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005469 if (WARN("PREFER_SEQ_PUTS",
5470 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5471 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005472 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005473 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005474 }
5475 }
5476
Andy Whitcroft554e1652012-01-10 15:09:57 -08005477# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005478 if ($^V && $^V ge 5.10.0 &&
5479 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005480 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005481
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005482 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005483 my $ms_val = $7;
5484 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005485
Andy Whitcroft554e1652012-01-10 15:09:57 -08005486 if ($ms_size =~ /^(0x|)0$/i) {
5487 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005488 "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 -08005489 } elsif ($ms_size =~ /^(0x|)1$/i) {
5490 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005491 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5492 }
5493 }
5494
Joe Perches98a9bba2014-01-23 15:54:52 -08005495# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5496 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005497 defined $stat &&
5498 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005499 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005500 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
Joe Perches98a9bba2014-01-23 15:54:52 -08005501 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005502 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
Joe Perches98a9bba2014-01-23 15:54:52 -08005503 }
5504 }
5505
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005506# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5507 if ($^V && $^V ge 5.10.0 &&
5508 defined $stat &&
5509 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5510 WARN("PREFER_ETHER_ADDR_EQUAL",
5511 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5512 }
5513
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005514# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5515# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5516 if ($^V && $^V ge 5.10.0 &&
5517 defined $stat &&
5518 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5519
5520 my $ms_val = $7;
5521
5522 if ($ms_val =~ /^(?:0x|)0+$/i) {
5523 if (WARN("PREFER_ETH_ZERO_ADDR",
5524 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5525 $fix) {
5526 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5527 }
5528 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5529 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5530 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5531 $fix) {
5532 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5533 }
5534 }
5535 }
5536
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005537# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005538 if ($^V && $^V ge 5.10.0 &&
5539 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005540 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005541 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005542 my $call = $1;
5543 my $cast1 = deparenthesize($2);
5544 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005545 my $cast2 = deparenthesize($7);
5546 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005547 my $cast;
5548
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005549 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005550 $cast = "$cast1 or $cast2";
5551 } elsif ($cast1 ne "") {
5552 $cast = $cast1;
5553 } else {
5554 $cast = $cast2;
5555 }
5556 WARN("MINMAX",
5557 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005558 }
5559 }
5560
Joe Perches4a273192012-07-30 14:41:20 -07005561# check usleep_range arguments
5562 if ($^V && $^V ge 5.10.0 &&
5563 defined $stat &&
5564 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5565 my $min = $1;
5566 my $max = $7;
5567 if ($min eq $max) {
5568 WARN("USLEEP_RANGE",
5569 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5570 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5571 $min > $max) {
5572 WARN("USLEEP_RANGE",
5573 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5574 }
5575 }
5576
Joe Perches823b7942013-11-12 15:10:15 -08005577# check for naked sscanf
5578 if ($^V && $^V ge 5.10.0 &&
5579 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005580 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005581 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5582 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5583 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5584 my $lc = $stat =~ tr@\n@@;
5585 $lc = $lc + $linenr;
5586 my $stat_real = raw_line($linenr, 0);
5587 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5588 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5589 }
5590 WARN("NAKED_SSCANF",
5591 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5592 }
5593
Joe Perchesafc819a2014-06-04 16:12:08 -07005594# check for simple sscanf that should be kstrto<foo>
5595 if ($^V && $^V ge 5.10.0 &&
5596 defined $stat &&
5597 $line =~ /\bsscanf\b/) {
5598 my $lc = $stat =~ tr@\n@@;
5599 $lc = $lc + $linenr;
5600 my $stat_real = raw_line($linenr, 0);
5601 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5602 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5603 }
5604 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5605 my $format = $6;
5606 my $count = $format =~ tr@%@%@;
5607 if ($count == 1 &&
5608 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5609 WARN("SSCANF_TO_KSTRTO",
5610 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5611 }
5612 }
5613 }
5614
Joe Perches70dc8a42013-09-11 14:23:58 -07005615# check for new externs in .h files.
5616 if ($realfile =~ /\.h$/ &&
5617 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005618 if (CHK("AVOID_EXTERNS",
5619 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005620 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005621 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005622 }
5623 }
5624
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005625# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005626 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005627 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005628 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005629 my $function_name = $1;
5630 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005631
5632 my $s = $stat;
5633 if (defined $cond) {
5634 substr($s, 0, length($cond), '');
5635 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005636 if ($s =~ /^\s*;/ &&
5637 $function_name ne 'uninitialized_var')
5638 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005639 WARN("AVOID_EXTERNS",
5640 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005641 }
5642
5643 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005644 WARN("FUNCTION_ARGUMENTS",
5645 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005646 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005647
5648 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5649 $stat =~ /^.\s*extern\s+/)
5650 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005651 WARN("AVOID_EXTERNS",
5652 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005653 }
5654
5655# checks for new __setup's
5656 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5657 my $name = $1;
5658
5659 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005660 CHK("UNDOCUMENTED_SETUP",
5661 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005662 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005663 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005664
5665# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005666 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005667 WARN("UNNECESSARY_CASTS",
5668 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005669 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005670
Joe Perchesa640d252013-07-03 15:05:21 -07005671# alloc style
5672# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5673 if ($^V && $^V ge 5.10.0 &&
5674 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5675 CHK("ALLOC_SIZEOF_STRUCT",
5676 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5677 }
5678
Joe Perches60a55362014-06-04 16:12:07 -07005679# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5680 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005681 $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 -07005682 my $oldfunc = $3;
5683 my $a1 = $4;
5684 my $a2 = $10;
5685 my $newfunc = "kmalloc_array";
5686 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005687 my $r1 = $a1;
5688 my $r2 = $a2;
5689 if ($a1 =~ /^sizeof\s*\S/) {
5690 $r1 = $a2;
5691 $r2 = $a1;
5692 }
5693 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5694 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005695 if (WARN("ALLOC_WITH_MULTIPLY",
5696 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5697 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005698 $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 -07005699
5700 }
5701 }
5702 }
5703
Joe Perches972fdea2013-04-29 16:18:12 -07005704# check for krealloc arg reuse
5705 if ($^V && $^V ge 5.10.0 &&
5706 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5707 WARN("KREALLOC_ARG_REUSE",
5708 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5709 }
5710
Joe Perches5ce59ae2013-02-21 16:44:18 -08005711# check for alloc argument mismatch
5712 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5713 WARN("ALLOC_ARRAY_ARGS",
5714 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5715 }
5716
Joe Perchescaf2a542011-01-12 16:59:56 -08005717# check for multiple semicolons
5718 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005719 if (WARN("ONE_SEMICOLON",
5720 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5721 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005722 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005723 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005724 }
5725
Joe Perches0ab90192014-12-10 15:51:57 -08005726# check for #defines like: 1 << <digit> that could be BIT(digit)
5727 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5728 my $ull = "";
5729 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5730 if (CHK("BIT_MACRO",
5731 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5732 $fix) {
5733 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5734 }
5735 }
5736
Joe Perches2d632742016-05-20 17:04:00 -07005737# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5738 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5739 my $config = $1;
5740 if (WARN("PREFER_IS_ENABLED",
5741 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5742 $fix) {
5743 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5744 }
5745 }
5746
Joe Perchese81f2392014-08-06 16:11:25 -07005747# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005748 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5749 my $has_break = 0;
5750 my $has_statement = 0;
5751 my $count = 0;
5752 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005753 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005754 $prevline--;
5755 my $rline = $rawlines[$prevline - 1];
5756 my $fline = $lines[$prevline - 1];
5757 last if ($fline =~ /^\@\@/);
5758 next if ($fline =~ /^\-/);
5759 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5760 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5761 next if ($fline =~ /^.[\s$;]*$/);
5762 $has_statement = 1;
5763 $count++;
5764 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5765 }
5766 if (!$has_break && $has_statement) {
5767 WARN("MISSING_BREAK",
5768 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5769 }
5770 }
5771
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005772# check for switch/default statements without a break;
5773 if ($^V && $^V ge 5.10.0 &&
5774 defined $stat &&
5775 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5776 my $ctx = '';
5777 my $herectx = $here . "\n";
5778 my $cnt = statement_rawlines($stat);
5779 for (my $n = 0; $n < $cnt; $n++) {
5780 $herectx .= raw_line($linenr, $n) . "\n";
5781 }
5782 WARN("DEFAULT_NO_BREAK",
5783 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005784 }
5785
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005786# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005787 if ($line =~ /\b__FUNCTION__\b/) {
5788 if (WARN("USE_FUNC",
5789 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5790 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005791 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005792 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005793 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005794
Joe Perches62ec8182015-02-13 14:38:18 -08005795# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5796 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5797 ERROR("DATE_TIME",
5798 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5799 }
5800
Joe Perches2c924882012-03-23 15:02:20 -07005801# check for use of yield()
5802 if ($line =~ /\byield\s*\(\s*\)/) {
5803 WARN("YIELD",
5804 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5805 }
5806
Joe Perches179f8f42013-07-03 15:05:30 -07005807# check for comparisons against true and false
5808 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5809 my $lead = $1;
5810 my $arg = $2;
5811 my $test = $3;
5812 my $otype = $4;
5813 my $trail = $5;
5814 my $op = "!";
5815
5816 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5817
5818 my $type = lc($otype);
5819 if ($type =~ /^(?:true|false)$/) {
5820 if (("$test" eq "==" && "$type" eq "true") ||
5821 ("$test" eq "!=" && "$type" eq "false")) {
5822 $op = "";
5823 }
5824
5825 CHK("BOOL_COMPARISON",
5826 "Using comparison to $otype is error prone\n" . $herecurr);
5827
5828## maybe suggesting a correct construct would better
5829## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5830
5831 }
5832 }
5833
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005834# check for semaphores initialized locked
5835 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005836 WARN("CONSIDER_COMPLETION",
5837 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005838 }
Joe Perches6712d852012-03-23 15:02:20 -07005839
Joe Perches67d0a072011-10-31 17:13:10 -07005840# recommend kstrto* over simple_strto* and strict_strto*
5841 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005842 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005843 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005844 }
Joe Perches6712d852012-03-23 15:02:20 -07005845
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005846# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005847 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005848 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005849 "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 -07005850 }
Joe Perches6712d852012-03-23 15:02:20 -07005851
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005852# check for various structs that are normally const (ops, kgdb, device_tree)
5853 my $const_structs = qr{
5854 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005855 address_space_operations|
5856 backlight_ops|
5857 block_device_operations|
5858 dentry_operations|
5859 dev_pm_ops|
5860 dma_map_ops|
5861 extent_io_ops|
5862 file_lock_operations|
5863 file_operations|
5864 hv_ops|
5865 ide_dma_ops|
5866 intel_dvo_dev_ops|
5867 item_operations|
5868 iwl_ops|
5869 kgdb_arch|
5870 kgdb_io|
5871 kset_uevent_ops|
5872 lock_manager_operations|
5873 microcode_ops|
5874 mtrr_ops|
5875 neigh_ops|
5876 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005877 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005878 pci_raw_ops|
5879 pipe_buf_operations|
5880 platform_hibernation_ops|
5881 platform_suspend_ops|
5882 proto_ops|
5883 rpc_pipe_ops|
5884 seq_operations|
5885 snd_ac97_build_ops|
5886 soc_pcmcia_socket_ops|
5887 stacktrace_ops|
5888 sysfs_ops|
5889 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005890 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005891 usb_mon_operations|
5892 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005893 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005894 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005895 WARN("CONST_STRUCT",
5896 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005897 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005898 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005899
5900# use of NR_CPUS is usually wrong
5901# ignore definitions of NR_CPUS and usage to define arrays as likely right
5902 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005903 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5904 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005905 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5906 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5907 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005908 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005909 WARN("NR_CPUS",
5910 "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 -07005911 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005912
Joe Perches52ea8502013-11-12 15:10:09 -08005913# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5914 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5915 ERROR("DEFINE_ARCH_HAS",
5916 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5917 }
5918
Joe Perchesacd93622015-02-13 14:38:38 -08005919# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5920 if ($^V && $^V ge 5.10.0 &&
5921 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5922 WARN("LIKELY_MISUSE",
5923 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5924 }
5925
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005926# whine mightly about in_atomic
5927 if ($line =~ /\bin_atomic\s*\(/) {
5928 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005929 ERROR("IN_ATOMIC",
5930 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005931 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005932 WARN("IN_ATOMIC",
5933 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005934 }
5935 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005936
Joe Perches481aea52016-05-20 17:04:08 -07005937# whine about ACCESS_ONCE
5938 if ($^V && $^V ge 5.10.0 &&
5939 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
5940 my $par = $1;
5941 my $eq = $2;
5942 my $fun = $3;
5943 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
5944 if (defined($eq)) {
5945 if (WARN("PREFER_WRITE_ONCE",
5946 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
5947 $fix) {
5948 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5949 }
5950 } else {
5951 if (WARN("PREFER_READ_ONCE",
5952 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
5953 $fix) {
5954 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
5955 }
5956 }
5957 }
5958
Peter Zijlstra1704f472010-03-19 01:37:42 +01005959# check for lockdep_set_novalidate_class
5960 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5961 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5962 if ($realfile !~ m@^kernel/lockdep@ &&
5963 $realfile !~ m@^include/linux/lockdep@ &&
5964 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005965 ERROR("LOCKDEP",
5966 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005967 }
5968 }
Dave Jones88f88312011-01-12 16:59:59 -08005969
Joe Perchesb392c642015-04-16 12:44:16 -07005970 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5971 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005972 WARN("EXPORTED_WORLD_WRITABLE",
5973 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005974 }
Joe Perches24358802014-04-03 14:49:13 -07005975
Joe Perches515a2352014-04-03 14:49:24 -07005976# Mode permission misuses where it seems decimal should be octal
5977# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5978 if ($^V && $^V ge 5.10.0 &&
5979 $line =~ /$mode_perms_search/) {
5980 foreach my $entry (@mode_permission_funcs) {
5981 my $func = $entry->[0];
5982 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005983
Joe Perches515a2352014-04-03 14:49:24 -07005984 my $skip_args = "";
5985 if ($arg_pos > 1) {
5986 $arg_pos--;
5987 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5988 }
5989 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5990 if ($line =~ /$test/) {
5991 my $val = $1;
5992 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005993
Joe Perches515a2352014-04-03 14:49:24 -07005994 if ($val !~ /^0$/ &&
5995 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5996 length($val) ne 4)) {
5997 ERROR("NON_OCTAL_PERMISSIONS",
5998 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08005999 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6000 ERROR("EXPORTED_WORLD_WRITABLE",
6001 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006002 }
Joe Perches24358802014-04-03 14:49:13 -07006003 }
6004 }
6005 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006006
6007# validate content of MODULE_LICENSE against list from include/linux/module.h
6008 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6009 my $extracted_string = get_quoted_string($line, $rawline);
6010 my $valid_licenses = qr{
6011 GPL|
6012 GPL\ v2|
6013 GPL\ and\ additional\ rights|
6014 Dual\ BSD/GPL|
6015 Dual\ MIT/GPL|
6016 Dual\ MPL/GPL|
6017 Proprietary
6018 }x;
6019 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6020 WARN("MODULE_LICENSE",
6021 "unknown module license " . $extracted_string . "\n" . $herecurr);
6022 }
6023 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006024 }
6025
6026 # If we have no input at all, then there is nothing to report on
6027 # so just keep quiet.
6028 if ($#rawlines == -1) {
6029 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006030 }
6031
Andy Whitcroft8905a672007-11-28 16:21:06 -08006032 # In mailback mode only produce a report in the negative, for
6033 # things that appear to be patches.
6034 if ($mailback && ($clean == 1 || !$is_patch)) {
6035 exit(0);
6036 }
6037
6038 # This is not a patch, and we are are in 'no-patch' mode so
6039 # just keep quiet.
6040 if (!$chk_patch && !$is_patch) {
6041 exit(0);
6042 }
6043
Joe Perches06330fc2015-06-25 15:03:11 -07006044 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006045 ERROR("NOT_UNIFIED_DIFF",
6046 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006047 }
Joe Perches34d88152015-06-25 15:03:05 -07006048 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006049 ERROR("MISSING_SIGN_OFF",
6050 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006051 }
6052
Andy Whitcroft8905a672007-11-28 16:21:06 -08006053 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006054 if ($summary && !($clean == 1 && $quiet == 1)) {
6055 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006056 print "total: $cnt_error errors, $cnt_warn warnings, " .
6057 (($check)? "$cnt_chk checks, " : "") .
6058 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006059 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006060
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006061 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006062 # If there were any defects found and not already fixing them
6063 if (!$clean and !$fix) {
6064 print << "EOM"
6065
6066NOTE: For some of the reported defects, checkpatch may be able to
6067 mechanically convert to the typical style using --fix or --fix-inplace.
6068EOM
6069 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006070 # If there were whitespace errors which cleanpatch can fix
6071 # then suggest that.
6072 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006073 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006074 print << "EOM"
6075
6076NOTE: Whitespace errors detected.
6077 You may wish to use scripts/cleanpatch or scripts/cleanfile
6078EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006079 }
6080 }
6081
Joe Perchesd752fcc2014-08-06 16:11:05 -07006082 if ($clean == 0 && $fix &&
6083 ("@rawlines" ne "@fixed" ||
6084 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006085 my $newfile = $filename;
6086 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006087 my $linecount = 0;
6088 my $f;
6089
Joe Perchesd752fcc2014-08-06 16:11:05 -07006090 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6091
Joe Perches3705ce52013-07-03 15:05:31 -07006092 open($f, '>', $newfile)
6093 or die "$P: Can't open $newfile for write\n";
6094 foreach my $fixed_line (@fixed) {
6095 $linecount++;
6096 if ($file) {
6097 if ($linecount > 3) {
6098 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006099 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006100 }
6101 } else {
6102 print $f $fixed_line . "\n";
6103 }
6104 }
6105 close($f);
6106
6107 if (!$quiet) {
6108 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006109
Joe Perches3705ce52013-07-03 15:05:31 -07006110Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6111
6112Do _NOT_ trust the results written to this file.
6113Do _NOT_ submit these changes without inspecting them for correctness.
6114
6115This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6116No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006117EOM
6118 }
6119 }
6120
Joe Perchesd8469f12015-06-25 15:03:00 -07006121 if ($quiet == 0) {
6122 print "\n";
6123 if ($clean == 1) {
6124 print "$vname has no obvious style problems and is ready for submission.\n";
6125 } else {
6126 print "$vname has style problems, please review.\n";
6127 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006128 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006129 return $clean;
6130}