blob: 24a08363995adeeda264cacd801bebf9cc48b5c6 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070030my $git = 0;
Joe Perches0dea9f12016-05-20 17:04:19 -070031my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070033my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080034my $summary = 1;
35my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080036my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070037my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070038my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070039my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080040my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070041my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080042my %debug;
Joe Perches34456862013-07-03 15:05:34 -070043my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070044my %use_type = ();
45my @use = ();
46my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070047my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070048my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070049my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080050my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070051my $ignore_perl_version = 0;
52my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070053my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070054my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070055my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070056my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe 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 Perches2ac73b4f2014-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|
316 __must_check|
317 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800318 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700319 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800320 __rcu|
321 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700322 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800323our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
324our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
325our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
326our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
327our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700328
Wolfram Sang52131292010-03-05 13:43:51 -0800329# Notes to $Attribute:
330# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700331our $Attribute = qr{
332 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700333 __percpu|
334 __nocast|
335 __safe|
336 __bitwise__|
337 __packed__|
338 __packed2__|
339 __naked|
340 __maybe_unused|
341 __always_unused|
342 __noreturn|
343 __used|
344 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800345 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700346 __noclone|
347 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700348 __read_mostly|
349 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700350 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700351 ____cacheline_aligned|
352 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800353 ____cacheline_internodealigned_in_smp|
354 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700355 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700356our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700357our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700358our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
359our $Lval = qr{$Ident(?:$Member)*};
360
Joe Perches95e2c602013-07-03 15:05:20 -0700361our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
362our $Binary = qr{(?i)0b[01]+$Int_type?};
363our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
364our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700365our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800366our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800367our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
368our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
369our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800370our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700371our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800372our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700373our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700374our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700375our $Operators = qr{
376 <=|>=|==|!=|
377 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700378 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700379 }x;
380
Joe Perches91cb5192014-04-03 14:49:32 -0700381our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
382
Joe Perchesab7e23f2015-04-16 12:44:22 -0700383our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800384our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700385our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700386our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800387our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700388our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800389our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700390our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800391
Joe Perches15662b32011-10-31 17:13:12 -0700392our $NON_ASCII_UTF8 = qr{
393 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700394 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
395 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
396 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
397 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
398 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
399 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
400}x;
401
Joe Perches15662b32011-10-31 17:13:12 -0700402our $UTF8 = qr{
403 [\x09\x0A\x0D\x20-\x7E] # ASCII
404 | $NON_ASCII_UTF8
405}x;
406
Joe Perchese6176fa2015-06-25 15:02:49 -0700407our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800408our $typeOtherOSTypedefs = qr{(?x:
409 u_(?:char|short|int|long) | # bsd
410 u(?:nchar|short|int|long) # sysv
411)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700412our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700413 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700414 atomic_t
415)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700416our $typeTypedefs = qr{(?x:
417 $typeC99Typedefs\b|
418 $typeOtherOSTypedefs\b|
419 $typeKernelTypedefs\b
420)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700421
Joe Perches6d32f7a2015-11-06 16:31:37 -0800422our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
423
Joe Perches691e6692010-03-05 13:43:51 -0800424our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700425 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700426 (?:[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 -0700427 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700428 panic|
Joe Perches06668722013-11-12 15:10:07 -0800429 MODULE_[A-Z_]+|
430 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800431)};
432
Joe Perches20112472011-07-25 17:13:23 -0700433our $signature_tags = qr{(?xi:
434 Signed-off-by:|
435 Acked-by:|
436 Tested-by:|
437 Reviewed-by:|
438 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700439 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700440 To:|
441 Cc:
442)};
443
Joe Perches18130872014-08-06 16:11:22 -0700444our @typeListMisordered = (
445 qr{char\s+(?:un)?signed},
446 qr{int\s+(?:(?:un)?signed\s+)?short\s},
447 qr{int\s+short(?:\s+(?:un)?signed)},
448 qr{short\s+int(?:\s+(?:un)?signed)},
449 qr{(?:un)?signed\s+int\s+short},
450 qr{short\s+(?:un)?signed},
451 qr{long\s+int\s+(?:un)?signed},
452 qr{int\s+long\s+(?:un)?signed},
453 qr{long\s+(?:un)?signed\s+int},
454 qr{int\s+(?:un)?signed\s+long},
455 qr{int\s+(?:un)?signed},
456 qr{int\s+long\s+long\s+(?:un)?signed},
457 qr{long\s+long\s+int\s+(?:un)?signed},
458 qr{long\s+long\s+(?:un)?signed\s+int},
459 qr{long\s+long\s+(?:un)?signed},
460 qr{long\s+(?:un)?signed},
461);
462
Andy Whitcroft8905a672007-11-28 16:21:06 -0800463our @typeList = (
464 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700465 qr{(?:(?:un)?signed\s+)?char},
466 qr{(?:(?:un)?signed\s+)?short\s+int},
467 qr{(?:(?:un)?signed\s+)?short},
468 qr{(?:(?:un)?signed\s+)?int},
469 qr{(?:(?:un)?signed\s+)?long\s+int},
470 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
471 qr{(?:(?:un)?signed\s+)?long\s+long},
472 qr{(?:(?:un)?signed\s+)?long},
473 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800474 qr{float},
475 qr{double},
476 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800477 qr{struct\s+$Ident},
478 qr{union\s+$Ident},
479 qr{enum\s+$Ident},
480 qr{${Ident}_t},
481 qr{${Ident}_handler},
482 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700483 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800484);
Joe Perches938224b2016-01-20 14:59:15 -0800485
486our $C90_int_types = qr{(?x:
487 long\s+long\s+int\s+(?:un)?signed|
488 long\s+long\s+(?:un)?signed\s+int|
489 long\s+long\s+(?:un)?signed|
490 (?:(?:un)?signed\s+)?long\s+long\s+int|
491 (?:(?:un)?signed\s+)?long\s+long|
492 int\s+long\s+long\s+(?:un)?signed|
493 int\s+(?:(?:un)?signed\s+)?long\s+long|
494
495 long\s+int\s+(?:un)?signed|
496 long\s+(?:un)?signed\s+int|
497 long\s+(?:un)?signed|
498 (?:(?:un)?signed\s+)?long\s+int|
499 (?:(?:un)?signed\s+)?long|
500 int\s+long\s+(?:un)?signed|
501 int\s+(?:(?:un)?signed\s+)?long|
502
503 int\s+(?:un)?signed|
504 (?:(?:un)?signed\s+)?int
505)};
506
Alex Dowad485ff232015-06-25 15:02:52 -0700507our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700508our @typeListWithAttr = (
509 @typeList,
510 qr{struct\s+$InitAttribute\s+$Ident},
511 qr{union\s+$InitAttribute\s+$Ident},
512);
513
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700514our @modifierList = (
515 qr{fastcall},
516);
Alex Dowad485ff232015-06-25 15:02:52 -0700517our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800518
Joe Perches24358802014-04-03 14:49:13 -0700519our @mode_permission_funcs = (
520 ["module_param", 3],
521 ["module_param_(?:array|named|string)", 4],
522 ["module_param_array_named", 5],
523 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
524 ["proc_create(?:_data|)", 2],
525 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
526);
527
Joe Perches515a2352014-04-03 14:49:24 -0700528#Create a search pattern for all these functions to speed up a loop below
529our $mode_perms_search = "";
530foreach my $entry (@mode_permission_funcs) {
531 $mode_perms_search .= '|' if ($mode_perms_search ne "");
532 $mode_perms_search .= $entry->[0];
533}
534
Joe Perchesb392c642015-04-16 12:44:16 -0700535our $mode_perms_world_writable = qr{
536 S_IWUGO |
537 S_IWOTH |
538 S_IRWXUGO |
539 S_IALLUGO |
540 0[0-7][0-7][2367]
541}x;
542
Wolfram Sang7840a942010-08-09 17:20:57 -0700543our $allowed_asm_includes = qr{(?x:
544 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700545 memory|
546 time|
547 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700548)};
549# memory.h: ARM has a custom one
550
Kees Cook66b47b42014-10-13 15:51:57 -0700551# Load common spelling mistakes and build regular expression list.
552my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700553my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700554
Joe Perches36061e32014-12-10 15:51:43 -0800555if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800556 while (<$spelling>) {
557 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700558
Joe Perches36061e32014-12-10 15:51:43 -0800559 $line =~ s/\s*\n?$//g;
560 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700561
Joe Perches36061e32014-12-10 15:51:43 -0800562 next if ($line =~ m/^\s*#/);
563 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700564
Joe Perches36061e32014-12-10 15:51:43 -0800565 my ($suspect, $fix) = split(/\|\|/, $line);
566
Joe Perches36061e32014-12-10 15:51:43 -0800567 $spelling_fix{$suspect} = $fix;
568 }
569 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800570} else {
571 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700572}
Kees Cook66b47b42014-10-13 15:51:57 -0700573
Joe Perchesebfd7d62015-04-16 12:44:14 -0700574if ($codespell) {
575 if (open(my $spelling, '<', $codespellfile)) {
576 while (<$spelling>) {
577 my $line = $_;
578
579 $line =~ s/\s*\n?$//g;
580 $line =~ s/^\s*//g;
581
582 next if ($line =~ m/^\s*#/);
583 next if ($line =~ m/^\s*$/);
584 next if ($line =~ m/, disabled/i);
585
586 $line =~ s/,.*$//;
587
588 my ($suspect, $fix) = split(/->/, $line);
589
590 $spelling_fix{$suspect} = $fix;
591 }
592 close($spelling);
593 } else {
594 warn "No codespell typos will be found - file '$codespellfile': $!\n";
595 }
596}
597
598$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
599
Andy Whitcroft8905a672007-11-28 16:21:06 -0800600sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700601 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
602 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700603 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700604 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700605 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700606 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700607 (?:$typeTypedefs\b)|
608 (?:${all}\b)
609 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800610 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700611 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800612 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800613 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700614 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700615 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800616 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700617 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800618 }x;
Joe Perches18130872014-08-06 16:11:22 -0700619 $NonptrTypeMisordered = qr{
620 (?:$Modifier\s+|const\s+)*
621 (?:
622 (?:${Misordered}\b)
623 )
624 (?:\s+$Modifier|\s+const)*
625 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700626 $NonptrTypeWithAttr = qr{
627 (?:$Modifier\s+|const\s+)*
628 (?:
629 (?:typeof|__typeof__)\s*\([^\)]*\)|
630 (?:$typeTypedefs\b)|
631 (?:${allWithAttr}\b)
632 )
633 (?:\s+$Modifier|\s+const)*
634 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800635 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700636 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700637 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700638 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800639 }x;
Joe Perches18130872014-08-06 16:11:22 -0700640 $TypeMisordered = qr{
641 $NonptrTypeMisordered
642 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
643 (?:\s+$Inline|\s+$Modifier)*
644 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700645 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700646 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800647}
648build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700649
Joe Perches7d2367a2011-07-25 17:13:22 -0700650our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700651
652# Using $balanced_parens, $LvalOrFunc, or $FuncArg
653# requires at least perl version v5.10.0
654# Any use must be runtime checked with $^V
655
656our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700657our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800658our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700659
Joe Perchesf8422302014-08-06 16:11:31 -0700660our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700661 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700662 (?:$Storage\s+)?LIST_HEAD\s*\(|
663 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
664)};
665
Joe Perches7d2367a2011-07-25 17:13:22 -0700666sub deparenthesize {
667 my ($string) = @_;
668 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700669
670 while ($string =~ /^\s*\(.*\)\s*$/) {
671 $string =~ s@^\s*\(\s*@@;
672 $string =~ s@\s*\)\s*$@@;
673 }
674
Joe Perches7d2367a2011-07-25 17:13:22 -0700675 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700676
Joe Perches7d2367a2011-07-25 17:13:22 -0700677 return $string;
678}
679
Joe Perches34456862013-07-03 15:05:34 -0700680sub seed_camelcase_file {
681 my ($file) = @_;
682
683 return if (!(-f $file));
684
685 local $/;
686
687 open(my $include_file, '<', "$file")
688 or warn "$P: Can't read '$file' $!\n";
689 my $text = <$include_file>;
690 close($include_file);
691
692 my @lines = split('\n', $text);
693
694 foreach my $line (@lines) {
695 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
696 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
697 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800698 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
699 $camelcase{$1} = 1;
700 } 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 -0700701 $camelcase{$1} = 1;
702 }
703 }
704}
705
706my $camelcase_seeded = 0;
707sub seed_camelcase_includes {
708 return if ($camelcase_seeded);
709
710 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700711 my $camelcase_cache = "";
712 my @include_files = ();
713
714 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700715
Richard Genoud3645e322014-02-10 14:25:32 -0800716 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700717 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
718 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700719 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700720 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700721 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700722 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700723 @include_files = split('\n', $files);
724 foreach my $file (@include_files) {
725 my $date = POSIX::strftime("%Y%m%d%H%M",
726 localtime((stat $file)[9]));
727 $last_mod_date = $date if ($last_mod_date < $date);
728 }
729 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700730 }
Joe Perchesc707a812013-07-08 16:00:43 -0700731
732 if ($camelcase_cache ne "" && -f $camelcase_cache) {
733 open(my $camelcase_file, '<', "$camelcase_cache")
734 or warn "$P: Can't read '$camelcase_cache' $!\n";
735 while (<$camelcase_file>) {
736 chomp;
737 $camelcase{$_} = 1;
738 }
739 close($camelcase_file);
740
741 return;
742 }
743
Richard Genoud3645e322014-02-10 14:25:32 -0800744 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700745 $files = `git ls-files "include/*.h"`;
746 @include_files = split('\n', $files);
747 }
748
Joe Perches34456862013-07-03 15:05:34 -0700749 foreach my $file (@include_files) {
750 seed_camelcase_file($file);
751 }
Joe Perches351b2a12013-07-03 15:05:36 -0700752
Joe Perchesc707a812013-07-08 16:00:43 -0700753 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700754 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700755 open(my $camelcase_file, '>', "$camelcase_cache")
756 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700757 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
758 print $camelcase_file ("$_\n");
759 }
760 close($camelcase_file);
761 }
Joe Perches34456862013-07-03 15:05:34 -0700762}
763
Joe Perchesd311cd42014-08-06 16:10:57 -0700764sub git_commit_info {
765 my ($commit, $id, $desc) = @_;
766
767 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
768
769 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
770 $output =~ s/^\s*//gm;
771 my @lines = split("\n", $output);
772
Joe Perches0d7835f2015-02-13 14:38:35 -0800773 return ($id, $desc) if ($#lines < 0);
774
Joe Perchesd311cd42014-08-06 16:10:57 -0700775 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
776# Maybe one day convert this block of bash into something that returns
777# all matching commit ids, but it's very slow...
778#
779# echo "checking commits $1..."
780# git rev-list --remotes | grep -i "^$1" |
781# while read line ; do
782# git log --format='%H %s' -1 $line |
783# echo "commit $(cut -c 1-12,41-)"
784# done
785 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
786 } else {
787 $id = substr($lines[0], 0, 12);
788 $desc = substr($lines[0], 41);
789 }
790
791 return ($id, $desc);
792}
793
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700794$chk_signoff = 0 if ($file);
795
Andy Whitcroft00df3442007-06-08 13:47:06 -0700796my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800797my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700798my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700799my @fixed_inserted = ();
800my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700801my $fixlinenr = -1;
802
Du, Changbin4a593c32016-05-20 17:04:16 -0700803# If input is git commits, extract all commits from the commit expressions.
804# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
805die "$P: No git repository found\n" if ($git && !-e ".git");
806
807if ($git) {
808 my @commits = ();
Joe Perches0dea9f12016-05-20 17:04:19 -0700809 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700810 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700811 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
812 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700813 } elsif ($commit_expr =~ m/\.\./) {
814 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700815 } else {
Joe Perches0dea9f12016-05-20 17:04:19 -0700816 $git_range = "-1 $commit_expr";
817 }
818 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
819 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700820 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
821 next if (!defined($1) || !defined($2));
Joe Perches0dea9f12016-05-20 17:04:19 -0700822 my $sha1 = $1;
823 my $subject = $2;
824 unshift(@commits, $sha1);
825 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700826 }
827 }
828 die "$P: no git commits after extraction!\n" if (@commits == 0);
829 @ARGV = @commits;
830}
831
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800832my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700833for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800834 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700835 if ($git) {
836 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
837 die "$P: $filename: git format-patch failed - $!\n";
838 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800839 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700840 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800841 } elsif ($filename eq '-') {
842 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700843 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800844 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700845 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700846 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800847 if ($filename eq '-') {
848 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700849 } elsif ($git) {
Joe Perches0dea9f12016-05-20 17:04:19 -0700850 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800851 } else {
852 $vname = $filename;
853 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800854 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700855 chomp;
856 push(@rawlines, $_);
857 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800858 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700859
860 if ($#ARGV > 0 && $quiet == 0) {
861 print '-' x length($vname) . "\n";
862 print "$vname\n";
863 print '-' x length($vname) . "\n";
864 }
865
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800866 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700867 $exit = 1;
868 }
869 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800870 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700871 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700872 @fixed_inserted = ();
873 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700874 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700875 @modifierListFile = ();
876 @typeListFile = ();
877 build_types();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700878}
879
Joe Perchesd8469f12015-06-25 15:03:00 -0700880if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700881 hash_show_words(\%use_type, "Used");
882 hash_show_words(\%ignore_type, "Ignored");
883
Joe Perchesd8469f12015-06-25 15:03:00 -0700884 if ($^V lt 5.10.0) {
885 print << "EOM"
886
887NOTE: perl $^V is not modern enough to detect all possible issues.
888 An upgrade to at least perl v5.10.0 is suggested.
889EOM
890 }
891 if ($exit) {
892 print << "EOM"
893
894NOTE: If any of the errors are false positives, please report
895 them to the maintainer, see CHECKPATCH in MAINTAINERS.
896EOM
897 }
898}
899
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700900exit($exit);
901
902sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700903 my ($root) = @_;
904
905 my @tree_check = (
906 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
907 "README", "Documentation", "arch", "include", "drivers",
908 "fs", "init", "ipc", "kernel", "lib", "scripts",
909 );
910
911 foreach my $check (@tree_check) {
912 if (! -e $root . '/' . $check) {
913 return 0;
914 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700915 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700916 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700917}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700918
Joe Perches20112472011-07-25 17:13:23 -0700919sub parse_email {
920 my ($formatted_email) = @_;
921
922 my $name = "";
923 my $address = "";
924 my $comment = "";
925
926 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
927 $name = $1;
928 $address = $2;
929 $comment = $3 if defined $3;
930 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
931 $address = $1;
932 $comment = $2 if defined $2;
933 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
934 $address = $1;
935 $comment = $2 if defined $2;
936 $formatted_email =~ s/$address.*$//;
937 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700938 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700939 $name =~ s/^\"|\"$//g;
940 # If there's a name left after stripping spaces and
941 # leading quotes, and the address doesn't have both
942 # leading and trailing angle brackets, the address
943 # is invalid. ie:
944 # "joe smith joe@smith.com" bad
945 # "joe smith <joe@smith.com" bad
946 if ($name ne "" && $address !~ /^<[^>]+>$/) {
947 $name = "";
948 $address = "";
949 $comment = "";
950 }
951 }
952
Joe Perches3705ce52013-07-03 15:05:31 -0700953 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700954 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700955 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700956 $address =~ s/^\<|\>$//g;
957
958 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
959 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
960 $name = "\"$name\"";
961 }
962
963 return ($name, $address, $comment);
964}
965
966sub format_email {
967 my ($name, $address) = @_;
968
969 my $formatted_email;
970
Joe Perches3705ce52013-07-03 15:05:31 -0700971 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700972 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700973 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700974
975 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
976 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
977 $name = "\"$name\"";
978 }
979
980 if ("$name" eq "") {
981 $formatted_email = "$address";
982 } else {
983 $formatted_email = "$name <$address>";
984 }
985
986 return $formatted_email;
987}
988
Joe Perchesd311cd42014-08-06 16:10:57 -0700989sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700990 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700991
Joe Perchesbd474ca2014-08-06 16:11:10 -0700992 foreach my $path (split(/:/, $ENV{PATH})) {
993 if (-e "$path/$bin") {
994 return "$path/$bin";
995 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700996 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700997
Joe Perchesbd474ca2014-08-06 16:11:10 -0700998 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700999}
1000
Joe Perches000d1cc12011-07-25 17:13:25 -07001001sub which_conf {
1002 my ($conf) = @_;
1003
1004 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1005 if (-e "$path/$conf") {
1006 return "$path/$conf";
1007 }
1008 }
1009
1010 return "";
1011}
1012
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001013sub expand_tabs {
1014 my ($str) = @_;
1015
1016 my $res = '';
1017 my $n = 0;
1018 for my $c (split(//, $str)) {
1019 if ($c eq "\t") {
1020 $res .= ' ';
1021 $n++;
1022 for (; ($n % 8) != 0; $n++) {
1023 $res .= ' ';
1024 }
1025 next;
1026 }
1027 $res .= $c;
1028 $n++;
1029 }
1030
1031 return $res;
1032}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001033sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001034 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001035 return $res;
1036}
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001037
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001038sub line_stats {
1039 my ($line) = @_;
1040
1041 # Drop the diff line leader and expand tabs
1042 $line =~ s/^.//;
1043 $line = expand_tabs($line);
1044
1045 # Pick the indent from the front of the line.
1046 my ($white) = ($line =~ /^(\s*)/);
1047
1048 return (length($line), length($white));
1049}
1050
Andy Whitcroft773647a2008-03-28 14:15:58 -07001051my $sanitise_quote = '';
1052
1053sub sanitise_line_reset {
1054 my ($in_comment) = @_;
1055
1056 if ($in_comment) {
1057 $sanitise_quote = '*/';
1058 } else {
1059 $sanitise_quote = '';
1060 }
1061}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001062sub sanitise_line {
1063 my ($line) = @_;
1064
1065 my $res = '';
1066 my $l = '';
1067
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001068 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001069 my $off = 0;
1070 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001071
Andy Whitcroft773647a2008-03-28 14:15:58 -07001072 # Always copy over the diff marker.
1073 $res = substr($line, 0, 1);
1074
1075 for ($off = 1; $off < length($line); $off++) {
1076 $c = substr($line, $off, 1);
1077
1078 # Comments we are wacking completly including the begin
1079 # and end, all to $;.
1080 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1081 $sanitise_quote = '*/';
1082
1083 substr($res, $off, 2, "$;$;");
1084 $off++;
1085 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001086 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001087 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001088 $sanitise_quote = '';
1089 substr($res, $off, 2, "$;$;");
1090 $off++;
1091 next;
1092 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001093 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1094 $sanitise_quote = '//';
1095
1096 substr($res, $off, 2, $sanitise_quote);
1097 $off++;
1098 next;
1099 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001100
1101 # A \ in a string means ignore the next character.
1102 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1103 $c eq "\\") {
1104 substr($res, $off, 2, 'XX');
1105 $off++;
1106 next;
1107 }
1108 # Regular quotes.
1109 if ($c eq "'" || $c eq '"') {
1110 if ($sanitise_quote eq '') {
1111 $sanitise_quote = $c;
1112
1113 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001114 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001115 } elsif ($sanitise_quote eq $c) {
1116 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001117 }
1118 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001119
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001120 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001121 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1122 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001123 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1124 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001125 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1126 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001127 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001128 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001129 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001130 }
1131
Daniel Walker113f04a2009-09-21 17:04:35 -07001132 if ($sanitise_quote eq '//') {
1133 $sanitise_quote = '';
1134 }
1135
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001136 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001137 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001138 my $clean = 'X' x length($1);
1139 $res =~ s@\<.*\>@<$clean>@;
1140
1141 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001142 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001143 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001144 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001145 }
1146
Andy Whitcroft00df3442007-06-08 13:47:06 -07001147 return $res;
1148}
1149
Joe Perchesa6962d72013-04-29 16:18:13 -07001150sub get_quoted_string {
1151 my ($line, $rawline) = @_;
1152
Joe Perches33acb542015-06-25 15:02:54 -07001153 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001154 return substr($rawline, $-[0], $+[0] - $-[0]);
1155}
1156
Andy Whitcroft8905a672007-11-28 16:21:06 -08001157sub ctx_statement_block {
1158 my ($linenr, $remain, $off) = @_;
1159 my $line = $linenr - 1;
1160 my $blk = '';
1161 my $soff = $off;
1162 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001163 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001164
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001165 my $loff = 0;
1166
Andy Whitcroft8905a672007-11-28 16:21:06 -08001167 my $type = '';
1168 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001169 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001170 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001171 my $c;
1172 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001173
1174 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001175 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001176 @stack = (['', 0]) if ($#stack == -1);
1177
Andy Whitcroft773647a2008-03-28 14:15:58 -07001178 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001179 # If we are about to drop off the end, pull in more
1180 # context.
1181 if ($off >= $len) {
1182 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001183 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001184 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001185 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001186 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001187 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001188 $len = length($blk);
1189 $line++;
1190 last;
1191 }
1192 # Bail if there is no further context.
1193 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001194 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001195 last;
1196 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001197 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1198 $level++;
1199 $type = '#';
1200 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001201 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001202 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001203 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001204 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001205
Andy Whitcroft773647a2008-03-28 14:15:58 -07001206 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001207
1208 # Handle nested #if/#else.
1209 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1210 push(@stack, [ $type, $level ]);
1211 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1212 ($type, $level) = @{$stack[$#stack - 1]};
1213 } elsif ($remainder =~ /^#\s*endif\b/) {
1214 ($type, $level) = @{pop(@stack)};
1215 }
1216
Andy Whitcroft8905a672007-11-28 16:21:06 -08001217 # Statement ends at the ';' or a close '}' at the
1218 # outermost level.
1219 if ($level == 0 && $c eq ';') {
1220 last;
1221 }
1222
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001223 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001224 if ($level == 0 && $coff_set == 0 &&
1225 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1226 $remainder =~ /^(else)(?:\s|{)/ &&
1227 $remainder !~ /^else\s+if\b/) {
1228 $coff = $off + length($1) - 1;
1229 $coff_set = 1;
1230 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1231 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001232 }
1233
Andy Whitcroft8905a672007-11-28 16:21:06 -08001234 if (($type eq '' || $type eq '(') && $c eq '(') {
1235 $level++;
1236 $type = '(';
1237 }
1238 if ($type eq '(' && $c eq ')') {
1239 $level--;
1240 $type = ($level != 0)? '(' : '';
1241
1242 if ($level == 0 && $coff < $soff) {
1243 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001244 $coff_set = 1;
1245 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001246 }
1247 }
1248 if (($type eq '' || $type eq '{') && $c eq '{') {
1249 $level++;
1250 $type = '{';
1251 }
1252 if ($type eq '{' && $c eq '}') {
1253 $level--;
1254 $type = ($level != 0)? '{' : '';
1255
1256 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001257 if (substr($blk, $off + 1, 1) eq ';') {
1258 $off++;
1259 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001260 last;
1261 }
1262 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001263 # Preprocessor commands end at the newline unless escaped.
1264 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1265 $level--;
1266 $type = '';
1267 $off++;
1268 last;
1269 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001270 $off++;
1271 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001272 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001273 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001274 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001275 $line++;
1276 $remain--;
1277 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001278
1279 my $statement = substr($blk, $soff, $off - $soff + 1);
1280 my $condition = substr($blk, $soff, $coff - $soff + 1);
1281
1282 #warn "STATEMENT<$statement>\n";
1283 #warn "CONDITION<$condition>\n";
1284
Andy Whitcroft773647a2008-03-28 14:15:58 -07001285 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001286
1287 return ($statement, $condition,
1288 $line, $remain + 1, $off - $loff + 1, $level);
1289}
1290
Andy Whitcroftcf655042008-03-04 14:28:20 -08001291sub statement_lines {
1292 my ($stmt) = @_;
1293
1294 # Strip the diff line prefixes and rip blank lines at start and end.
1295 $stmt =~ s/(^|\n)./$1/g;
1296 $stmt =~ s/^\s*//;
1297 $stmt =~ s/\s*$//;
1298
1299 my @stmt_lines = ($stmt =~ /\n/g);
1300
1301 return $#stmt_lines + 2;
1302}
1303
1304sub statement_rawlines {
1305 my ($stmt) = @_;
1306
1307 my @stmt_lines = ($stmt =~ /\n/g);
1308
1309 return $#stmt_lines + 2;
1310}
1311
1312sub statement_block_size {
1313 my ($stmt) = @_;
1314
1315 $stmt =~ s/(^|\n)./$1/g;
1316 $stmt =~ s/^\s*{//;
1317 $stmt =~ s/}\s*$//;
1318 $stmt =~ s/^\s*//;
1319 $stmt =~ s/\s*$//;
1320
1321 my @stmt_lines = ($stmt =~ /\n/g);
1322 my @stmt_statements = ($stmt =~ /;/g);
1323
1324 my $stmt_lines = $#stmt_lines + 2;
1325 my $stmt_statements = $#stmt_statements + 1;
1326
1327 if ($stmt_lines > $stmt_statements) {
1328 return $stmt_lines;
1329 } else {
1330 return $stmt_statements;
1331 }
1332}
1333
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001334sub ctx_statement_full {
1335 my ($linenr, $remain, $off) = @_;
1336 my ($statement, $condition, $level);
1337
1338 my (@chunks);
1339
Andy Whitcroftcf655042008-03-04 14:28:20 -08001340 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001341 ($statement, $condition, $linenr, $remain, $off, $level) =
1342 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001343 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001344 push(@chunks, [ $condition, $statement ]);
1345 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1346 return ($level, $linenr, @chunks);
1347 }
1348
1349 # Pull in the following conditional/block pairs and see if they
1350 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001351 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001352 ($statement, $condition, $linenr, $remain, $off, $level) =
1353 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001354 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001355 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001356 #print "C: push\n";
1357 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001358 }
1359
1360 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001361}
1362
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001363sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001364 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001365 my $line;
1366 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001367 my $blk = '';
1368 my @o;
1369 my @c;
1370 my @res = ();
1371
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001372 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001373 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001374 for ($line = $start; $remain > 0; $line++) {
1375 next if ($rawlines[$line] =~ /^-/);
1376 $remain--;
1377
1378 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001379
1380 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001381 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001382 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001383 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001384 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001385 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001386 $level = pop(@stack);
1387 }
1388
Andy Whitcroft01464f32010-10-26 14:23:19 -07001389 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001390 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1391 if ($off > 0) {
1392 $off--;
1393 next;
1394 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001395
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001396 if ($c eq $close && $level > 0) {
1397 $level--;
1398 last if ($level == 0);
1399 } elsif ($c eq $open) {
1400 $level++;
1401 }
1402 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001403
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001404 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001405 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001406 }
1407
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001408 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001409 }
1410
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001411 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001412}
1413sub ctx_block_outer {
1414 my ($linenr, $remain) = @_;
1415
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001416 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1417 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001418}
1419sub ctx_block {
1420 my ($linenr, $remain) = @_;
1421
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001422 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1423 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001424}
1425sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001426 my ($linenr, $remain, $off) = @_;
1427
1428 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1429 return @r;
1430}
1431sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001432 my ($linenr, $remain) = @_;
1433
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001434 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001435}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001436sub ctx_statement_level {
1437 my ($linenr, $remain, $off) = @_;
1438
1439 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1440}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001441
1442sub ctx_locate_comment {
1443 my ($first_line, $end_line) = @_;
1444
1445 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001446 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001447 return $current_comment if (defined $current_comment);
1448
1449 # Look through the context and try and figure out if there is a
1450 # comment.
1451 my $in_comment = 0;
1452 $current_comment = '';
1453 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001454 my $line = $rawlines[$linenr - 1];
1455 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001456 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1457 $in_comment = 1;
1458 }
1459 if ($line =~ m@/\*@) {
1460 $in_comment = 1;
1461 }
1462 if (!$in_comment && $current_comment ne '') {
1463 $current_comment = '';
1464 }
1465 $current_comment .= $line . "\n" if ($in_comment);
1466 if ($line =~ m@\*/@) {
1467 $in_comment = 0;
1468 }
1469 }
1470
1471 chomp($current_comment);
1472 return($current_comment);
1473}
1474sub ctx_has_comment {
1475 my ($first_line, $end_line) = @_;
1476 my $cmt = ctx_locate_comment($first_line, $end_line);
1477
Andy Whitcroft00df3442007-06-08 13:47:06 -07001478 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001479 ##print "CMMT: $cmt\n";
1480
1481 return ($cmt ne '');
1482}
1483
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001484sub raw_line {
1485 my ($linenr, $cnt) = @_;
1486
1487 my $offset = $linenr - 1;
1488 $cnt++;
1489
1490 my $line;
1491 while ($cnt) {
1492 $line = $rawlines[$offset++];
1493 next if (defined($line) && $line =~ /^-/);
1494 $cnt--;
1495 }
1496
1497 return $line;
1498}
1499
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001500sub cat_vet {
1501 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001502 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001503
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001504 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001505 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1506 $res .= $1;
1507 if ($2 ne '') {
1508 $coded = sprintf("^%c", unpack('C', $2) + 64);
1509 $res .= $coded;
1510 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001511 }
1512 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001513
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001514 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001515}
1516
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001517my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001518my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001519my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001520my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001521
1522sub annotate_reset {
1523 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001524 $av_pending = '_';
1525 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001526 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001527}
1528
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001529sub annotate_values {
1530 my ($stream, $type) = @_;
1531
1532 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001533 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001534 my $cur = $stream;
1535
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001536 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001537
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001538 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001539 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001540 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001541 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001542 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001543 print "WS($1)\n" if ($dbg_values > 1);
1544 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001545 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001546 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001547 }
1548
Florian Micklerc023e4732011-01-12 16:59:58 -08001549 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001550 print "CAST($1)\n" if ($dbg_values > 1);
1551 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001552 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001553
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001554 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001555 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001556 $type = 'T';
1557
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001558 } elsif ($cur =~ /^($Modifier)\s*/) {
1559 print "MODIFIER($1)\n" if ($dbg_values > 1);
1560 $type = 'T';
1561
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001562 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001563 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001564 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001565 push(@av_paren_type, $type);
1566 if ($2 ne '') {
1567 $av_pending = 'N';
1568 }
1569 $type = 'E';
1570
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001571 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001572 print "UNDEF($1)\n" if ($dbg_values > 1);
1573 $av_preprocessor = 1;
1574 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001575
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001576 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001577 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001578 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001579
1580 push(@av_paren_type, $type);
1581 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001582 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001583
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001584 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001585 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1586 $av_preprocessor = 1;
1587
1588 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1589
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001590 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001591
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001592 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001593 print "PRE_END($1)\n" if ($dbg_values > 1);
1594
1595 $av_preprocessor = 1;
1596
1597 # Assume all arms of the conditional end as this
1598 # one does, and continue as if the #endif was not here.
1599 pop(@av_paren_type);
1600 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001601 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001602
1603 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001604 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001605
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001606 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1607 print "ATTR($1)\n" if ($dbg_values > 1);
1608 $av_pending = $type;
1609 $type = 'N';
1610
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001611 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001612 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001613 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001614 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001615 }
1616 $type = 'N';
1617
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001618 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001619 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001620 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001621 $type = 'N';
1622
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001623 } elsif ($cur =~/^(case)/o) {
1624 print "CASE($1)\n" if ($dbg_values > 1);
1625 $av_pend_colon = 'C';
1626 $type = 'N';
1627
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001628 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001629 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001630 $type = 'N';
1631
1632 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001633 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001634 push(@av_paren_type, $av_pending);
1635 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001636 $type = 'N';
1637
1638 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001639 my $new_type = pop(@av_paren_type);
1640 if ($new_type ne '_') {
1641 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001642 print "PAREN('$1') -> $type\n"
1643 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001644 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001645 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001646 }
1647
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001648 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001649 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001650 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001651 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001653 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1654 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001655 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001656 } elsif ($type eq 'E') {
1657 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001658 }
1659 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1660 $type = 'V';
1661
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001662 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001663 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001664 $type = 'V';
1665
1666 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001667 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001668 $type = 'N';
1669
Andy Whitcroftcf655042008-03-04 14:28:20 -08001670 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001671 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001672 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001673 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001674
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001675 } elsif ($cur =~/^(,)/) {
1676 print "COMMA($1)\n" if ($dbg_values > 1);
1677 $type = 'C';
1678
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001679 } elsif ($cur =~ /^(\?)/o) {
1680 print "QUESTION($1)\n" if ($dbg_values > 1);
1681 $type = 'N';
1682
1683 } elsif ($cur =~ /^(:)/o) {
1684 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1685
1686 substr($var, length($res), 1, $av_pend_colon);
1687 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1688 $type = 'E';
1689 } else {
1690 $type = 'N';
1691 }
1692 $av_pend_colon = 'O';
1693
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001694 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001695 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001696 $type = 'N';
1697
Andy Whitcroft0d413862008-10-15 22:02:16 -07001698 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001699 my $variant;
1700
1701 print "OPV($1)\n" if ($dbg_values > 1);
1702 if ($type eq 'V') {
1703 $variant = 'B';
1704 } else {
1705 $variant = 'U';
1706 }
1707
1708 substr($var, length($res), 1, $variant);
1709 $type = 'N';
1710
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001711 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001712 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001713 if ($1 ne '++' && $1 ne '--') {
1714 $type = 'N';
1715 }
1716
1717 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001719 }
1720 if (defined $1) {
1721 $cur = substr($cur, length($1));
1722 $res .= $type x length($1);
1723 }
1724 }
1725
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001726 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001727}
1728
Andy Whitcroft8905a672007-11-28 16:21:06 -08001729sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001730 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001731 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001732 ^(?:
1733 $Modifier|
1734 $Storage|
1735 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001736 DEFINE_\S+
1737 )$|
1738 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001739 goto|
1740 return|
1741 case|
1742 else|
1743 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001744 do|
1745 \#|
1746 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001747 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001748 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001749 )}x;
1750 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1751 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001752 # Check for modifiers.
1753 $possible =~ s/\s*$Storage\s*//g;
1754 $possible =~ s/\s*$Sparse\s*//g;
1755 if ($possible =~ /^\s*$/) {
1756
1757 } elsif ($possible =~ /\s/) {
1758 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001759 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001760 if ($modifier !~ $notPermitted) {
1761 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001762 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001763 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001764 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001765
1766 } else {
1767 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001768 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001769 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001770 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001771 } else {
1772 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001773 }
1774}
1775
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001776my $prefix = '';
1777
Joe Perches000d1cc12011-07-25 17:13:25 -07001778sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001779 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001780
Joe Perchescbec18a2014-04-03 14:49:19 -07001781 return defined $use_type{$type} if (scalar keys %use_type > 0);
1782
1783 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001784}
1785
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001786sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001787 my ($level, $type, $msg) = @_;
1788
1789 if (!show_type($type) ||
1790 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001791 return 0;
1792 }
Joe Perches57230292015-06-25 15:03:03 -07001793 my $output = '';
1794 if (-t STDOUT && $color) {
1795 if ($level eq 'ERROR') {
1796 $output .= RED;
1797 } elsif ($level eq 'WARNING') {
1798 $output .= YELLOW;
1799 } else {
1800 $output .= GREEN;
1801 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001802 }
Joe Perches57230292015-06-25 15:03:03 -07001803 $output .= $prefix . $level . ':';
1804 if ($show_types) {
1805 $output .= BLUE if (-t STDOUT && $color);
1806 $output .= "$type:";
1807 }
1808 $output .= RESET if (-t STDOUT && $color);
1809 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001810
1811 if ($showfile) {
1812 my @lines = split("\n", $output, -1);
1813 splice(@lines, 1, 1);
1814 $output = join("\n", @lines);
1815 }
Joe Perches57230292015-06-25 15:03:03 -07001816 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001817
Joe Perches57230292015-06-25 15:03:03 -07001818 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001819
1820 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001821}
Joe Perchescbec18a2014-04-03 14:49:19 -07001822
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001823sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001824 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001825}
Joe Perches000d1cc12011-07-25 17:13:25 -07001826
Joe Perchesd752fcc2014-08-06 16:11:05 -07001827sub fixup_current_range {
1828 my ($lineRef, $offset, $length) = @_;
1829
1830 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1831 my $o = $1;
1832 my $l = $2;
1833 my $no = $o + $offset;
1834 my $nl = $l + $length;
1835 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1836 }
1837}
1838
1839sub fix_inserted_deleted_lines {
1840 my ($linesRef, $insertedRef, $deletedRef) = @_;
1841
1842 my $range_last_linenr = 0;
1843 my $delta_offset = 0;
1844
1845 my $old_linenr = 0;
1846 my $new_linenr = 0;
1847
1848 my $next_insert = 0;
1849 my $next_delete = 0;
1850
1851 my @lines = ();
1852
1853 my $inserted = @{$insertedRef}[$next_insert++];
1854 my $deleted = @{$deletedRef}[$next_delete++];
1855
1856 foreach my $old_line (@{$linesRef}) {
1857 my $save_line = 1;
1858 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001859 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001860 $delta_offset = 0;
1861 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1862 $range_last_linenr = $new_linenr;
1863 fixup_current_range(\$line, $delta_offset, 0);
1864 }
1865
1866 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1867 $deleted = @{$deletedRef}[$next_delete++];
1868 $save_line = 0;
1869 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1870 }
1871
1872 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1873 push(@lines, ${$inserted}{'LINE'});
1874 $inserted = @{$insertedRef}[$next_insert++];
1875 $new_linenr++;
1876 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1877 }
1878
1879 if ($save_line) {
1880 push(@lines, $line);
1881 $new_linenr++;
1882 }
1883
1884 $old_linenr++;
1885 }
1886
1887 return @lines;
1888}
1889
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001890sub fix_insert_line {
1891 my ($linenr, $line) = @_;
1892
1893 my $inserted = {
1894 LINENR => $linenr,
1895 LINE => $line,
1896 };
1897 push(@fixed_inserted, $inserted);
1898}
1899
1900sub fix_delete_line {
1901 my ($linenr, $line) = @_;
1902
1903 my $deleted = {
1904 LINENR => $linenr,
1905 LINE => $line,
1906 };
1907
1908 push(@fixed_deleted, $deleted);
1909}
1910
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001911sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001912 my ($type, $msg) = @_;
1913
1914 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001915 our $clean = 0;
1916 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001917 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001918 }
Joe Perches3705ce52013-07-03 15:05:31 -07001919 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001920}
1921sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001922 my ($type, $msg) = @_;
1923
1924 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001925 our $clean = 0;
1926 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001927 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001928 }
Joe Perches3705ce52013-07-03 15:05:31 -07001929 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001930}
1931sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001932 my ($type, $msg) = @_;
1933
1934 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001935 our $clean = 0;
1936 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001937 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001938 }
Joe Perches3705ce52013-07-03 15:05:31 -07001939 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001940}
1941
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001942sub check_absolute_file {
1943 my ($absolute, $herecurr) = @_;
1944 my $file = $absolute;
1945
1946 ##print "absolute<$absolute>\n";
1947
1948 # See if any suffix of this path is a path within the tree.
1949 while ($file =~ s@^[^/]*/@@) {
1950 if (-f "$root/$file") {
1951 ##print "file<$file>\n";
1952 last;
1953 }
1954 }
1955 if (! -f _) {
1956 return 0;
1957 }
1958
1959 # It is, so see if the prefix is acceptable.
1960 my $prefix = $absolute;
1961 substr($prefix, -length($file)) = '';
1962
1963 ##print "prefix<$prefix>\n";
1964 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001965 WARN("USE_RELATIVE_PATH",
1966 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001967 }
1968}
1969
Joe Perches3705ce52013-07-03 15:05:31 -07001970sub trim {
1971 my ($string) = @_;
1972
Joe Perchesb34c6482013-09-11 14:24:01 -07001973 $string =~ s/^\s+|\s+$//g;
1974
1975 return $string;
1976}
1977
1978sub ltrim {
1979 my ($string) = @_;
1980
1981 $string =~ s/^\s+//;
1982
1983 return $string;
1984}
1985
1986sub rtrim {
1987 my ($string) = @_;
1988
1989 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001990
1991 return $string;
1992}
1993
Joe Perches52ea8502013-11-12 15:10:09 -08001994sub string_find_replace {
1995 my ($string, $find, $replace) = @_;
1996
1997 $string =~ s/$find/$replace/g;
1998
1999 return $string;
2000}
2001
Joe Perches3705ce52013-07-03 15:05:31 -07002002sub tabify {
2003 my ($leading) = @_;
2004
2005 my $source_indent = 8;
2006 my $max_spaces_before_tab = $source_indent - 1;
2007 my $spaces_to_tab = " " x $source_indent;
2008
2009 #convert leading spaces to tabs
2010 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2011 #Remove spaces before a tab
2012 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2013
2014 return "$leading";
2015}
2016
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002017sub pos_last_openparen {
2018 my ($line) = @_;
2019
2020 my $pos = 0;
2021
2022 my $opens = $line =~ tr/\(/\(/;
2023 my $closes = $line =~ tr/\)/\)/;
2024
2025 my $last_openparen = 0;
2026
2027 if (($opens == 0) || ($closes >= $opens)) {
2028 return -1;
2029 }
2030
2031 my $len = length($line);
2032
2033 for ($pos = 0; $pos < $len; $pos++) {
2034 my $string = substr($line, $pos);
2035 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2036 $pos += length($1) - 1;
2037 } elsif (substr($line, $pos, 1) eq '(') {
2038 $last_openparen = $pos;
2039 } elsif (index($string, '(') == -1) {
2040 last;
2041 }
2042 }
2043
Joe Perches91cb5192014-04-03 14:49:32 -07002044 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002045}
2046
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002047sub process {
2048 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002049
2050 my $linenr=0;
2051 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002052 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002053 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002054 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002055
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002056 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002057 my $indent;
2058 my $previndent=0;
2059 my $stashindent=0;
2060
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002061 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002062 my $signoff = 0;
2063 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002064 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002065 my $in_commit_log = 0; #Scanning lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002066 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002067 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002068 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002069 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002070 my $non_utf8_charset = 0;
2071
Joe Perches365dd4e2014-08-06 16:10:42 -07002072 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002073 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002074
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002075 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002076 our $cnt_lines = 0;
2077 our $cnt_error = 0;
2078 our $cnt_warn = 0;
2079 our $cnt_chk = 0;
2080
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002081 # Trace the real file/line as we go.
2082 my $realfile = '';
2083 my $realline = 0;
2084 my $realcnt = 0;
2085 my $here = '';
2086 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002087 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002088 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002089 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002090
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002091 my $prev_values = 'E';
2092
2093 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002094 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002095 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002096 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002097 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002098
Joe Perches7e51f192013-09-11 14:23:57 -07002099 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002100
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002101 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002102 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002103 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002104 my @setup_docs = ();
2105 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002106
Joe Perchesd8b07712013-11-12 15:10:06 -08002107 my $camelcase_file_seeded = 0;
2108
Andy Whitcroft773647a2008-03-28 14:15:58 -07002109 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002110 my $line;
2111 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002112 $linenr++;
2113 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002114
Joe Perches3705ce52013-07-03 15:05:31 -07002115 push(@fixed, $rawline) if ($fix);
2116
Andy Whitcroft773647a2008-03-28 14:15:58 -07002117 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002118 $setup_docs = 0;
2119 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2120 $setup_docs = 1;
2121 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002122 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002123 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002124 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2125 $realline=$1-1;
2126 if (defined $2) {
2127 $realcnt=$3+1;
2128 } else {
2129 $realcnt=1+1;
2130 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002131 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002132
2133 # Guestimate if this is a continuing comment. Run
2134 # the context looking for a comment "edge". If this
2135 # edge is a close comment then we must be in a comment
2136 # at context start.
2137 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002138 my $cnt = $realcnt;
2139 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2140 next if (defined $rawlines[$ln - 1] &&
2141 $rawlines[$ln - 1] =~ /^-/);
2142 $cnt--;
2143 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002144 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002145 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2146 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2147 ($edge) = $1;
2148 last;
2149 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002150 }
2151 if (defined $edge && $edge eq '*/') {
2152 $in_comment = 1;
2153 }
2154
2155 # Guestimate if this is a continuing comment. If this
2156 # is the start of a diff block and this line starts
2157 # ' *' then it is very likely a comment.
2158 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002159 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002160 {
2161 $in_comment = 1;
2162 }
2163
2164 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2165 sanitise_line_reset($in_comment);
2166
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002167 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002168 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002169 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002170 $line = sanitise_line($rawline);
2171 }
2172 push(@lines, $line);
2173
2174 if ($realcnt > 1) {
2175 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2176 } else {
2177 $realcnt = 0;
2178 }
2179
2180 #print "==>$rawline\n";
2181 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002182
2183 if ($setup_docs && $line =~ /^\+/) {
2184 push(@setup_docs, $line);
2185 }
2186 }
2187
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002188 $prefix = '';
2189
Andy Whitcroft773647a2008-03-28 14:15:58 -07002190 $realcnt = 0;
2191 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002192 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002193 foreach my $line (@lines) {
2194 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002195 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002196 my $sline = $line; #copy of $line
2197 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002198
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002199 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002200
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002201#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002202 if (!$in_commit_log &&
2203 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002204 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002205 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002206 $realline=$1-1;
2207 if (defined $2) {
2208 $realcnt=$3+1;
2209 } else {
2210 $realcnt=1+1;
2211 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002212 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002213 $prev_values = 'E';
2214
Andy Whitcroft773647a2008-03-28 14:15:58 -07002215 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002216 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002217 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002218 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002219 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002220
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002221# track the line number as we move through the hunk, note that
2222# new versions of GNU diff omit the leading space on completely
2223# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002224 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002225 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002226 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002227
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002228 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002229 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002230
2231 # Track the previous line.
2232 ($prevline, $stashline) = ($stashline, $line);
2233 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002234 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2235
Andy Whitcroft773647a2008-03-28 14:15:58 -07002236 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002237
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002238 } elsif ($realcnt == 1) {
2239 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002240 }
2241
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002242 my $hunk_line = ($realcnt != 0);
2243
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002244 $here = "#$linenr: " if (!$file);
2245 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002246
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002247 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002248 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002249 if ($line =~ /^diff --git.*?(\S+)$/) {
2250 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002251 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002252 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002253 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002254 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002255 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002256 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002257 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002258
2259 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002260 if (!$file && $tree && $p1_prefix ne '' &&
2261 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002262 WARN("PATCH_PREFIX",
2263 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002264 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002265
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002266 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002267 ERROR("MODIFIED_INCLUDE_ASM",
2268 "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 -07002269 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002270 $found_file = 1;
2271 }
2272
Joe Perches34d88152015-06-25 15:03:05 -07002273#make up the handle for any error we report on this line
2274 if ($showfile) {
2275 $prefix = "$realfile:$realline: "
2276 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002277 if ($file) {
2278 $prefix = "$filename:$realline: ";
2279 } else {
2280 $prefix = "$filename:$linenr: ";
2281 }
Joe Perches34d88152015-06-25 15:03:05 -07002282 }
2283
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002284 if ($found_file) {
Joe Perches7bd7e482015-09-09 15:37:44 -07002285 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002286 $check = 1;
2287 } else {
2288 $check = $check_orig;
2289 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002290 next;
2291 }
2292
Randy Dunlap389834b2007-06-08 13:47:03 -07002293 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002294
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002295 my $hereline = "$here\n$rawline\n";
2296 my $herecurr = "$here\n$rawline\n";
2297 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002298
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002299 $cnt_lines++ if ($realcnt != 0);
2300
Joe Perchese518e9a2015-06-25 15:03:27 -07002301# Check if the commit log has what seems like a diff which can confuse patch
2302 if ($in_commit_log && !$commit_log_has_diff &&
2303 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2304 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2305 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2306 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2307 ERROR("DIFF_IN_COMMIT_MSG",
2308 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2309 $commit_log_has_diff = 1;
2310 }
2311
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002312# Check for incorrect file permissions
2313 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2314 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002315 if ($realfile !~ m@scripts/@ &&
2316 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002317 ERROR("EXECUTE_PERMISSIONS",
2318 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002319 }
2320 }
2321
Joe Perches20112472011-07-25 17:13:23 -07002322# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002323 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002324 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002325 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002326 }
2327
Joe Perchese0d975b2014-12-10 15:51:49 -08002328# Check if MAINTAINERS is being updated. If so, there's probably no need to
2329# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2330 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2331 $reported_maintainer_file = 1;
2332 }
2333
Joe Perches20112472011-07-25 17:13:23 -07002334# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002335 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002336 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002337 my $space_before = $1;
2338 my $sign_off = $2;
2339 my $space_after = $3;
2340 my $email = $4;
2341 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2342
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002343 if ($sign_off !~ /$signature_tags/) {
2344 WARN("BAD_SIGN_OFF",
2345 "Non-standard signature: $sign_off\n" . $herecurr);
2346 }
Joe Perches20112472011-07-25 17:13:23 -07002347 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002348 if (WARN("BAD_SIGN_OFF",
2349 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2350 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002351 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002352 "$ucfirst_sign_off $email";
2353 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002354 }
Joe Perches20112472011-07-25 17:13:23 -07002355 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002356 if (WARN("BAD_SIGN_OFF",
2357 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2358 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002359 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002360 "$ucfirst_sign_off $email";
2361 }
2362
Joe Perches20112472011-07-25 17:13:23 -07002363 }
2364 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002365 if (WARN("BAD_SIGN_OFF",
2366 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2367 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002368 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002369 "$ucfirst_sign_off $email";
2370 }
Joe Perches20112472011-07-25 17:13:23 -07002371 }
2372
2373 my ($email_name, $email_address, $comment) = parse_email($email);
2374 my $suggested_email = format_email(($email_name, $email_address));
2375 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002376 ERROR("BAD_SIGN_OFF",
2377 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002378 } else {
2379 my $dequoted = $suggested_email;
2380 $dequoted =~ s/^"//;
2381 $dequoted =~ s/" </ </;
2382 # Don't force email to have quotes
2383 # Allow just an angle bracketed address
2384 if ("$dequoted$comment" ne $email &&
2385 "<$email_address>$comment" ne $email &&
2386 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002387 WARN("BAD_SIGN_OFF",
2388 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002389 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002390 }
Joe Perches7e51f192013-09-11 14:23:57 -07002391
2392# Check for duplicate signatures
2393 my $sig_nospace = $line;
2394 $sig_nospace =~ s/\s//g;
2395 $sig_nospace = lc($sig_nospace);
2396 if (defined $signatures{$sig_nospace}) {
2397 WARN("BAD_SIGN_OFF",
2398 "Duplicate signature\n" . $herecurr);
2399 } else {
2400 $signatures{$sig_nospace} = 1;
2401 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002402 }
2403
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002404# Check email subject for common tools that don't need to be mentioned
2405 if ($in_header_lines &&
2406 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2407 WARN("EMAIL_SUBJECT",
2408 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2409 }
2410
Joe Perches9b3189e2014-06-04 16:12:10 -07002411# Check for old stable address
2412 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2413 ERROR("STABLE_ADDRESS",
2414 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2415 }
2416
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002417# Check for unwanted Gerrit info
2418 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2419 ERROR("GERRIT_CHANGE_ID",
2420 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2421 }
2422
Joe Perches369c8dd2015-11-06 16:31:34 -08002423# Check if the commit log is in a possible stack dump
2424 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2425 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2426 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2427 # timestamp
2428 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2429 # stack dump address
2430 $commit_log_possible_stack_dump = 1;
2431 }
2432
Joe Perches2a076f42015-04-16 12:44:28 -07002433# Check for line lengths > 75 in commit log, warn once
2434 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002435 length($line) > 75 &&
2436 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2437 # file delta changes
2438 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2439 # filename then :
2440 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2441 # A Fixes: or Link: line
2442 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002443 WARN("COMMIT_LOG_LONG_LINE",
2444 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2445 $commit_log_long_line = 1;
2446 }
2447
Joe Perchesbf4daf12015-09-09 15:37:50 -07002448# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002449 if ($in_commit_log && $commit_log_possible_stack_dump &&
2450 $line =~ /^\s*$/) {
2451 $commit_log_possible_stack_dump = 0;
2452 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002453
Joe Perches0d7835f2015-02-13 14:38:35 -08002454# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002455 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perches879be4f2016-06-03 14:55:49 -07002456 $line !~ /^\s*(?:Link|Patchwork|http|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002457 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perches369c8dd2015-11-06 16:31:34 -08002458 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2459 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2460 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002461 my $init_char = "c";
2462 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002463 my $short = 1;
2464 my $long = 0;
2465 my $case = 1;
2466 my $space = 1;
2467 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002468 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002469 my $id = '0123456789ab';
2470 my $orig_desc = "commit description";
2471 my $description = "";
2472
Joe Perchesfe043ea2015-09-09 15:37:25 -07002473 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2474 $init_char = $1;
2475 $orig_commit = lc($2);
2476 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2477 $orig_commit = lc($1);
2478 }
2479
Joe Perches0d7835f2015-02-13 14:38:35 -08002480 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2481 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2482 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2483 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2484 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2485 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002486 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002487 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2488 defined $rawlines[$linenr] &&
2489 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2490 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002491 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002492 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2493 defined $rawlines[$linenr] &&
2494 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2495 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2496 $orig_desc = $1;
2497 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2498 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002499 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002500 }
2501
2502 ($id, $description) = git_commit_info($orig_commit,
2503 $id, $orig_desc);
2504
Joe Perches19c146a2015-02-13 14:39:00 -08002505 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002506 ERROR("GIT_COMMIT_ID",
2507 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2508 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002509 }
2510
Joe Perches13f19372014-08-06 16:10:59 -07002511# Check for added, moved or deleted files
2512 if (!$reported_maintainer_file && !$in_commit_log &&
2513 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2514 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2515 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2516 (defined($1) || defined($2))))) {
2517 $reported_maintainer_file = 1;
2518 WARN("FILE_PATH_CHANGES",
2519 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2520 }
2521
Andy Whitcroft00df3442007-06-08 13:47:06 -07002522# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002523 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002524 ERROR("CORRUPTED_PATCH",
2525 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002526 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002527 }
2528
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002529# Check for absolute kernel paths.
2530 if ($tree) {
2531 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2532 my $file = $1;
2533
2534 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2535 check_absolute_file($1, $herecurr)) {
2536 #
2537 } else {
2538 check_absolute_file($file, $herecurr);
2539 }
2540 }
2541 }
2542
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002543# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2544 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002545 $rawline !~ m/^$UTF8*$/) {
2546 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2547
2548 my $blank = copy_spacing($rawline);
2549 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2550 my $hereptr = "$hereline$ptr\n";
2551
Joe Perches34d99212011-07-25 17:13:26 -07002552 CHK("INVALID_UTF8",
2553 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002554 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002555
Joe Perches15662b32011-10-31 17:13:12 -07002556# Check if it's the start of a commit log
2557# (not a header line and we haven't seen the patch filename)
2558 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002559 !($rawline =~ /^\s+\S/ ||
2560 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002561 $in_header_lines = 0;
2562 $in_commit_log = 1;
2563 }
2564
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002565# Check if there is UTF-8 in a commit log when a mail header has explicitly
2566# declined it, i.e defined some charset where it is missing.
2567 if ($in_header_lines &&
2568 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2569 $1 !~ /utf-8/i) {
2570 $non_utf8_charset = 1;
2571 }
2572
2573 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002574 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002575 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002576 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2577 }
2578
Kees Cook66b47b42014-10-13 15:51:57 -07002579# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002580 if (defined($misspellings) &&
2581 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002582 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002583 my $typo = $1;
2584 my $typo_fix = $spelling_fix{lc($typo)};
2585 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2586 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2587 my $msg_type = \&WARN;
2588 $msg_type = \&CHK if ($file);
2589 if (&{$msg_type}("TYPO_SPELLING",
2590 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2591 $fix) {
2592 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2593 }
2594 }
2595 }
2596
Andy Whitcroft306708542008-10-15 22:02:28 -07002597# ignore non-hunk lines and lines being removed
2598 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002599
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002600#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002601 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002602 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002603 if (ERROR("DOS_LINE_ENDINGS",
2604 "DOS line endings\n" . $herevet) &&
2605 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002606 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002607 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002608 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2609 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002610 if (ERROR("TRAILING_WHITESPACE",
2611 "trailing whitespace\n" . $herevet) &&
2612 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002613 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002614 }
2615
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002616 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002617 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002618
Josh Triplett4783f892013-11-12 15:10:12 -08002619# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002620 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002621 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2622 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002623 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2624 my $msg_type = \&ERROR;
2625 $msg_type = \&CHK if ($file);
2626 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002627 "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 -08002628 }
2629
Andi Kleen33549572010-05-24 14:33:29 -07002630# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002631# Only applies when adding the entry originally, after that we do not have
2632# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002633 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002634 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002635 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002636 my $cnt = $realcnt;
2637 my $ln = $linenr + 1;
2638 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002639 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002640 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002641 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002642 $f = $lines[$ln - 1];
2643 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2644 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002645
2646 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002647 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002648
Joe Perches8d73e0e2014-08-06 16:10:46 -07002649 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002650 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002651 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002652 $length = -1;
2653 }
2654
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002655 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002656 $f =~ s/#.*//;
2657 $f =~ s/^\s+//;
2658 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002659 if ($f =~ /^\s*config\s/) {
2660 $is_end = 1;
2661 last;
2662 }
Andi Kleen33549572010-05-24 14:33:29 -07002663 $length++;
2664 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002665 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2666 WARN("CONFIG_DESCRIPTION",
2667 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2668 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002669 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002670 }
2671
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002672# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2673 if ($realfile =~ /Kconfig/ &&
2674 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2675 WARN("CONFIG_EXPERIMENTAL",
2676 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2677 }
2678
Christoph Jaeger327953e2015-02-13 14:38:29 -08002679# discourage the use of boolean for type definition attributes of Kconfig options
2680 if ($realfile =~ /Kconfig/ &&
2681 $line =~ /^\+\s*\bboolean\b/) {
2682 WARN("CONFIG_TYPE_BOOLEAN",
2683 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2684 }
2685
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002686 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2687 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2688 my $flag = $1;
2689 my $replacement = {
2690 'EXTRA_AFLAGS' => 'asflags-y',
2691 'EXTRA_CFLAGS' => 'ccflags-y',
2692 'EXTRA_CPPFLAGS' => 'cppflags-y',
2693 'EXTRA_LDFLAGS' => 'ldflags-y',
2694 };
2695
2696 WARN("DEPRECATED_VARIABLE",
2697 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2698 }
2699
Rob Herringbff5da42014-01-23 15:54:51 -08002700# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002701 if (defined $root &&
2702 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2703 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2704
Rob Herringbff5da42014-01-23 15:54:51 -08002705 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2706
Florian Vaussardcc933192014-04-03 14:49:27 -07002707 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2708 my $vp_file = $dt_path . "vendor-prefixes.txt";
2709
Rob Herringbff5da42014-01-23 15:54:51 -08002710 foreach my $compat (@compats) {
2711 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002712 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2713 my $compat3 = $compat;
2714 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2715 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002716 if ( $? >> 8 ) {
2717 WARN("UNDOCUMENTED_DT_STRING",
2718 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2719 }
2720
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002721 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2722 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002723 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002724 if ( $? >> 8 ) {
2725 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002726 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002727 }
2728 }
2729 }
2730
Andy Whitcroft5368df22008-10-15 22:02:27 -07002731# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002732 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002733
Joe Perches47e0c882015-06-25 15:02:57 -07002734# line length limit (with some exclusions)
2735#
2736# There are a few types of lines that may extend beyond $max_line_length:
2737# logging functions like pr_info that end in a string
2738# lines with a single string
2739# #defines that are a single string
2740#
2741# There are 3 different line length message types:
2742# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2743# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2744# LONG_LINE all other lines longer than $max_line_length
2745#
2746# if LONG_LINE is ignored, the other 2 types are also ignored
2747#
2748
Joe Perchesb4749e92015-07-17 16:24:01 -07002749 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002750 my $msg_type = "LONG_LINE";
2751
2752 # Check the allowed long line types first
2753
2754 # logging functions that end in a string that starts
2755 # before $max_line_length
2756 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2757 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2758 $msg_type = "";
2759
2760 # lines with only strings (w/ possible termination)
2761 # #defines with only strings
2762 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2763 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2764 $msg_type = "";
2765
2766 # Otherwise set the alternate message types
2767
2768 # a comment starts before $max_line_length
2769 } elsif ($line =~ /($;[\s$;]*)$/ &&
2770 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2771 $msg_type = "LONG_LINE_COMMENT"
2772
2773 # a quoted string starts before $max_line_length
2774 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2775 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2776 $msg_type = "LONG_LINE_STRING"
2777 }
2778
2779 if ($msg_type ne "" &&
2780 (show_type("LONG_LINE") || show_type($msg_type))) {
2781 WARN($msg_type,
2782 "line over $max_line_length characters\n" . $herecurr);
2783 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002784 }
2785
Andy Whitcroft8905a672007-11-28 16:21:06 -08002786# check for adding lines without a newline.
2787 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002788 WARN("MISSING_EOF_NEWLINE",
2789 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002790 }
2791
Mike Frysinger42e41c52009-09-21 17:04:40 -07002792# Blackfin: use hi/lo macros
2793 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2794 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2795 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002796 ERROR("LO_MACRO",
2797 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002798 }
2799 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2800 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002801 ERROR("HI_MACRO",
2802 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002803 }
2804 }
2805
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002806# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002807 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002808
2809# at the beginning of a line any tabs must come first and anything
2810# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002811 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2812 $rawline =~ /^\+\s* \s*/) {
2813 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002814 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002815 if (ERROR("CODE_INDENT",
2816 "code indent should use tabs where possible\n" . $herevet) &&
2817 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002818 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002819 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002820 }
2821
Alberto Panizzo08e44362010-03-05 13:43:54 -08002822# check for space before tabs.
2823 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2824 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002825 if (WARN("SPACE_BEFORE_TAB",
2826 "please, no space before tabs\n" . $herevet) &&
2827 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002828 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002829 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002830 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002831 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002832 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002833 }
2834
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002835# check for && or || at the start of a line
2836 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2837 CHK("LOGICAL_CONTINUATIONS",
2838 "Logical continuations should be on the previous line\n" . $hereprev);
2839 }
2840
Joe Perchesa91e8992016-05-20 17:04:05 -07002841# check indentation starts on a tab stop
2842 if ($^V && $^V ge 5.10.0 &&
2843 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2844 my $indent = length($1);
2845 if ($indent % 8) {
2846 if (WARN("TABSTOP",
2847 "Statements should start on a tabstop\n" . $herecurr) &&
2848 $fix) {
2849 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2850 }
2851 }
2852 }
2853
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002854# check multi-line statement indentation matches previous line
2855 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002856 $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 -07002857 $prevline =~ /^\+(\t*)(.*)$/;
2858 my $oldindent = $1;
2859 my $rest = $2;
2860
2861 my $pos = pos_last_openparen($rest);
2862 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002863 $line =~ /^(\+| )([ \t]*)/;
2864 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002865
2866 my $goodtabindent = $oldindent .
2867 "\t" x ($pos / 8) .
2868 " " x ($pos % 8);
2869 my $goodspaceindent = $oldindent . " " x $pos;
2870
2871 if ($newindent ne $goodtabindent &&
2872 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002873
2874 if (CHK("PARENTHESIS_ALIGNMENT",
2875 "Alignment should match open parenthesis\n" . $hereprev) &&
2876 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002877 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002878 s/^\+[ \t]*/\+$goodtabindent/;
2879 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002880 }
2881 }
2882 }
2883
Joe Perches6ab3a972015-04-16 12:44:05 -07002884# check for space after cast like "(int) foo" or "(struct foo) bar"
2885# avoid checking a few false positives:
2886# "sizeof(<type>)" or "__alignof__(<type>)"
2887# function pointer declarations like "(*foo)(int) = bar;"
2888# structure definitions like "(struct foo) { 0 };"
2889# multiline macros that define functions
2890# known attributes or the __attribute__ keyword
2891 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2892 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002893 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002894 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002895 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002896 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002897 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002898 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002899 }
2900
Joe Perches86406b12015-09-09 15:37:41 -07002901# Block comment styles
2902# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002903 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002904 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002905 $rawline =~ /^\+[ \t]*\*/ &&
2906 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002907 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2908 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2909 }
2910
Joe Perches86406b12015-09-09 15:37:41 -07002911# Block comments use * on subsequent lines
2912 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2913 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002914 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002915 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002916 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002917 WARN("BLOCK_COMMENT_STYLE",
2918 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002919 }
2920
Joe Perches86406b12015-09-09 15:37:41 -07002921# Block comments use */ on trailing lines
2922 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002923 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2924 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2925 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002926 WARN("BLOCK_COMMENT_STYLE",
2927 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002928 }
2929
Joe Perches7f619192014-08-06 16:10:39 -07002930# check for missing blank lines after struct/union declarations
2931# with exceptions for various attributes and macros
2932 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2933 $line =~ /^\+/ &&
2934 !($line =~ /^\+\s*$/ ||
2935 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2936 $line =~ /^\+\s*MODULE_/i ||
2937 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2938 $line =~ /^\+[a-z_]*init/ ||
2939 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2940 $line =~ /^\+\s*DECLARE/ ||
2941 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002942 if (CHK("LINE_SPACING",
2943 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2944 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002945 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002946 }
Joe Perches7f619192014-08-06 16:10:39 -07002947 }
2948
Joe Perches365dd4e2014-08-06 16:10:42 -07002949# check for multiple consecutive blank lines
2950 if ($prevline =~ /^[\+ ]\s*$/ &&
2951 $line =~ /^\+\s*$/ &&
2952 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002953 if (CHK("LINE_SPACING",
2954 "Please don't use multiple blank lines\n" . $hereprev) &&
2955 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002956 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002957 }
2958
Joe Perches365dd4e2014-08-06 16:10:42 -07002959 $last_blank_line = $linenr;
2960 }
2961
Joe Perches3b617e32014-04-03 14:49:28 -07002962# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002963 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2964 # actual declarations
2965 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002966 # function pointer declarations
2967 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002968 # foo bar; where foo is some local typedef or #define
2969 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2970 # known declaration macros
2971 $prevline =~ /^\+\s+$declaration_macros/) &&
2972 # for "else if" which can look like "$Ident $Ident"
2973 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2974 # other possible extensions of declaration lines
2975 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2976 # not starting a section or a macro "\" extended line
2977 $prevline =~ /(?:\{\s*|\\)$/) &&
2978 # looks like a declaration
2979 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002980 # function pointer declarations
2981 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002982 # foo bar; where foo is some local typedef or #define
2983 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2984 # known declaration macros
2985 $sline =~ /^\+\s+$declaration_macros/ ||
2986 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002987 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002988 # start or end of block or continuation of declaration
2989 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2990 # bitfield continuation
2991 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2992 # other possible extensions of declaration lines
2993 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2994 # indentation of previous and current line are the same
2995 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002996 if (WARN("LINE_SPACING",
2997 "Missing a blank line after declarations\n" . $hereprev) &&
2998 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002999 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003000 }
Joe Perches3b617e32014-04-03 14:49:28 -07003001 }
3002
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003003# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003004# Exceptions:
3005# 1) within comments
3006# 2) indented preprocessor commands
3007# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003008 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003009 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003010 if (WARN("LEADING_SPACE",
3011 "please, no spaces at the start of a line\n" . $herevet) &&
3012 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003013 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003014 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003015 }
3016
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003017# check we are in a valid C source file if not then ignore this hunk
3018 next if ($realfile !~ /\.(h|c)$/);
3019
Joe Perches032a4c02014-08-06 16:10:29 -07003020# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003021# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003022# if the previous line is a break or return and is indented 1 tab more...
3023 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3024 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003025 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3026 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3027 defined $lines[$linenr] &&
3028 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003029 WARN("UNNECESSARY_ELSE",
3030 "else is not generally useful after a break or return\n" . $hereprev);
3031 }
3032 }
3033
Joe Perchesc00df192014-08-06 16:11:01 -07003034# check indentation of a line with a break;
3035# if the previous line is a goto or return and is indented the same # of tabs
3036 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3037 my $tabs = $1;
3038 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3039 WARN("UNNECESSARY_BREAK",
3040 "break is not useful after a goto or return\n" . $hereprev);
3041 }
3042 }
3043
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003044# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3045 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3046 WARN("CONFIG_EXPERIMENTAL",
3047 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3048 }
3049
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003050# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003051 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003052 WARN("CVS_KEYWORD",
3053 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003054 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003055
Mike Frysinger42e41c52009-09-21 17:04:40 -07003056# Blackfin: don't use __builtin_bfin_[cs]sync
3057 if ($line =~ /__builtin_bfin_csync/) {
3058 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003059 ERROR("CSYNC",
3060 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003061 }
3062 if ($line =~ /__builtin_bfin_ssync/) {
3063 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003064 ERROR("SSYNC",
3065 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003066 }
3067
Joe Perches56e77d72013-02-21 16:44:14 -08003068# check for old HOTPLUG __dev<foo> section markings
3069 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3070 WARN("HOTPLUG_SECTION",
3071 "Using $1 is unnecessary\n" . $herecurr);
3072 }
3073
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003074# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003075 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3076 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003077#print "LINE<$line>\n";
3078 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003079 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003080 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003081 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003082 $stat =~ s/\n./\n /g;
3083 $cond =~ s/\n./\n /g;
3084
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003085#print "linenr<$linenr> <$stat>\n";
3086 # If this statement has no statement boundaries within
3087 # it there is no point in retrying a statement scan
3088 # until we hit end of it.
3089 my $frag = $stat; $frag =~ s/;+\s*$//;
3090 if ($frag !~ /(?:{|;)/) {
3091#print "skip<$line_nr_next>\n";
3092 $suppress_statement = $line_nr_next;
3093 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003094
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003095 # Find the real next line.
3096 $realline_next = $line_nr_next;
3097 if (defined $realline_next &&
3098 (!defined $lines[$realline_next - 1] ||
3099 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3100 $realline_next++;
3101 }
3102
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003103 my $s = $stat;
3104 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003105
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003106 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003107 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003108
3109 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003110 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003111
Andy Whitcroft463f2862009-09-21 17:04:34 -07003112 } elsif ($s =~ /^.\s*else\b/s) {
3113
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003114 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003115 } 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 -07003116 my $type = $1;
3117 $type =~ s/\s+/ /g;
3118 possible($type, "A:" . $s);
3119
Andy Whitcroft8905a672007-11-28 16:21:06 -08003120 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003121 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003122 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003123 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003124
3125 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003126 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003127 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003128 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003129
3130 # Check for any sort of function declaration.
3131 # int foo(something bar, other baz);
3132 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003133 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 -08003134 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003135
Andy Whitcroftcf655042008-03-04 14:28:20 -08003136 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003137 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003138 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003139
Andy Whitcroft8905a672007-11-28 16:21:06 -08003140 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003141 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003142
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003143 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003144 }
3145 }
3146 }
3147
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003148 }
3149
Andy Whitcroft653d4872007-06-23 17:16:34 -07003150#
3151# Checks which may be anchored in the context.
3152#
3153
3154# Check for switch () and associated case and default
3155# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003156 if ($line=~/\bswitch\s*\(.*\)/) {
3157 my $err = '';
3158 my $sep = '';
3159 my @ctx = ctx_block_outer($linenr, $realcnt);
3160 shift(@ctx);
3161 for my $ctx (@ctx) {
3162 my ($clen, $cindent) = line_stats($ctx);
3163 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3164 $indent != $cindent) {
3165 $err .= "$sep$ctx\n";
3166 $sep = '';
3167 } else {
3168 $sep = "[...]\n";
3169 }
3170 }
3171 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003172 ERROR("SWITCH_CASE_INDENT_LEVEL",
3173 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003174 }
3175 }
3176
3177# if/while/etc brace do not go on next line, unless defining a do while loop,
3178# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003179 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 -07003180 my $pre_ctx = "$1$2";
3181
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003182 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003183
3184 if ($line =~ /^\+\t{6,}/) {
3185 WARN("DEEP_INDENTATION",
3186 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3187 }
3188
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003189 my $ctx_cnt = $realcnt - $#ctx - 1;
3190 my $ctx = join("\n", @ctx);
3191
Andy Whitcroft548596d2008-07-23 21:29:01 -07003192 my $ctx_ln = $linenr;
3193 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003194
Andy Whitcroft548596d2008-07-23 21:29:01 -07003195 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3196 defined $lines[$ctx_ln - 1] &&
3197 $lines[$ctx_ln - 1] =~ /^-/)) {
3198 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3199 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003200 $ctx_ln++;
3201 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003202
Andy Whitcroft53210162008-07-23 21:29:03 -07003203 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3204 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003205
Joe Perchesd752fcc2014-08-06 16:11:05 -07003206 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003207 ERROR("OPEN_BRACE",
3208 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003209 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003210 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003211 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3212 $ctx =~ /\)\s*\;\s*$/ &&
3213 defined $lines[$ctx_ln - 1])
3214 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003215 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3216 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003217 WARN("TRAILING_SEMICOLON",
3218 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003219 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003220 }
3221 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003222 }
3223
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003224# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003225 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 -08003226 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3227 ctx_statement_block($linenr, $realcnt, 0)
3228 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003229 my ($s, $c) = ($stat, $cond);
3230
3231 substr($s, 0, length($c), '');
3232
Joe Perches9f5af482015-09-09 15:37:30 -07003233 # remove inline comments
3234 $s =~ s/$;/ /g;
3235 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003236
3237 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003238 my @newlines = ($c =~ /\n/gs);
3239 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003240
Joe Perches9f5af482015-09-09 15:37:30 -07003241 # Make sure we remove the line prefixes as we have
3242 # none on the first line, and are going to readd them
3243 # where necessary.
3244 $s =~ s/\n./\n/gs;
3245 while ($s =~ /\n\s+\\\n/) {
3246 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3247 }
3248
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003249 # We want to check the first line inside the block
3250 # starting at the end of the conditional, so remove:
3251 # 1) any blank line termination
3252 # 2) any opening brace { on end of the line
3253 # 3) any do (...) {
3254 my $continuation = 0;
3255 my $check = 0;
3256 $s =~ s/^.*\bdo\b//;
3257 $s =~ s/^\s*{//;
3258 if ($s =~ s/^\s*\\//) {
3259 $continuation = 1;
3260 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003261 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003262 $check = 1;
3263 $cond_lines++;
3264 }
3265
3266 # Also ignore a loop construct at the end of a
3267 # preprocessor statement.
3268 if (($prevline =~ /^.\s*#\s*define\s/ ||
3269 $prevline =~ /\\\s*$/) && $continuation == 0) {
3270 $check = 0;
3271 }
3272
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003273 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003274 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003275 while ($cond_ptr != $cond_lines) {
3276 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003277
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003278 # If we see an #else/#elif then the code
3279 # is not linear.
3280 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3281 $check = 0;
3282 }
3283
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003284 # Ignore:
3285 # 1) blank lines, they should be at 0,
3286 # 2) preprocessor lines, and
3287 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003288 if ($continuation ||
3289 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003290 $s =~ /^\s*#\s*?/ ||
3291 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003292 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003293 if ($s =~ s/^.*?\n//) {
3294 $cond_lines++;
3295 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003296 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003297 }
3298
3299 my (undef, $sindent) = line_stats("+" . $s);
3300 my $stat_real = raw_line($linenr, $cond_lines);
3301
3302 # Check if either of these lines are modified, else
3303 # this is not this patch's fault.
3304 if (!defined($stat_real) ||
3305 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3306 $check = 0;
3307 }
3308 if (defined($stat_real) && $cond_lines > 1) {
3309 $stat_real = "[...]\n$stat_real";
3310 }
3311
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003312 #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 -07003313
Joe Perches9f5af482015-09-09 15:37:30 -07003314 if ($check && $s ne '' &&
3315 (($sindent % 8) != 0 ||
3316 ($sindent < $indent) ||
3317 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003318 WARN("SUSPECT_CODE_INDENT",
3319 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003320 }
3321 }
3322
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003323 # Track the 'values' across context and added lines.
3324 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003325 my ($curr_values, $curr_vars) =
3326 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003327 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003328 if ($dbg_values) {
3329 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003330 print "$linenr > .$outline\n";
3331 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003332 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003333 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003334 $prev_values = substr($curr_values, -1);
3335
Andy Whitcroft00df3442007-06-08 13:47:06 -07003336#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003337 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003338
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003339# check for declarations of signed or unsigned without int
Joe Perches207a8e82016-03-15 14:58:06 -07003340 while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003341 my $type = $1;
3342 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003343 $var = "" if (!defined $var);
3344 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003345 my $sign = $1;
3346 my $pointer = $2;
3347
3348 $pointer = "" if (!defined $pointer);
3349
3350 if (WARN("UNSPECIFIED_INT",
3351 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3352 $fix) {
3353 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003354 my $comp_pointer = $pointer;
3355 $comp_pointer =~ s/\s//g;
3356 $decl .= $comp_pointer;
3357 $decl = rtrim($decl) if ($var eq "");
3358 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003359 }
3360 }
3361 }
3362
Andy Whitcroft653d4872007-06-23 17:16:34 -07003363# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003364 if ($dbg_type) {
3365 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003366 ERROR("TEST_TYPE",
3367 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003368 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003369 ERROR("TEST_NOT_TYPE",
3370 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003371 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003372 next;
3373 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003374# TEST: allow direct testing of the attribute matcher.
3375 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003376 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003377 ERROR("TEST_ATTR",
3378 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003379 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003380 ERROR("TEST_NOT_ATTR",
3381 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003382 }
3383 next;
3384 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003385
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003386# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003387 if ($line =~ /^.\s*{/ &&
3388 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003389 if (ERROR("OPEN_BRACE",
3390 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003391 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3392 fix_delete_line($fixlinenr - 1, $prevrawline);
3393 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003394 my $fixedline = $prevrawline;
3395 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003396 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003397 $fixedline = $line;
3398 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003399 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003400 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003401 }
3402
Andy Whitcroft653d4872007-06-23 17:16:34 -07003403#
3404# Checks which are anchored on the added line.
3405#
3406
3407# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003408 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003409 my $path = $1;
3410 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003411 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003412 "malformed #include filename\n" . $herecurr);
3413 }
3414 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3415 ERROR("UAPI_INCLUDE",
3416 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003417 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003418 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003419
3420# no C99 // comments
3421 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003422 if (ERROR("C99_COMMENTS",
3423 "do not use C99 // comments\n" . $herecurr) &&
3424 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003425 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003426 if ($line =~ /\/\/(.*)$/) {
3427 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003428 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003429 }
3430 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003431 }
3432 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003433 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003434 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003435
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003436# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3437# the whole statement.
3438#print "APW <$lines[$realline_next - 1]>\n";
3439 if (defined $realline_next &&
3440 exists $lines[$realline_next - 1] &&
3441 !defined $suppress_export{$realline_next} &&
3442 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3443 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003444 # Handle definitions which produce identifiers with
3445 # a prefix:
3446 # XXX(foo);
3447 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003448 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003449 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003450 $name =~ /^${Ident}_$2/) {
3451#print "FOO C name<$name>\n";
3452 $suppress_export{$realline_next} = 1;
3453
3454 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003455 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003456 ^.DEFINE_$Ident\(\Q$name\E\)|
3457 ^.DECLARE_$Ident\(\Q$name\E\)|
3458 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003459 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3460 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003461 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003462#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3463 $suppress_export{$realline_next} = 2;
3464 } else {
3465 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003466 }
3467 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003468 if (!defined $suppress_export{$linenr} &&
3469 $prevline =~ /^.\s*$/ &&
3470 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3471 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3472#print "FOO B <$lines[$linenr - 1]>\n";
3473 $suppress_export{$linenr} = 2;
3474 }
3475 if (defined $suppress_export{$linenr} &&
3476 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003477 WARN("EXPORT_SYMBOL",
3478 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003479 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003480
Joe Eloff5150bda2010-08-09 17:21:00 -07003481# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003482 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003483 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003484 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003485 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003486 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003487 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003488 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003489# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003490 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003491 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003492 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003493 $herecurr) &&
3494 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003495 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003496 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003497 }
3498
Joe Perches18130872014-08-06 16:11:22 -07003499# check for misordered declarations of char/short/int/long with signed/unsigned
3500 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3501 my $tmp = trim($1);
3502 WARN("MISORDERED_TYPE",
3503 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3504 }
3505
Joe Perchescb710ec2010-10-26 14:23:20 -07003506# check for static const char * arrays.
3507 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003508 WARN("STATIC_CONST_CHAR_ARRAY",
3509 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003510 $herecurr);
3511 }
3512
3513# check for static char foo[] = "bar" declarations.
3514 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003515 WARN("STATIC_CONST_CHAR_ARRAY",
3516 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003517 $herecurr);
3518 }
3519
Joe Perchesab7e23f2015-04-16 12:44:22 -07003520# check for const <foo> const where <foo> is not a pointer or array type
3521 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3522 my $found = $1;
3523 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3524 WARN("CONST_CONST",
3525 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3526 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3527 WARN("CONST_CONST",
3528 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3529 }
3530 }
3531
Joe Perches9b0fa602014-04-03 14:49:18 -07003532# check for non-global char *foo[] = {"bar", ...} declarations.
3533 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3534 WARN("STATIC_CONST_CHAR_ARRAY",
3535 "char * array declaration might be better as static const\n" .
3536 $herecurr);
3537 }
3538
Joe Perchesb598b672015-04-16 12:44:36 -07003539# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3540 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3541 my $array = $1;
3542 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3543 my $array_div = $1;
3544 if (WARN("ARRAY_SIZE",
3545 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3546 $fix) {
3547 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3548 }
3549 }
3550 }
3551
Joe Perchesb36190c2014-01-27 17:07:18 -08003552# check for function declarations without arguments like "int foo()"
3553 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3554 if (ERROR("FUNCTION_WITHOUT_ARGS",
3555 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3556 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003557 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003558 }
3559 }
3560
Joe Perches92e112f2013-12-13 11:36:22 -07003561# check for uses of DEFINE_PCI_DEVICE_TABLE
3562 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3563 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3564 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3565 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003566 $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 -07003567 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003568 }
3569
Andy Whitcroft653d4872007-06-23 17:16:34 -07003570# check for new typedefs, only function parameters and sparse annotations
3571# make sense.
3572 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003573 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003574 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003575 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003576 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003577 WARN("NEW_TYPEDEFS",
3578 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003579 }
3580
3581# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003582 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003583 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3584 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003585 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003586
Andy Whitcroft65863862009-01-06 14:41:21 -08003587 # Should start with a space.
3588 $to =~ s/^(\S)/ $1/;
3589 # Should not end with a space.
3590 $to =~ s/\s+$//;
3591 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003592 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003593 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003594
Joe Perches3705ce52013-07-03 15:05:31 -07003595## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003596 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003597 if (ERROR("POINTER_LOCATION",
3598 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3599 $fix) {
3600 my $sub_from = $ident;
3601 my $sub_to = $ident;
3602 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003603 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003604 s@\Q$sub_from\E@$sub_to@;
3605 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003606 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003607 }
3608 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3609 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003610 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003611
Andy Whitcroft65863862009-01-06 14:41:21 -08003612 # Should start with a space.
3613 $to =~ s/^(\S)/ $1/;
3614 # Should not end with a space.
3615 $to =~ s/\s+$//;
3616 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003617 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003618 }
3619 # Modifiers should have spaces.
3620 $to =~ s/(\b$Modifier$)/$1 /;
3621
Joe Perches3705ce52013-07-03 15:05:31 -07003622## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003623 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003624 if (ERROR("POINTER_LOCATION",
3625 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3626 $fix) {
3627
3628 my $sub_from = $match;
3629 my $sub_to = $match;
3630 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003631 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003632 s@\Q$sub_from\E@$sub_to@;
3633 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003634 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003635 }
3636
Joe Perches9d3e3c72015-09-09 15:37:27 -07003637# avoid BUG() or BUG_ON()
3638 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3639 my $msg_type = \&WARN;
3640 $msg_type = \&CHK if ($file);
3641 &{$msg_type}("AVOID_BUG",
3642 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3643 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003644
Joe Perches9d3e3c72015-09-09 15:37:27 -07003645# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003646 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003647 WARN("LINUX_VERSION_CODE",
3648 "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 -08003649 }
3650
Joe Perches17441222011-06-15 15:08:17 -07003651# check for uses of printk_ratelimit
3652 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003653 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003654 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003655 }
3656
Andy Whitcroft00df3442007-06-08 13:47:06 -07003657# printk should use KERN_* levels. Note that follow on printk's on the
3658# same line do not need a level, so we use the current block context
3659# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003660# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003661# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003662 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003663 my $ok = 0;
3664 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3665 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003666 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003667 # with "\n" ignore it, else it is to blame
3668 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3669 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3670 $ok = 1;
3671 }
3672 last;
3673 }
3674 }
3675 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003676 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3677 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003678 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003679 }
3680
Joe Perches243f3802012-05-31 16:26:09 -07003681 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3682 my $orig = $1;
3683 my $level = lc($orig);
3684 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003685 my $level2 = $level;
3686 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003687 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003688 "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 -07003689 }
3690
3691 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003692 if (WARN("PREFER_PR_LEVEL",
3693 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3694 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003695 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003696 s/\bpr_warning\b/pr_warn/;
3697 }
Joe Perches243f3802012-05-31 16:26:09 -07003698 }
3699
Joe Perchesdc139312013-02-21 16:44:13 -08003700 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3701 my $orig = $1;
3702 my $level = lc($orig);
3703 $level = "warn" if ($level eq "warning");
3704 $level = "dbg" if ($level eq "debug");
3705 WARN("PREFER_DEV_LEVEL",
3706 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3707 }
3708
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003709# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3710# number of false positives, but assembly files are not checked, so at
3711# least the arch entry code will not trigger this warning.
3712 if ($line =~ /\bENOSYS\b/) {
3713 WARN("ENOSYS",
3714 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3715 }
3716
Andy Whitcroft653d4872007-06-23 17:16:34 -07003717# function brace can't be on same line, except for #defines of do while,
3718# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003719 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003720 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003721 if (ERROR("OPEN_BRACE",
3722 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3723 $fix) {
3724 fix_delete_line($fixlinenr, $rawline);
3725 my $fixed_line = $rawline;
3726 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3727 my $line1 = $1;
3728 my $line2 = $2;
3729 fix_insert_line($fixlinenr, ltrim($line1));
3730 fix_insert_line($fixlinenr, "\+{");
3731 if ($line2 !~ /^\s*$/) {
3732 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3733 }
3734 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003735 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003736
Andy Whitcroft8905a672007-11-28 16:21:06 -08003737# open braces for enum, union and struct go on the same line.
3738 if ($line =~ /^.\s*{/ &&
3739 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003740 if (ERROR("OPEN_BRACE",
3741 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3742 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3743 fix_delete_line($fixlinenr - 1, $prevrawline);
3744 fix_delete_line($fixlinenr, $rawline);
3745 my $fixedline = rtrim($prevrawline) . " {";
3746 fix_insert_line($fixlinenr, $fixedline);
3747 $fixedline = $rawline;
3748 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3749 if ($fixedline !~ /^\+\s*$/) {
3750 fix_insert_line($fixlinenr, $fixedline);
3751 }
3752 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003753 }
3754
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003755# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003756 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3757 if (WARN("SPACING",
3758 "missing space after $1 definition\n" . $herecurr) &&
3759 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003760 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003761 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3762 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003763 }
3764
Joe Perches31070b52014-01-23 15:54:49 -08003765# Function pointer declarations
3766# check spacing between type, funcptr, and args
3767# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003768 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003769 my $declare = $1;
3770 my $pre_pointer_space = $2;
3771 my $post_pointer_space = $3;
3772 my $funcname = $4;
3773 my $post_funcname_space = $5;
3774 my $pre_args_space = $6;
3775
Joe Perches91f72e92014-04-03 14:49:12 -07003776# the $Declare variable will capture all spaces after the type
3777# so check it for a missing trailing missing space but pointer return types
3778# don't need a space so don't warn for those.
3779 my $post_declare_space = "";
3780 if ($declare =~ /(\s+)$/) {
3781 $post_declare_space = $1;
3782 $declare = rtrim($declare);
3783 }
3784 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003785 WARN("SPACING",
3786 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003787 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003788 }
3789
3790# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003791# This test is not currently implemented because these declarations are
3792# equivalent to
3793# int foo(int bar, ...)
3794# and this is form shouldn't/doesn't generate a checkpatch warning.
3795#
3796# elsif ($declare =~ /\s{2,}$/) {
3797# WARN("SPACING",
3798# "Multiple spaces after return type\n" . $herecurr);
3799# }
Joe Perches31070b52014-01-23 15:54:49 -08003800
3801# unnecessary space "type ( *funcptr)(args...)"
3802 if (defined $pre_pointer_space &&
3803 $pre_pointer_space =~ /^\s/) {
3804 WARN("SPACING",
3805 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3806 }
3807
3808# unnecessary space "type (* funcptr)(args...)"
3809 if (defined $post_pointer_space &&
3810 $post_pointer_space =~ /^\s/) {
3811 WARN("SPACING",
3812 "Unnecessary space before function pointer name\n" . $herecurr);
3813 }
3814
3815# unnecessary space "type (*funcptr )(args...)"
3816 if (defined $post_funcname_space &&
3817 $post_funcname_space =~ /^\s/) {
3818 WARN("SPACING",
3819 "Unnecessary space after function pointer name\n" . $herecurr);
3820 }
3821
3822# unnecessary space "type (*funcptr) (args...)"
3823 if (defined $pre_args_space &&
3824 $pre_args_space =~ /^\s/) {
3825 WARN("SPACING",
3826 "Unnecessary space before function pointer arguments\n" . $herecurr);
3827 }
3828
3829 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003830 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003831 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003832 }
3833 }
3834
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003835# check for spacing round square brackets; allowed:
3836# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003837# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3838# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003839 while ($line =~ /(.*?\s)\[/g) {
3840 my ($where, $prefix) = ($-[1], $1);
3841 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003842 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003843 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003844 if (ERROR("BRACKET_SPACE",
3845 "space prohibited before open square bracket '['\n" . $herecurr) &&
3846 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003847 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003848 s/^(\+.*?)\s+\[/$1\[/;
3849 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003850 }
3851 }
3852
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003853# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003854 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003855 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003856 my $ctx_before = substr($line, 0, $-[1]);
3857 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003858
3859 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003860 if ($name =~ /^(?:
3861 if|for|while|switch|return|case|
3862 volatile|__volatile__|
3863 __attribute__|format|__extension__|
3864 asm|__asm__)$/x)
3865 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003866 # cpp #define statements have non-optional spaces, ie
3867 # if there is a space between the name and the open
3868 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003869 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003870
3871 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003872 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003873
3874 # If this whole things ends with a type its most
3875 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003876 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003877
3878 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003879 if (WARN("SPACING",
3880 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3881 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003882 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003883 s/\b$name\s+\(/$name\(/;
3884 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003885 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003886 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003887
Andy Whitcroft653d4872007-06-23 17:16:34 -07003888# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003889 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003890 my $fixed_line = "";
3891 my $line_fixed = 0;
3892
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003893 my $ops = qr{
3894 <<=|>>=|<=|>=|==|!=|
3895 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3896 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003897 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003898 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003899 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003900 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003901
3902## print("element count: <" . $#elements . ">\n");
3903## foreach my $el (@elements) {
3904## print("el: <$el>\n");
3905## }
3906
3907 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003908 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003909
Joe Perches3705ce52013-07-03 15:05:31 -07003910 foreach my $el (@elements) {
3911 push(@fix_elements, substr($rawline, $off, length($el)));
3912 $off += length($el);
3913 }
3914
3915 $off = 0;
3916
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003917 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003918 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003919
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003920 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003921
3922 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3923
3924## print("n: <$n> good: <$good>\n");
3925
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003926 $off += length($elements[$n]);
3927
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003928 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003929 my $ca = substr($opline, 0, $off);
3930 my $cc = '';
3931 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3932 $cc = substr($opline, $off + length($elements[$n + 1]));
3933 }
3934 my $cb = "$ca$;$cc";
3935
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003936 my $a = '';
3937 $a = 'V' if ($elements[$n] ne '');
3938 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003939 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003940 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3941 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003942 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003943
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003944 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003945
3946 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003947 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003948 $c = 'V' if ($elements[$n + 2] ne '');
3949 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003950 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003951 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3952 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003953 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003954 } else {
3955 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003956 }
3957
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003958 my $ctx = "${a}x${c}";
3959
3960 my $at = "(ctx:$ctx)";
3961
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003962 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003963 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003964
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003965 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003966 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003967
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003968 # Get the full operator variant.
3969 my $opv = $op . substr($curr_vars, $off, 1);
3970
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003971 # Ignore operators passed as parameters.
3972 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003973 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003974
Andy Whitcroftcf655042008-03-04 14:28:20 -08003975# # Ignore comments
3976# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003977
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003978 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003979 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003980 if ($ctx !~ /.x[WEBC]/ &&
3981 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003982 if (ERROR("SPACING",
3983 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003984 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003985 $line_fixed = 1;
3986 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003987 }
3988
3989 # // is a comment
3990 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003991
Joe Perchesb00e4812014-04-03 14:49:33 -07003992 # : when part of a bitfield
3993 } elsif ($opv eq ':B') {
3994 # skip the bitfield test for now
3995
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003996 # No spaces for:
3997 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003998 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003999 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004000 if (ERROR("SPACING",
4001 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004002 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004003 if (defined $fix_elements[$n + 2]) {
4004 $fix_elements[$n + 2] =~ s/^\s+//;
4005 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004006 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004007 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004008 }
4009
Joe Perches23810972014-12-10 15:51:32 -08004010 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004011 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004012 my $rtrim_before = 0;
4013 my $space_after = 0;
4014 if ($ctx =~ /Wx./) {
4015 if (ERROR("SPACING",
4016 "space prohibited before that '$op' $at\n" . $hereptr)) {
4017 $line_fixed = 1;
4018 $rtrim_before = 1;
4019 }
4020 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004021 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004022 if (ERROR("SPACING",
4023 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004024 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004025 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004026 $space_after = 1;
4027 }
4028 }
4029 if ($rtrim_before || $space_after) {
4030 if ($rtrim_before) {
4031 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4032 } else {
4033 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4034 }
4035 if ($space_after) {
4036 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004037 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004038 }
4039
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004040 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004041 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004042 #warn "'*' is part of type\n";
4043
4044 # unary operators should have a space before and
4045 # none after. May be left adjacent to another
4046 # unary operator, or a cast
4047 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004048 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004049 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004050 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004051 if (ERROR("SPACING",
4052 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004053 if ($n != $last_after + 2) {
4054 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4055 $line_fixed = 1;
4056 }
Joe Perches3705ce52013-07-03 15:05:31 -07004057 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004058 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004059 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004060 # A unary '*' may be const
4061
4062 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004063 if (ERROR("SPACING",
4064 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004065 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004066 if (defined $fix_elements[$n + 2]) {
4067 $fix_elements[$n + 2] =~ s/^\s+//;
4068 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004069 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004070 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004071 }
4072
4073 # unary ++ and unary -- are allowed no space on one side.
4074 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004075 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004076 if (ERROR("SPACING",
4077 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004078 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004079 $line_fixed = 1;
4080 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004081 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004082 if ($ctx =~ /Wx[BE]/ ||
4083 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004084 if (ERROR("SPACING",
4085 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004086 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004087 $line_fixed = 1;
4088 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004089 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004090 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004091 if (ERROR("SPACING",
4092 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004093 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004094 if (defined $fix_elements[$n + 2]) {
4095 $fix_elements[$n + 2] =~ s/^\s+//;
4096 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004097 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004098 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004099 }
4100
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004101 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004102 } elsif ($op eq '<<' or $op eq '>>' or
4103 $op eq '&' or $op eq '^' or $op eq '|' or
4104 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004105 $op eq '*' or $op eq '/' or
4106 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004107 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004108 if ($check) {
4109 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4110 if (CHK("SPACING",
4111 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4112 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4113 $fix_elements[$n + 2] =~ s/^\s+//;
4114 $line_fixed = 1;
4115 }
4116 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4117 if (CHK("SPACING",
4118 "space preferred before that '$op' $at\n" . $hereptr)) {
4119 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4120 $line_fixed = 1;
4121 }
4122 }
4123 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004124 if (ERROR("SPACING",
4125 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004126 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4127 if (defined $fix_elements[$n + 2]) {
4128 $fix_elements[$n + 2] =~ s/^\s+//;
4129 }
Joe Perches3705ce52013-07-03 15:05:31 -07004130 $line_fixed = 1;
4131 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004132 }
4133
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004134 # A colon needs no spaces before when it is
4135 # terminating a case value or a label.
4136 } elsif ($opv eq ':C' || $opv eq ':L') {
4137 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004138 if (ERROR("SPACING",
4139 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004140 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004141 $line_fixed = 1;
4142 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004143 }
4144
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004145 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004146 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004147 my $ok = 0;
4148
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004149 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004150 if (($op eq '<' &&
4151 $cc =~ /^\S+\@\S+>/) ||
4152 ($op eq '>' &&
4153 $ca =~ /<\S+\@\S+$/))
4154 {
4155 $ok = 1;
4156 }
4157
Joe Perchese0df7e12015-04-16 12:44:53 -07004158 # for asm volatile statements
4159 # ignore a colon with another
4160 # colon immediately before or after
4161 if (($op eq ':') &&
4162 ($ca =~ /:$/ || $cc =~ /^:/)) {
4163 $ok = 1;
4164 }
4165
Joe Perches84731622013-11-12 15:10:05 -08004166 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004167 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004168 my $msg_type = \&ERROR;
4169 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4170
4171 if (&{$msg_type}("SPACING",
4172 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004173 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4174 if (defined $fix_elements[$n + 2]) {
4175 $fix_elements[$n + 2] =~ s/^\s+//;
4176 }
Joe Perches3705ce52013-07-03 15:05:31 -07004177 $line_fixed = 1;
4178 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004179 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004180 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004181 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004182
4183## print("n: <$n> GOOD: <$good>\n");
4184
4185 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004186 }
Joe Perches3705ce52013-07-03 15:05:31 -07004187
4188 if (($#elements % 2) == 0) {
4189 $fixed_line = $fixed_line . $fix_elements[$#elements];
4190 }
4191
Joe Perches194f66f2014-08-06 16:11:03 -07004192 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4193 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004194 }
4195
4196
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004197 }
4198
Joe Perches786b6322013-07-03 15:05:32 -07004199# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004200 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004201 if (WARN("SPACING",
4202 "space prohibited before semicolon\n" . $herecurr) &&
4203 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004204 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004205 s/^(\+.*\S)\s+;/$1;/;
4206 }
4207 }
4208
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004209# check for multiple assignments
4210 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004211 CHK("MULTIPLE_ASSIGNMENTS",
4212 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004213 }
4214
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004215## # check for multiple declarations, allowing for a function declaration
4216## # continuation.
4217## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4218## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4219##
4220## # Remove any bracketed sections to ensure we do not
4221## # falsly report the parameters of functions.
4222## my $ln = $line;
4223## while ($ln =~ s/\([^\(\)]*\)//g) {
4224## }
4225## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004226## WARN("MULTIPLE_DECLARATION",
4227## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004228## }
4229## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004230
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004231#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004232 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004233 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004234 if (ERROR("SPACING",
4235 "space required before the open brace '{'\n" . $herecurr) &&
4236 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004237 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004238 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004239 }
4240
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004241## # check for blank lines before declarations
4242## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4243## $prevrawline =~ /^.\s*$/) {
4244## WARN("SPACING",
4245## "No blank lines before declarations\n" . $hereprev);
4246## }
4247##
4248
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004249# closing brace should have a space following it when it has anything
4250# on the line
4251 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004252 if (ERROR("SPACING",
4253 "space required after that close brace '}'\n" . $herecurr) &&
4254 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004255 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004256 s/}((?!(?:,|;|\)))\S)/} $1/;
4257 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004258 }
4259
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004260# check spacing on square brackets
4261 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004262 if (ERROR("SPACING",
4263 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4264 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004265 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004266 s/\[\s+/\[/;
4267 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004268 }
4269 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004270 if (ERROR("SPACING",
4271 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4272 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004273 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004274 s/\s+\]/\]/;
4275 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004276 }
4277
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004278# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004279 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4280 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004281 if (ERROR("SPACING",
4282 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4283 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004284 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004285 s/\(\s+/\(/;
4286 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004287 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004288 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004289 $line !~ /for\s*\(.*;\s+\)/ &&
4290 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004291 if (ERROR("SPACING",
4292 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4293 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004294 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004295 s/\s+\)/\)/;
4296 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004297 }
4298
Joe Perchese2826fd2014-08-06 16:10:48 -07004299# check unnecessary parentheses around addressof/dereference single $Lvals
4300# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4301
4302 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004303 my $var = $1;
4304 if (CHK("UNNECESSARY_PARENTHESES",
4305 "Unnecessary parentheses around $var\n" . $herecurr) &&
4306 $fix) {
4307 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4308 }
4309 }
4310
4311# check for unnecessary parentheses around function pointer uses
4312# ie: (foo->bar)(); should be foo->bar();
4313# but not "if (foo->bar) (" to avoid some false positives
4314 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4315 my $var = $2;
4316 if (CHK("UNNECESSARY_PARENTHESES",
4317 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4318 $fix) {
4319 my $var2 = deparenthesize($var);
4320 $var2 =~ s/\s//g;
4321 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4322 }
4323 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004324
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004325#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004326 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004327 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004328 if (WARN("INDENTED_LABEL",
4329 "labels should not be indented\n" . $herecurr) &&
4330 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004331 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004332 s/^(.)\s+/$1/;
4333 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004334 }
4335
Joe Perches5b9553a2014-04-03 14:49:21 -07004336# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004337 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004338 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004339 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004340 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4341 my $value = $1;
4342 $value = deparenthesize($value);
4343 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4344 ERROR("RETURN_PARENTHESES",
4345 "return is not a function, parentheses are not required\n" . $herecurr);
4346 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004347 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004348 ERROR("SPACING",
4349 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004350 }
4351 }
Joe Perches507e5142013-11-12 15:10:13 -08004352
Joe Perchesb43ae212014-06-23 13:22:07 -07004353# unnecessary return in a void function
4354# at end-of-function, with the previous line a single leading tab, then return;
4355# and the line before that not a goto label target like "out:"
4356 if ($sline =~ /^[ \+]}\s*$/ &&
4357 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4358 $linenr >= 3 &&
4359 $lines[$linenr - 3] =~ /^[ +]/ &&
4360 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004361 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004362 "void function return statements are not generally useful\n" . $hereprev);
4363 }
Joe Perches9819cf22014-06-04 16:12:09 -07004364
Joe Perches189248d2014-01-23 15:54:47 -08004365# if statements using unnecessary parentheses - ie: if ((foo == bar))
4366 if ($^V && $^V ge 5.10.0 &&
4367 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4368 my $openparens = $1;
4369 my $count = $openparens =~ tr@\(@\(@;
4370 my $msg = "";
4371 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4372 my $comp = $4; #Not $1 because of $LvalOrFunc
4373 $msg = " - maybe == should be = ?" if ($comp eq "==");
4374 WARN("UNNECESSARY_PARENTHESES",
4375 "Unnecessary parentheses$msg\n" . $herecurr);
4376 }
4377 }
4378
Joe Perchesc5595fa2015-09-09 15:37:58 -07004379# comparisons with a constant or upper case identifier on the left
4380# avoid cases like "foo + BAR < baz"
4381# only fix matches surrounded by parentheses to avoid incorrect
4382# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4383 if ($^V && $^V ge 5.10.0 &&
4384 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4385 my $lead = $1;
4386 my $const = $2;
4387 my $comp = $3;
4388 my $to = $4;
4389 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004390 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004391 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4392 WARN("CONSTANT_COMPARISON",
4393 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4394 $fix) {
4395 if ($comp eq "<") {
4396 $newcomp = ">";
4397 } elsif ($comp eq "<=") {
4398 $newcomp = ">=";
4399 } elsif ($comp eq ">") {
4400 $newcomp = "<";
4401 } elsif ($comp eq ">=") {
4402 $newcomp = "<=";
4403 }
4404 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4405 }
4406 }
4407
Joe Perchesf34e4a42015-04-16 12:44:19 -07004408# Return of what appears to be an errno should normally be negative
4409 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004410 my $name = $1;
4411 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004412 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004413 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004414 }
4415 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004416
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004417# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004418 if ($line =~ /\b(if|while|for|switch)\(/) {
4419 if (ERROR("SPACING",
4420 "space required before the open parenthesis '('\n" . $herecurr) &&
4421 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004422 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004423 s/\b(if|while|for|switch)\(/$1 \(/;
4424 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004425 }
4426
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004427# Check for illegal assignment in if conditional -- and check for trailing
4428# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004429 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004430 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4431 ctx_statement_block($linenr, $realcnt, 0)
4432 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004433 my ($stat_next) = ctx_statement_block($line_nr_next,
4434 $remain_next, $off_next);
4435 $stat_next =~ s/\n./\n /g;
4436 ##print "stat<$stat> stat_next<$stat_next>\n";
4437
4438 if ($stat_next =~ /^\s*while\b/) {
4439 # If the statement carries leading newlines,
4440 # then count those as offsets.
4441 my ($whitespace) =
4442 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4443 my $offset =
4444 statement_rawlines($whitespace) - 1;
4445
4446 $suppress_whiletrailers{$line_nr_next +
4447 $offset} = 1;
4448 }
4449 }
4450 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004451 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004452 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004453 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004454
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004455 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004456 ERROR("ASSIGN_IN_IF",
4457 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004458 }
4459
4460 # Find out what is on the end of the line after the
4461 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004462 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004463 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004464 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004465 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4466 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004467 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004468 # Find out how long the conditional actually is.
4469 my @newlines = ($c =~ /\n/gs);
4470 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004471 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004472
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004473 $stat_real = raw_line($linenr, $cond_lines)
4474 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004475 if (defined($stat_real) && $cond_lines > 1) {
4476 $stat_real = "[...]\n$stat_real";
4477 }
4478
Joe Perches000d1cc12011-07-25 17:13:25 -07004479 ERROR("TRAILING_STATEMENTS",
4480 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004481 }
4482 }
4483
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004484# Check for bitwise tests written as boolean
4485 if ($line =~ /
4486 (?:
4487 (?:\[|\(|\&\&|\|\|)
4488 \s*0[xX][0-9]+\s*
4489 (?:\&\&|\|\|)
4490 |
4491 (?:\&\&|\|\|)
4492 \s*0[xX][0-9]+\s*
4493 (?:\&\&|\|\||\)|\])
4494 )/x)
4495 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004496 WARN("HEXADECIMAL_BOOLEAN_TEST",
4497 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004498 }
4499
Andy Whitcroft8905a672007-11-28 16:21:06 -08004500# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004501 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4502 my $s = $1;
4503 $s =~ s/$;//g; # Remove any comments
4504 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004505 ERROR("TRAILING_STATEMENTS",
4506 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004507 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004508 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004509# if should not continue a brace
4510 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004511 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004512 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004513 $herecurr);
4514 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004515# case and default should not have general statements after them
4516 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4517 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004518 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004519 \s*return\s+
4520 )/xg)
4521 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004522 ERROR("TRAILING_STATEMENTS",
4523 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004524 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004525
4526 # Check for }<nl>else {, these must be at the same
4527 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004528 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4529 $previndent == $indent) {
4530 if (ERROR("ELSE_AFTER_BRACE",
4531 "else should follow close brace '}'\n" . $hereprev) &&
4532 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4533 fix_delete_line($fixlinenr - 1, $prevrawline);
4534 fix_delete_line($fixlinenr, $rawline);
4535 my $fixedline = $prevrawline;
4536 $fixedline =~ s/}\s*$//;
4537 if ($fixedline !~ /^\+\s*$/) {
4538 fix_insert_line($fixlinenr, $fixedline);
4539 }
4540 $fixedline = $rawline;
4541 $fixedline =~ s/^(.\s*)else/$1} else/;
4542 fix_insert_line($fixlinenr, $fixedline);
4543 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004544 }
4545
Joe Perches8b8856f2014-08-06 16:11:14 -07004546 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4547 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004548 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4549
4550 # Find out what is on the end of the line after the
4551 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004552 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004553 $s =~ s/\n.*//g;
4554
4555 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004556 if (ERROR("WHILE_AFTER_BRACE",
4557 "while should follow close brace '}'\n" . $hereprev) &&
4558 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4559 fix_delete_line($fixlinenr - 1, $prevrawline);
4560 fix_delete_line($fixlinenr, $rawline);
4561 my $fixedline = $prevrawline;
4562 my $trailing = $rawline;
4563 $trailing =~ s/^\+//;
4564 $trailing = trim($trailing);
4565 $fixedline =~ s/}\s*$/} $trailing/;
4566 fix_insert_line($fixlinenr, $fixedline);
4567 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004568 }
4569 }
4570
Joe Perches95e2c602013-07-03 15:05:20 -07004571#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004572 while ($line =~ m{($Constant|$Lval)}g) {
4573 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004574
4575#gcc binary extension
4576 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004577 if (WARN("GCC_BINARY_CONSTANT",
4578 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4579 $fix) {
4580 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004581 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004582 s/\b$var\b/$hexval/;
4583 }
Joe Perches95e2c602013-07-03 15:05:20 -07004584 }
4585
4586#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004587 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004588 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004589#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004590 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004591#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004592 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4593#Ignore some three character SI units explicitly, like MiB and KHz
4594 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004595 while ($var =~ m{($Ident)}g) {
4596 my $word = $1;
4597 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004598 if ($check) {
4599 seed_camelcase_includes();
4600 if (!$file && !$camelcase_file_seeded) {
4601 seed_camelcase_file($realfile);
4602 $camelcase_file_seeded = 1;
4603 }
4604 }
Joe Perches7e781f62013-09-11 14:23:55 -07004605 if (!defined $camelcase{$word}) {
4606 $camelcase{$word} = 1;
4607 CHK("CAMELCASE",
4608 "Avoid CamelCase: <$word>\n" . $herecurr);
4609 }
Joe Perches34456862013-07-03 15:05:34 -07004610 }
Joe Perches323c1262012-12-17 16:02:07 -08004611 }
4612 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004613
4614#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004615 if ($line =~ /\#\s*define.*\\\s+$/) {
4616 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4617 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4618 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004619 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004620 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004621 }
4622
Fabian Frederick0e212e02015-04-16 12:44:25 -07004623# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4624# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004625 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004626 my $file = "$1.h";
4627 my $checkfile = "include/linux/$file";
4628 if (-f "$root/$checkfile" &&
4629 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004630 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004631 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004632 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4633 if ($asminclude > 0) {
4634 if ($realfile =~ m{^arch/}) {
4635 CHK("ARCH_INCLUDE_LINUX",
4636 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4637 } else {
4638 WARN("INCLUDE_LINUX",
4639 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4640 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004641 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004642 }
4643 }
4644
Andy Whitcroft653d4872007-06-23 17:16:34 -07004645# multi-statement macros should be enclosed in a do while loop, grab the
4646# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004647# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004648 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4649 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004650 my $ln = $linenr;
4651 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004652 my ($off, $dstat, $dcond, $rest);
4653 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004654 my $has_flow_statement = 0;
4655 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004656 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004657 ctx_statement_block($linenr, $realcnt, 0);
4658 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004659 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004660 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004661
Joe Perches08a28432014-10-13 15:51:55 -07004662 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004663 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004664
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004665 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004666 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004667 $dstat =~ s/\\\n.//g;
4668 $dstat =~ s/^\s*//s;
4669 $dstat =~ s/\s*$//s;
4670
4671 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004672 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4673 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004674 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004675 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004676 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004677
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004678 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004679 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4680 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004681 {
4682 }
4683
Joe Perches42e15292016-03-15 14:58:01 -07004684 # Make asm volatile uses seem like a generic function
4685 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4686
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004687 my $exceptions = qr{
4688 $Declare|
4689 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004690 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004691 DECLARE_PER_CPU|
4692 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004693 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004694 union|
4695 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004696 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004697 ^\"|\"$|
4698 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004699 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004700 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004701 if ($dstat ne '' &&
4702 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4703 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004704 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004705 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004706 $dstat !~ /$exceptions/ &&
4707 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004708 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004709 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004710 $dstat !~ /^for\s*$Constant$/ && # for (...)
4711 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4712 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004713 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004714 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004715 {
4716 $ctx =~ s/\n*$//;
4717 my $herectx = $here . "\n";
4718 my $cnt = statement_rawlines($ctx);
4719
4720 for (my $n = 0; $n < $cnt; $n++) {
4721 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004722 }
4723
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004724 if ($dstat =~ /;/) {
4725 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4726 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4727 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004728 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004729 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004730 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004731 }
Joe Perches5023d342012-12-17 16:01:47 -08004732
Joe Perches08a28432014-10-13 15:51:55 -07004733# check for macros with flow control, but without ## concatenation
4734# ## concatenation is commonly a macro that defines a function so ignore those
4735 if ($has_flow_statement && !$has_arg_concat) {
4736 my $herectx = $here . "\n";
4737 my $cnt = statement_rawlines($ctx);
4738
4739 for (my $n = 0; $n < $cnt; $n++) {
4740 $herectx .= raw_line($linenr, $n) . "\n";
4741 }
4742 WARN("MACRO_WITH_FLOW_CONTROL",
4743 "Macros with flow control statements should be avoided\n" . "$herectx");
4744 }
4745
Joe Perches481eb482012-12-17 16:01:56 -08004746# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004747
4748 } else {
4749 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004750 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4751 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004752 $line =~ /^\+.*\\$/) {
4753 WARN("LINE_CONTINUATIONS",
4754 "Avoid unnecessary line continuations\n" . $herecurr);
4755 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004756 }
4757
Joe Perchesb13edf72012-07-30 14:41:24 -07004758# do {} while (0) macro tests:
4759# single-statement macros do not need to be enclosed in do while (0) loop,
4760# macro should not end with a semicolon
4761 if ($^V && $^V ge 5.10.0 &&
4762 $realfile !~ m@/vmlinux.lds.h$@ &&
4763 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4764 my $ln = $linenr;
4765 my $cnt = $realcnt;
4766 my ($off, $dstat, $dcond, $rest);
4767 my $ctx = '';
4768 ($dstat, $dcond, $ln, $cnt, $off) =
4769 ctx_statement_block($linenr, $realcnt, 0);
4770 $ctx = $dstat;
4771
4772 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004773 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004774
4775 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4776 my $stmts = $2;
4777 my $semis = $3;
4778
4779 $ctx =~ s/\n*$//;
4780 my $cnt = statement_rawlines($ctx);
4781 my $herectx = $here . "\n";
4782
4783 for (my $n = 0; $n < $cnt; $n++) {
4784 $herectx .= raw_line($linenr, $n) . "\n";
4785 }
4786
Joe Perchesac8e97f2012-08-21 16:15:53 -07004787 if (($stmts =~ tr/;/;/) == 1 &&
4788 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004789 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4790 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4791 }
4792 if (defined $semis && $semis ne "") {
4793 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4794 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4795 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004796 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4797 $ctx =~ s/\n*$//;
4798 my $cnt = statement_rawlines($ctx);
4799 my $herectx = $here . "\n";
4800
4801 for (my $n = 0; $n < $cnt; $n++) {
4802 $herectx .= raw_line($linenr, $n) . "\n";
4803 }
4804
4805 WARN("TRAILING_SEMICOLON",
4806 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004807 }
4808 }
4809
Mike Frysinger080ba922009-01-06 14:41:25 -08004810# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4811# all assignments may have only one of the following with an assignment:
4812# .
4813# ALIGN(...)
4814# VMLINUX_SYMBOL(...)
4815 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004816 WARN("MISSING_VMLINUX_SYMBOL",
4817 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004818 }
4819
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004820# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004821 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4822 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004823 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004824 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004825 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4826 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004827 my @allowed = ();
4828 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004829 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004830 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004831 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004832 for my $chunk (@chunks) {
4833 my ($cond, $block) = @{$chunk};
4834
Andy Whitcroft773647a2008-03-28 14:15:58 -07004835 # If the condition carries leading newlines, then count those as offsets.
4836 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4837 my $offset = statement_rawlines($whitespace) - 1;
4838
Joe Perchesaad4f612012-03-23 15:02:19 -07004839 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004840 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4841
4842 # We have looked at and allowed this specific line.
4843 $suppress_ifbraces{$ln + $offset} = 1;
4844
4845 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004846 $ln += statement_rawlines($block) - 1;
4847
Andy Whitcroft773647a2008-03-28 14:15:58 -07004848 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004849
4850 $seen++ if ($block =~ /^\s*{/);
4851
Joe Perchesaad4f612012-03-23 15:02:19 -07004852 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004853 if (statement_lines($cond) > 1) {
4854 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004855 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004856 }
4857 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004858 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004859 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004860 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004861 if (statement_block_size($block) > 1) {
4862 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004863 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004864 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004865 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004866 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004867 if ($seen) {
4868 my $sum_allowed = 0;
4869 foreach (@allowed) {
4870 $sum_allowed += $_;
4871 }
4872 if ($sum_allowed == 0) {
4873 WARN("BRACES",
4874 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4875 } elsif ($sum_allowed != $allow &&
4876 $seen != $allow) {
4877 CHK("BRACES",
4878 "braces {} should be used on all arms of this statement\n" . $herectx);
4879 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004880 }
4881 }
4882 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004883 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004884 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004885 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004886
Andy Whitcroftcf655042008-03-04 14:28:20 -08004887 # Check the pre-context.
4888 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4889 #print "APW: ALLOWED: pre<$1>\n";
4890 $allowed = 1;
4891 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004892
4893 my ($level, $endln, @chunks) =
4894 ctx_statement_full($linenr, $realcnt, $-[0]);
4895
Andy Whitcroftcf655042008-03-04 14:28:20 -08004896 # Check the condition.
4897 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004898 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004899 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004900 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004901 }
4902 if (statement_lines($cond) > 1) {
4903 #print "APW: ALLOWED: cond<$cond>\n";
4904 $allowed = 1;
4905 }
4906 if ($block =~/\b(?:if|for|while)\b/) {
4907 #print "APW: ALLOWED: block<$block>\n";
4908 $allowed = 1;
4909 }
4910 if (statement_block_size($block) > 1) {
4911 #print "APW: ALLOWED: lines block<$block>\n";
4912 $allowed = 1;
4913 }
4914 # Check the post-context.
4915 if (defined $chunks[1]) {
4916 my ($cond, $block) = @{$chunks[1]};
4917 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004918 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004919 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004920 if ($block =~ /^\s*\{/) {
4921 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4922 $allowed = 1;
4923 }
4924 }
4925 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004926 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004927 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004928
Andy Whitcroftf0556632008-10-15 22:02:23 -07004929 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004930 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004931 }
4932
Joe Perches000d1cc12011-07-25 17:13:25 -07004933 WARN("BRACES",
4934 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004935 }
4936 }
4937
Joe Perches0979ae62012-12-17 16:01:59 -08004938# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004939 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004940 if (CHK("BRACES",
4941 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4942 $fix && $prevrawline =~ /^\+/) {
4943 fix_delete_line($fixlinenr - 1, $prevrawline);
4944 }
Joe Perches0979ae62012-12-17 16:01:59 -08004945 }
Joe Perches77b9a532013-07-03 15:05:29 -07004946 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004947 if (CHK("BRACES",
4948 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4949 $fix) {
4950 fix_delete_line($fixlinenr, $rawline);
4951 }
Joe Perches0979ae62012-12-17 16:01:59 -08004952 }
4953
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004954# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004955 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4956 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004957 WARN("VOLATILE",
4958 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004959 }
4960
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004961# Check for user-visible strings broken across lines, which breaks the ability
4962# to grep for the string. Make exceptions when the previous string ends in a
4963# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4964# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004965 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004966 $prevline =~ /"\s*$/ &&
4967 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4968 if (WARN("SPLIT_STRING",
4969 "quoted string split across lines\n" . $hereprev) &&
4970 $fix &&
4971 $prevrawline =~ /^\+.*"\s*$/ &&
4972 $last_coalesced_string_linenr != $linenr - 1) {
4973 my $extracted_string = get_quoted_string($line, $rawline);
4974 my $comma_close = "";
4975 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4976 $comma_close = $1;
4977 }
4978
4979 fix_delete_line($fixlinenr - 1, $prevrawline);
4980 fix_delete_line($fixlinenr, $rawline);
4981 my $fixedline = $prevrawline;
4982 $fixedline =~ s/"\s*$//;
4983 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4984 fix_insert_line($fixlinenr - 1, $fixedline);
4985 $fixedline = $rawline;
4986 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4987 if ($fixedline !~ /\+\s*$/) {
4988 fix_insert_line($fixlinenr, $fixedline);
4989 }
4990 $last_coalesced_string_linenr = $linenr;
4991 }
4992 }
4993
4994# check for missing a space in a string concatenation
4995 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4996 WARN('MISSING_SPACE',
4997 "break quoted strings at a space character\n" . $hereprev);
4998 }
4999
5000# check for spaces before a quoted newline
5001 if ($rawline =~ /^.*\".*\s\\n/) {
5002 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5003 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5004 $fix) {
5005 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5006 }
5007
5008 }
5009
Joe Perchesf17dba42014-10-13 15:51:51 -07005010# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005011 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005012 CHK("CONCATENATED_STRING",
5013 "Concatenated strings should use spaces between elements\n" . $herecurr);
5014 }
5015
Joe Perches90ad30e2014-12-10 15:51:59 -08005016# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005017 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005018 WARN("STRING_FRAGMENTS",
5019 "Consecutive strings are generally better as a single string\n" . $herecurr);
5020 }
5021
Joe Perches6e300752015-09-09 15:37:47 -07005022# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005023 my $string;
5024 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5025 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5026 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005027 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005028 WARN("PRINTF_L",
5029 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5030 last;
5031 }
Joe Perches6e300752015-09-09 15:37:47 -07005032 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5033 ERROR("PRINTF_0xDECIMAL",
5034 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5035 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005036 }
5037
5038# check for line continuations in quoted strings with odd counts of "
5039 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5040 WARN("LINE_CONTINUATIONS",
5041 "Avoid line continuations in quoted strings\n" . $herecurr);
5042 }
5043
Andy Whitcroft00df3442007-06-08 13:47:06 -07005044# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005045 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005046 CHK("REDUNDANT_CODE",
5047 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005048 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005049 }
5050
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005051# check for needless "if (<foo>) fn(<foo>)" uses
5052 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005053 my $tested = quotemeta($1);
5054 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5055 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5056 my $func = $1;
5057 if (WARN('NEEDLESS_IF',
5058 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5059 $fix) {
5060 my $do_fix = 1;
5061 my $leading_tabs = "";
5062 my $new_leading_tabs = "";
5063 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5064 $leading_tabs = $1;
5065 } else {
5066 $do_fix = 0;
5067 }
5068 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5069 $new_leading_tabs = $1;
5070 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5071 $do_fix = 0;
5072 }
5073 } else {
5074 $do_fix = 0;
5075 }
5076 if ($do_fix) {
5077 fix_delete_line($fixlinenr - 1, $prevrawline);
5078 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5079 }
5080 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005081 }
5082 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005083
Joe Perchesebfdc402014-08-06 16:10:27 -07005084# check for unnecessary "Out of Memory" messages
5085 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5086 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5087 (defined $1 || defined $3) &&
5088 $linenr > 3) {
5089 my $testval = $2;
5090 my $testline = $lines[$linenr - 3];
5091
5092 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5093# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5094
5095 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5096 WARN("OOM_MESSAGE",
5097 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5098 }
5099 }
5100
Joe Perchesf78d98f2014-10-13 15:52:01 -07005101# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005102 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005103 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5104 my $level = $1;
5105 if (WARN("UNNECESSARY_KERN_LEVEL",
5106 "Possible unnecessary $level\n" . $herecurr) &&
5107 $fix) {
5108 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5109 }
5110 }
5111
Joe Perchesabb08a52014-12-10 15:51:46 -08005112# check for mask then right shift without a parentheses
5113 if ($^V && $^V ge 5.10.0 &&
5114 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5115 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5116 WARN("MASK_THEN_SHIFT",
5117 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5118 }
5119
Joe Perchesb75ac612014-12-10 15:52:02 -08005120# check for pointer comparisons to NULL
5121 if ($^V && $^V ge 5.10.0) {
5122 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5123 my $val = $1;
5124 my $equal = "!";
5125 $equal = "" if ($4 eq "!=");
5126 if (CHK("COMPARISON_TO_NULL",
5127 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5128 $fix) {
5129 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5130 }
5131 }
5132 }
5133
Joe Perches8716de32013-09-11 14:24:05 -07005134# check for bad placement of section $InitAttribute (e.g.: __initdata)
5135 if ($line =~ /(\b$InitAttribute\b)/) {
5136 my $attr = $1;
5137 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5138 my $ptr = $1;
5139 my $var = $2;
5140 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5141 ERROR("MISPLACED_INIT",
5142 "$attr should be placed after $var\n" . $herecurr)) ||
5143 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5144 WARN("MISPLACED_INIT",
5145 "$attr should be placed after $var\n" . $herecurr))) &&
5146 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005147 $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 -07005148 }
5149 }
5150 }
5151
Joe Perchese970b882013-11-12 15:10:10 -08005152# check for $InitAttributeData (ie: __initdata) with const
5153 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5154 my $attr = $1;
5155 $attr =~ /($InitAttributePrefix)(.*)/;
5156 my $attr_prefix = $1;
5157 my $attr_type = $2;
5158 if (ERROR("INIT_ATTRIBUTE",
5159 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5160 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005161 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005162 s/$InitAttributeData/${attr_prefix}initconst/;
5163 }
5164 }
5165
5166# check for $InitAttributeConst (ie: __initconst) without const
5167 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5168 my $attr = $1;
5169 if (ERROR("INIT_ATTRIBUTE",
5170 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5171 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005172 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005173 /(^\+\s*(?:static\s+))/;
5174 $lead = rtrim($1);
5175 $lead = "$lead " if ($lead !~ /^\+$/);
5176 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005177 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08005178 }
5179 }
5180
Joe Perchesc17893c2015-04-16 12:44:42 -07005181# check for __read_mostly with const non-pointer (should just be const)
5182 if ($line =~ /\b__read_mostly\b/ &&
5183 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5184 if (ERROR("CONST_READ_MOSTLY",
5185 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5186 $fix) {
5187 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5188 }
5189 }
5190
Joe Perchesfbdb8132014-04-03 14:49:14 -07005191# don't use __constant_<foo> functions outside of include/uapi/
5192 if ($realfile !~ m@^include/uapi/@ &&
5193 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5194 my $constant_func = $1;
5195 my $func = $constant_func;
5196 $func =~ s/^__constant_//;
5197 if (WARN("CONSTANT_CONVERSION",
5198 "$constant_func should be $func\n" . $herecurr) &&
5199 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005200 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005201 }
5202 }
5203
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005204# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005205 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005206 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005207 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005208 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005209 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005210 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5211 }
5212 if ($delay > 2000) {
5213 WARN("LONG_UDELAY",
5214 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005215 }
5216 }
5217
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005218# warn about unexpectedly long msleep's
5219 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5220 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005221 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005222 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005223 }
5224 }
5225
Joe Perches36ec1932013-07-03 15:05:25 -07005226# check for comparisons of jiffies
5227 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5228 WARN("JIFFIES_COMPARISON",
5229 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5230 }
5231
Joe Perches9d7a34a2013-07-03 15:05:26 -07005232# check for comparisons of get_jiffies_64()
5233 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5234 WARN("JIFFIES_COMPARISON",
5235 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5236 }
5237
Andy Whitcroft00df3442007-06-08 13:47:06 -07005238# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005239# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005240# print "#ifdef in C files should be avoided\n";
5241# print "$herecurr";
5242# $clean = 0;
5243# }
5244
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005245# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005246 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005247 if (ERROR("SPACING",
5248 "exactly one space required after that #$1\n" . $herecurr) &&
5249 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005250 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005251 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5252 }
5253
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005254 }
5255
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005256# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005257 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5258 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005259 my $which = $1;
5260 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005261 CHK("UNCOMMENTED_DEFINITION",
5262 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005263 }
5264 }
5265# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005266
5267 my $barriers = qr{
5268 mb|
5269 rmb|
5270 wmb|
5271 read_barrier_depends
5272 }x;
5273 my $barrier_stems = qr{
5274 mb__before_atomic|
5275 mb__after_atomic|
5276 store_release|
5277 load_acquire|
5278 store_mb|
5279 (?:$barriers)
5280 }x;
5281 my $all_barriers = qr{
5282 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005283 smp_(?:$barrier_stems)|
5284 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005285 }x;
5286
5287 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005288 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005289 WARN("MEMORY_BARRIER",
5290 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005291 }
5292 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005293
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005294 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5295
5296 if ($realfile !~ m@^include/asm-generic/@ &&
5297 $realfile !~ m@/barrier\.h$@ &&
5298 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5299 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5300 WARN("MEMORY_BARRIER",
5301 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5302 }
5303
Joe Perchescb426e92015-06-25 15:02:46 -07005304# check for waitqueue_active without a comment.
5305 if ($line =~ /\bwaitqueue_active\s*\(/) {
5306 if (!ctx_has_comment($first_line, $linenr)) {
5307 WARN("WAITQUEUE_ACTIVE",
5308 "waitqueue_active without comment\n" . $herecurr);
5309 }
5310 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005311
5312# Check for expedited grace periods that interrupt non-idle non-nohz
5313# online CPUs. These expedited can therefore degrade real-time response
5314# if used carelessly, and should be avoided where not absolutely
5315# needed. It is always OK to use synchronize_rcu_expedited() and
5316# synchronize_sched_expedited() at boot time (before real-time applications
5317# start) and in error situations where real-time response is compromised in
5318# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5319# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5320# Of course, nothing comes for free, and srcu_read_lock() and
5321# srcu_read_unlock() do contain full memory barriers in payment for
5322# synchronize_srcu_expedited() non-interruption properties.
5323 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5324 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5325 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5326
5327 }
5328
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005329# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005330 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005331 CHK("ARCH_DEFINES",
5332 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005333 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005334
Tobias Klauserd4977c72010-05-24 14:33:30 -07005335# Check that the storage class is at the beginning of a declaration
5336 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005337 WARN("STORAGE_CLASS",
5338 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005339 }
5340
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005341# check the location of the inline attribute, that it is between
5342# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005343 if ($line =~ /\b$Type\s+$Inline\b/ ||
5344 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005345 ERROR("INLINE_LOCATION",
5346 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005347 }
5348
Andy Whitcroft8905a672007-11-28 16:21:06 -08005349# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005350 if ($realfile !~ m@\binclude/uapi/@ &&
5351 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005352 if (WARN("INLINE",
5353 "plain inline is preferred over $1\n" . $herecurr) &&
5354 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005355 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005356
5357 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005358 }
5359
Joe Perches3d130fd2011-01-12 17:00:00 -08005360# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005361 if ($realfile !~ m@\binclude/uapi/@ &&
5362 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005363 WARN("PREFER_PACKED",
5364 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005365 }
5366
Joe Perches39b7e282011-07-25 17:13:24 -07005367# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005368 if ($realfile !~ m@\binclude/uapi/@ &&
5369 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005370 WARN("PREFER_ALIGNED",
5371 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005372 }
5373
Joe Perches5f14d3b2012-01-10 15:09:52 -08005374# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005375 if ($realfile !~ m@\binclude/uapi/@ &&
5376 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005377 if (WARN("PREFER_PRINTF",
5378 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5379 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005380 $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 -07005381
5382 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005383 }
5384
Joe Perches6061d942012-03-23 15:02:16 -07005385# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005386 if ($realfile !~ m@\binclude/uapi/@ &&
5387 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005388 if (WARN("PREFER_SCANF",
5389 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5390 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005391 $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 -07005392 }
Joe Perches6061d942012-03-23 15:02:16 -07005393 }
5394
Joe Perches619a9082014-12-10 15:51:35 -08005395# Check for __attribute__ weak, or __weak declarations (may have link issues)
5396 if ($^V && $^V ge 5.10.0 &&
5397 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5398 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5399 $line =~ /\b__weak\b/)) {
5400 ERROR("WEAK_DECLARATION",
5401 "Using weak declarations can have unintended link defects\n" . $herecurr);
5402 }
5403
Joe Perchese6176fa2015-06-25 15:02:49 -07005404# check for c99 types like uint8_t used outside of uapi/
5405 if ($realfile !~ m@\binclude/uapi/@ &&
5406 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5407 my $type = $1;
5408 if ($type =~ /\b($typeC99Typedefs)\b/) {
5409 $type = $1;
5410 my $kernel_type = 'u';
5411 $kernel_type = 's' if ($type =~ /^_*[si]/);
5412 $type =~ /(\d+)/;
5413 $kernel_type .= $1;
5414 if (CHK("PREFER_KERNEL_TYPES",
5415 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5416 $fix) {
5417 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5418 }
5419 }
5420 }
5421
Joe Perches938224b2016-01-20 14:59:15 -08005422# check for cast of C90 native int or longer types constants
5423 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5424 my $cast = $1;
5425 my $const = $2;
5426 if (WARN("TYPECAST_INT_CONSTANT",
5427 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5428 $fix) {
5429 my $suffix = "";
5430 my $newconst = $const;
5431 $newconst =~ s/${Int_type}$//;
5432 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5433 if ($cast =~ /\blong\s+long\b/) {
5434 $suffix .= 'LL';
5435 } elsif ($cast =~ /\blong\b/) {
5436 $suffix .= 'L';
5437 }
5438 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5439 }
5440 }
5441
Joe Perches8f53a9b2010-03-05 13:43:48 -08005442# check for sizeof(&)
5443 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005444 WARN("SIZEOF_ADDRESS",
5445 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005446 }
5447
Joe Perches66c80b62012-07-30 14:41:22 -07005448# check for sizeof without parenthesis
5449 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005450 if (WARN("SIZEOF_PARENTHESIS",
5451 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5452 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005453 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005454 }
Joe Perches66c80b62012-07-30 14:41:22 -07005455 }
5456
Joe Perches88982fe2012-12-17 16:02:00 -08005457# check for struct spinlock declarations
5458 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5459 WARN("USE_SPINLOCK_T",
5460 "struct spinlock should be spinlock_t\n" . $herecurr);
5461 }
5462
Joe Perchesa6962d72013-04-29 16:18:13 -07005463# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005464 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005465 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005466 $fmt =~ s/%%//g;
5467 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005468 if (WARN("PREFER_SEQ_PUTS",
5469 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5470 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005471 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005472 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005473 }
5474 }
5475
Andy Whitcroft554e1652012-01-10 15:09:57 -08005476# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005477 if ($^V && $^V ge 5.10.0 &&
5478 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005479 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005480
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005481 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005482 my $ms_val = $7;
5483 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005484
Andy Whitcroft554e1652012-01-10 15:09:57 -08005485 if ($ms_size =~ /^(0x|)0$/i) {
5486 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005487 "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 -08005488 } elsif ($ms_size =~ /^(0x|)1$/i) {
5489 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005490 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5491 }
5492 }
5493
Joe Perches98a9bba2014-01-23 15:54:52 -08005494# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5495 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005496 defined $stat &&
5497 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005498 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005499 "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 -08005500 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005501 $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 -08005502 }
5503 }
5504
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005505# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5506 if ($^V && $^V ge 5.10.0 &&
5507 defined $stat &&
5508 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5509 WARN("PREFER_ETHER_ADDR_EQUAL",
5510 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5511 }
5512
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005513# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5514# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5515 if ($^V && $^V ge 5.10.0 &&
5516 defined $stat &&
5517 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5518
5519 my $ms_val = $7;
5520
5521 if ($ms_val =~ /^(?:0x|)0+$/i) {
5522 if (WARN("PREFER_ETH_ZERO_ADDR",
5523 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5524 $fix) {
5525 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5526 }
5527 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5528 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5529 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5530 $fix) {
5531 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5532 }
5533 }
5534 }
5535
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005536# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005537 if ($^V && $^V ge 5.10.0 &&
5538 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005539 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005540 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005541 my $call = $1;
5542 my $cast1 = deparenthesize($2);
5543 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005544 my $cast2 = deparenthesize($7);
5545 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005546 my $cast;
5547
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005548 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005549 $cast = "$cast1 or $cast2";
5550 } elsif ($cast1 ne "") {
5551 $cast = $cast1;
5552 } else {
5553 $cast = $cast2;
5554 }
5555 WARN("MINMAX",
5556 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005557 }
5558 }
5559
Joe Perches4a273192012-07-30 14:41:20 -07005560# check usleep_range arguments
5561 if ($^V && $^V ge 5.10.0 &&
5562 defined $stat &&
5563 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5564 my $min = $1;
5565 my $max = $7;
5566 if ($min eq $max) {
5567 WARN("USLEEP_RANGE",
5568 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5569 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5570 $min > $max) {
5571 WARN("USLEEP_RANGE",
5572 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5573 }
5574 }
5575
Joe Perches823b7942013-11-12 15:10:15 -08005576# check for naked sscanf
5577 if ($^V && $^V ge 5.10.0 &&
5578 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005579 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005580 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5581 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5582 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5583 my $lc = $stat =~ tr@\n@@;
5584 $lc = $lc + $linenr;
5585 my $stat_real = raw_line($linenr, 0);
5586 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5587 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5588 }
5589 WARN("NAKED_SSCANF",
5590 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5591 }
5592
Joe Perchesafc819a2014-06-04 16:12:08 -07005593# check for simple sscanf that should be kstrto<foo>
5594 if ($^V && $^V ge 5.10.0 &&
5595 defined $stat &&
5596 $line =~ /\bsscanf\b/) {
5597 my $lc = $stat =~ tr@\n@@;
5598 $lc = $lc + $linenr;
5599 my $stat_real = raw_line($linenr, 0);
5600 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5601 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5602 }
5603 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5604 my $format = $6;
5605 my $count = $format =~ tr@%@%@;
5606 if ($count == 1 &&
5607 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5608 WARN("SSCANF_TO_KSTRTO",
5609 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5610 }
5611 }
5612 }
5613
Joe Perches70dc8a42013-09-11 14:23:58 -07005614# check for new externs in .h files.
5615 if ($realfile =~ /\.h$/ &&
5616 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005617 if (CHK("AVOID_EXTERNS",
5618 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005619 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005620 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005621 }
5622 }
5623
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005624# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005625 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005626 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005627 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005628 my $function_name = $1;
5629 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005630
5631 my $s = $stat;
5632 if (defined $cond) {
5633 substr($s, 0, length($cond), '');
5634 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005635 if ($s =~ /^\s*;/ &&
5636 $function_name ne 'uninitialized_var')
5637 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005638 WARN("AVOID_EXTERNS",
5639 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005640 }
5641
5642 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005643 WARN("FUNCTION_ARGUMENTS",
5644 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005645 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005646
5647 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5648 $stat =~ /^.\s*extern\s+/)
5649 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005650 WARN("AVOID_EXTERNS",
5651 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005652 }
5653
5654# checks for new __setup's
5655 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5656 my $name = $1;
5657
5658 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005659 CHK("UNDOCUMENTED_SETUP",
5660 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005661 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005662 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005663
5664# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005665 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005666 WARN("UNNECESSARY_CASTS",
5667 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005668 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005669
Joe Perchesa640d252013-07-03 15:05:21 -07005670# alloc style
5671# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5672 if ($^V && $^V ge 5.10.0 &&
5673 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5674 CHK("ALLOC_SIZEOF_STRUCT",
5675 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5676 }
5677
Joe Perches60a55362014-06-04 16:12:07 -07005678# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5679 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005680 $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 -07005681 my $oldfunc = $3;
5682 my $a1 = $4;
5683 my $a2 = $10;
5684 my $newfunc = "kmalloc_array";
5685 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005686 my $r1 = $a1;
5687 my $r2 = $a2;
5688 if ($a1 =~ /^sizeof\s*\S/) {
5689 $r1 = $a2;
5690 $r2 = $a1;
5691 }
5692 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5693 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005694 if (WARN("ALLOC_WITH_MULTIPLY",
5695 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5696 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005697 $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 -07005698
5699 }
5700 }
5701 }
5702
Joe Perches972fdea2013-04-29 16:18:12 -07005703# check for krealloc arg reuse
5704 if ($^V && $^V ge 5.10.0 &&
5705 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5706 WARN("KREALLOC_ARG_REUSE",
5707 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5708 }
5709
Joe Perches5ce59ae2013-02-21 16:44:18 -08005710# check for alloc argument mismatch
5711 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5712 WARN("ALLOC_ARRAY_ARGS",
5713 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5714 }
5715
Joe Perchescaf2a542011-01-12 16:59:56 -08005716# check for multiple semicolons
5717 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005718 if (WARN("ONE_SEMICOLON",
5719 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5720 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005721 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005722 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005723 }
5724
Joe Perches0ab90192014-12-10 15:51:57 -08005725# check for #defines like: 1 << <digit> that could be BIT(digit)
5726 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5727 my $ull = "";
5728 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5729 if (CHK("BIT_MACRO",
5730 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5731 $fix) {
5732 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5733 }
5734 }
5735
Joe Perches2d632742016-05-20 17:04:00 -07005736# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5737 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5738 my $config = $1;
5739 if (WARN("PREFER_IS_ENABLED",
5740 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5741 $fix) {
5742 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5743 }
5744 }
5745
Joe Perchese81f2392014-08-06 16:11:25 -07005746# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005747 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5748 my $has_break = 0;
5749 my $has_statement = 0;
5750 my $count = 0;
5751 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005752 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005753 $prevline--;
5754 my $rline = $rawlines[$prevline - 1];
5755 my $fline = $lines[$prevline - 1];
5756 last if ($fline =~ /^\@\@/);
5757 next if ($fline =~ /^\-/);
5758 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5759 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5760 next if ($fline =~ /^.[\s$;]*$/);
5761 $has_statement = 1;
5762 $count++;
5763 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5764 }
5765 if (!$has_break && $has_statement) {
5766 WARN("MISSING_BREAK",
5767 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5768 }
5769 }
5770
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005771# check for switch/default statements without a break;
5772 if ($^V && $^V ge 5.10.0 &&
5773 defined $stat &&
5774 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5775 my $ctx = '';
5776 my $herectx = $here . "\n";
5777 my $cnt = statement_rawlines($stat);
5778 for (my $n = 0; $n < $cnt; $n++) {
5779 $herectx .= raw_line($linenr, $n) . "\n";
5780 }
5781 WARN("DEFAULT_NO_BREAK",
5782 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005783 }
5784
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005785# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005786 if ($line =~ /\b__FUNCTION__\b/) {
5787 if (WARN("USE_FUNC",
5788 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5789 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005790 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005791 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005792 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005793
Joe Perches62ec8182015-02-13 14:38:18 -08005794# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5795 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5796 ERROR("DATE_TIME",
5797 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5798 }
5799
Joe Perches2c924882012-03-23 15:02:20 -07005800# check for use of yield()
5801 if ($line =~ /\byield\s*\(\s*\)/) {
5802 WARN("YIELD",
5803 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5804 }
5805
Joe Perches179f8f42013-07-03 15:05:30 -07005806# check for comparisons against true and false
5807 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5808 my $lead = $1;
5809 my $arg = $2;
5810 my $test = $3;
5811 my $otype = $4;
5812 my $trail = $5;
5813 my $op = "!";
5814
5815 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5816
5817 my $type = lc($otype);
5818 if ($type =~ /^(?:true|false)$/) {
5819 if (("$test" eq "==" && "$type" eq "true") ||
5820 ("$test" eq "!=" && "$type" eq "false")) {
5821 $op = "";
5822 }
5823
5824 CHK("BOOL_COMPARISON",
5825 "Using comparison to $otype is error prone\n" . $herecurr);
5826
5827## maybe suggesting a correct construct would better
5828## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5829
5830 }
5831 }
5832
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005833# check for semaphores initialized locked
5834 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005835 WARN("CONSIDER_COMPLETION",
5836 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005837 }
Joe Perches6712d852012-03-23 15:02:20 -07005838
Joe Perches67d0a072011-10-31 17:13:10 -07005839# recommend kstrto* over simple_strto* and strict_strto*
5840 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005841 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005842 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005843 }
Joe Perches6712d852012-03-23 15:02:20 -07005844
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005845# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005846 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005847 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005848 "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 -07005849 }
Joe Perches6712d852012-03-23 15:02:20 -07005850
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005851# check for various structs that are normally const (ops, kgdb, device_tree)
5852 my $const_structs = qr{
5853 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005854 address_space_operations|
5855 backlight_ops|
5856 block_device_operations|
5857 dentry_operations|
5858 dev_pm_ops|
5859 dma_map_ops|
5860 extent_io_ops|
5861 file_lock_operations|
5862 file_operations|
5863 hv_ops|
5864 ide_dma_ops|
5865 intel_dvo_dev_ops|
5866 item_operations|
5867 iwl_ops|
5868 kgdb_arch|
5869 kgdb_io|
5870 kset_uevent_ops|
5871 lock_manager_operations|
5872 microcode_ops|
5873 mtrr_ops|
5874 neigh_ops|
5875 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005876 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005877 pci_raw_ops|
5878 pipe_buf_operations|
5879 platform_hibernation_ops|
5880 platform_suspend_ops|
5881 proto_ops|
5882 rpc_pipe_ops|
5883 seq_operations|
5884 snd_ac97_build_ops|
5885 soc_pcmcia_socket_ops|
5886 stacktrace_ops|
5887 sysfs_ops|
5888 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005889 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005890 usb_mon_operations|
5891 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005892 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005893 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005894 WARN("CONST_STRUCT",
5895 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005896 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005897 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005898
5899# use of NR_CPUS is usually wrong
5900# ignore definitions of NR_CPUS and usage to define arrays as likely right
5901 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005902 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5903 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005904 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5905 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5906 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005907 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005908 WARN("NR_CPUS",
5909 "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 -07005910 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005911
Joe Perches52ea8502013-11-12 15:10:09 -08005912# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5913 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5914 ERROR("DEFINE_ARCH_HAS",
5915 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5916 }
5917
Joe Perchesacd93622015-02-13 14:38:38 -08005918# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5919 if ($^V && $^V ge 5.10.0 &&
5920 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5921 WARN("LIKELY_MISUSE",
5922 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5923 }
5924
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005925# whine mightly about in_atomic
5926 if ($line =~ /\bin_atomic\s*\(/) {
5927 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005928 ERROR("IN_ATOMIC",
5929 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005930 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005931 WARN("IN_ATOMIC",
5932 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005933 }
5934 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005935
Joe Perches481aea52016-05-20 17:04:08 -07005936# whine about ACCESS_ONCE
5937 if ($^V && $^V ge 5.10.0 &&
5938 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
5939 my $par = $1;
5940 my $eq = $2;
5941 my $fun = $3;
5942 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
5943 if (defined($eq)) {
5944 if (WARN("PREFER_WRITE_ONCE",
5945 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
5946 $fix) {
5947 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5948 }
5949 } else {
5950 if (WARN("PREFER_READ_ONCE",
5951 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
5952 $fix) {
5953 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
5954 }
5955 }
5956 }
5957
Peter Zijlstra1704f472010-03-19 01:37:42 +01005958# check for lockdep_set_novalidate_class
5959 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5960 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5961 if ($realfile !~ m@^kernel/lockdep@ &&
5962 $realfile !~ m@^include/linux/lockdep@ &&
5963 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005964 ERROR("LOCKDEP",
5965 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005966 }
5967 }
Dave Jones88f88312011-01-12 16:59:59 -08005968
Joe Perchesb392c642015-04-16 12:44:16 -07005969 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5970 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005971 WARN("EXPORTED_WORLD_WRITABLE",
5972 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005973 }
Joe Perches24358802014-04-03 14:49:13 -07005974
Joe Perches515a2352014-04-03 14:49:24 -07005975# Mode permission misuses where it seems decimal should be octal
5976# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5977 if ($^V && $^V ge 5.10.0 &&
5978 $line =~ /$mode_perms_search/) {
5979 foreach my $entry (@mode_permission_funcs) {
5980 my $func = $entry->[0];
5981 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005982
Joe Perches515a2352014-04-03 14:49:24 -07005983 my $skip_args = "";
5984 if ($arg_pos > 1) {
5985 $arg_pos--;
5986 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5987 }
5988 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5989 if ($line =~ /$test/) {
5990 my $val = $1;
5991 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005992
Joe Perches515a2352014-04-03 14:49:24 -07005993 if ($val !~ /^0$/ &&
5994 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5995 length($val) ne 4)) {
5996 ERROR("NON_OCTAL_PERMISSIONS",
5997 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08005998 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5999 ERROR("EXPORTED_WORLD_WRITABLE",
6000 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006001 }
Joe Perches24358802014-04-03 14:49:13 -07006002 }
6003 }
6004 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006005
6006# validate content of MODULE_LICENSE against list from include/linux/module.h
6007 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6008 my $extracted_string = get_quoted_string($line, $rawline);
6009 my $valid_licenses = qr{
6010 GPL|
6011 GPL\ v2|
6012 GPL\ and\ additional\ rights|
6013 Dual\ BSD/GPL|
6014 Dual\ MIT/GPL|
6015 Dual\ MPL/GPL|
6016 Proprietary
6017 }x;
6018 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6019 WARN("MODULE_LICENSE",
6020 "unknown module license " . $extracted_string . "\n" . $herecurr);
6021 }
6022 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006023 }
6024
6025 # If we have no input at all, then there is nothing to report on
6026 # so just keep quiet.
6027 if ($#rawlines == -1) {
6028 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006029 }
6030
Andy Whitcroft8905a672007-11-28 16:21:06 -08006031 # In mailback mode only produce a report in the negative, for
6032 # things that appear to be patches.
6033 if ($mailback && ($clean == 1 || !$is_patch)) {
6034 exit(0);
6035 }
6036
6037 # This is not a patch, and we are are in 'no-patch' mode so
6038 # just keep quiet.
6039 if (!$chk_patch && !$is_patch) {
6040 exit(0);
6041 }
6042
Joe Perches06330fc2015-06-25 15:03:11 -07006043 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006044 ERROR("NOT_UNIFIED_DIFF",
6045 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006046 }
Joe Perches34d88152015-06-25 15:03:05 -07006047 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006048 ERROR("MISSING_SIGN_OFF",
6049 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006050 }
6051
Andy Whitcroft8905a672007-11-28 16:21:06 -08006052 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006053 if ($summary && !($clean == 1 && $quiet == 1)) {
6054 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006055 print "total: $cnt_error errors, $cnt_warn warnings, " .
6056 (($check)? "$cnt_chk checks, " : "") .
6057 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006058 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006059
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006060 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006061 # If there were any defects found and not already fixing them
6062 if (!$clean and !$fix) {
6063 print << "EOM"
6064
6065NOTE: For some of the reported defects, checkpatch may be able to
6066 mechanically convert to the typical style using --fix or --fix-inplace.
6067EOM
6068 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006069 # If there were whitespace errors which cleanpatch can fix
6070 # then suggest that.
6071 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006072 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006073 print << "EOM"
6074
6075NOTE: Whitespace errors detected.
6076 You may wish to use scripts/cleanpatch or scripts/cleanfile
6077EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006078 }
6079 }
6080
Joe Perchesd752fcc2014-08-06 16:11:05 -07006081 if ($clean == 0 && $fix &&
6082 ("@rawlines" ne "@fixed" ||
6083 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006084 my $newfile = $filename;
6085 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006086 my $linecount = 0;
6087 my $f;
6088
Joe Perchesd752fcc2014-08-06 16:11:05 -07006089 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6090
Joe Perches3705ce52013-07-03 15:05:31 -07006091 open($f, '>', $newfile)
6092 or die "$P: Can't open $newfile for write\n";
6093 foreach my $fixed_line (@fixed) {
6094 $linecount++;
6095 if ($file) {
6096 if ($linecount > 3) {
6097 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006098 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006099 }
6100 } else {
6101 print $f $fixed_line . "\n";
6102 }
6103 }
6104 close($f);
6105
6106 if (!$quiet) {
6107 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006108
Joe Perches3705ce52013-07-03 15:05:31 -07006109Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6110
6111Do _NOT_ trust the results written to this file.
6112Do _NOT_ submit these changes without inspecting them for correctness.
6113
6114This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6115No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006116EOM
6117 }
6118 }
6119
Joe Perchesd8469f12015-06-25 15:03:00 -07006120 if ($quiet == 0) {
6121 print "\n";
6122 if ($clean == 1) {
6123 print "$vname has no obvious style problems and is ready for submission.\n";
6124 } else {
6125 print "$vname has style problems, please review.\n";
6126 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006127 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006128 return $clean;
6129}