blob: 928366215fc53877df21b35d375b10838c219f0a [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070030my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070031my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $check = 0;
Joe 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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700180GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700181 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700230if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700231 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700302}
303
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700304my $emitted_corrupt = 0;
305
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700306our $Ident = qr{
307 [A-Za-z_][A-Za-z\d_]*
308 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
309 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700310our $Storage = qr{extern|static|asmlinkage};
311our $Sparse = qr{
312 __user|
313 __kernel|
314 __force|
315 __iomem|
Joe Perches54507b52015-09-09 15:37:55 -0700316 __pmem|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700317 __must_check|
318 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800319 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700320 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800321 __rcu|
322 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700323 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800324our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
325our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
326our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
327our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
328our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700329
Wolfram Sang52131292010-03-05 13:43:51 -0800330# Notes to $Attribute:
331# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700332our $Attribute = qr{
333 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700334 __percpu|
335 __nocast|
336 __safe|
337 __bitwise__|
338 __packed__|
339 __packed2__|
340 __naked|
341 __maybe_unused|
342 __always_unused|
343 __noreturn|
344 __used|
345 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800346 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700347 __noclone|
348 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700349 __read_mostly|
350 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700351 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700352 ____cacheline_aligned|
353 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800354 ____cacheline_internodealigned_in_smp|
355 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700356 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700357our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700358our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700359our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
360our $Lval = qr{$Ident(?:$Member)*};
361
Joe Perches95e2c602013-07-03 15:05:20 -0700362our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
363our $Binary = qr{(?i)0b[01]+$Int_type?};
364our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
365our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700366our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800367our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800368our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
369our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
370our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800371our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700372our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800373our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700374our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700375our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700376our $Operators = qr{
377 <=|>=|==|!=|
378 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700379 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700380 }x;
381
Joe Perches91cb5192014-04-03 14:49:32 -0700382our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
383
Joe Perchesab7e23f2015-04-16 12:44:22 -0700384our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700386our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700387our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700389our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800390our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700391our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392
Joe Perches15662b32011-10-31 17:13:12 -0700393our $NON_ASCII_UTF8 = qr{
394 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700395 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
396 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
397 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
398 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
399 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
400 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
401}x;
402
Joe Perches15662b32011-10-31 17:13:12 -0700403our $UTF8 = qr{
404 [\x09\x0A\x0D\x20-\x7E] # ASCII
405 | $NON_ASCII_UTF8
406}x;
407
Joe Perchese6176fa2015-06-25 15:02:49 -0700408our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800409our $typeOtherOSTypedefs = qr{(?x:
410 u_(?:char|short|int|long) | # bsd
411 u(?:nchar|short|int|long) # sysv
412)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700413our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700414 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700415 atomic_t
416)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700417our $typeTypedefs = qr{(?x:
418 $typeC99Typedefs\b|
419 $typeOtherOSTypedefs\b|
420 $typeKernelTypedefs\b
421)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700422
Joe Perches6d32f7a2015-11-06 16:31:37 -0800423our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
424
Joe Perches691e6692010-03-05 13:43:51 -0800425our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700426 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700427 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700428 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700429 panic|
Joe Perches06668722013-11-12 15:10:07 -0800430 MODULE_[A-Z_]+|
431 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800432)};
433
Joe Perches20112472011-07-25 17:13:23 -0700434our $signature_tags = qr{(?xi:
435 Signed-off-by:|
436 Acked-by:|
437 Tested-by:|
438 Reviewed-by:|
439 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700440 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700441 To:|
442 Cc:
443)};
444
Joe Perches18130872014-08-06 16:11:22 -0700445our @typeListMisordered = (
446 qr{char\s+(?:un)?signed},
447 qr{int\s+(?:(?:un)?signed\s+)?short\s},
448 qr{int\s+short(?:\s+(?:un)?signed)},
449 qr{short\s+int(?:\s+(?:un)?signed)},
450 qr{(?:un)?signed\s+int\s+short},
451 qr{short\s+(?:un)?signed},
452 qr{long\s+int\s+(?:un)?signed},
453 qr{int\s+long\s+(?:un)?signed},
454 qr{long\s+(?:un)?signed\s+int},
455 qr{int\s+(?:un)?signed\s+long},
456 qr{int\s+(?:un)?signed},
457 qr{int\s+long\s+long\s+(?:un)?signed},
458 qr{long\s+long\s+int\s+(?:un)?signed},
459 qr{long\s+long\s+(?:un)?signed\s+int},
460 qr{long\s+long\s+(?:un)?signed},
461 qr{long\s+(?:un)?signed},
462);
463
Andy Whitcroft8905a672007-11-28 16:21:06 -0800464our @typeList = (
465 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700466 qr{(?:(?:un)?signed\s+)?char},
467 qr{(?:(?:un)?signed\s+)?short\s+int},
468 qr{(?:(?:un)?signed\s+)?short},
469 qr{(?:(?:un)?signed\s+)?int},
470 qr{(?:(?:un)?signed\s+)?long\s+int},
471 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long},
473 qr{(?:(?:un)?signed\s+)?long},
474 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800475 qr{float},
476 qr{double},
477 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800478 qr{struct\s+$Ident},
479 qr{union\s+$Ident},
480 qr{enum\s+$Ident},
481 qr{${Ident}_t},
482 qr{${Ident}_handler},
483 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700484 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800485);
Joe Perches938224b52016-01-20 14:59:15 -0800486
487our $C90_int_types = qr{(?x:
488 long\s+long\s+int\s+(?:un)?signed|
489 long\s+long\s+(?:un)?signed\s+int|
490 long\s+long\s+(?:un)?signed|
491 (?:(?:un)?signed\s+)?long\s+long\s+int|
492 (?:(?:un)?signed\s+)?long\s+long|
493 int\s+long\s+long\s+(?:un)?signed|
494 int\s+(?:(?:un)?signed\s+)?long\s+long|
495
496 long\s+int\s+(?:un)?signed|
497 long\s+(?:un)?signed\s+int|
498 long\s+(?:un)?signed|
499 (?:(?:un)?signed\s+)?long\s+int|
500 (?:(?:un)?signed\s+)?long|
501 int\s+long\s+(?:un)?signed|
502 int\s+(?:(?:un)?signed\s+)?long|
503
504 int\s+(?:un)?signed|
505 (?:(?:un)?signed\s+)?int
506)};
507
Alex Dowad485ff232015-06-25 15:02:52 -0700508our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700509our @typeListWithAttr = (
510 @typeList,
511 qr{struct\s+$InitAttribute\s+$Ident},
512 qr{union\s+$InitAttribute\s+$Ident},
513);
514
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700515our @modifierList = (
516 qr{fastcall},
517);
Alex Dowad485ff232015-06-25 15:02:52 -0700518our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800519
Joe Perches24358802014-04-03 14:49:13 -0700520our @mode_permission_funcs = (
521 ["module_param", 3],
522 ["module_param_(?:array|named|string)", 4],
523 ["module_param_array_named", 5],
524 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
525 ["proc_create(?:_data|)", 2],
526 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
527);
528
Joe Perches515a2352014-04-03 14:49:24 -0700529#Create a search pattern for all these functions to speed up a loop below
530our $mode_perms_search = "";
531foreach my $entry (@mode_permission_funcs) {
532 $mode_perms_search .= '|' if ($mode_perms_search ne "");
533 $mode_perms_search .= $entry->[0];
534}
535
Joe Perchesb392c642015-04-16 12:44:16 -0700536our $mode_perms_world_writable = qr{
537 S_IWUGO |
538 S_IWOTH |
539 S_IRWXUGO |
540 S_IALLUGO |
541 0[0-7][0-7][2367]
542}x;
543
Wolfram Sang7840a942010-08-09 17:20:57 -0700544our $allowed_asm_includes = qr{(?x:
545 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700546 memory|
547 time|
548 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700549)};
550# memory.h: ARM has a custom one
551
Kees Cook66b47b42014-10-13 15:51:57 -0700552# Load common spelling mistakes and build regular expression list.
553my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700554my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700555
Joe Perches36061e32014-12-10 15:51:43 -0800556if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800557 while (<$spelling>) {
558 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700559
Joe Perches36061e32014-12-10 15:51:43 -0800560 $line =~ s/\s*\n?$//g;
561 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700562
Joe Perches36061e32014-12-10 15:51:43 -0800563 next if ($line =~ m/^\s*#/);
564 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700565
Joe Perches36061e32014-12-10 15:51:43 -0800566 my ($suspect, $fix) = split(/\|\|/, $line);
567
Joe Perches36061e32014-12-10 15:51:43 -0800568 $spelling_fix{$suspect} = $fix;
569 }
570 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800571} else {
572 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700573}
Kees Cook66b47b42014-10-13 15:51:57 -0700574
Joe Perchesebfd7d62015-04-16 12:44:14 -0700575if ($codespell) {
576 if (open(my $spelling, '<', $codespellfile)) {
577 while (<$spelling>) {
578 my $line = $_;
579
580 $line =~ s/\s*\n?$//g;
581 $line =~ s/^\s*//g;
582
583 next if ($line =~ m/^\s*#/);
584 next if ($line =~ m/^\s*$/);
585 next if ($line =~ m/, disabled/i);
586
587 $line =~ s/,.*$//;
588
589 my ($suspect, $fix) = split(/->/, $line);
590
591 $spelling_fix{$suspect} = $fix;
592 }
593 close($spelling);
594 } else {
595 warn "No codespell typos will be found - file '$codespellfile': $!\n";
596 }
597}
598
599$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
600
Andy Whitcroft8905a672007-11-28 16:21:06 -0800601sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700602 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
603 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700604 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700605 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700606 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700607 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700608 (?:$typeTypedefs\b)|
609 (?:${all}\b)
610 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800611 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700612 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800613 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800614 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700615 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700616 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800617 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700618 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800619 }x;
Joe Perches18130872014-08-06 16:11:22 -0700620 $NonptrTypeMisordered = qr{
621 (?:$Modifier\s+|const\s+)*
622 (?:
623 (?:${Misordered}\b)
624 )
625 (?:\s+$Modifier|\s+const)*
626 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700627 $NonptrTypeWithAttr = qr{
628 (?:$Modifier\s+|const\s+)*
629 (?:
630 (?:typeof|__typeof__)\s*\([^\)]*\)|
631 (?:$typeTypedefs\b)|
632 (?:${allWithAttr}\b)
633 )
634 (?:\s+$Modifier|\s+const)*
635 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800636 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700637 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700638 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700639 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800640 }x;
Joe Perches18130872014-08-06 16:11:22 -0700641 $TypeMisordered = qr{
642 $NonptrTypeMisordered
643 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
644 (?:\s+$Inline|\s+$Modifier)*
645 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700646 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700647 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800648}
649build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700650
Joe Perches7d2367a2011-07-25 17:13:22 -0700651our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700652
653# Using $balanced_parens, $LvalOrFunc, or $FuncArg
654# requires at least perl version v5.10.0
655# Any use must be runtime checked with $^V
656
657our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700658our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800659our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700660
Joe Perchesf8422302014-08-06 16:11:31 -0700661our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700662 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700663 (?:$Storage\s+)?LIST_HEAD\s*\(|
664 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
665)};
666
Joe Perches7d2367a2011-07-25 17:13:22 -0700667sub deparenthesize {
668 my ($string) = @_;
669 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700670
671 while ($string =~ /^\s*\(.*\)\s*$/) {
672 $string =~ s@^\s*\(\s*@@;
673 $string =~ s@\s*\)\s*$@@;
674 }
675
Joe Perches7d2367a2011-07-25 17:13:22 -0700676 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700677
Joe Perches7d2367a2011-07-25 17:13:22 -0700678 return $string;
679}
680
Joe Perches34456862013-07-03 15:05:34 -0700681sub seed_camelcase_file {
682 my ($file) = @_;
683
684 return if (!(-f $file));
685
686 local $/;
687
688 open(my $include_file, '<', "$file")
689 or warn "$P: Can't read '$file' $!\n";
690 my $text = <$include_file>;
691 close($include_file);
692
693 my @lines = split('\n', $text);
694
695 foreach my $line (@lines) {
696 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
697 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
698 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800699 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
700 $camelcase{$1} = 1;
701 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700702 $camelcase{$1} = 1;
703 }
704 }
705}
706
707my $camelcase_seeded = 0;
708sub seed_camelcase_includes {
709 return if ($camelcase_seeded);
710
711 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700712 my $camelcase_cache = "";
713 my @include_files = ();
714
715 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700716
Richard Genoud3645e322014-02-10 14:25:32 -0800717 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700718 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
719 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700720 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700721 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700722 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700723 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700724 @include_files = split('\n', $files);
725 foreach my $file (@include_files) {
726 my $date = POSIX::strftime("%Y%m%d%H%M",
727 localtime((stat $file)[9]));
728 $last_mod_date = $date if ($last_mod_date < $date);
729 }
730 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700731 }
Joe Perchesc707a812013-07-08 16:00:43 -0700732
733 if ($camelcase_cache ne "" && -f $camelcase_cache) {
734 open(my $camelcase_file, '<', "$camelcase_cache")
735 or warn "$P: Can't read '$camelcase_cache' $!\n";
736 while (<$camelcase_file>) {
737 chomp;
738 $camelcase{$_} = 1;
739 }
740 close($camelcase_file);
741
742 return;
743 }
744
Richard Genoud3645e322014-02-10 14:25:32 -0800745 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700746 $files = `git ls-files "include/*.h"`;
747 @include_files = split('\n', $files);
748 }
749
Joe Perches34456862013-07-03 15:05:34 -0700750 foreach my $file (@include_files) {
751 seed_camelcase_file($file);
752 }
Joe Perches351b2a12013-07-03 15:05:36 -0700753
Joe Perchesc707a812013-07-08 16:00:43 -0700754 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700755 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700756 open(my $camelcase_file, '>', "$camelcase_cache")
757 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700758 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
759 print $camelcase_file ("$_\n");
760 }
761 close($camelcase_file);
762 }
Joe Perches34456862013-07-03 15:05:34 -0700763}
764
Joe Perchesd311cd42014-08-06 16:10:57 -0700765sub git_commit_info {
766 my ($commit, $id, $desc) = @_;
767
768 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
769
770 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
771 $output =~ s/^\s*//gm;
772 my @lines = split("\n", $output);
773
Joe Perches0d7835f2015-02-13 14:38:35 -0800774 return ($id, $desc) if ($#lines < 0);
775
Joe Perchesd311cd42014-08-06 16:10:57 -0700776 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
777# Maybe one day convert this block of bash into something that returns
778# all matching commit ids, but it's very slow...
779#
780# echo "checking commits $1..."
781# git rev-list --remotes | grep -i "^$1" |
782# while read line ; do
783# git log --format='%H %s' -1 $line |
784# echo "commit $(cut -c 1-12,41-)"
785# done
786 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
787 } else {
788 $id = substr($lines[0], 0, 12);
789 $desc = substr($lines[0], 41);
790 }
791
792 return ($id, $desc);
793}
794
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700795$chk_signoff = 0 if ($file);
796
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700797my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800798my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700799my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700800my @fixed_inserted = ();
801my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700802my $fixlinenr = -1;
803
Du, Changbin4a593c32016-05-20 17:04:16 -0700804# If input is git commits, extract all commits from the commit expressions.
805# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
806die "$P: No git repository found\n" if ($git && !-e ".git");
807
808if ($git) {
809 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700810 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700811 my $git_range;
812 if ($commit_expr =~ m/-/) {
813 my @tmp = split(/-/, $commit_expr);
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700814 die "$P: incorrect git commit expression '$commit_expr' $!\n"
Du, Changbin4a593c32016-05-20 17:04:16 -0700815 if (@tmp != 2);
816 $git_range = "-$tmp[1] $tmp[0]";
817 } elsif ($commit_expr =~ m/\.\./) {
818 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700819 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700820 $git_range = "-1 $commit_expr";
821 }
822 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
823 foreach my $line (split(/\n/, $lines)) {
824 $line =~ /(^\w+) (.*)/;
825 my $sha1 = $1;
826 my $subject = $2;
827 unshift(@commits, $sha1);
828 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700829 }
830 }
831 die "$P: no git commits after extraction!\n" if (@commits == 0);
832 @ARGV = @commits;
833}
834
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800835my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700836for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800837 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700838 if ($git) {
839 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
840 die "$P: $filename: git format-patch failed - $!\n";
841 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800842 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700843 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800844 } elsif ($filename eq '-') {
845 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700846 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800847 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700848 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700849 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800850 if ($filename eq '-') {
851 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700852 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700853 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800854 } else {
855 $vname = $filename;
856 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800857 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700858 chomp;
859 push(@rawlines, $_);
860 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800861 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700862
863 if ($#ARGV > 0 && $quiet == 0) {
864 print '-' x length($vname) . "\n";
865 print "$vname\n";
866 print '-' x length($vname) . "\n";
867 }
868
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800869 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700870 $exit = 1;
871 }
872 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800873 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700874 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700875 @fixed_inserted = ();
876 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700877 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700878 @modifierListFile = ();
879 @typeListFile = ();
880 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700881}
882
Joe Perchesd8469f12015-06-25 15:03:00 -0700883if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700884 hash_show_words(\%use_type, "Used");
885 hash_show_words(\%ignore_type, "Ignored");
886
Joe Perchesd8469f12015-06-25 15:03:00 -0700887 if ($^V lt 5.10.0) {
888 print << "EOM"
889
890NOTE: perl $^V is not modern enough to detect all possible issues.
891 An upgrade to at least perl v5.10.0 is suggested.
892EOM
893 }
894 if ($exit) {
895 print << "EOM"
896
897NOTE: If any of the errors are false positives, please report
898 them to the maintainer, see CHECKPATCH in MAINTAINERS.
899EOM
900 }
901}
902
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700903exit($exit);
904
905sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700906 my ($root) = @_;
907
908 my @tree_check = (
909 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
910 "README", "Documentation", "arch", "include", "drivers",
911 "fs", "init", "ipc", "kernel", "lib", "scripts",
912 );
913
914 foreach my $check (@tree_check) {
915 if (! -e $root . '/' . $check) {
916 return 0;
917 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700918 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700919 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700920}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700921
Joe Perches20112472011-07-25 17:13:23 -0700922sub parse_email {
923 my ($formatted_email) = @_;
924
925 my $name = "";
926 my $address = "";
927 my $comment = "";
928
929 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
930 $name = $1;
931 $address = $2;
932 $comment = $3 if defined $3;
933 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
934 $address = $1;
935 $comment = $2 if defined $2;
936 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
937 $address = $1;
938 $comment = $2 if defined $2;
939 $formatted_email =~ s/$address.*$//;
940 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700941 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700942 $name =~ s/^\"|\"$//g;
943 # If there's a name left after stripping spaces and
944 # leading quotes, and the address doesn't have both
945 # leading and trailing angle brackets, the address
946 # is invalid. ie:
947 # "joe smith joe@smith.com" bad
948 # "joe smith <joe@smith.com" bad
949 if ($name ne "" && $address !~ /^<[^>]+>$/) {
950 $name = "";
951 $address = "";
952 $comment = "";
953 }
954 }
955
Joe Perches3705ce52013-07-03 15:05:31 -0700956 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700957 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700958 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700959 $address =~ s/^\<|\>$//g;
960
961 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
962 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
963 $name = "\"$name\"";
964 }
965
966 return ($name, $address, $comment);
967}
968
969sub format_email {
970 my ($name, $address) = @_;
971
972 my $formatted_email;
973
Joe Perches3705ce52013-07-03 15:05:31 -0700974 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700975 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700976 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700977
978 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
979 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
980 $name = "\"$name\"";
981 }
982
983 if ("$name" eq "") {
984 $formatted_email = "$address";
985 } else {
986 $formatted_email = "$name <$address>";
987 }
988
989 return $formatted_email;
990}
991
Joe Perchesd311cd42014-08-06 16:10:57 -0700992sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700993 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700994
Joe Perchesbd474ca2014-08-06 16:11:10 -0700995 foreach my $path (split(/:/, $ENV{PATH})) {
996 if (-e "$path/$bin") {
997 return "$path/$bin";
998 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700999 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001000
Joe Perchesbd474ca2014-08-06 16:11:10 -07001001 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001002}
1003
Joe Perches000d1cc12011-07-25 17:13:25 -07001004sub which_conf {
1005 my ($conf) = @_;
1006
1007 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1008 if (-e "$path/$conf") {
1009 return "$path/$conf";
1010 }
1011 }
1012
1013 return "";
1014}
1015
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001016sub expand_tabs {
1017 my ($str) = @_;
1018
1019 my $res = '';
1020 my $n = 0;
1021 for my $c (split(//, $str)) {
1022 if ($c eq "\t") {
1023 $res .= ' ';
1024 $n++;
1025 for (; ($n % 8) != 0; $n++) {
1026 $res .= ' ';
1027 }
1028 next;
1029 }
1030 $res .= $c;
1031 $n++;
1032 }
1033
1034 return $res;
1035}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001036sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001037 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001038 return $res;
1039}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001040
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001041sub line_stats {
1042 my ($line) = @_;
1043
1044 # Drop the diff line leader and expand tabs
1045 $line =~ s/^.//;
1046 $line = expand_tabs($line);
1047
1048 # Pick the indent from the front of the line.
1049 my ($white) = ($line =~ /^(\s*)/);
1050
1051 return (length($line), length($white));
1052}
1053
Andy Whitcroft773647a2008-03-28 14:15:58 -07001054my $sanitise_quote = '';
1055
1056sub sanitise_line_reset {
1057 my ($in_comment) = @_;
1058
1059 if ($in_comment) {
1060 $sanitise_quote = '*/';
1061 } else {
1062 $sanitise_quote = '';
1063 }
1064}
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001065sub sanitise_line {
1066 my ($line) = @_;
1067
1068 my $res = '';
1069 my $l = '';
1070
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001071 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001072 my $off = 0;
1073 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001074
Andy Whitcroft773647a2008-03-28 14:15:58 -07001075 # Always copy over the diff marker.
1076 $res = substr($line, 0, 1);
1077
1078 for ($off = 1; $off < length($line); $off++) {
1079 $c = substr($line, $off, 1);
1080
1081 # Comments we are wacking completly including the begin
1082 # and end, all to $;.
1083 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1084 $sanitise_quote = '*/';
1085
1086 substr($res, $off, 2, "$;$;");
1087 $off++;
1088 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001089 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001090 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001091 $sanitise_quote = '';
1092 substr($res, $off, 2, "$;$;");
1093 $off++;
1094 next;
1095 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001096 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1097 $sanitise_quote = '//';
1098
1099 substr($res, $off, 2, $sanitise_quote);
1100 $off++;
1101 next;
1102 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001103
1104 # A \ in a string means ignore the next character.
1105 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1106 $c eq "\\") {
1107 substr($res, $off, 2, 'XX');
1108 $off++;
1109 next;
1110 }
1111 # Regular quotes.
1112 if ($c eq "'" || $c eq '"') {
1113 if ($sanitise_quote eq '') {
1114 $sanitise_quote = $c;
1115
1116 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001117 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001118 } elsif ($sanitise_quote eq $c) {
1119 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001120 }
1121 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001122
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001123 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001124 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1125 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001126 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1127 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001128 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1129 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001130 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001131 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001132 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001133 }
1134
Daniel Walker113f04a2009-09-21 17:04:35 -07001135 if ($sanitise_quote eq '//') {
1136 $sanitise_quote = '';
1137 }
1138
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001139 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001140 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001141 my $clean = 'X' x length($1);
1142 $res =~ s@\<.*\>@<$clean>@;
1143
1144 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001145 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001146 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001147 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001148 }
1149
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001150 return $res;
1151}
1152
Joe Perchesa6962d72013-04-29 16:18:13 -07001153sub get_quoted_string {
1154 my ($line, $rawline) = @_;
1155
Joe Perches33acb542015-06-25 15:02:54 -07001156 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001157 return substr($rawline, $-[0], $+[0] - $-[0]);
1158}
1159
Andy Whitcroft8905a672007-11-28 16:21:06 -08001160sub ctx_statement_block {
1161 my ($linenr, $remain, $off) = @_;
1162 my $line = $linenr - 1;
1163 my $blk = '';
1164 my $soff = $off;
1165 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001166 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001167
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001168 my $loff = 0;
1169
Andy Whitcroft8905a672007-11-28 16:21:06 -08001170 my $type = '';
1171 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001172 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001173 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001174 my $c;
1175 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001176
1177 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001178 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001179 @stack = (['', 0]) if ($#stack == -1);
1180
Andy Whitcroft773647a2008-03-28 14:15:58 -07001181 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001182 # If we are about to drop off the end, pull in more
1183 # context.
1184 if ($off >= $len) {
1185 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001186 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001187 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001188 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001189 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001190 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001191 $len = length($blk);
1192 $line++;
1193 last;
1194 }
1195 # Bail if there is no further context.
1196 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001197 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001198 last;
1199 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001200 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1201 $level++;
1202 $type = '#';
1203 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001204 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001205 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001206 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001207 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001208
Andy Whitcroft773647a2008-03-28 14:15:58 -07001209 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001210
1211 # Handle nested #if/#else.
1212 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1213 push(@stack, [ $type, $level ]);
1214 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1215 ($type, $level) = @{$stack[$#stack - 1]};
1216 } elsif ($remainder =~ /^#\s*endif\b/) {
1217 ($type, $level) = @{pop(@stack)};
1218 }
1219
Andy Whitcroft8905a672007-11-28 16:21:06 -08001220 # Statement ends at the ';' or a close '}' at the
1221 # outermost level.
1222 if ($level == 0 && $c eq ';') {
1223 last;
1224 }
1225
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001226 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001227 if ($level == 0 && $coff_set == 0 &&
1228 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1229 $remainder =~ /^(else)(?:\s|{)/ &&
1230 $remainder !~ /^else\s+if\b/) {
1231 $coff = $off + length($1) - 1;
1232 $coff_set = 1;
1233 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1234 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001235 }
1236
Andy Whitcroft8905a672007-11-28 16:21:06 -08001237 if (($type eq '' || $type eq '(') && $c eq '(') {
1238 $level++;
1239 $type = '(';
1240 }
1241 if ($type eq '(' && $c eq ')') {
1242 $level--;
1243 $type = ($level != 0)? '(' : '';
1244
1245 if ($level == 0 && $coff < $soff) {
1246 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001247 $coff_set = 1;
1248 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001249 }
1250 }
1251 if (($type eq '' || $type eq '{') && $c eq '{') {
1252 $level++;
1253 $type = '{';
1254 }
1255 if ($type eq '{' && $c eq '}') {
1256 $level--;
1257 $type = ($level != 0)? '{' : '';
1258
1259 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001260 if (substr($blk, $off + 1, 1) eq ';') {
1261 $off++;
1262 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001263 last;
1264 }
1265 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001266 # Preprocessor commands end at the newline unless escaped.
1267 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1268 $level--;
1269 $type = '';
1270 $off++;
1271 last;
1272 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001273 $off++;
1274 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001275 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001276 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001277 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001278 $line++;
1279 $remain--;
1280 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001281
1282 my $statement = substr($blk, $soff, $off - $soff + 1);
1283 my $condition = substr($blk, $soff, $coff - $soff + 1);
1284
1285 #warn "STATEMENT<$statement>\n";
1286 #warn "CONDITION<$condition>\n";
1287
Andy Whitcroft773647a2008-03-28 14:15:58 -07001288 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001289
1290 return ($statement, $condition,
1291 $line, $remain + 1, $off - $loff + 1, $level);
1292}
1293
Andy Whitcroftcf655042008-03-04 14:28:20 -08001294sub statement_lines {
1295 my ($stmt) = @_;
1296
1297 # Strip the diff line prefixes and rip blank lines at start and end.
1298 $stmt =~ s/(^|\n)./$1/g;
1299 $stmt =~ s/^\s*//;
1300 $stmt =~ s/\s*$//;
1301
1302 my @stmt_lines = ($stmt =~ /\n/g);
1303
1304 return $#stmt_lines + 2;
1305}
1306
1307sub statement_rawlines {
1308 my ($stmt) = @_;
1309
1310 my @stmt_lines = ($stmt =~ /\n/g);
1311
1312 return $#stmt_lines + 2;
1313}
1314
1315sub statement_block_size {
1316 my ($stmt) = @_;
1317
1318 $stmt =~ s/(^|\n)./$1/g;
1319 $stmt =~ s/^\s*{//;
1320 $stmt =~ s/}\s*$//;
1321 $stmt =~ s/^\s*//;
1322 $stmt =~ s/\s*$//;
1323
1324 my @stmt_lines = ($stmt =~ /\n/g);
1325 my @stmt_statements = ($stmt =~ /;/g);
1326
1327 my $stmt_lines = $#stmt_lines + 2;
1328 my $stmt_statements = $#stmt_statements + 1;
1329
1330 if ($stmt_lines > $stmt_statements) {
1331 return $stmt_lines;
1332 } else {
1333 return $stmt_statements;
1334 }
1335}
1336
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001337sub ctx_statement_full {
1338 my ($linenr, $remain, $off) = @_;
1339 my ($statement, $condition, $level);
1340
1341 my (@chunks);
1342
Andy Whitcroftcf655042008-03-04 14:28:20 -08001343 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001344 ($statement, $condition, $linenr, $remain, $off, $level) =
1345 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001346 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001347 push(@chunks, [ $condition, $statement ]);
1348 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1349 return ($level, $linenr, @chunks);
1350 }
1351
1352 # Pull in the following conditional/block pairs and see if they
1353 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001354 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001355 ($statement, $condition, $linenr, $remain, $off, $level) =
1356 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001357 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001358 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001359 #print "C: push\n";
1360 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001361 }
1362
1363 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001364}
1365
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001366sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001367 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001368 my $line;
1369 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001370 my $blk = '';
1371 my @o;
1372 my @c;
1373 my @res = ();
1374
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001375 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001376 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001377 for ($line = $start; $remain > 0; $line++) {
1378 next if ($rawlines[$line] =~ /^-/);
1379 $remain--;
1380
1381 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001382
1383 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001384 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001385 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001386 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001387 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001388 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001389 $level = pop(@stack);
1390 }
1391
Andy Whitcroft01464f32010-10-26 14:23:19 -07001392 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001393 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1394 if ($off > 0) {
1395 $off--;
1396 next;
1397 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001398
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001399 if ($c eq $close && $level > 0) {
1400 $level--;
1401 last if ($level == 0);
1402 } elsif ($c eq $open) {
1403 $level++;
1404 }
1405 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001406
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001407 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001408 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001409 }
1410
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001411 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001412 }
1413
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001414 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001415}
1416sub ctx_block_outer {
1417 my ($linenr, $remain) = @_;
1418
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001419 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1420 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001421}
1422sub ctx_block {
1423 my ($linenr, $remain) = @_;
1424
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001425 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1426 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001427}
1428sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001429 my ($linenr, $remain, $off) = @_;
1430
1431 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1432 return @r;
1433}
1434sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001435 my ($linenr, $remain) = @_;
1436
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001437 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001438}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001439sub ctx_statement_level {
1440 my ($linenr, $remain, $off) = @_;
1441
1442 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1443}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001444
1445sub ctx_locate_comment {
1446 my ($first_line, $end_line) = @_;
1447
1448 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001449 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001450 return $current_comment if (defined $current_comment);
1451
1452 # Look through the context and try and figure out if there is a
1453 # comment.
1454 my $in_comment = 0;
1455 $current_comment = '';
1456 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001457 my $line = $rawlines[$linenr - 1];
1458 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001459 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1460 $in_comment = 1;
1461 }
1462 if ($line =~ m@/\*@) {
1463 $in_comment = 1;
1464 }
1465 if (!$in_comment && $current_comment ne '') {
1466 $current_comment = '';
1467 }
1468 $current_comment .= $line . "\n" if ($in_comment);
1469 if ($line =~ m@\*/@) {
1470 $in_comment = 0;
1471 }
1472 }
1473
1474 chomp($current_comment);
1475 return($current_comment);
1476}
1477sub ctx_has_comment {
1478 my ($first_line, $end_line) = @_;
1479 my $cmt = ctx_locate_comment($first_line, $end_line);
1480
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001481 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001482 ##print "CMMT: $cmt\n";
1483
1484 return ($cmt ne '');
1485}
1486
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001487sub raw_line {
1488 my ($linenr, $cnt) = @_;
1489
1490 my $offset = $linenr - 1;
1491 $cnt++;
1492
1493 my $line;
1494 while ($cnt) {
1495 $line = $rawlines[$offset++];
1496 next if (defined($line) && $line =~ /^-/);
1497 $cnt--;
1498 }
1499
1500 return $line;
1501}
1502
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001503sub cat_vet {
1504 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001505 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001506
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001507 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001508 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1509 $res .= $1;
1510 if ($2 ne '') {
1511 $coded = sprintf("^%c", unpack('C', $2) + 64);
1512 $res .= $coded;
1513 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001514 }
1515 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001516
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001517 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001518}
1519
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001520my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001521my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001522my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001523my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001524
1525sub annotate_reset {
1526 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001527 $av_pending = '_';
1528 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001529 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001530}
1531
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001532sub annotate_values {
1533 my ($stream, $type) = @_;
1534
1535 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001536 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001537 my $cur = $stream;
1538
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001539 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001540
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001541 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001542 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001543 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001544 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001545 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001546 print "WS($1)\n" if ($dbg_values > 1);
1547 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001548 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001549 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001550 }
1551
Florian Micklerc023e4732011-01-12 16:59:58 -08001552 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001553 print "CAST($1)\n" if ($dbg_values > 1);
1554 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001555 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001556
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001557 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001558 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001559 $type = 'T';
1560
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001561 } elsif ($cur =~ /^($Modifier)\s*/) {
1562 print "MODIFIER($1)\n" if ($dbg_values > 1);
1563 $type = 'T';
1564
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001565 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001566 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001567 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001568 push(@av_paren_type, $type);
1569 if ($2 ne '') {
1570 $av_pending = 'N';
1571 }
1572 $type = 'E';
1573
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001574 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001575 print "UNDEF($1)\n" if ($dbg_values > 1);
1576 $av_preprocessor = 1;
1577 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001578
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001579 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001580 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001581 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001582
1583 push(@av_paren_type, $type);
1584 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001585 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001586
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001587 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001588 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1589 $av_preprocessor = 1;
1590
1591 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1592
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001593 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001594
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001595 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001596 print "PRE_END($1)\n" if ($dbg_values > 1);
1597
1598 $av_preprocessor = 1;
1599
1600 # Assume all arms of the conditional end as this
1601 # one does, and continue as if the #endif was not here.
1602 pop(@av_paren_type);
1603 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001604 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001605
1606 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001607 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001608
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001609 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1610 print "ATTR($1)\n" if ($dbg_values > 1);
1611 $av_pending = $type;
1612 $type = 'N';
1613
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001614 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001615 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001616 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001617 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001618 }
1619 $type = 'N';
1620
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001621 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001622 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001623 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001624 $type = 'N';
1625
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001626 } elsif ($cur =~/^(case)/o) {
1627 print "CASE($1)\n" if ($dbg_values > 1);
1628 $av_pend_colon = 'C';
1629 $type = 'N';
1630
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001631 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001632 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001633 $type = 'N';
1634
1635 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001636 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001637 push(@av_paren_type, $av_pending);
1638 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001639 $type = 'N';
1640
1641 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001642 my $new_type = pop(@av_paren_type);
1643 if ($new_type ne '_') {
1644 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001645 print "PAREN('$1') -> $type\n"
1646 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001647 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001648 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001649 }
1650
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001651 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001652 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001653 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001654 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001655
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001656 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1657 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001658 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001659 } elsif ($type eq 'E') {
1660 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001661 }
1662 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1663 $type = 'V';
1664
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001665 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001666 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001667 $type = 'V';
1668
1669 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001670 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001671 $type = 'N';
1672
Andy Whitcroftcf655042008-03-04 14:28:20 -08001673 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001674 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001675 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001676 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001677
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001678 } elsif ($cur =~/^(,)/) {
1679 print "COMMA($1)\n" if ($dbg_values > 1);
1680 $type = 'C';
1681
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001682 } elsif ($cur =~ /^(\?)/o) {
1683 print "QUESTION($1)\n" if ($dbg_values > 1);
1684 $type = 'N';
1685
1686 } elsif ($cur =~ /^(:)/o) {
1687 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1688
1689 substr($var, length($res), 1, $av_pend_colon);
1690 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1691 $type = 'E';
1692 } else {
1693 $type = 'N';
1694 }
1695 $av_pend_colon = 'O';
1696
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001697 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001698 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001699 $type = 'N';
1700
Andy Whitcroft0d413862008-10-15 22:02:16 -07001701 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001702 my $variant;
1703
1704 print "OPV($1)\n" if ($dbg_values > 1);
1705 if ($type eq 'V') {
1706 $variant = 'B';
1707 } else {
1708 $variant = 'U';
1709 }
1710
1711 substr($var, length($res), 1, $variant);
1712 $type = 'N';
1713
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001714 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001715 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001716 if ($1 ne '++' && $1 ne '--') {
1717 $type = 'N';
1718 }
1719
1720 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001721 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001722 }
1723 if (defined $1) {
1724 $cur = substr($cur, length($1));
1725 $res .= $type x length($1);
1726 }
1727 }
1728
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001729 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001730}
1731
Andy Whitcroft8905a672007-11-28 16:21:06 -08001732sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001733 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001734 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001735 ^(?:
1736 $Modifier|
1737 $Storage|
1738 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001739 DEFINE_\S+
1740 )$|
1741 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001742 goto|
1743 return|
1744 case|
1745 else|
1746 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001747 do|
1748 \#|
1749 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001750 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001751 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001752 )}x;
1753 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1754 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001755 # Check for modifiers.
1756 $possible =~ s/\s*$Storage\s*//g;
1757 $possible =~ s/\s*$Sparse\s*//g;
1758 if ($possible =~ /^\s*$/) {
1759
1760 } elsif ($possible =~ /\s/) {
1761 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001762 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001763 if ($modifier !~ $notPermitted) {
1764 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001765 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001766 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001767 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001768
1769 } else {
1770 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001771 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001772 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001773 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001774 } else {
1775 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001776 }
1777}
1778
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001779my $prefix = '';
1780
Joe Perches000d1cc12011-07-25 17:13:25 -07001781sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001782 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001783
Joe Perchescbec18a2014-04-03 14:49:19 -07001784 return defined $use_type{$type} if (scalar keys %use_type > 0);
1785
1786 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001787}
1788
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001789sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001790 my ($level, $type, $msg) = @_;
1791
1792 if (!show_type($type) ||
1793 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001794 return 0;
1795 }
Joe Perches57230292015-06-25 15:03:03 -07001796 my $output = '';
1797 if (-t STDOUT && $color) {
1798 if ($level eq 'ERROR') {
1799 $output .= RED;
1800 } elsif ($level eq 'WARNING') {
1801 $output .= YELLOW;
1802 } else {
1803 $output .= GREEN;
1804 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001805 }
Joe Perches57230292015-06-25 15:03:03 -07001806 $output .= $prefix . $level . ':';
1807 if ($show_types) {
1808 $output .= BLUE if (-t STDOUT && $color);
1809 $output .= "$type:";
1810 }
1811 $output .= RESET if (-t STDOUT && $color);
1812 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001813
1814 if ($showfile) {
1815 my @lines = split("\n", $output, -1);
1816 splice(@lines, 1, 1);
1817 $output = join("\n", @lines);
1818 }
Joe Perches57230292015-06-25 15:03:03 -07001819 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001820
Joe Perches57230292015-06-25 15:03:03 -07001821 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001822
1823 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001824}
Joe Perchescbec18a2014-04-03 14:49:19 -07001825
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001826sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001827 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001828}
Joe Perches000d1cc12011-07-25 17:13:25 -07001829
Joe Perchesd752fcc2014-08-06 16:11:05 -07001830sub fixup_current_range {
1831 my ($lineRef, $offset, $length) = @_;
1832
1833 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1834 my $o = $1;
1835 my $l = $2;
1836 my $no = $o + $offset;
1837 my $nl = $l + $length;
1838 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1839 }
1840}
1841
1842sub fix_inserted_deleted_lines {
1843 my ($linesRef, $insertedRef, $deletedRef) = @_;
1844
1845 my $range_last_linenr = 0;
1846 my $delta_offset = 0;
1847
1848 my $old_linenr = 0;
1849 my $new_linenr = 0;
1850
1851 my $next_insert = 0;
1852 my $next_delete = 0;
1853
1854 my @lines = ();
1855
1856 my $inserted = @{$insertedRef}[$next_insert++];
1857 my $deleted = @{$deletedRef}[$next_delete++];
1858
1859 foreach my $old_line (@{$linesRef}) {
1860 my $save_line = 1;
1861 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001862 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001863 $delta_offset = 0;
1864 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1865 $range_last_linenr = $new_linenr;
1866 fixup_current_range(\$line, $delta_offset, 0);
1867 }
1868
1869 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1870 $deleted = @{$deletedRef}[$next_delete++];
1871 $save_line = 0;
1872 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1873 }
1874
1875 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1876 push(@lines, ${$inserted}{'LINE'});
1877 $inserted = @{$insertedRef}[$next_insert++];
1878 $new_linenr++;
1879 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1880 }
1881
1882 if ($save_line) {
1883 push(@lines, $line);
1884 $new_linenr++;
1885 }
1886
1887 $old_linenr++;
1888 }
1889
1890 return @lines;
1891}
1892
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001893sub fix_insert_line {
1894 my ($linenr, $line) = @_;
1895
1896 my $inserted = {
1897 LINENR => $linenr,
1898 LINE => $line,
1899 };
1900 push(@fixed_inserted, $inserted);
1901}
1902
1903sub fix_delete_line {
1904 my ($linenr, $line) = @_;
1905
1906 my $deleted = {
1907 LINENR => $linenr,
1908 LINE => $line,
1909 };
1910
1911 push(@fixed_deleted, $deleted);
1912}
1913
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001914sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001915 my ($type, $msg) = @_;
1916
1917 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001918 our $clean = 0;
1919 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001920 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001921 }
Joe Perches3705ce52013-07-03 15:05:31 -07001922 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001923}
1924sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001925 my ($type, $msg) = @_;
1926
1927 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001928 our $clean = 0;
1929 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001930 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001931 }
Joe Perches3705ce52013-07-03 15:05:31 -07001932 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001933}
1934sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001935 my ($type, $msg) = @_;
1936
1937 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001938 our $clean = 0;
1939 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001940 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001941 }
Joe Perches3705ce52013-07-03 15:05:31 -07001942 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001943}
1944
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001945sub check_absolute_file {
1946 my ($absolute, $herecurr) = @_;
1947 my $file = $absolute;
1948
1949 ##print "absolute<$absolute>\n";
1950
1951 # See if any suffix of this path is a path within the tree.
1952 while ($file =~ s@^[^/]*/@@) {
1953 if (-f "$root/$file") {
1954 ##print "file<$file>\n";
1955 last;
1956 }
1957 }
1958 if (! -f _) {
1959 return 0;
1960 }
1961
1962 # It is, so see if the prefix is acceptable.
1963 my $prefix = $absolute;
1964 substr($prefix, -length($file)) = '';
1965
1966 ##print "prefix<$prefix>\n";
1967 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001968 WARN("USE_RELATIVE_PATH",
1969 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001970 }
1971}
1972
Joe Perches3705ce52013-07-03 15:05:31 -07001973sub trim {
1974 my ($string) = @_;
1975
Joe Perchesb34c6482013-09-11 14:24:01 -07001976 $string =~ s/^\s+|\s+$//g;
1977
1978 return $string;
1979}
1980
1981sub ltrim {
1982 my ($string) = @_;
1983
1984 $string =~ s/^\s+//;
1985
1986 return $string;
1987}
1988
1989sub rtrim {
1990 my ($string) = @_;
1991
1992 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001993
1994 return $string;
1995}
1996
Joe Perches52ea8502013-11-12 15:10:09 -08001997sub string_find_replace {
1998 my ($string, $find, $replace) = @_;
1999
2000 $string =~ s/$find/$replace/g;
2001
2002 return $string;
2003}
2004
Joe Perches3705ce52013-07-03 15:05:31 -07002005sub tabify {
2006 my ($leading) = @_;
2007
2008 my $source_indent = 8;
2009 my $max_spaces_before_tab = $source_indent - 1;
2010 my $spaces_to_tab = " " x $source_indent;
2011
2012 #convert leading spaces to tabs
2013 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2014 #Remove spaces before a tab
2015 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2016
2017 return "$leading";
2018}
2019
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002020sub pos_last_openparen {
2021 my ($line) = @_;
2022
2023 my $pos = 0;
2024
2025 my $opens = $line =~ tr/\(/\(/;
2026 my $closes = $line =~ tr/\)/\)/;
2027
2028 my $last_openparen = 0;
2029
2030 if (($opens == 0) || ($closes >= $opens)) {
2031 return -1;
2032 }
2033
2034 my $len = length($line);
2035
2036 for ($pos = 0; $pos < $len; $pos++) {
2037 my $string = substr($line, $pos);
2038 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2039 $pos += length($1) - 1;
2040 } elsif (substr($line, $pos, 1) eq '(') {
2041 $last_openparen = $pos;
2042 } elsif (index($string, '(') == -1) {
2043 last;
2044 }
2045 }
2046
Joe Perches91cb5192014-04-03 14:49:32 -07002047 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002048}
2049
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002050sub process {
2051 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002052
2053 my $linenr=0;
2054 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002055 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002056 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002057 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002058
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002059 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002060 my $indent;
2061 my $previndent=0;
2062 my $stashindent=0;
2063
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002064 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002065 my $signoff = 0;
2066 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002067 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002068 my $in_commit_log = 0; #Scanning lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002069 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002070 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002071 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002072 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002073 my $non_utf8_charset = 0;
2074
Joe Perches365dd4e2014-08-06 16:10:42 -07002075 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002076 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002077
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002078 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002079 our $cnt_lines = 0;
2080 our $cnt_error = 0;
2081 our $cnt_warn = 0;
2082 our $cnt_chk = 0;
2083
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002084 # Trace the real file/line as we go.
2085 my $realfile = '';
2086 my $realline = 0;
2087 my $realcnt = 0;
2088 my $here = '';
2089 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002090 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002091 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002092 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002093
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002094 my $prev_values = 'E';
2095
2096 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002097 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002098 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002099 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002100 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002101
Joe Perches7e51f192013-09-11 14:23:57 -07002102 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002103
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002104 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002105 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002106 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002107 my @setup_docs = ();
2108 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002109
Joe Perchesd8b07712013-11-12 15:10:06 -08002110 my $camelcase_file_seeded = 0;
2111
Andy Whitcroft773647a2008-03-28 14:15:58 -07002112 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002113 my $line;
2114 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002115 $linenr++;
2116 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002117
Joe Perches3705ce52013-07-03 15:05:31 -07002118 push(@fixed, $rawline) if ($fix);
2119
Andy Whitcroft773647a2008-03-28 14:15:58 -07002120 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002121 $setup_docs = 0;
2122 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2123 $setup_docs = 1;
2124 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002125 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002126 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002127 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2128 $realline=$1-1;
2129 if (defined $2) {
2130 $realcnt=$3+1;
2131 } else {
2132 $realcnt=1+1;
2133 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002134 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002135
2136 # Guestimate if this is a continuing comment. Run
2137 # the context looking for a comment "edge". If this
2138 # edge is a close comment then we must be in a comment
2139 # at context start.
2140 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002141 my $cnt = $realcnt;
2142 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2143 next if (defined $rawlines[$ln - 1] &&
2144 $rawlines[$ln - 1] =~ /^-/);
2145 $cnt--;
2146 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002147 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002148 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2149 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2150 ($edge) = $1;
2151 last;
2152 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002153 }
2154 if (defined $edge && $edge eq '*/') {
2155 $in_comment = 1;
2156 }
2157
2158 # Guestimate if this is a continuing comment. If this
2159 # is the start of a diff block and this line starts
2160 # ' *' then it is very likely a comment.
2161 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002162 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002163 {
2164 $in_comment = 1;
2165 }
2166
2167 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2168 sanitise_line_reset($in_comment);
2169
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002170 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002171 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002172 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002173 $line = sanitise_line($rawline);
2174 }
2175 push(@lines, $line);
2176
2177 if ($realcnt > 1) {
2178 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2179 } else {
2180 $realcnt = 0;
2181 }
2182
2183 #print "==>$rawline\n";
2184 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002185
2186 if ($setup_docs && $line =~ /^\+/) {
2187 push(@setup_docs, $line);
2188 }
2189 }
2190
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002191 $prefix = '';
2192
Andy Whitcroft773647a2008-03-28 14:15:58 -07002193 $realcnt = 0;
2194 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002195 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002196 foreach my $line (@lines) {
2197 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002198 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002199 my $sline = $line; #copy of $line
2200 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002201
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002202 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002203
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002204#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002205 if (!$in_commit_log &&
2206 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002207 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002208 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002209 $realline=$1-1;
2210 if (defined $2) {
2211 $realcnt=$3+1;
2212 } else {
2213 $realcnt=1+1;
2214 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002215 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002216 $prev_values = 'E';
2217
Andy Whitcroft773647a2008-03-28 14:15:58 -07002218 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002219 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002220 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002221 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002222 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002223
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002224# track the line number as we move through the hunk, note that
2225# new versions of GNU diff omit the leading space on completely
2226# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002227 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002228 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002229 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002230
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002231 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002232 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002233
2234 # Track the previous line.
2235 ($prevline, $stashline) = ($stashline, $line);
2236 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002237 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2238
Andy Whitcroft773647a2008-03-28 14:15:58 -07002239 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002240
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002241 } elsif ($realcnt == 1) {
2242 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002243 }
2244
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002245 my $hunk_line = ($realcnt != 0);
2246
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002247 $here = "#$linenr: " if (!$file);
2248 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002249
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002250 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002251 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002252 if ($line =~ /^diff --git.*?(\S+)$/) {
2253 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002254 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002255 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002256 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002257 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002258 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002259 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002260 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002261
2262 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002263 if (!$file && $tree && $p1_prefix ne '' &&
2264 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002265 WARN("PATCH_PREFIX",
2266 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002267 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002268
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002269 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002270 ERROR("MODIFIED_INCLUDE_ASM",
2271 "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 -07002272 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002273 $found_file = 1;
2274 }
2275
Joe Perches34d88152015-06-25 15:03:05 -07002276#make up the handle for any error we report on this line
2277 if ($showfile) {
2278 $prefix = "$realfile:$realline: "
2279 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002280 if ($file) {
2281 $prefix = "$filename:$realline: ";
2282 } else {
2283 $prefix = "$filename:$linenr: ";
2284 }
Joe Perches34d88152015-06-25 15:03:05 -07002285 }
2286
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002287 if ($found_file) {
Joe Perches7bd7e482015-09-09 15:37:44 -07002288 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002289 $check = 1;
2290 } else {
2291 $check = $check_orig;
2292 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002293 next;
2294 }
2295
Randy Dunlap389834b2007-06-08 13:47:03 -07002296 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002297
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002298 my $hereline = "$here\n$rawline\n";
2299 my $herecurr = "$here\n$rawline\n";
2300 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002301
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002302 $cnt_lines++ if ($realcnt != 0);
2303
Joe Perchese518e9a2015-06-25 15:03:27 -07002304# Check if the commit log has what seems like a diff which can confuse patch
2305 if ($in_commit_log && !$commit_log_has_diff &&
2306 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2307 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2308 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2309 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2310 ERROR("DIFF_IN_COMMIT_MSG",
2311 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2312 $commit_log_has_diff = 1;
2313 }
2314
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002315# Check for incorrect file permissions
2316 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2317 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002318 if ($realfile !~ m@scripts/@ &&
2319 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002320 ERROR("EXECUTE_PERMISSIONS",
2321 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002322 }
2323 }
2324
Joe Perches20112472011-07-25 17:13:23 -07002325# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002326 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002327 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002328 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002329 }
2330
Joe Perchese0d975b2014-12-10 15:51:49 -08002331# Check if MAINTAINERS is being updated. If so, there's probably no need to
2332# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2333 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2334 $reported_maintainer_file = 1;
2335 }
2336
Joe Perches20112472011-07-25 17:13:23 -07002337# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002338 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002339 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002340 my $space_before = $1;
2341 my $sign_off = $2;
2342 my $space_after = $3;
2343 my $email = $4;
2344 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2345
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002346 if ($sign_off !~ /$signature_tags/) {
2347 WARN("BAD_SIGN_OFF",
2348 "Non-standard signature: $sign_off\n" . $herecurr);
2349 }
Joe Perches20112472011-07-25 17:13:23 -07002350 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002351 if (WARN("BAD_SIGN_OFF",
2352 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2353 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002354 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002355 "$ucfirst_sign_off $email";
2356 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002357 }
Joe Perches20112472011-07-25 17:13:23 -07002358 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002359 if (WARN("BAD_SIGN_OFF",
2360 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2361 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002362 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002363 "$ucfirst_sign_off $email";
2364 }
2365
Joe Perches20112472011-07-25 17:13:23 -07002366 }
2367 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002368 if (WARN("BAD_SIGN_OFF",
2369 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2370 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002371 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002372 "$ucfirst_sign_off $email";
2373 }
Joe Perches20112472011-07-25 17:13:23 -07002374 }
2375
2376 my ($email_name, $email_address, $comment) = parse_email($email);
2377 my $suggested_email = format_email(($email_name, $email_address));
2378 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002379 ERROR("BAD_SIGN_OFF",
2380 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002381 } else {
2382 my $dequoted = $suggested_email;
2383 $dequoted =~ s/^"//;
2384 $dequoted =~ s/" </ </;
2385 # Don't force email to have quotes
2386 # Allow just an angle bracketed address
2387 if ("$dequoted$comment" ne $email &&
2388 "<$email_address>$comment" ne $email &&
2389 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002390 WARN("BAD_SIGN_OFF",
2391 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002392 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002393 }
Joe Perches7e51f192013-09-11 14:23:57 -07002394
2395# Check for duplicate signatures
2396 my $sig_nospace = $line;
2397 $sig_nospace =~ s/\s//g;
2398 $sig_nospace = lc($sig_nospace);
2399 if (defined $signatures{$sig_nospace}) {
2400 WARN("BAD_SIGN_OFF",
2401 "Duplicate signature\n" . $herecurr);
2402 } else {
2403 $signatures{$sig_nospace} = 1;
2404 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002405 }
2406
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002407# Check email subject for common tools that don't need to be mentioned
2408 if ($in_header_lines &&
2409 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2410 WARN("EMAIL_SUBJECT",
2411 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2412 }
2413
Joe Perches9b3189eb2014-06-04 16:12:10 -07002414# Check for old stable address
2415 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2416 ERROR("STABLE_ADDRESS",
2417 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2418 }
2419
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002420# Check for unwanted Gerrit info
2421 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2422 ERROR("GERRIT_CHANGE_ID",
2423 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2424 }
2425
Joe Perches369c8dd2015-11-06 16:31:34 -08002426# Check if the commit log is in a possible stack dump
2427 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2428 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2429 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2430 # timestamp
2431 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2432 # stack dump address
2433 $commit_log_possible_stack_dump = 1;
2434 }
2435
Joe Perches2a076f42015-04-16 12:44:28 -07002436# Check for line lengths > 75 in commit log, warn once
2437 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002438 length($line) > 75 &&
2439 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2440 # file delta changes
2441 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2442 # filename then :
2443 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2444 # A Fixes: or Link: line
2445 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002446 WARN("COMMIT_LOG_LONG_LINE",
2447 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2448 $commit_log_long_line = 1;
2449 }
2450
Joe Perchesbf4daf12015-09-09 15:37:50 -07002451# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002452 if ($in_commit_log && $commit_log_possible_stack_dump &&
2453 $line =~ /^\s*$/) {
2454 $commit_log_possible_stack_dump = 0;
2455 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002456
Joe Perches0d7835f2015-02-13 14:38:35 -08002457# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002458 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002459 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perches369c8dd2015-11-06 16:31:34 -08002460 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2461 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2462 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002463 my $init_char = "c";
2464 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002465 my $short = 1;
2466 my $long = 0;
2467 my $case = 1;
2468 my $space = 1;
2469 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002470 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002471 my $id = '0123456789ab';
2472 my $orig_desc = "commit description";
2473 my $description = "";
2474
Joe Perchesfe043ea2015-09-09 15:37:25 -07002475 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2476 $init_char = $1;
2477 $orig_commit = lc($2);
2478 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2479 $orig_commit = lc($1);
2480 }
2481
Joe Perches0d7835f2015-02-13 14:38:35 -08002482 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2483 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2484 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2485 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2486 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2487 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002488 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002489 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2490 defined $rawlines[$linenr] &&
2491 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2492 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002493 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002494 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2495 defined $rawlines[$linenr] &&
2496 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2497 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2498 $orig_desc = $1;
2499 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2500 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002501 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002502 }
2503
2504 ($id, $description) = git_commit_info($orig_commit,
2505 $id, $orig_desc);
2506
Joe Perches19c146a2015-02-13 14:39:00 -08002507 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002508 ERROR("GIT_COMMIT_ID",
2509 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2510 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002511 }
2512
Joe Perches13f19372014-08-06 16:10:59 -07002513# Check for added, moved or deleted files
2514 if (!$reported_maintainer_file && !$in_commit_log &&
2515 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2516 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2517 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2518 (defined($1) || defined($2))))) {
2519 $reported_maintainer_file = 1;
2520 WARN("FILE_PATH_CHANGES",
2521 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2522 }
2523
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002524# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002525 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002526 ERROR("CORRUPTED_PATCH",
2527 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002528 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002529 }
2530
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002531# Check for absolute kernel paths.
2532 if ($tree) {
2533 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2534 my $file = $1;
2535
2536 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2537 check_absolute_file($1, $herecurr)) {
2538 #
2539 } else {
2540 check_absolute_file($file, $herecurr);
2541 }
2542 }
2543 }
2544
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002545# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2546 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002547 $rawline !~ m/^$UTF8*$/) {
2548 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2549
2550 my $blank = copy_spacing($rawline);
2551 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2552 my $hereptr = "$hereline$ptr\n";
2553
Joe Perches34d99212011-07-25 17:13:26 -07002554 CHK("INVALID_UTF8",
2555 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002556 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002557
Joe Perches15662b32011-10-31 17:13:12 -07002558# Check if it's the start of a commit log
2559# (not a header line and we haven't seen the patch filename)
2560 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002561 !($rawline =~ /^\s+\S/ ||
2562 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002563 $in_header_lines = 0;
2564 $in_commit_log = 1;
2565 }
2566
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002567# Check if there is UTF-8 in a commit log when a mail header has explicitly
2568# declined it, i.e defined some charset where it is missing.
2569 if ($in_header_lines &&
2570 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2571 $1 !~ /utf-8/i) {
2572 $non_utf8_charset = 1;
2573 }
2574
2575 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002576 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002577 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002578 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2579 }
2580
Kees Cook66b47b42014-10-13 15:51:57 -07002581# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002582 if (defined($misspellings) &&
2583 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002584 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002585 my $typo = $1;
2586 my $typo_fix = $spelling_fix{lc($typo)};
2587 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2588 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2589 my $msg_type = \&WARN;
2590 $msg_type = \&CHK if ($file);
2591 if (&{$msg_type}("TYPO_SPELLING",
2592 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2593 $fix) {
2594 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2595 }
2596 }
2597 }
2598
Andy Whitcroft306708542008-10-15 22:02:28 -07002599# ignore non-hunk lines and lines being removed
2600 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002601
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002602#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002603 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002604 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002605 if (ERROR("DOS_LINE_ENDINGS",
2606 "DOS line endings\n" . $herevet) &&
2607 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002608 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002609 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002610 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2611 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002612 if (ERROR("TRAILING_WHITESPACE",
2613 "trailing whitespace\n" . $herevet) &&
2614 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002615 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002616 }
2617
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002618 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002619 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002620
Josh Triplett4783f892013-11-12 15:10:12 -08002621# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002622 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002623 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2624 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002625 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2626 my $msg_type = \&ERROR;
2627 $msg_type = \&CHK if ($file);
2628 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002629 "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 -08002630 }
2631
Andi Kleen33549572010-05-24 14:33:29 -07002632# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002633# Only applies when adding the entry originally, after that we do not have
2634# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002635 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002636 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002637 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002638 my $cnt = $realcnt;
2639 my $ln = $linenr + 1;
2640 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002641 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002642 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002643 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002644 $f = $lines[$ln - 1];
2645 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2646 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002647
2648 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002649 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002650
Joe Perches8d73e0e2014-08-06 16:10:46 -07002651 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002652 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002653 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002654 $length = -1;
2655 }
2656
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002657 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002658 $f =~ s/#.*//;
2659 $f =~ s/^\s+//;
2660 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002661 if ($f =~ /^\s*config\s/) {
2662 $is_end = 1;
2663 last;
2664 }
Andi Kleen33549572010-05-24 14:33:29 -07002665 $length++;
2666 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002667 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2668 WARN("CONFIG_DESCRIPTION",
2669 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2670 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002671 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002672 }
2673
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002674# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2675 if ($realfile =~ /Kconfig/ &&
2676 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2677 WARN("CONFIG_EXPERIMENTAL",
2678 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2679 }
2680
Christoph Jaeger327953e2015-02-13 14:38:29 -08002681# discourage the use of boolean for type definition attributes of Kconfig options
2682 if ($realfile =~ /Kconfig/ &&
2683 $line =~ /^\+\s*\bboolean\b/) {
2684 WARN("CONFIG_TYPE_BOOLEAN",
2685 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2686 }
2687
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002688 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2689 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2690 my $flag = $1;
2691 my $replacement = {
2692 'EXTRA_AFLAGS' => 'asflags-y',
2693 'EXTRA_CFLAGS' => 'ccflags-y',
2694 'EXTRA_CPPFLAGS' => 'cppflags-y',
2695 'EXTRA_LDFLAGS' => 'ldflags-y',
2696 };
2697
2698 WARN("DEPRECATED_VARIABLE",
2699 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2700 }
2701
Rob Herringbff5da42014-01-23 15:54:51 -08002702# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002703 if (defined $root &&
2704 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2705 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2706
Rob Herringbff5da42014-01-23 15:54:51 -08002707 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2708
Florian Vaussardcc933192014-04-03 14:49:27 -07002709 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2710 my $vp_file = $dt_path . "vendor-prefixes.txt";
2711
Rob Herringbff5da42014-01-23 15:54:51 -08002712 foreach my $compat (@compats) {
2713 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002714 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2715 my $compat3 = $compat;
2716 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2717 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002718 if ( $? >> 8 ) {
2719 WARN("UNDOCUMENTED_DT_STRING",
2720 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2721 }
2722
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002723 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2724 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002725 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002726 if ( $? >> 8 ) {
2727 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002728 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002729 }
2730 }
2731 }
2732
Andy Whitcroft5368df202008-10-15 22:02:27 -07002733# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002734 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002735
Joe Perches47e0c882015-06-25 15:02:57 -07002736# line length limit (with some exclusions)
2737#
2738# There are a few types of lines that may extend beyond $max_line_length:
2739# logging functions like pr_info that end in a string
2740# lines with a single string
2741# #defines that are a single string
2742#
2743# There are 3 different line length message types:
2744# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2745# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2746# LONG_LINE all other lines longer than $max_line_length
2747#
2748# if LONG_LINE is ignored, the other 2 types are also ignored
2749#
2750
Joe Perchesb4749e92015-07-17 16:24:01 -07002751 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002752 my $msg_type = "LONG_LINE";
2753
2754 # Check the allowed long line types first
2755
2756 # logging functions that end in a string that starts
2757 # before $max_line_length
2758 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2759 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2760 $msg_type = "";
2761
2762 # lines with only strings (w/ possible termination)
2763 # #defines with only strings
2764 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2765 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2766 $msg_type = "";
2767
2768 # Otherwise set the alternate message types
2769
2770 # a comment starts before $max_line_length
2771 } elsif ($line =~ /($;[\s$;]*)$/ &&
2772 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2773 $msg_type = "LONG_LINE_COMMENT"
2774
2775 # a quoted string starts before $max_line_length
2776 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2777 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2778 $msg_type = "LONG_LINE_STRING"
2779 }
2780
2781 if ($msg_type ne "" &&
2782 (show_type("LONG_LINE") || show_type($msg_type))) {
2783 WARN($msg_type,
2784 "line over $max_line_length characters\n" . $herecurr);
2785 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002786 }
2787
Andy Whitcroft8905a672007-11-28 16:21:06 -08002788# check for adding lines without a newline.
2789 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002790 WARN("MISSING_EOF_NEWLINE",
2791 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002792 }
2793
Mike Frysinger42e41c52009-09-21 17:04:40 -07002794# Blackfin: use hi/lo macros
2795 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2796 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2797 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002798 ERROR("LO_MACRO",
2799 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002800 }
2801 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2802 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002803 ERROR("HI_MACRO",
2804 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002805 }
2806 }
2807
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002808# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002809 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002810
2811# at the beginning of a line any tabs must come first and anything
2812# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002813 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2814 $rawline =~ /^\+\s* \s*/) {
2815 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002816 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002817 if (ERROR("CODE_INDENT",
2818 "code indent should use tabs where possible\n" . $herevet) &&
2819 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002820 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002821 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002822 }
2823
Alberto Panizzo08e44362010-03-05 13:43:54 -08002824# check for space before tabs.
2825 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2826 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002827 if (WARN("SPACE_BEFORE_TAB",
2828 "please, no space before tabs\n" . $herevet) &&
2829 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002830 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002831 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002832 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002833 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002834 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002835 }
2836
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002837# check for && or || at the start of a line
2838 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2839 CHK("LOGICAL_CONTINUATIONS",
2840 "Logical continuations should be on the previous line\n" . $hereprev);
2841 }
2842
Joe Perchesa91e8992016-05-20 17:04:05 -07002843# check indentation starts on a tab stop
2844 if ($^V && $^V ge 5.10.0 &&
2845 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2846 my $indent = length($1);
2847 if ($indent % 8) {
2848 if (WARN("TABSTOP",
2849 "Statements should start on a tabstop\n" . $herecurr) &&
2850 $fix) {
2851 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2852 }
2853 }
2854 }
2855
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002856# check multi-line statement indentation matches previous line
2857 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002858 $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 -07002859 $prevline =~ /^\+(\t*)(.*)$/;
2860 my $oldindent = $1;
2861 my $rest = $2;
2862
2863 my $pos = pos_last_openparen($rest);
2864 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002865 $line =~ /^(\+| )([ \t]*)/;
2866 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002867
2868 my $goodtabindent = $oldindent .
2869 "\t" x ($pos / 8) .
2870 " " x ($pos % 8);
2871 my $goodspaceindent = $oldindent . " " x $pos;
2872
2873 if ($newindent ne $goodtabindent &&
2874 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002875
2876 if (CHK("PARENTHESIS_ALIGNMENT",
2877 "Alignment should match open parenthesis\n" . $hereprev) &&
2878 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002879 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002880 s/^\+[ \t]*/\+$goodtabindent/;
2881 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002882 }
2883 }
2884 }
2885
Joe Perches6ab3a972015-04-16 12:44:05 -07002886# check for space after cast like "(int) foo" or "(struct foo) bar"
2887# avoid checking a few false positives:
2888# "sizeof(<type>)" or "__alignof__(<type>)"
2889# function pointer declarations like "(*foo)(int) = bar;"
2890# structure definitions like "(struct foo) { 0 };"
2891# multiline macros that define functions
2892# known attributes or the __attribute__ keyword
2893 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2894 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002895 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002896 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002897 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002898 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002899 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002900 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002901 }
2902
Joe Perches86406b12015-09-09 15:37:41 -07002903# Block comment styles
2904# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002905 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002906 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002907 $rawline =~ /^\+[ \t]*\*/ &&
2908 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002909 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2910 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2911 }
2912
Joe Perches86406b12015-09-09 15:37:41 -07002913# Block comments use * on subsequent lines
2914 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2915 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002916 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002917 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002918 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002919 WARN("BLOCK_COMMENT_STYLE",
2920 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002921 }
2922
Joe Perches86406b12015-09-09 15:37:41 -07002923# Block comments use */ on trailing lines
2924 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002925 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2926 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2927 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002928 WARN("BLOCK_COMMENT_STYLE",
2929 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002930 }
2931
Joe Perches7f619192014-08-06 16:10:39 -07002932# check for missing blank lines after struct/union declarations
2933# with exceptions for various attributes and macros
2934 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2935 $line =~ /^\+/ &&
2936 !($line =~ /^\+\s*$/ ||
2937 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2938 $line =~ /^\+\s*MODULE_/i ||
2939 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2940 $line =~ /^\+[a-z_]*init/ ||
2941 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2942 $line =~ /^\+\s*DECLARE/ ||
2943 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002944 if (CHK("LINE_SPACING",
2945 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2946 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002947 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002948 }
Joe Perches7f619192014-08-06 16:10:39 -07002949 }
2950
Joe Perches365dd4e2014-08-06 16:10:42 -07002951# check for multiple consecutive blank lines
2952 if ($prevline =~ /^[\+ ]\s*$/ &&
2953 $line =~ /^\+\s*$/ &&
2954 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002955 if (CHK("LINE_SPACING",
2956 "Please don't use multiple blank lines\n" . $hereprev) &&
2957 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002958 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002959 }
2960
Joe Perches365dd4e2014-08-06 16:10:42 -07002961 $last_blank_line = $linenr;
2962 }
2963
Joe Perches3b617e32014-04-03 14:49:28 -07002964# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002965 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2966 # actual declarations
2967 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002968 # function pointer declarations
2969 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002970 # foo bar; where foo is some local typedef or #define
2971 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2972 # known declaration macros
2973 $prevline =~ /^\+\s+$declaration_macros/) &&
2974 # for "else if" which can look like "$Ident $Ident"
2975 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2976 # other possible extensions of declaration lines
2977 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2978 # not starting a section or a macro "\" extended line
2979 $prevline =~ /(?:\{\s*|\\)$/) &&
2980 # looks like a declaration
2981 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002982 # function pointer declarations
2983 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002984 # foo bar; where foo is some local typedef or #define
2985 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2986 # known declaration macros
2987 $sline =~ /^\+\s+$declaration_macros/ ||
2988 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002989 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002990 # start or end of block or continuation of declaration
2991 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2992 # bitfield continuation
2993 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2994 # other possible extensions of declaration lines
2995 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2996 # indentation of previous and current line are the same
2997 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002998 if (WARN("LINE_SPACING",
2999 "Missing a blank line after declarations\n" . $hereprev) &&
3000 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003001 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003002 }
Joe Perches3b617e32014-04-03 14:49:28 -07003003 }
3004
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003005# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003006# Exceptions:
3007# 1) within comments
3008# 2) indented preprocessor commands
3009# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003010 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003011 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003012 if (WARN("LEADING_SPACE",
3013 "please, no spaces at the start of a line\n" . $herevet) &&
3014 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003015 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003016 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003017 }
3018
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003019# check we are in a valid C source file if not then ignore this hunk
3020 next if ($realfile !~ /\.(h|c)$/);
3021
Joe Perches032a4c02014-08-06 16:10:29 -07003022# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003023# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003024# if the previous line is a break or return and is indented 1 tab more...
3025 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3026 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003027 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3028 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3029 defined $lines[$linenr] &&
3030 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003031 WARN("UNNECESSARY_ELSE",
3032 "else is not generally useful after a break or return\n" . $hereprev);
3033 }
3034 }
3035
Joe Perchesc00df192014-08-06 16:11:01 -07003036# check indentation of a line with a break;
3037# if the previous line is a goto or return and is indented the same # of tabs
3038 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3039 my $tabs = $1;
3040 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3041 WARN("UNNECESSARY_BREAK",
3042 "break is not useful after a goto or return\n" . $hereprev);
3043 }
3044 }
3045
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003046# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3047 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3048 WARN("CONFIG_EXPERIMENTAL",
3049 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3050 }
3051
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003052# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003053 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003054 WARN("CVS_KEYWORD",
3055 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003056 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003057
Mike Frysinger42e41c52009-09-21 17:04:40 -07003058# Blackfin: don't use __builtin_bfin_[cs]sync
3059 if ($line =~ /__builtin_bfin_csync/) {
3060 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003061 ERROR("CSYNC",
3062 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003063 }
3064 if ($line =~ /__builtin_bfin_ssync/) {
3065 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003066 ERROR("SSYNC",
3067 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003068 }
3069
Joe Perches56e77d72013-02-21 16:44:14 -08003070# check for old HOTPLUG __dev<foo> section markings
3071 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3072 WARN("HOTPLUG_SECTION",
3073 "Using $1 is unnecessary\n" . $herecurr);
3074 }
3075
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003076# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003077 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3078 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003079#print "LINE<$line>\n";
3080 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003081 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003082 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003083 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003084 $stat =~ s/\n./\n /g;
3085 $cond =~ s/\n./\n /g;
3086
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003087#print "linenr<$linenr> <$stat>\n";
3088 # If this statement has no statement boundaries within
3089 # it there is no point in retrying a statement scan
3090 # until we hit end of it.
3091 my $frag = $stat; $frag =~ s/;+\s*$//;
3092 if ($frag !~ /(?:{|;)/) {
3093#print "skip<$line_nr_next>\n";
3094 $suppress_statement = $line_nr_next;
3095 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003096
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003097 # Find the real next line.
3098 $realline_next = $line_nr_next;
3099 if (defined $realline_next &&
3100 (!defined $lines[$realline_next - 1] ||
3101 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3102 $realline_next++;
3103 }
3104
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003105 my $s = $stat;
3106 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003107
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003108 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003109 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003110
3111 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003112 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003113
Andy Whitcroft463f2862009-09-21 17:04:34 -07003114 } elsif ($s =~ /^.\s*else\b/s) {
3115
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003116 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003117 } 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 -07003118 my $type = $1;
3119 $type =~ s/\s+/ /g;
3120 possible($type, "A:" . $s);
3121
Andy Whitcroft8905a672007-11-28 16:21:06 -08003122 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003123 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003124 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003125 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003126
3127 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003128 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003129 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003130 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003131
3132 # Check for any sort of function declaration.
3133 # int foo(something bar, other baz);
3134 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003135 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 -08003136 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003137
Andy Whitcroftcf655042008-03-04 14:28:20 -08003138 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003139 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003140 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003141
Andy Whitcroft8905a672007-11-28 16:21:06 -08003142 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003143 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003144
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003145 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003146 }
3147 }
3148 }
3149
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003150 }
3151
Andy Whitcroft653d4872007-06-23 17:16:34 -07003152#
3153# Checks which may be anchored in the context.
3154#
3155
3156# Check for switch () and associated case and default
3157# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003158 if ($line=~/\bswitch\s*\(.*\)/) {
3159 my $err = '';
3160 my $sep = '';
3161 my @ctx = ctx_block_outer($linenr, $realcnt);
3162 shift(@ctx);
3163 for my $ctx (@ctx) {
3164 my ($clen, $cindent) = line_stats($ctx);
3165 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3166 $indent != $cindent) {
3167 $err .= "$sep$ctx\n";
3168 $sep = '';
3169 } else {
3170 $sep = "[...]\n";
3171 }
3172 }
3173 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003174 ERROR("SWITCH_CASE_INDENT_LEVEL",
3175 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003176 }
3177 }
3178
3179# if/while/etc brace do not go on next line, unless defining a do while loop,
3180# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003181 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 -07003182 my $pre_ctx = "$1$2";
3183
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003184 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003185
3186 if ($line =~ /^\+\t{6,}/) {
3187 WARN("DEEP_INDENTATION",
3188 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3189 }
3190
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003191 my $ctx_cnt = $realcnt - $#ctx - 1;
3192 my $ctx = join("\n", @ctx);
3193
Andy Whitcroft548596d2008-07-23 21:29:01 -07003194 my $ctx_ln = $linenr;
3195 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003196
Andy Whitcroft548596d2008-07-23 21:29:01 -07003197 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3198 defined $lines[$ctx_ln - 1] &&
3199 $lines[$ctx_ln - 1] =~ /^-/)) {
3200 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3201 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003202 $ctx_ln++;
3203 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003204
Andy Whitcroft53210162008-07-23 21:29:03 -07003205 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3206 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003207
Joe Perchesd752fcc2014-08-06 16:11:05 -07003208 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003209 ERROR("OPEN_BRACE",
3210 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003211 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003212 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003213 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3214 $ctx =~ /\)\s*\;\s*$/ &&
3215 defined $lines[$ctx_ln - 1])
3216 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003217 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3218 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003219 WARN("TRAILING_SEMICOLON",
3220 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003221 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003222 }
3223 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003224 }
3225
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003226# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003227 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 -08003228 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3229 ctx_statement_block($linenr, $realcnt, 0)
3230 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003231 my ($s, $c) = ($stat, $cond);
3232
3233 substr($s, 0, length($c), '');
3234
Joe Perches9f5af482015-09-09 15:37:30 -07003235 # remove inline comments
3236 $s =~ s/$;/ /g;
3237 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003238
3239 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003240 my @newlines = ($c =~ /\n/gs);
3241 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003242
Joe Perches9f5af482015-09-09 15:37:30 -07003243 # Make sure we remove the line prefixes as we have
3244 # none on the first line, and are going to readd them
3245 # where necessary.
3246 $s =~ s/\n./\n/gs;
3247 while ($s =~ /\n\s+\\\n/) {
3248 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3249 }
3250
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003251 # We want to check the first line inside the block
3252 # starting at the end of the conditional, so remove:
3253 # 1) any blank line termination
3254 # 2) any opening brace { on end of the line
3255 # 3) any do (...) {
3256 my $continuation = 0;
3257 my $check = 0;
3258 $s =~ s/^.*\bdo\b//;
3259 $s =~ s/^\s*{//;
3260 if ($s =~ s/^\s*\\//) {
3261 $continuation = 1;
3262 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003263 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003264 $check = 1;
3265 $cond_lines++;
3266 }
3267
3268 # Also ignore a loop construct at the end of a
3269 # preprocessor statement.
3270 if (($prevline =~ /^.\s*#\s*define\s/ ||
3271 $prevline =~ /\\\s*$/) && $continuation == 0) {
3272 $check = 0;
3273 }
3274
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003275 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003276 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003277 while ($cond_ptr != $cond_lines) {
3278 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003279
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003280 # If we see an #else/#elif then the code
3281 # is not linear.
3282 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3283 $check = 0;
3284 }
3285
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003286 # Ignore:
3287 # 1) blank lines, they should be at 0,
3288 # 2) preprocessor lines, and
3289 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003290 if ($continuation ||
3291 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003292 $s =~ /^\s*#\s*?/ ||
3293 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003294 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003295 if ($s =~ s/^.*?\n//) {
3296 $cond_lines++;
3297 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003298 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003299 }
3300
3301 my (undef, $sindent) = line_stats("+" . $s);
3302 my $stat_real = raw_line($linenr, $cond_lines);
3303
3304 # Check if either of these lines are modified, else
3305 # this is not this patch's fault.
3306 if (!defined($stat_real) ||
3307 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3308 $check = 0;
3309 }
3310 if (defined($stat_real) && $cond_lines > 1) {
3311 $stat_real = "[...]\n$stat_real";
3312 }
3313
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003314 #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 -07003315
Joe Perches9f5af482015-09-09 15:37:30 -07003316 if ($check && $s ne '' &&
3317 (($sindent % 8) != 0 ||
3318 ($sindent < $indent) ||
3319 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003320 WARN("SUSPECT_CODE_INDENT",
3321 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003322 }
3323 }
3324
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003325 # Track the 'values' across context and added lines.
3326 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003327 my ($curr_values, $curr_vars) =
3328 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003329 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003330 if ($dbg_values) {
3331 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003332 print "$linenr > .$outline\n";
3333 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003334 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003335 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003336 $prev_values = substr($curr_values, -1);
3337
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003338#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003339 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003340
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003341# check for declarations of signed or unsigned without int
Joe Perches207a8e82016-03-15 14:58:06 -07003342 while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003343 my $type = $1;
3344 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003345 $var = "" if (!defined $var);
3346 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003347 my $sign = $1;
3348 my $pointer = $2;
3349
3350 $pointer = "" if (!defined $pointer);
3351
3352 if (WARN("UNSPECIFIED_INT",
3353 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3354 $fix) {
3355 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003356 my $comp_pointer = $pointer;
3357 $comp_pointer =~ s/\s//g;
3358 $decl .= $comp_pointer;
3359 $decl = rtrim($decl) if ($var eq "");
3360 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003361 }
3362 }
3363 }
3364
Andy Whitcroft653d4872007-06-23 17:16:34 -07003365# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003366 if ($dbg_type) {
3367 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003368 ERROR("TEST_TYPE",
3369 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003370 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003371 ERROR("TEST_NOT_TYPE",
3372 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003373 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003374 next;
3375 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003376# TEST: allow direct testing of the attribute matcher.
3377 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003378 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003379 ERROR("TEST_ATTR",
3380 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003381 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003382 ERROR("TEST_NOT_ATTR",
3383 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003384 }
3385 next;
3386 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003387
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003388# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003389 if ($line =~ /^.\s*{/ &&
3390 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003391 if (ERROR("OPEN_BRACE",
3392 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003393 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3394 fix_delete_line($fixlinenr - 1, $prevrawline);
3395 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003396 my $fixedline = $prevrawline;
3397 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003398 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003399 $fixedline = $line;
3400 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003401 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003402 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003403 }
3404
Andy Whitcroft653d4872007-06-23 17:16:34 -07003405#
3406# Checks which are anchored on the added line.
3407#
3408
3409# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003410 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003411 my $path = $1;
3412 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003413 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003414 "malformed #include filename\n" . $herecurr);
3415 }
3416 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3417 ERROR("UAPI_INCLUDE",
3418 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003419 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003420 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003421
3422# no C99 // comments
3423 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003424 if (ERROR("C99_COMMENTS",
3425 "do not use C99 // comments\n" . $herecurr) &&
3426 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003427 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003428 if ($line =~ /\/\/(.*)$/) {
3429 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003430 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003431 }
3432 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003433 }
3434 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003435 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003436 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003437
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003438# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3439# the whole statement.
3440#print "APW <$lines[$realline_next - 1]>\n";
3441 if (defined $realline_next &&
3442 exists $lines[$realline_next - 1] &&
3443 !defined $suppress_export{$realline_next} &&
3444 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3445 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003446 # Handle definitions which produce identifiers with
3447 # a prefix:
3448 # XXX(foo);
3449 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003450 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003451 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003452 $name =~ /^${Ident}_$2/) {
3453#print "FOO C name<$name>\n";
3454 $suppress_export{$realline_next} = 1;
3455
3456 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003457 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003458 ^.DEFINE_$Ident\(\Q$name\E\)|
3459 ^.DECLARE_$Ident\(\Q$name\E\)|
3460 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003461 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3462 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003463 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003464#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3465 $suppress_export{$realline_next} = 2;
3466 } else {
3467 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003468 }
3469 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003470 if (!defined $suppress_export{$linenr} &&
3471 $prevline =~ /^.\s*$/ &&
3472 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3473 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3474#print "FOO B <$lines[$linenr - 1]>\n";
3475 $suppress_export{$linenr} = 2;
3476 }
3477 if (defined $suppress_export{$linenr} &&
3478 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003479 WARN("EXPORT_SYMBOL",
3480 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003481 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003482
Joe Eloff5150bda2010-08-09 17:21:00 -07003483# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003484 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003485 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003486 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003487 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003488 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003489 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003490 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003491# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003492 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003493 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003494 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003495 $herecurr) &&
3496 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003497 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003498 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003499 }
3500
Joe Perches18130872014-08-06 16:11:22 -07003501# check for misordered declarations of char/short/int/long with signed/unsigned
3502 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3503 my $tmp = trim($1);
3504 WARN("MISORDERED_TYPE",
3505 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3506 }
3507
Joe Perchescb710ec2010-10-26 14:23:20 -07003508# check for static const char * arrays.
3509 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003510 WARN("STATIC_CONST_CHAR_ARRAY",
3511 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003512 $herecurr);
3513 }
3514
3515# check for static char foo[] = "bar" declarations.
3516 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003517 WARN("STATIC_CONST_CHAR_ARRAY",
3518 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003519 $herecurr);
3520 }
3521
Joe Perchesab7e23f2015-04-16 12:44:22 -07003522# check for const <foo> const where <foo> is not a pointer or array type
3523 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3524 my $found = $1;
3525 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3526 WARN("CONST_CONST",
3527 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3528 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3529 WARN("CONST_CONST",
3530 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3531 }
3532 }
3533
Joe Perches9b0fa602014-04-03 14:49:18 -07003534# check for non-global char *foo[] = {"bar", ...} declarations.
3535 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3536 WARN("STATIC_CONST_CHAR_ARRAY",
3537 "char * array declaration might be better as static const\n" .
3538 $herecurr);
3539 }
3540
Joe Perchesb598b672015-04-16 12:44:36 -07003541# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3542 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3543 my $array = $1;
3544 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3545 my $array_div = $1;
3546 if (WARN("ARRAY_SIZE",
3547 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3548 $fix) {
3549 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3550 }
3551 }
3552 }
3553
Joe Perchesb36190c2014-01-27 17:07:18 -08003554# check for function declarations without arguments like "int foo()"
3555 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3556 if (ERROR("FUNCTION_WITHOUT_ARGS",
3557 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3558 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003559 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003560 }
3561 }
3562
Joe Perches92e112f2013-12-13 11:36:22 -07003563# check for uses of DEFINE_PCI_DEVICE_TABLE
3564 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3565 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3566 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3567 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003568 $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 -07003569 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003570 }
3571
Andy Whitcroft653d4872007-06-23 17:16:34 -07003572# check for new typedefs, only function parameters and sparse annotations
3573# make sense.
3574 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003575 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003576 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003577 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003578 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003579 WARN("NEW_TYPEDEFS",
3580 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003581 }
3582
3583# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003584 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003585 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3586 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003587 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003588
Andy Whitcroft65863862009-01-06 14:41:21 -08003589 # Should start with a space.
3590 $to =~ s/^(\S)/ $1/;
3591 # Should not end with a space.
3592 $to =~ s/\s+$//;
3593 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003594 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003595 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003596
Joe Perches3705ce52013-07-03 15:05:31 -07003597## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003598 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003599 if (ERROR("POINTER_LOCATION",
3600 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3601 $fix) {
3602 my $sub_from = $ident;
3603 my $sub_to = $ident;
3604 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003605 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003606 s@\Q$sub_from\E@$sub_to@;
3607 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003608 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003609 }
3610 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3611 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003612 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003613
Andy Whitcroft65863862009-01-06 14:41:21 -08003614 # Should start with a space.
3615 $to =~ s/^(\S)/ $1/;
3616 # Should not end with a space.
3617 $to =~ s/\s+$//;
3618 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003619 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003620 }
3621 # Modifiers should have spaces.
3622 $to =~ s/(\b$Modifier$)/$1 /;
3623
Joe Perches3705ce52013-07-03 15:05:31 -07003624## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003625 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003626 if (ERROR("POINTER_LOCATION",
3627 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3628 $fix) {
3629
3630 my $sub_from = $match;
3631 my $sub_to = $match;
3632 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003633 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003634 s@\Q$sub_from\E@$sub_to@;
3635 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003636 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003637 }
3638
Joe Perches9d3e3c72015-09-09 15:37:27 -07003639# avoid BUG() or BUG_ON()
3640 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3641 my $msg_type = \&WARN;
3642 $msg_type = \&CHK if ($file);
3643 &{$msg_type}("AVOID_BUG",
3644 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3645 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003646
Joe Perches9d3e3c72015-09-09 15:37:27 -07003647# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003648 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003649 WARN("LINUX_VERSION_CODE",
3650 "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 -08003651 }
3652
Joe Perches17441222011-06-15 15:08:17 -07003653# check for uses of printk_ratelimit
3654 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003655 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003656 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003657 }
3658
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003659# printk should use KERN_* levels. Note that follow on printk's on the
3660# same line do not need a level, so we use the current block context
3661# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003662# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003663# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003664 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003665 my $ok = 0;
3666 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3667 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003668 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003669 # with "\n" ignore it, else it is to blame
3670 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3671 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3672 $ok = 1;
3673 }
3674 last;
3675 }
3676 }
3677 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003678 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3679 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003680 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003681 }
3682
Joe Perches243f3802012-05-31 16:26:09 -07003683 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3684 my $orig = $1;
3685 my $level = lc($orig);
3686 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003687 my $level2 = $level;
3688 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003689 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003690 "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 -07003691 }
3692
3693 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003694 if (WARN("PREFER_PR_LEVEL",
3695 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3696 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003697 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003698 s/\bpr_warning\b/pr_warn/;
3699 }
Joe Perches243f3802012-05-31 16:26:09 -07003700 }
3701
Joe Perchesdc139312013-02-21 16:44:13 -08003702 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3703 my $orig = $1;
3704 my $level = lc($orig);
3705 $level = "warn" if ($level eq "warning");
3706 $level = "dbg" if ($level eq "debug");
3707 WARN("PREFER_DEV_LEVEL",
3708 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3709 }
3710
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003711# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3712# number of false positives, but assembly files are not checked, so at
3713# least the arch entry code will not trigger this warning.
3714 if ($line =~ /\bENOSYS\b/) {
3715 WARN("ENOSYS",
3716 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3717 }
3718
Andy Whitcroft653d4872007-06-23 17:16:34 -07003719# function brace can't be on same line, except for #defines of do while,
3720# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003721 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003722 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003723 if (ERROR("OPEN_BRACE",
3724 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3725 $fix) {
3726 fix_delete_line($fixlinenr, $rawline);
3727 my $fixed_line = $rawline;
3728 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3729 my $line1 = $1;
3730 my $line2 = $2;
3731 fix_insert_line($fixlinenr, ltrim($line1));
3732 fix_insert_line($fixlinenr, "\+{");
3733 if ($line2 !~ /^\s*$/) {
3734 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3735 }
3736 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003737 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003738
Andy Whitcroft8905a672007-11-28 16:21:06 -08003739# open braces for enum, union and struct go on the same line.
3740 if ($line =~ /^.\s*{/ &&
3741 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003742 if (ERROR("OPEN_BRACE",
3743 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3744 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3745 fix_delete_line($fixlinenr - 1, $prevrawline);
3746 fix_delete_line($fixlinenr, $rawline);
3747 my $fixedline = rtrim($prevrawline) . " {";
3748 fix_insert_line($fixlinenr, $fixedline);
3749 $fixedline = $rawline;
3750 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3751 if ($fixedline !~ /^\+\s*$/) {
3752 fix_insert_line($fixlinenr, $fixedline);
3753 }
3754 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003755 }
3756
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003757# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003758 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3759 if (WARN("SPACING",
3760 "missing space after $1 definition\n" . $herecurr) &&
3761 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003762 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003763 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3764 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003765 }
3766
Joe Perches31070b52014-01-23 15:54:49 -08003767# Function pointer declarations
3768# check spacing between type, funcptr, and args
3769# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003770 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003771 my $declare = $1;
3772 my $pre_pointer_space = $2;
3773 my $post_pointer_space = $3;
3774 my $funcname = $4;
3775 my $post_funcname_space = $5;
3776 my $pre_args_space = $6;
3777
Joe Perches91f72e92014-04-03 14:49:12 -07003778# the $Declare variable will capture all spaces after the type
3779# so check it for a missing trailing missing space but pointer return types
3780# don't need a space so don't warn for those.
3781 my $post_declare_space = "";
3782 if ($declare =~ /(\s+)$/) {
3783 $post_declare_space = $1;
3784 $declare = rtrim($declare);
3785 }
3786 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003787 WARN("SPACING",
3788 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003789 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003790 }
3791
3792# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003793# This test is not currently implemented because these declarations are
3794# equivalent to
3795# int foo(int bar, ...)
3796# and this is form shouldn't/doesn't generate a checkpatch warning.
3797#
3798# elsif ($declare =~ /\s{2,}$/) {
3799# WARN("SPACING",
3800# "Multiple spaces after return type\n" . $herecurr);
3801# }
Joe Perches31070b52014-01-23 15:54:49 -08003802
3803# unnecessary space "type ( *funcptr)(args...)"
3804 if (defined $pre_pointer_space &&
3805 $pre_pointer_space =~ /^\s/) {
3806 WARN("SPACING",
3807 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3808 }
3809
3810# unnecessary space "type (* funcptr)(args...)"
3811 if (defined $post_pointer_space &&
3812 $post_pointer_space =~ /^\s/) {
3813 WARN("SPACING",
3814 "Unnecessary space before function pointer name\n" . $herecurr);
3815 }
3816
3817# unnecessary space "type (*funcptr )(args...)"
3818 if (defined $post_funcname_space &&
3819 $post_funcname_space =~ /^\s/) {
3820 WARN("SPACING",
3821 "Unnecessary space after function pointer name\n" . $herecurr);
3822 }
3823
3824# unnecessary space "type (*funcptr) (args...)"
3825 if (defined $pre_args_space &&
3826 $pre_args_space =~ /^\s/) {
3827 WARN("SPACING",
3828 "Unnecessary space before function pointer arguments\n" . $herecurr);
3829 }
3830
3831 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003832 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003833 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003834 }
3835 }
3836
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003837# check for spacing round square brackets; allowed:
3838# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003839# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3840# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003841 while ($line =~ /(.*?\s)\[/g) {
3842 my ($where, $prefix) = ($-[1], $1);
3843 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003844 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003845 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003846 if (ERROR("BRACKET_SPACE",
3847 "space prohibited before open square bracket '['\n" . $herecurr) &&
3848 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003849 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003850 s/^(\+.*?)\s+\[/$1\[/;
3851 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003852 }
3853 }
3854
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003855# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003856 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003857 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003858 my $ctx_before = substr($line, 0, $-[1]);
3859 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003860
3861 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003862 if ($name =~ /^(?:
3863 if|for|while|switch|return|case|
3864 volatile|__volatile__|
3865 __attribute__|format|__extension__|
3866 asm|__asm__)$/x)
3867 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003868 # cpp #define statements have non-optional spaces, ie
3869 # if there is a space between the name and the open
3870 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003871 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003872
3873 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003874 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003875
3876 # If this whole things ends with a type its most
3877 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003878 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003879
3880 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003881 if (WARN("SPACING",
3882 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3883 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003884 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003885 s/\b$name\s+\(/$name\(/;
3886 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003887 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003888 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003889
Andy Whitcroft653d4872007-06-23 17:16:34 -07003890# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003891 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003892 my $fixed_line = "";
3893 my $line_fixed = 0;
3894
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003895 my $ops = qr{
3896 <<=|>>=|<=|>=|==|!=|
3897 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3898 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003899 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003900 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003901 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003902 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003903
3904## print("element count: <" . $#elements . ">\n");
3905## foreach my $el (@elements) {
3906## print("el: <$el>\n");
3907## }
3908
3909 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003910 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003911
Joe Perches3705ce52013-07-03 15:05:31 -07003912 foreach my $el (@elements) {
3913 push(@fix_elements, substr($rawline, $off, length($el)));
3914 $off += length($el);
3915 }
3916
3917 $off = 0;
3918
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003919 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003920 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003921
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003922 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003923
3924 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3925
3926## print("n: <$n> good: <$good>\n");
3927
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003928 $off += length($elements[$n]);
3929
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003930 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003931 my $ca = substr($opline, 0, $off);
3932 my $cc = '';
3933 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3934 $cc = substr($opline, $off + length($elements[$n + 1]));
3935 }
3936 my $cb = "$ca$;$cc";
3937
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003938 my $a = '';
3939 $a = 'V' if ($elements[$n] ne '');
3940 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003941 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003942 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3943 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003944 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003945
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003946 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003947
3948 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003949 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003950 $c = 'V' if ($elements[$n + 2] ne '');
3951 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003952 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003953 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3954 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003955 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003956 } else {
3957 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003958 }
3959
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003960 my $ctx = "${a}x${c}";
3961
3962 my $at = "(ctx:$ctx)";
3963
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003964 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003965 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003966
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003967 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003968 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003969
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003970 # Get the full operator variant.
3971 my $opv = $op . substr($curr_vars, $off, 1);
3972
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003973 # Ignore operators passed as parameters.
3974 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003975 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003976
Andy Whitcroftcf655042008-03-04 14:28:20 -08003977# # Ignore comments
3978# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003979
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003980 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003981 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003982 if ($ctx !~ /.x[WEBC]/ &&
3983 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003984 if (ERROR("SPACING",
3985 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003986 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003987 $line_fixed = 1;
3988 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003989 }
3990
3991 # // is a comment
3992 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003993
Joe Perchesb00e4812014-04-03 14:49:33 -07003994 # : when part of a bitfield
3995 } elsif ($opv eq ':B') {
3996 # skip the bitfield test for now
3997
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003998 # No spaces for:
3999 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004000 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004001 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004002 if (ERROR("SPACING",
4003 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004004 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004005 if (defined $fix_elements[$n + 2]) {
4006 $fix_elements[$n + 2] =~ s/^\s+//;
4007 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004008 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004009 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004010 }
4011
Joe Perches23810972014-12-10 15:51:32 -08004012 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004013 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004014 my $rtrim_before = 0;
4015 my $space_after = 0;
4016 if ($ctx =~ /Wx./) {
4017 if (ERROR("SPACING",
4018 "space prohibited before that '$op' $at\n" . $hereptr)) {
4019 $line_fixed = 1;
4020 $rtrim_before = 1;
4021 }
4022 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004023 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004024 if (ERROR("SPACING",
4025 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004026 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004027 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004028 $space_after = 1;
4029 }
4030 }
4031 if ($rtrim_before || $space_after) {
4032 if ($rtrim_before) {
4033 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4034 } else {
4035 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4036 }
4037 if ($space_after) {
4038 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004039 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004040 }
4041
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004042 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004043 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004044 #warn "'*' is part of type\n";
4045
4046 # unary operators should have a space before and
4047 # none after. May be left adjacent to another
4048 # unary operator, or a cast
4049 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004050 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004051 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004052 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004053 if (ERROR("SPACING",
4054 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004055 if ($n != $last_after + 2) {
4056 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4057 $line_fixed = 1;
4058 }
Joe Perches3705ce52013-07-03 15:05:31 -07004059 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004060 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004061 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004062 # A unary '*' may be const
4063
4064 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004065 if (ERROR("SPACING",
4066 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004067 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004068 if (defined $fix_elements[$n + 2]) {
4069 $fix_elements[$n + 2] =~ s/^\s+//;
4070 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004071 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004072 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004073 }
4074
4075 # unary ++ and unary -- are allowed no space on one side.
4076 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004077 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004078 if (ERROR("SPACING",
4079 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004080 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004081 $line_fixed = 1;
4082 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004083 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004084 if ($ctx =~ /Wx[BE]/ ||
4085 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004086 if (ERROR("SPACING",
4087 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004088 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004089 $line_fixed = 1;
4090 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004091 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004092 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004093 if (ERROR("SPACING",
4094 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004095 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004096 if (defined $fix_elements[$n + 2]) {
4097 $fix_elements[$n + 2] =~ s/^\s+//;
4098 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004099 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004100 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004101 }
4102
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004103 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004104 } elsif ($op eq '<<' or $op eq '>>' or
4105 $op eq '&' or $op eq '^' or $op eq '|' or
4106 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004107 $op eq '*' or $op eq '/' or
4108 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004109 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004110 if ($check) {
4111 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4112 if (CHK("SPACING",
4113 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4114 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4115 $fix_elements[$n + 2] =~ s/^\s+//;
4116 $line_fixed = 1;
4117 }
4118 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4119 if (CHK("SPACING",
4120 "space preferred before that '$op' $at\n" . $hereptr)) {
4121 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4122 $line_fixed = 1;
4123 }
4124 }
4125 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004126 if (ERROR("SPACING",
4127 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004128 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4129 if (defined $fix_elements[$n + 2]) {
4130 $fix_elements[$n + 2] =~ s/^\s+//;
4131 }
Joe Perches3705ce52013-07-03 15:05:31 -07004132 $line_fixed = 1;
4133 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004134 }
4135
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004136 # A colon needs no spaces before when it is
4137 # terminating a case value or a label.
4138 } elsif ($opv eq ':C' || $opv eq ':L') {
4139 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004140 if (ERROR("SPACING",
4141 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004142 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004143 $line_fixed = 1;
4144 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004145 }
4146
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004147 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004148 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004149 my $ok = 0;
4150
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004151 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004152 if (($op eq '<' &&
4153 $cc =~ /^\S+\@\S+>/) ||
4154 ($op eq '>' &&
4155 $ca =~ /<\S+\@\S+$/))
4156 {
4157 $ok = 1;
4158 }
4159
Joe Perchese0df7e12015-04-16 12:44:53 -07004160 # for asm volatile statements
4161 # ignore a colon with another
4162 # colon immediately before or after
4163 if (($op eq ':') &&
4164 ($ca =~ /:$/ || $cc =~ /^:/)) {
4165 $ok = 1;
4166 }
4167
Joe Perches84731622013-11-12 15:10:05 -08004168 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004169 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004170 my $msg_type = \&ERROR;
4171 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4172
4173 if (&{$msg_type}("SPACING",
4174 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004175 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4176 if (defined $fix_elements[$n + 2]) {
4177 $fix_elements[$n + 2] =~ s/^\s+//;
4178 }
Joe Perches3705ce52013-07-03 15:05:31 -07004179 $line_fixed = 1;
4180 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004181 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004182 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004183 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004184
4185## print("n: <$n> GOOD: <$good>\n");
4186
4187 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004188 }
Joe Perches3705ce52013-07-03 15:05:31 -07004189
4190 if (($#elements % 2) == 0) {
4191 $fixed_line = $fixed_line . $fix_elements[$#elements];
4192 }
4193
Joe Perches194f66f2014-08-06 16:11:03 -07004194 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4195 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004196 }
4197
4198
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004199 }
4200
Joe Perches786b6322013-07-03 15:05:32 -07004201# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004202 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004203 if (WARN("SPACING",
4204 "space prohibited before semicolon\n" . $herecurr) &&
4205 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004206 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004207 s/^(\+.*\S)\s+;/$1;/;
4208 }
4209 }
4210
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004211# check for multiple assignments
4212 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004213 CHK("MULTIPLE_ASSIGNMENTS",
4214 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004215 }
4216
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004217## # check for multiple declarations, allowing for a function declaration
4218## # continuation.
4219## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4220## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4221##
4222## # Remove any bracketed sections to ensure we do not
4223## # falsly report the parameters of functions.
4224## my $ln = $line;
4225## while ($ln =~ s/\([^\(\)]*\)//g) {
4226## }
4227## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004228## WARN("MULTIPLE_DECLARATION",
4229## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004230## }
4231## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004232
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004233#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004234 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004235 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004236 if (ERROR("SPACING",
4237 "space required before the open brace '{'\n" . $herecurr) &&
4238 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004239 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004240 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004241 }
4242
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004243## # check for blank lines before declarations
4244## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4245## $prevrawline =~ /^.\s*$/) {
4246## WARN("SPACING",
4247## "No blank lines before declarations\n" . $hereprev);
4248## }
4249##
4250
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004251# closing brace should have a space following it when it has anything
4252# on the line
4253 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004254 if (ERROR("SPACING",
4255 "space required after that close brace '}'\n" . $herecurr) &&
4256 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004257 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004258 s/}((?!(?:,|;|\)))\S)/} $1/;
4259 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004260 }
4261
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004262# check spacing on square brackets
4263 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004264 if (ERROR("SPACING",
4265 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4266 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004267 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004268 s/\[\s+/\[/;
4269 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004270 }
4271 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004272 if (ERROR("SPACING",
4273 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4274 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004275 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004276 s/\s+\]/\]/;
4277 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004278 }
4279
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004280# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004281 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4282 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004283 if (ERROR("SPACING",
4284 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4285 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004286 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004287 s/\(\s+/\(/;
4288 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004289 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004290 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004291 $line !~ /for\s*\(.*;\s+\)/ &&
4292 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004293 if (ERROR("SPACING",
4294 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4295 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004296 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004297 s/\s+\)/\)/;
4298 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004299 }
4300
Joe Perchese2826fd2014-08-06 16:10:48 -07004301# check unnecessary parentheses around addressof/dereference single $Lvals
4302# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4303
4304 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004305 my $var = $1;
4306 if (CHK("UNNECESSARY_PARENTHESES",
4307 "Unnecessary parentheses around $var\n" . $herecurr) &&
4308 $fix) {
4309 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4310 }
4311 }
4312
4313# check for unnecessary parentheses around function pointer uses
4314# ie: (foo->bar)(); should be foo->bar();
4315# but not "if (foo->bar) (" to avoid some false positives
4316 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4317 my $var = $2;
4318 if (CHK("UNNECESSARY_PARENTHESES",
4319 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4320 $fix) {
4321 my $var2 = deparenthesize($var);
4322 $var2 =~ s/\s//g;
4323 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4324 }
4325 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004326
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004327#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004328 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004329 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004330 if (WARN("INDENTED_LABEL",
4331 "labels should not be indented\n" . $herecurr) &&
4332 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004333 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004334 s/^(.)\s+/$1/;
4335 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004336 }
4337
Joe Perches5b9553a2014-04-03 14:49:21 -07004338# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004339 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004340 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004341 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004342 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4343 my $value = $1;
4344 $value = deparenthesize($value);
4345 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4346 ERROR("RETURN_PARENTHESES",
4347 "return is not a function, parentheses are not required\n" . $herecurr);
4348 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004349 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004350 ERROR("SPACING",
4351 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004352 }
4353 }
Joe Perches507e5142013-11-12 15:10:13 -08004354
Joe Perchesb43ae212014-06-23 13:22:07 -07004355# unnecessary return in a void function
4356# at end-of-function, with the previous line a single leading tab, then return;
4357# and the line before that not a goto label target like "out:"
4358 if ($sline =~ /^[ \+]}\s*$/ &&
4359 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4360 $linenr >= 3 &&
4361 $lines[$linenr - 3] =~ /^[ +]/ &&
4362 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004363 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004364 "void function return statements are not generally useful\n" . $hereprev);
4365 }
Joe Perches9819cf22014-06-04 16:12:09 -07004366
Joe Perches189248d2014-01-23 15:54:47 -08004367# if statements using unnecessary parentheses - ie: if ((foo == bar))
4368 if ($^V && $^V ge 5.10.0 &&
4369 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4370 my $openparens = $1;
4371 my $count = $openparens =~ tr@\(@\(@;
4372 my $msg = "";
4373 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4374 my $comp = $4; #Not $1 because of $LvalOrFunc
4375 $msg = " - maybe == should be = ?" if ($comp eq "==");
4376 WARN("UNNECESSARY_PARENTHESES",
4377 "Unnecessary parentheses$msg\n" . $herecurr);
4378 }
4379 }
4380
Joe Perchesc5595fa2015-09-09 15:37:58 -07004381# comparisons with a constant or upper case identifier on the left
4382# avoid cases like "foo + BAR < baz"
4383# only fix matches surrounded by parentheses to avoid incorrect
4384# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4385 if ($^V && $^V ge 5.10.0 &&
4386 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4387 my $lead = $1;
4388 my $const = $2;
4389 my $comp = $3;
4390 my $to = $4;
4391 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004392 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004393 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4394 WARN("CONSTANT_COMPARISON",
4395 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4396 $fix) {
4397 if ($comp eq "<") {
4398 $newcomp = ">";
4399 } elsif ($comp eq "<=") {
4400 $newcomp = ">=";
4401 } elsif ($comp eq ">") {
4402 $newcomp = "<";
4403 } elsif ($comp eq ">=") {
4404 $newcomp = "<=";
4405 }
4406 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4407 }
4408 }
4409
Joe Perchesf34e4a42015-04-16 12:44:19 -07004410# Return of what appears to be an errno should normally be negative
4411 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004412 my $name = $1;
4413 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004414 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004415 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004416 }
4417 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004418
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004419# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004420 if ($line =~ /\b(if|while|for|switch)\(/) {
4421 if (ERROR("SPACING",
4422 "space required before the open parenthesis '('\n" . $herecurr) &&
4423 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004424 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004425 s/\b(if|while|for|switch)\(/$1 \(/;
4426 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004427 }
4428
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004429# Check for illegal assignment in if conditional -- and check for trailing
4430# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004431 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004432 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4433 ctx_statement_block($linenr, $realcnt, 0)
4434 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004435 my ($stat_next) = ctx_statement_block($line_nr_next,
4436 $remain_next, $off_next);
4437 $stat_next =~ s/\n./\n /g;
4438 ##print "stat<$stat> stat_next<$stat_next>\n";
4439
4440 if ($stat_next =~ /^\s*while\b/) {
4441 # If the statement carries leading newlines,
4442 # then count those as offsets.
4443 my ($whitespace) =
4444 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4445 my $offset =
4446 statement_rawlines($whitespace) - 1;
4447
4448 $suppress_whiletrailers{$line_nr_next +
4449 $offset} = 1;
4450 }
4451 }
4452 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004453 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004454 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004455 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004456
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004457 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004458 ERROR("ASSIGN_IN_IF",
4459 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004460 }
4461
4462 # Find out what is on the end of the line after the
4463 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004464 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004465 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004466 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004467 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4468 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004469 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004470 # Find out how long the conditional actually is.
4471 my @newlines = ($c =~ /\n/gs);
4472 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004473 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004474
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004475 $stat_real = raw_line($linenr, $cond_lines)
4476 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004477 if (defined($stat_real) && $cond_lines > 1) {
4478 $stat_real = "[...]\n$stat_real";
4479 }
4480
Joe Perches000d1cc12011-07-25 17:13:25 -07004481 ERROR("TRAILING_STATEMENTS",
4482 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004483 }
4484 }
4485
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004486# Check for bitwise tests written as boolean
4487 if ($line =~ /
4488 (?:
4489 (?:\[|\(|\&\&|\|\|)
4490 \s*0[xX][0-9]+\s*
4491 (?:\&\&|\|\|)
4492 |
4493 (?:\&\&|\|\|)
4494 \s*0[xX][0-9]+\s*
4495 (?:\&\&|\|\||\)|\])
4496 )/x)
4497 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004498 WARN("HEXADECIMAL_BOOLEAN_TEST",
4499 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004500 }
4501
Andy Whitcroft8905a672007-11-28 16:21:06 -08004502# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004503 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4504 my $s = $1;
4505 $s =~ s/$;//g; # Remove any comments
4506 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004507 ERROR("TRAILING_STATEMENTS",
4508 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004509 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004510 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004511# if should not continue a brace
4512 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004513 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004514 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004515 $herecurr);
4516 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004517# case and default should not have general statements after them
4518 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4519 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004520 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004521 \s*return\s+
4522 )/xg)
4523 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004524 ERROR("TRAILING_STATEMENTS",
4525 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004526 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004527
4528 # Check for }<nl>else {, these must be at the same
4529 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004530 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4531 $previndent == $indent) {
4532 if (ERROR("ELSE_AFTER_BRACE",
4533 "else should follow close brace '}'\n" . $hereprev) &&
4534 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4535 fix_delete_line($fixlinenr - 1, $prevrawline);
4536 fix_delete_line($fixlinenr, $rawline);
4537 my $fixedline = $prevrawline;
4538 $fixedline =~ s/}\s*$//;
4539 if ($fixedline !~ /^\+\s*$/) {
4540 fix_insert_line($fixlinenr, $fixedline);
4541 }
4542 $fixedline = $rawline;
4543 $fixedline =~ s/^(.\s*)else/$1} else/;
4544 fix_insert_line($fixlinenr, $fixedline);
4545 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004546 }
4547
Joe Perches8b8856f2014-08-06 16:11:14 -07004548 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4549 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004550 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4551
4552 # Find out what is on the end of the line after the
4553 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004554 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004555 $s =~ s/\n.*//g;
4556
4557 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004558 if (ERROR("WHILE_AFTER_BRACE",
4559 "while should follow close brace '}'\n" . $hereprev) &&
4560 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4561 fix_delete_line($fixlinenr - 1, $prevrawline);
4562 fix_delete_line($fixlinenr, $rawline);
4563 my $fixedline = $prevrawline;
4564 my $trailing = $rawline;
4565 $trailing =~ s/^\+//;
4566 $trailing = trim($trailing);
4567 $fixedline =~ s/}\s*$/} $trailing/;
4568 fix_insert_line($fixlinenr, $fixedline);
4569 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004570 }
4571 }
4572
Joe Perches95e2c602013-07-03 15:05:20 -07004573#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004574 while ($line =~ m{($Constant|$Lval)}g) {
4575 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004576
4577#gcc binary extension
4578 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004579 if (WARN("GCC_BINARY_CONSTANT",
4580 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4581 $fix) {
4582 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004583 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004584 s/\b$var\b/$hexval/;
4585 }
Joe Perches95e2c602013-07-03 15:05:20 -07004586 }
4587
4588#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004589 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004590 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004591#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004592 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004593#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004594 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4595#Ignore some three character SI units explicitly, like MiB and KHz
4596 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004597 while ($var =~ m{($Ident)}g) {
4598 my $word = $1;
4599 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004600 if ($check) {
4601 seed_camelcase_includes();
4602 if (!$file && !$camelcase_file_seeded) {
4603 seed_camelcase_file($realfile);
4604 $camelcase_file_seeded = 1;
4605 }
4606 }
Joe Perches7e781f62013-09-11 14:23:55 -07004607 if (!defined $camelcase{$word}) {
4608 $camelcase{$word} = 1;
4609 CHK("CAMELCASE",
4610 "Avoid CamelCase: <$word>\n" . $herecurr);
4611 }
Joe Perches34456862013-07-03 15:05:34 -07004612 }
Joe Perches323c1262012-12-17 16:02:07 -08004613 }
4614 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004615
4616#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004617 if ($line =~ /\#\s*define.*\\\s+$/) {
4618 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4619 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4620 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004621 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004622 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004623 }
4624
Fabian Frederick0e212e02015-04-16 12:44:25 -07004625# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4626# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004627 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004628 my $file = "$1.h";
4629 my $checkfile = "include/linux/$file";
4630 if (-f "$root/$checkfile" &&
4631 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004632 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004633 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004634 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4635 if ($asminclude > 0) {
4636 if ($realfile =~ m{^arch/}) {
4637 CHK("ARCH_INCLUDE_LINUX",
4638 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4639 } else {
4640 WARN("INCLUDE_LINUX",
4641 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4642 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004643 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004644 }
4645 }
4646
Andy Whitcroft653d4872007-06-23 17:16:34 -07004647# multi-statement macros should be enclosed in a do while loop, grab the
4648# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004649# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004650 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4651 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004652 my $ln = $linenr;
4653 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004654 my ($off, $dstat, $dcond, $rest);
4655 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004656 my $has_flow_statement = 0;
4657 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004658 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004659 ctx_statement_block($linenr, $realcnt, 0);
4660 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004661 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004662 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004663
Joe Perches08a28432014-10-13 15:51:55 -07004664 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004665 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004666
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004667 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004668 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004669 $dstat =~ s/\\\n.//g;
4670 $dstat =~ s/^\s*//s;
4671 $dstat =~ s/\s*$//s;
4672
4673 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004674 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4675 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004676 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004677 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004678 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004679
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004680 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004681 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4682 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004683 {
4684 }
4685
Joe Perches42e15292016-03-15 14:58:01 -07004686 # Make asm volatile uses seem like a generic function
4687 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4688
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004689 my $exceptions = qr{
4690 $Declare|
4691 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004692 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004693 DECLARE_PER_CPU|
4694 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004695 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004696 union|
4697 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004698 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004699 ^\"|\"$|
4700 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004701 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004702 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004703 if ($dstat ne '' &&
4704 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4705 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004706 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004707 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004708 $dstat !~ /$exceptions/ &&
4709 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004710 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004711 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004712 $dstat !~ /^for\s*$Constant$/ && # for (...)
4713 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4714 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004715 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004716 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004717 {
4718 $ctx =~ s/\n*$//;
4719 my $herectx = $here . "\n";
4720 my $cnt = statement_rawlines($ctx);
4721
4722 for (my $n = 0; $n < $cnt; $n++) {
4723 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004724 }
4725
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004726 if ($dstat =~ /;/) {
4727 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4728 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4729 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004730 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004731 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004732 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004733 }
Joe Perches5023d342012-12-17 16:01:47 -08004734
Joe Perches08a28432014-10-13 15:51:55 -07004735# check for macros with flow control, but without ## concatenation
4736# ## concatenation is commonly a macro that defines a function so ignore those
4737 if ($has_flow_statement && !$has_arg_concat) {
4738 my $herectx = $here . "\n";
4739 my $cnt = statement_rawlines($ctx);
4740
4741 for (my $n = 0; $n < $cnt; $n++) {
4742 $herectx .= raw_line($linenr, $n) . "\n";
4743 }
4744 WARN("MACRO_WITH_FLOW_CONTROL",
4745 "Macros with flow control statements should be avoided\n" . "$herectx");
4746 }
4747
Joe Perches481eb482012-12-17 16:01:56 -08004748# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004749
4750 } else {
4751 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004752 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4753 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004754 $line =~ /^\+.*\\$/) {
4755 WARN("LINE_CONTINUATIONS",
4756 "Avoid unnecessary line continuations\n" . $herecurr);
4757 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004758 }
4759
Joe Perchesb13edf72012-07-30 14:41:24 -07004760# do {} while (0) macro tests:
4761# single-statement macros do not need to be enclosed in do while (0) loop,
4762# macro should not end with a semicolon
4763 if ($^V && $^V ge 5.10.0 &&
4764 $realfile !~ m@/vmlinux.lds.h$@ &&
4765 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4766 my $ln = $linenr;
4767 my $cnt = $realcnt;
4768 my ($off, $dstat, $dcond, $rest);
4769 my $ctx = '';
4770 ($dstat, $dcond, $ln, $cnt, $off) =
4771 ctx_statement_block($linenr, $realcnt, 0);
4772 $ctx = $dstat;
4773
4774 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004775 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004776
4777 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4778 my $stmts = $2;
4779 my $semis = $3;
4780
4781 $ctx =~ s/\n*$//;
4782 my $cnt = statement_rawlines($ctx);
4783 my $herectx = $here . "\n";
4784
4785 for (my $n = 0; $n < $cnt; $n++) {
4786 $herectx .= raw_line($linenr, $n) . "\n";
4787 }
4788
Joe Perchesac8e97f2012-08-21 16:15:53 -07004789 if (($stmts =~ tr/;/;/) == 1 &&
4790 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004791 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4792 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4793 }
4794 if (defined $semis && $semis ne "") {
4795 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4796 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4797 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004798 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4799 $ctx =~ s/\n*$//;
4800 my $cnt = statement_rawlines($ctx);
4801 my $herectx = $here . "\n";
4802
4803 for (my $n = 0; $n < $cnt; $n++) {
4804 $herectx .= raw_line($linenr, $n) . "\n";
4805 }
4806
4807 WARN("TRAILING_SEMICOLON",
4808 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004809 }
4810 }
4811
Mike Frysinger080ba922009-01-06 14:41:25 -08004812# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4813# all assignments may have only one of the following with an assignment:
4814# .
4815# ALIGN(...)
4816# VMLINUX_SYMBOL(...)
4817 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004818 WARN("MISSING_VMLINUX_SYMBOL",
4819 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004820 }
4821
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004822# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004823 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4824 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004825 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004826 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004827 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4828 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004829 my @allowed = ();
4830 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004831 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004832 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004833 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004834 for my $chunk (@chunks) {
4835 my ($cond, $block) = @{$chunk};
4836
Andy Whitcroft773647a2008-03-28 14:15:58 -07004837 # If the condition carries leading newlines, then count those as offsets.
4838 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4839 my $offset = statement_rawlines($whitespace) - 1;
4840
Joe Perchesaad4f612012-03-23 15:02:19 -07004841 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004842 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4843
4844 # We have looked at and allowed this specific line.
4845 $suppress_ifbraces{$ln + $offset} = 1;
4846
4847 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004848 $ln += statement_rawlines($block) - 1;
4849
Andy Whitcroft773647a2008-03-28 14:15:58 -07004850 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004851
4852 $seen++ if ($block =~ /^\s*{/);
4853
Joe Perchesaad4f612012-03-23 15:02:19 -07004854 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004855 if (statement_lines($cond) > 1) {
4856 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004857 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004858 }
4859 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004860 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004861 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004862 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004863 if (statement_block_size($block) > 1) {
4864 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004865 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004866 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004867 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004868 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004869 if ($seen) {
4870 my $sum_allowed = 0;
4871 foreach (@allowed) {
4872 $sum_allowed += $_;
4873 }
4874 if ($sum_allowed == 0) {
4875 WARN("BRACES",
4876 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4877 } elsif ($sum_allowed != $allow &&
4878 $seen != $allow) {
4879 CHK("BRACES",
4880 "braces {} should be used on all arms of this statement\n" . $herectx);
4881 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004882 }
4883 }
4884 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004885 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004886 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004887 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004888
Andy Whitcroftcf655042008-03-04 14:28:20 -08004889 # Check the pre-context.
4890 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4891 #print "APW: ALLOWED: pre<$1>\n";
4892 $allowed = 1;
4893 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004894
4895 my ($level, $endln, @chunks) =
4896 ctx_statement_full($linenr, $realcnt, $-[0]);
4897
Andy Whitcroftcf655042008-03-04 14:28:20 -08004898 # Check the condition.
4899 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004900 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004901 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004902 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004903 }
4904 if (statement_lines($cond) > 1) {
4905 #print "APW: ALLOWED: cond<$cond>\n";
4906 $allowed = 1;
4907 }
4908 if ($block =~/\b(?:if|for|while)\b/) {
4909 #print "APW: ALLOWED: block<$block>\n";
4910 $allowed = 1;
4911 }
4912 if (statement_block_size($block) > 1) {
4913 #print "APW: ALLOWED: lines block<$block>\n";
4914 $allowed = 1;
4915 }
4916 # Check the post-context.
4917 if (defined $chunks[1]) {
4918 my ($cond, $block) = @{$chunks[1]};
4919 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004920 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004921 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004922 if ($block =~ /^\s*\{/) {
4923 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4924 $allowed = 1;
4925 }
4926 }
4927 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004928 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004929 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004930
Andy Whitcroftf0556632008-10-15 22:02:23 -07004931 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004932 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004933 }
4934
Joe Perches000d1cc12011-07-25 17:13:25 -07004935 WARN("BRACES",
4936 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004937 }
4938 }
4939
Joe Perches0979ae62012-12-17 16:01:59 -08004940# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004941 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004942 if (CHK("BRACES",
4943 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4944 $fix && $prevrawline =~ /^\+/) {
4945 fix_delete_line($fixlinenr - 1, $prevrawline);
4946 }
Joe Perches0979ae62012-12-17 16:01:59 -08004947 }
Joe Perches77b9a532013-07-03 15:05:29 -07004948 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004949 if (CHK("BRACES",
4950 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4951 $fix) {
4952 fix_delete_line($fixlinenr, $rawline);
4953 }
Joe Perches0979ae62012-12-17 16:01:59 -08004954 }
4955
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004956# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004957 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4958 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004959 WARN("VOLATILE",
4960 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004961 }
4962
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004963# Check for user-visible strings broken across lines, which breaks the ability
4964# to grep for the string. Make exceptions when the previous string ends in a
4965# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4966# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004967 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004968 $prevline =~ /"\s*$/ &&
4969 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4970 if (WARN("SPLIT_STRING",
4971 "quoted string split across lines\n" . $hereprev) &&
4972 $fix &&
4973 $prevrawline =~ /^\+.*"\s*$/ &&
4974 $last_coalesced_string_linenr != $linenr - 1) {
4975 my $extracted_string = get_quoted_string($line, $rawline);
4976 my $comma_close = "";
4977 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4978 $comma_close = $1;
4979 }
4980
4981 fix_delete_line($fixlinenr - 1, $prevrawline);
4982 fix_delete_line($fixlinenr, $rawline);
4983 my $fixedline = $prevrawline;
4984 $fixedline =~ s/"\s*$//;
4985 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4986 fix_insert_line($fixlinenr - 1, $fixedline);
4987 $fixedline = $rawline;
4988 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4989 if ($fixedline !~ /\+\s*$/) {
4990 fix_insert_line($fixlinenr, $fixedline);
4991 }
4992 $last_coalesced_string_linenr = $linenr;
4993 }
4994 }
4995
4996# check for missing a space in a string concatenation
4997 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4998 WARN('MISSING_SPACE',
4999 "break quoted strings at a space character\n" . $hereprev);
5000 }
5001
5002# check for spaces before a quoted newline
5003 if ($rawline =~ /^.*\".*\s\\n/) {
5004 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5005 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5006 $fix) {
5007 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5008 }
5009
5010 }
5011
Joe Perchesf17dba42014-10-13 15:51:51 -07005012# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005013 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005014 CHK("CONCATENATED_STRING",
5015 "Concatenated strings should use spaces between elements\n" . $herecurr);
5016 }
5017
Joe Perches90ad30e2014-12-10 15:51:59 -08005018# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005019 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005020 WARN("STRING_FRAGMENTS",
5021 "Consecutive strings are generally better as a single string\n" . $herecurr);
5022 }
5023
Joe Perches6e300752015-09-09 15:37:47 -07005024# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005025 my $string;
5026 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5027 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5028 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005029 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005030 WARN("PRINTF_L",
5031 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5032 last;
5033 }
Joe Perches6e300752015-09-09 15:37:47 -07005034 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5035 ERROR("PRINTF_0xDECIMAL",
5036 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5037 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005038 }
5039
5040# check for line continuations in quoted strings with odd counts of "
5041 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5042 WARN("LINE_CONTINUATIONS",
5043 "Avoid line continuations in quoted strings\n" . $herecurr);
5044 }
5045
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005046# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005047 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005048 CHK("REDUNDANT_CODE",
5049 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005050 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005051 }
5052
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005053# check for needless "if (<foo>) fn(<foo>)" uses
5054 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005055 my $tested = quotemeta($1);
5056 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5057 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5058 my $func = $1;
5059 if (WARN('NEEDLESS_IF',
5060 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5061 $fix) {
5062 my $do_fix = 1;
5063 my $leading_tabs = "";
5064 my $new_leading_tabs = "";
5065 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5066 $leading_tabs = $1;
5067 } else {
5068 $do_fix = 0;
5069 }
5070 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5071 $new_leading_tabs = $1;
5072 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5073 $do_fix = 0;
5074 }
5075 } else {
5076 $do_fix = 0;
5077 }
5078 if ($do_fix) {
5079 fix_delete_line($fixlinenr - 1, $prevrawline);
5080 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5081 }
5082 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005083 }
5084 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005085
Joe Perchesebfdc402014-08-06 16:10:27 -07005086# check for unnecessary "Out of Memory" messages
5087 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5088 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5089 (defined $1 || defined $3) &&
5090 $linenr > 3) {
5091 my $testval = $2;
5092 my $testline = $lines[$linenr - 3];
5093
5094 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5095# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5096
5097 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5098 WARN("OOM_MESSAGE",
5099 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5100 }
5101 }
5102
Joe Perchesf78d98f2014-10-13 15:52:01 -07005103# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005104 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005105 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5106 my $level = $1;
5107 if (WARN("UNNECESSARY_KERN_LEVEL",
5108 "Possible unnecessary $level\n" . $herecurr) &&
5109 $fix) {
5110 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5111 }
5112 }
5113
Joe Perchesabb08a52014-12-10 15:51:46 -08005114# check for mask then right shift without a parentheses
5115 if ($^V && $^V ge 5.10.0 &&
5116 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5117 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5118 WARN("MASK_THEN_SHIFT",
5119 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5120 }
5121
Joe Perchesb75ac612014-12-10 15:52:02 -08005122# check for pointer comparisons to NULL
5123 if ($^V && $^V ge 5.10.0) {
5124 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5125 my $val = $1;
5126 my $equal = "!";
5127 $equal = "" if ($4 eq "!=");
5128 if (CHK("COMPARISON_TO_NULL",
5129 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5130 $fix) {
5131 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5132 }
5133 }
5134 }
5135
Joe Perches8716de32013-09-11 14:24:05 -07005136# check for bad placement of section $InitAttribute (e.g.: __initdata)
5137 if ($line =~ /(\b$InitAttribute\b)/) {
5138 my $attr = $1;
5139 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5140 my $ptr = $1;
5141 my $var = $2;
5142 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5143 ERROR("MISPLACED_INIT",
5144 "$attr should be placed after $var\n" . $herecurr)) ||
5145 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5146 WARN("MISPLACED_INIT",
5147 "$attr should be placed after $var\n" . $herecurr))) &&
5148 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005149 $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 -07005150 }
5151 }
5152 }
5153
Joe Perchese970b8842013-11-12 15:10:10 -08005154# check for $InitAttributeData (ie: __initdata) with const
5155 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5156 my $attr = $1;
5157 $attr =~ /($InitAttributePrefix)(.*)/;
5158 my $attr_prefix = $1;
5159 my $attr_type = $2;
5160 if (ERROR("INIT_ATTRIBUTE",
5161 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5162 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005163 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005164 s/$InitAttributeData/${attr_prefix}initconst/;
5165 }
5166 }
5167
5168# check for $InitAttributeConst (ie: __initconst) without const
5169 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5170 my $attr = $1;
5171 if (ERROR("INIT_ATTRIBUTE",
5172 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5173 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005174 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005175 /(^\+\s*(?:static\s+))/;
5176 $lead = rtrim($1);
5177 $lead = "$lead " if ($lead !~ /^\+$/);
5178 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005179 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005180 }
5181 }
5182
Joe Perchesc17893c2015-04-16 12:44:42 -07005183# check for __read_mostly with const non-pointer (should just be const)
5184 if ($line =~ /\b__read_mostly\b/ &&
5185 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5186 if (ERROR("CONST_READ_MOSTLY",
5187 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5188 $fix) {
5189 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5190 }
5191 }
5192
Joe Perchesfbdb8132014-04-03 14:49:14 -07005193# don't use __constant_<foo> functions outside of include/uapi/
5194 if ($realfile !~ m@^include/uapi/@ &&
5195 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5196 my $constant_func = $1;
5197 my $func = $constant_func;
5198 $func =~ s/^__constant_//;
5199 if (WARN("CONSTANT_CONVERSION",
5200 "$constant_func should be $func\n" . $herecurr) &&
5201 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005202 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005203 }
5204 }
5205
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005206# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005207 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005208 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005209 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005210 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005211 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005212 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5213 }
5214 if ($delay > 2000) {
5215 WARN("LONG_UDELAY",
5216 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005217 }
5218 }
5219
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005220# warn about unexpectedly long msleep's
5221 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5222 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005223 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005224 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005225 }
5226 }
5227
Joe Perches36ec1932013-07-03 15:05:25 -07005228# check for comparisons of jiffies
5229 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5230 WARN("JIFFIES_COMPARISON",
5231 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5232 }
5233
Joe Perches9d7a34a2013-07-03 15:05:26 -07005234# check for comparisons of get_jiffies_64()
5235 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5236 WARN("JIFFIES_COMPARISON",
5237 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5238 }
5239
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005240# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005241# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005242# print "#ifdef in C files should be avoided\n";
5243# print "$herecurr";
5244# $clean = 0;
5245# }
5246
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005247# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005248 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005249 if (ERROR("SPACING",
5250 "exactly one space required after that #$1\n" . $herecurr) &&
5251 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005252 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005253 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5254 }
5255
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005256 }
5257
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005258# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005259 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5260 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005261 my $which = $1;
5262 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005263 CHK("UNCOMMENTED_DEFINITION",
5264 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005265 }
5266 }
5267# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005268
5269 my $barriers = qr{
5270 mb|
5271 rmb|
5272 wmb|
5273 read_barrier_depends
5274 }x;
5275 my $barrier_stems = qr{
5276 mb__before_atomic|
5277 mb__after_atomic|
5278 store_release|
5279 load_acquire|
5280 store_mb|
5281 (?:$barriers)
5282 }x;
5283 my $all_barriers = qr{
5284 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005285 smp_(?:$barrier_stems)|
5286 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005287 }x;
5288
5289 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005290 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005291 WARN("MEMORY_BARRIER",
5292 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005293 }
5294 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005295
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005296 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5297
5298 if ($realfile !~ m@^include/asm-generic/@ &&
5299 $realfile !~ m@/barrier\.h$@ &&
5300 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5301 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5302 WARN("MEMORY_BARRIER",
5303 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5304 }
5305
Joe Perchescb426e92015-06-25 15:02:46 -07005306# check for waitqueue_active without a comment.
5307 if ($line =~ /\bwaitqueue_active\s*\(/) {
5308 if (!ctx_has_comment($first_line, $linenr)) {
5309 WARN("WAITQUEUE_ACTIVE",
5310 "waitqueue_active without comment\n" . $herecurr);
5311 }
5312 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005313
5314# Check for expedited grace periods that interrupt non-idle non-nohz
5315# online CPUs. These expedited can therefore degrade real-time response
5316# if used carelessly, and should be avoided where not absolutely
5317# needed. It is always OK to use synchronize_rcu_expedited() and
5318# synchronize_sched_expedited() at boot time (before real-time applications
5319# start) and in error situations where real-time response is compromised in
5320# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5321# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5322# Of course, nothing comes for free, and srcu_read_lock() and
5323# srcu_read_unlock() do contain full memory barriers in payment for
5324# synchronize_srcu_expedited() non-interruption properties.
5325 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5326 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5327 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5328
5329 }
5330
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005331# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005332 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005333 CHK("ARCH_DEFINES",
5334 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005335 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005336
Tobias Klauserd4977c72010-05-24 14:33:30 -07005337# Check that the storage class is at the beginning of a declaration
5338 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005339 WARN("STORAGE_CLASS",
5340 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005341 }
5342
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005343# check the location of the inline attribute, that it is between
5344# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005345 if ($line =~ /\b$Type\s+$Inline\b/ ||
5346 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005347 ERROR("INLINE_LOCATION",
5348 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005349 }
5350
Andy Whitcroft8905a672007-11-28 16:21:06 -08005351# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005352 if ($realfile !~ m@\binclude/uapi/@ &&
5353 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005354 if (WARN("INLINE",
5355 "plain inline is preferred over $1\n" . $herecurr) &&
5356 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005357 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005358
5359 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005360 }
5361
Joe Perches3d130fd2011-01-12 17:00:00 -08005362# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005363 if ($realfile !~ m@\binclude/uapi/@ &&
5364 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005365 WARN("PREFER_PACKED",
5366 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005367 }
5368
Joe Perches39b7e282011-07-25 17:13:24 -07005369# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005370 if ($realfile !~ m@\binclude/uapi/@ &&
5371 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005372 WARN("PREFER_ALIGNED",
5373 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005374 }
5375
Joe Perches5f14d3b2012-01-10 15:09:52 -08005376# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005377 if ($realfile !~ m@\binclude/uapi/@ &&
5378 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005379 if (WARN("PREFER_PRINTF",
5380 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5381 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005382 $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 -07005383
5384 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005385 }
5386
Joe Perches6061d942012-03-23 15:02:16 -07005387# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005388 if ($realfile !~ m@\binclude/uapi/@ &&
5389 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005390 if (WARN("PREFER_SCANF",
5391 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5392 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005393 $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 -07005394 }
Joe Perches6061d942012-03-23 15:02:16 -07005395 }
5396
Joe Perches619a9082014-12-10 15:51:35 -08005397# Check for __attribute__ weak, or __weak declarations (may have link issues)
5398 if ($^V && $^V ge 5.10.0 &&
5399 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5400 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5401 $line =~ /\b__weak\b/)) {
5402 ERROR("WEAK_DECLARATION",
5403 "Using weak declarations can have unintended link defects\n" . $herecurr);
5404 }
5405
Joe Perchese6176fa2015-06-25 15:02:49 -07005406# check for c99 types like uint8_t used outside of uapi/
5407 if ($realfile !~ m@\binclude/uapi/@ &&
5408 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5409 my $type = $1;
5410 if ($type =~ /\b($typeC99Typedefs)\b/) {
5411 $type = $1;
5412 my $kernel_type = 'u';
5413 $kernel_type = 's' if ($type =~ /^_*[si]/);
5414 $type =~ /(\d+)/;
5415 $kernel_type .= $1;
5416 if (CHK("PREFER_KERNEL_TYPES",
5417 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5418 $fix) {
5419 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5420 }
5421 }
5422 }
5423
Joe Perches938224b52016-01-20 14:59:15 -08005424# check for cast of C90 native int or longer types constants
5425 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5426 my $cast = $1;
5427 my $const = $2;
5428 if (WARN("TYPECAST_INT_CONSTANT",
5429 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5430 $fix) {
5431 my $suffix = "";
5432 my $newconst = $const;
5433 $newconst =~ s/${Int_type}$//;
5434 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5435 if ($cast =~ /\blong\s+long\b/) {
5436 $suffix .= 'LL';
5437 } elsif ($cast =~ /\blong\b/) {
5438 $suffix .= 'L';
5439 }
5440 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5441 }
5442 }
5443
Joe Perches8f53a9b2010-03-05 13:43:48 -08005444# check for sizeof(&)
5445 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005446 WARN("SIZEOF_ADDRESS",
5447 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005448 }
5449
Joe Perches66c80b62012-07-30 14:41:22 -07005450# check for sizeof without parenthesis
5451 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005452 if (WARN("SIZEOF_PARENTHESIS",
5453 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5454 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005455 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005456 }
Joe Perches66c80b62012-07-30 14:41:22 -07005457 }
5458
Joe Perches88982fe2012-12-17 16:02:00 -08005459# check for struct spinlock declarations
5460 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5461 WARN("USE_SPINLOCK_T",
5462 "struct spinlock should be spinlock_t\n" . $herecurr);
5463 }
5464
Joe Perchesa6962d72013-04-29 16:18:13 -07005465# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005466 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005467 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005468 $fmt =~ s/%%//g;
5469 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005470 if (WARN("PREFER_SEQ_PUTS",
5471 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5472 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005473 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005474 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005475 }
5476 }
5477
Andy Whitcroft554e1652012-01-10 15:09:57 -08005478# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005479 if ($^V && $^V ge 5.10.0 &&
5480 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005481 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005482
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005483 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005484 my $ms_val = $7;
5485 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005486
Andy Whitcroft554e1652012-01-10 15:09:57 -08005487 if ($ms_size =~ /^(0x|)0$/i) {
5488 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005489 "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 -08005490 } elsif ($ms_size =~ /^(0x|)1$/i) {
5491 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005492 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5493 }
5494 }
5495
Joe Perches98a9bba2014-01-23 15:54:52 -08005496# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5497 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005498 defined $stat &&
5499 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005500 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005501 "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 -08005502 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005503 $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 -08005504 }
5505 }
5506
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005507# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5508 if ($^V && $^V ge 5.10.0 &&
5509 defined $stat &&
5510 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5511 WARN("PREFER_ETHER_ADDR_EQUAL",
5512 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5513 }
5514
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005515# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5516# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5517 if ($^V && $^V ge 5.10.0 &&
5518 defined $stat &&
5519 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5520
5521 my $ms_val = $7;
5522
5523 if ($ms_val =~ /^(?:0x|)0+$/i) {
5524 if (WARN("PREFER_ETH_ZERO_ADDR",
5525 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5526 $fix) {
5527 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5528 }
5529 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5530 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5531 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5532 $fix) {
5533 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5534 }
5535 }
5536 }
5537
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005538# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005539 if ($^V && $^V ge 5.10.0 &&
5540 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005541 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005542 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005543 my $call = $1;
5544 my $cast1 = deparenthesize($2);
5545 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005546 my $cast2 = deparenthesize($7);
5547 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005548 my $cast;
5549
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005550 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005551 $cast = "$cast1 or $cast2";
5552 } elsif ($cast1 ne "") {
5553 $cast = $cast1;
5554 } else {
5555 $cast = $cast2;
5556 }
5557 WARN("MINMAX",
5558 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005559 }
5560 }
5561
Joe Perches4a273192012-07-30 14:41:20 -07005562# check usleep_range arguments
5563 if ($^V && $^V ge 5.10.0 &&
5564 defined $stat &&
5565 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5566 my $min = $1;
5567 my $max = $7;
5568 if ($min eq $max) {
5569 WARN("USLEEP_RANGE",
5570 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5571 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5572 $min > $max) {
5573 WARN("USLEEP_RANGE",
5574 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5575 }
5576 }
5577
Joe Perches823b7942013-11-12 15:10:15 -08005578# check for naked sscanf
5579 if ($^V && $^V ge 5.10.0 &&
5580 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005581 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005582 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5583 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5584 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5585 my $lc = $stat =~ tr@\n@@;
5586 $lc = $lc + $linenr;
5587 my $stat_real = raw_line($linenr, 0);
5588 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5589 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5590 }
5591 WARN("NAKED_SSCANF",
5592 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5593 }
5594
Joe Perchesafc819a2014-06-04 16:12:08 -07005595# check for simple sscanf that should be kstrto<foo>
5596 if ($^V && $^V ge 5.10.0 &&
5597 defined $stat &&
5598 $line =~ /\bsscanf\b/) {
5599 my $lc = $stat =~ tr@\n@@;
5600 $lc = $lc + $linenr;
5601 my $stat_real = raw_line($linenr, 0);
5602 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5603 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5604 }
5605 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5606 my $format = $6;
5607 my $count = $format =~ tr@%@%@;
5608 if ($count == 1 &&
5609 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5610 WARN("SSCANF_TO_KSTRTO",
5611 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5612 }
5613 }
5614 }
5615
Joe Perches70dc8a42013-09-11 14:23:58 -07005616# check for new externs in .h files.
5617 if ($realfile =~ /\.h$/ &&
5618 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005619 if (CHK("AVOID_EXTERNS",
5620 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005621 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005622 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005623 }
5624 }
5625
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005626# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005627 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005628 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005629 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005630 my $function_name = $1;
5631 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005632
5633 my $s = $stat;
5634 if (defined $cond) {
5635 substr($s, 0, length($cond), '');
5636 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005637 if ($s =~ /^\s*;/ &&
5638 $function_name ne 'uninitialized_var')
5639 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005640 WARN("AVOID_EXTERNS",
5641 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005642 }
5643
5644 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005645 WARN("FUNCTION_ARGUMENTS",
5646 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005647 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005648
5649 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5650 $stat =~ /^.\s*extern\s+/)
5651 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005652 WARN("AVOID_EXTERNS",
5653 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005654 }
5655
5656# checks for new __setup's
5657 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5658 my $name = $1;
5659
5660 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005661 CHK("UNDOCUMENTED_SETUP",
5662 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005663 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005664 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005665
5666# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005667 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005668 WARN("UNNECESSARY_CASTS",
5669 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005670 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005671
Joe Perchesa640d252013-07-03 15:05:21 -07005672# alloc style
5673# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5674 if ($^V && $^V ge 5.10.0 &&
5675 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5676 CHK("ALLOC_SIZEOF_STRUCT",
5677 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5678 }
5679
Joe Perches60a55362014-06-04 16:12:07 -07005680# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5681 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005682 $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 -07005683 my $oldfunc = $3;
5684 my $a1 = $4;
5685 my $a2 = $10;
5686 my $newfunc = "kmalloc_array";
5687 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005688 my $r1 = $a1;
5689 my $r2 = $a2;
5690 if ($a1 =~ /^sizeof\s*\S/) {
5691 $r1 = $a2;
5692 $r2 = $a1;
5693 }
5694 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5695 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005696 if (WARN("ALLOC_WITH_MULTIPLY",
5697 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5698 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005699 $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 -07005700
5701 }
5702 }
5703 }
5704
Joe Perches972fdea2013-04-29 16:18:12 -07005705# check for krealloc arg reuse
5706 if ($^V && $^V ge 5.10.0 &&
5707 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5708 WARN("KREALLOC_ARG_REUSE",
5709 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5710 }
5711
Joe Perches5ce59ae2013-02-21 16:44:18 -08005712# check for alloc argument mismatch
5713 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5714 WARN("ALLOC_ARRAY_ARGS",
5715 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5716 }
5717
Joe Perchescaf2a542011-01-12 16:59:56 -08005718# check for multiple semicolons
5719 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005720 if (WARN("ONE_SEMICOLON",
5721 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5722 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005723 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005724 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005725 }
5726
Joe Perches0ab90192014-12-10 15:51:57 -08005727# check for #defines like: 1 << <digit> that could be BIT(digit)
5728 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5729 my $ull = "";
5730 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5731 if (CHK("BIT_MACRO",
5732 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5733 $fix) {
5734 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5735 }
5736 }
5737
Joe Perches2d632742016-05-20 17:04:00 -07005738# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5739 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5740 my $config = $1;
5741 if (WARN("PREFER_IS_ENABLED",
5742 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5743 $fix) {
5744 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5745 }
5746 }
5747
Joe Perchese81f2392014-08-06 16:11:25 -07005748# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005749 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5750 my $has_break = 0;
5751 my $has_statement = 0;
5752 my $count = 0;
5753 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005754 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005755 $prevline--;
5756 my $rline = $rawlines[$prevline - 1];
5757 my $fline = $lines[$prevline - 1];
5758 last if ($fline =~ /^\@\@/);
5759 next if ($fline =~ /^\-/);
5760 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5761 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5762 next if ($fline =~ /^.[\s$;]*$/);
5763 $has_statement = 1;
5764 $count++;
5765 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5766 }
5767 if (!$has_break && $has_statement) {
5768 WARN("MISSING_BREAK",
5769 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5770 }
5771 }
5772
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005773# check for switch/default statements without a break;
5774 if ($^V && $^V ge 5.10.0 &&
5775 defined $stat &&
5776 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5777 my $ctx = '';
5778 my $herectx = $here . "\n";
5779 my $cnt = statement_rawlines($stat);
5780 for (my $n = 0; $n < $cnt; $n++) {
5781 $herectx .= raw_line($linenr, $n) . "\n";
5782 }
5783 WARN("DEFAULT_NO_BREAK",
5784 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005785 }
5786
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005787# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005788 if ($line =~ /\b__FUNCTION__\b/) {
5789 if (WARN("USE_FUNC",
5790 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5791 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005792 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005793 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005794 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005795
Joe Perches62ec8182015-02-13 14:38:18 -08005796# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5797 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5798 ERROR("DATE_TIME",
5799 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5800 }
5801
Joe Perches2c924882012-03-23 15:02:20 -07005802# check for use of yield()
5803 if ($line =~ /\byield\s*\(\s*\)/) {
5804 WARN("YIELD",
5805 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5806 }
5807
Joe Perches179f8f42013-07-03 15:05:30 -07005808# check for comparisons against true and false
5809 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5810 my $lead = $1;
5811 my $arg = $2;
5812 my $test = $3;
5813 my $otype = $4;
5814 my $trail = $5;
5815 my $op = "!";
5816
5817 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5818
5819 my $type = lc($otype);
5820 if ($type =~ /^(?:true|false)$/) {
5821 if (("$test" eq "==" && "$type" eq "true") ||
5822 ("$test" eq "!=" && "$type" eq "false")) {
5823 $op = "";
5824 }
5825
5826 CHK("BOOL_COMPARISON",
5827 "Using comparison to $otype is error prone\n" . $herecurr);
5828
5829## maybe suggesting a correct construct would better
5830## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5831
5832 }
5833 }
5834
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005835# check for semaphores initialized locked
5836 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005837 WARN("CONSIDER_COMPLETION",
5838 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005839 }
Joe Perches6712d852012-03-23 15:02:20 -07005840
Joe Perches67d0a072011-10-31 17:13:10 -07005841# recommend kstrto* over simple_strto* and strict_strto*
5842 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005843 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005844 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005845 }
Joe Perches6712d852012-03-23 15:02:20 -07005846
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005847# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005848 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005849 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005850 "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 -07005851 }
Joe Perches6712d852012-03-23 15:02:20 -07005852
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005853# check for various structs that are normally const (ops, kgdb, device_tree)
5854 my $const_structs = qr{
5855 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005856 address_space_operations|
5857 backlight_ops|
5858 block_device_operations|
5859 dentry_operations|
5860 dev_pm_ops|
5861 dma_map_ops|
5862 extent_io_ops|
5863 file_lock_operations|
5864 file_operations|
5865 hv_ops|
5866 ide_dma_ops|
5867 intel_dvo_dev_ops|
5868 item_operations|
5869 iwl_ops|
5870 kgdb_arch|
5871 kgdb_io|
5872 kset_uevent_ops|
5873 lock_manager_operations|
5874 microcode_ops|
5875 mtrr_ops|
5876 neigh_ops|
5877 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005878 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005879 pci_raw_ops|
5880 pipe_buf_operations|
5881 platform_hibernation_ops|
5882 platform_suspend_ops|
5883 proto_ops|
5884 rpc_pipe_ops|
5885 seq_operations|
5886 snd_ac97_build_ops|
5887 soc_pcmcia_socket_ops|
5888 stacktrace_ops|
5889 sysfs_ops|
5890 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005891 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005892 usb_mon_operations|
5893 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005894 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005895 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005896 WARN("CONST_STRUCT",
5897 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005898 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005899 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005900
5901# use of NR_CPUS is usually wrong
5902# ignore definitions of NR_CPUS and usage to define arrays as likely right
5903 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005904 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5905 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005906 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5907 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5908 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005909 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005910 WARN("NR_CPUS",
5911 "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 -07005912 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005913
Joe Perches52ea8502013-11-12 15:10:09 -08005914# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5915 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5916 ERROR("DEFINE_ARCH_HAS",
5917 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5918 }
5919
Joe Perchesacd93622015-02-13 14:38:38 -08005920# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5921 if ($^V && $^V ge 5.10.0 &&
5922 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5923 WARN("LIKELY_MISUSE",
5924 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5925 }
5926
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005927# whine mightly about in_atomic
5928 if ($line =~ /\bin_atomic\s*\(/) {
5929 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005930 ERROR("IN_ATOMIC",
5931 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005932 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005933 WARN("IN_ATOMIC",
5934 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005935 }
5936 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005937
Joe Perches481aea52016-05-20 17:04:08 -07005938# whine about ACCESS_ONCE
5939 if ($^V && $^V ge 5.10.0 &&
5940 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
5941 my $par = $1;
5942 my $eq = $2;
5943 my $fun = $3;
5944 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
5945 if (defined($eq)) {
5946 if (WARN("PREFER_WRITE_ONCE",
5947 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
5948 $fix) {
5949 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5950 }
5951 } else {
5952 if (WARN("PREFER_READ_ONCE",
5953 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
5954 $fix) {
5955 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
5956 }
5957 }
5958 }
5959
Peter Zijlstra1704f472010-03-19 01:37:42 +01005960# check for lockdep_set_novalidate_class
5961 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5962 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5963 if ($realfile !~ m@^kernel/lockdep@ &&
5964 $realfile !~ m@^include/linux/lockdep@ &&
5965 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005966 ERROR("LOCKDEP",
5967 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005968 }
5969 }
Dave Jones88f88312011-01-12 16:59:59 -08005970
Joe Perchesb392c642015-04-16 12:44:16 -07005971 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5972 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005973 WARN("EXPORTED_WORLD_WRITABLE",
5974 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005975 }
Joe Perches24358802014-04-03 14:49:13 -07005976
Joe Perches515a2352014-04-03 14:49:24 -07005977# Mode permission misuses where it seems decimal should be octal
5978# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5979 if ($^V && $^V ge 5.10.0 &&
5980 $line =~ /$mode_perms_search/) {
5981 foreach my $entry (@mode_permission_funcs) {
5982 my $func = $entry->[0];
5983 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005984
Joe Perches515a2352014-04-03 14:49:24 -07005985 my $skip_args = "";
5986 if ($arg_pos > 1) {
5987 $arg_pos--;
5988 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5989 }
5990 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5991 if ($line =~ /$test/) {
5992 my $val = $1;
5993 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005994
Joe Perches515a2352014-04-03 14:49:24 -07005995 if ($val !~ /^0$/ &&
5996 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5997 length($val) ne 4)) {
5998 ERROR("NON_OCTAL_PERMISSIONS",
5999 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08006000 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6001 ERROR("EXPORTED_WORLD_WRITABLE",
6002 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006003 }
Joe Perches24358802014-04-03 14:49:13 -07006004 }
6005 }
6006 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006007
6008# validate content of MODULE_LICENSE against list from include/linux/module.h
6009 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6010 my $extracted_string = get_quoted_string($line, $rawline);
6011 my $valid_licenses = qr{
6012 GPL|
6013 GPL\ v2|
6014 GPL\ and\ additional\ rights|
6015 Dual\ BSD/GPL|
6016 Dual\ MIT/GPL|
6017 Dual\ MPL/GPL|
6018 Proprietary
6019 }x;
6020 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6021 WARN("MODULE_LICENSE",
6022 "unknown module license " . $extracted_string . "\n" . $herecurr);
6023 }
6024 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006025 }
6026
6027 # If we have no input at all, then there is nothing to report on
6028 # so just keep quiet.
6029 if ($#rawlines == -1) {
6030 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006031 }
6032
Andy Whitcroft8905a672007-11-28 16:21:06 -08006033 # In mailback mode only produce a report in the negative, for
6034 # things that appear to be patches.
6035 if ($mailback && ($clean == 1 || !$is_patch)) {
6036 exit(0);
6037 }
6038
6039 # This is not a patch, and we are are in 'no-patch' mode so
6040 # just keep quiet.
6041 if (!$chk_patch && !$is_patch) {
6042 exit(0);
6043 }
6044
Joe Perches06330fc2015-06-25 15:03:11 -07006045 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006046 ERROR("NOT_UNIFIED_DIFF",
6047 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006048 }
Joe Perches34d88152015-06-25 15:03:05 -07006049 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006050 ERROR("MISSING_SIGN_OFF",
6051 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006052 }
6053
Andy Whitcroft8905a672007-11-28 16:21:06 -08006054 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006055 if ($summary && !($clean == 1 && $quiet == 1)) {
6056 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006057 print "total: $cnt_error errors, $cnt_warn warnings, " .
6058 (($check)? "$cnt_chk checks, " : "") .
6059 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006060 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006061
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006062 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006063 # If there were any defects found and not already fixing them
6064 if (!$clean and !$fix) {
6065 print << "EOM"
6066
6067NOTE: For some of the reported defects, checkpatch may be able to
6068 mechanically convert to the typical style using --fix or --fix-inplace.
6069EOM
6070 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006071 # If there were whitespace errors which cleanpatch can fix
6072 # then suggest that.
6073 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006074 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006075 print << "EOM"
6076
6077NOTE: Whitespace errors detected.
6078 You may wish to use scripts/cleanpatch or scripts/cleanfile
6079EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006080 }
6081 }
6082
Joe Perchesd752fcc2014-08-06 16:11:05 -07006083 if ($clean == 0 && $fix &&
6084 ("@rawlines" ne "@fixed" ||
6085 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006086 my $newfile = $filename;
6087 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006088 my $linecount = 0;
6089 my $f;
6090
Joe Perchesd752fcc2014-08-06 16:11:05 -07006091 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6092
Joe Perches3705ce52013-07-03 15:05:31 -07006093 open($f, '>', $newfile)
6094 or die "$P: Can't open $newfile for write\n";
6095 foreach my $fixed_line (@fixed) {
6096 $linecount++;
6097 if ($file) {
6098 if ($linecount > 3) {
6099 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006100 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006101 }
6102 } else {
6103 print $f $fixed_line . "\n";
6104 }
6105 }
6106 close($f);
6107
6108 if (!$quiet) {
6109 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006110
Joe Perches3705ce52013-07-03 15:05:31 -07006111Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6112
6113Do _NOT_ trust the results written to this file.
6114Do _NOT_ submit these changes without inspecting them for correctness.
6115
6116This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6117No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006118EOM
6119 }
6120 }
6121
Joe Perchesd8469f12015-06-25 15:03:00 -07006122 if ($quiet == 0) {
6123 print "\n";
6124 if ($clean == 1) {
6125 print "$vname has no obvious style problems and is ready for submission.\n";
6126 } else {
6127 print "$vname has style problems, please review.\n";
6128 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006129 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006130 return $clean;
6131}