blob: 8fc9edd3289a9225276521cc2ce1af80f2e00c9a [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070030my $git = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070031my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070032my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080033my $summary = 1;
34my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080035my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070036my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070037my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070038my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080039my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070040my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080041my %debug;
Joe Perches34456862013-07-03 15:05:34 -070042my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070043my %use_type = ();
44my @use = ();
45my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070046my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070047my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070048my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080049my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070050my $ignore_perl_version = 0;
51my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070052my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070053my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070054my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070055my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perches57230292015-06-25 15:03:03 -070056my $color = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070057
58sub help {
59 my ($exitcode) = @_;
60
61 print << "EOM";
62Usage: $P [OPTION]... [FILE]...
63Version: $V
64
65Options:
66 -q, --quiet quiet
67 --no-tree run without a kernel tree
68 --no-signoff do not check for 'Signed-off-by' line
69 --patch treat FILE as patchfile (default)
70 --emacs emacs compile window format
71 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070072 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070073 -g, --git treat FILE as a single commit or git revision range
74 single git commit with:
75 <rev>
76 <rev>^
77 <rev>~n
78 multiple git commits with:
79 <rev1>..<rev2>
80 <rev1>...<rev2>
81 <rev>-<count>
82 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070083 -f, --file treat FILE as regular source file
84 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070085 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070086 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070087 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070088 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080089 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070090 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070091 --root=PATH PATH to the kernel tree root
92 --no-summary suppress the per-file summary
93 --mailback only produce a report in case of warnings/errors
94 --summary-file include the filename in summary
95 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
96 'values', 'possible', 'type', and 'attr' (default
97 is all off)
98 --test-only=WORD report only warnings/errors containing WORD
99 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700100 --fix EXPERIMENTAL - may create horrible results
101 If correctable single-line errors exist, create
102 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
103 with potential errors corrected to the preferred
104 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800105 --fix-inplace EXPERIMENTAL - may create horrible results
106 Is the same as --fix, but overwrites the input
107 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700108 --ignore-perl-version override checking of perl version. expect
109 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700110 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700111 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700112 --codespellfile Use this codespell dictionary
Joe Perches57230292015-06-25 15:03:03 -0700113 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700114 -h, --help, --version display this help and exit
115
116When FILE is - read standard input.
117EOM
118
119 exit($exitcode);
120}
121
Joe Perches3beb42e2016-05-20 17:04:14 -0700122sub uniq {
123 my %seen;
124 return grep { !$seen{$_}++ } @_;
125}
126
127sub list_types {
128 my ($exitcode) = @_;
129
130 my $count = 0;
131
132 local $/ = undef;
133
134 open(my $script, '<', abs_path($P)) or
135 die "$P: Can't read '$P' $!\n";
136
137 my $text = <$script>;
138 close($script);
139
140 my @types = ();
141 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
142 push (@types, $_);
143 }
144 @types = sort(uniq(@types));
145 print("#\tMessage type\n\n");
146 foreach my $type (@types) {
147 print(++$count . "\t" . $type . "\n");
148 }
149
150 exit($exitcode);
151}
152
Joe Perches000d1cc12011-07-25 17:13:25 -0700153my $conf = which_conf($configuration_file);
154if (-f $conf) {
155 my @conf_args;
156 open(my $conffile, '<', "$conf")
157 or warn "$P: Can't find a readable $configuration_file file $!\n";
158
159 while (<$conffile>) {
160 my $line = $_;
161
162 $line =~ s/\s*\n?$//g;
163 $line =~ s/^\s*//g;
164 $line =~ s/\s+/ /g;
165
166 next if ($line =~ m/^\s*#/);
167 next if ($line =~ m/^\s*$/);
168
169 my @words = split(" ", $line);
170 foreach my $word (@words) {
171 last if ($word =~ m/^#/);
172 push (@conf_args, $word);
173 }
174 }
175 close($conffile);
176 unshift(@ARGV, @conf_args) if @conf_args;
177}
178
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700179GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700180 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700181 'tree!' => \$tree,
182 'signoff!' => \$chk_signoff,
183 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700184 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800185 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700186 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700187 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700188 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700189 'subjective!' => \$check,
190 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700191 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700192 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700193 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700194 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800195 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700196 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700197 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800198 'summary!' => \$summary,
199 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800200 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700201 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800202 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700203 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800204 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700205 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700206 'codespell!' => \$codespell,
207 'codespellfile=s' => \$codespellfile,
Joe Perches57230292015-06-25 15:03:03 -0700208 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700209 'h|help' => \$help,
210 'version' => \$help
211) or help(1);
212
213help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700214
Joe Perches3beb42e2016-05-20 17:04:14 -0700215list_types(0) if ($list_types);
216
Joe Perches9624b8d2014-01-23 15:54:44 -0800217$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700218$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800219
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700220my $exit = 0;
221
Dave Hansend62a2012013-09-11 14:23:56 -0700222if ($^V && $^V lt $minimum_perl_version) {
223 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
224 if (!$ignore_perl_version) {
225 exit(1);
226 }
227}
228
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700229if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700230 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700231 exit(1);
232}
233
Joe Perches91bfe482013-09-11 14:23:59 -0700234sub hash_save_array_words {
235 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700236
Joe Perches91bfe482013-09-11 14:23:59 -0700237 my @array = split(/,/, join(',', @$arrayRef));
238 foreach my $word (@array) {
239 $word =~ s/\s*\n?$//g;
240 $word =~ s/^\s*//g;
241 $word =~ s/\s+/ /g;
242 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700243
Joe Perches91bfe482013-09-11 14:23:59 -0700244 next if ($word =~ m/^\s*#/);
245 next if ($word =~ m/^\s*$/);
246
247 $hashRef->{$word}++;
248 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700249}
250
Joe Perches91bfe482013-09-11 14:23:59 -0700251sub hash_show_words {
252 my ($hashRef, $prefix) = @_;
253
Joe Perches3c816e42015-06-25 15:03:29 -0700254 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700255 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700256 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700257 print " $word";
258 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700259 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700260 }
261}
262
263hash_save_array_words(\%ignore_type, \@ignore);
264hash_save_array_words(\%use_type, \@use);
265
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800266my $dbg_values = 0;
267my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700268my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700269my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800270for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800271 ## no critic
272 eval "\${dbg_$key} = '$debug{$key}';";
273 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800274}
275
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700276my $rpt_cleaners = 0;
277
Andy Whitcroft8905a672007-11-28 16:21:06 -0800278if ($terse) {
279 $emacs = 1;
280 $quiet++;
281}
282
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700283if ($tree) {
284 if (defined $root) {
285 if (!top_of_kernel_tree($root)) {
286 die "$P: $root: --root does not point at a valid tree\n";
287 }
288 } else {
289 if (top_of_kernel_tree('.')) {
290 $root = '.';
291 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
292 top_of_kernel_tree($1)) {
293 $root = $1;
294 }
295 }
296
297 if (!defined $root) {
298 print "Must be run from the top-level dir. of a kernel tree\n";
299 exit(2);
300 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700301}
302
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700303my $emitted_corrupt = 0;
304
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700305our $Ident = qr{
306 [A-Za-z_][A-Za-z\d_]*
307 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
308 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700309our $Storage = qr{extern|static|asmlinkage};
310our $Sparse = qr{
311 __user|
312 __kernel|
313 __force|
314 __iomem|
Joe Perches54507b52015-09-09 15:37:55 -0700315 __pmem|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700316 __must_check|
317 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800318 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700319 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800320 __rcu|
321 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700322 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800323our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
324our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
325our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
326our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
327our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700328
Wolfram Sang52131292010-03-05 13:43:51 -0800329# Notes to $Attribute:
330# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700331our $Attribute = qr{
332 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700333 __percpu|
334 __nocast|
335 __safe|
336 __bitwise__|
337 __packed__|
338 __packed2__|
339 __naked|
340 __maybe_unused|
341 __always_unused|
342 __noreturn|
343 __used|
344 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800345 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700346 __noclone|
347 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700348 __read_mostly|
349 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700350 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700351 ____cacheline_aligned|
352 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800353 ____cacheline_internodealigned_in_smp|
354 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700355 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700356our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700357our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700358our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
359our $Lval = qr{$Ident(?:$Member)*};
360
Joe Perches95e2c602013-07-03 15:05:20 -0700361our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
362our $Binary = qr{(?i)0b[01]+$Int_type?};
363our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
364our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700365our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800366our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800367our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
368our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
369our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800370our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700371our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800372our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700373our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700374our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700375our $Operators = qr{
376 <=|>=|==|!=|
377 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700378 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700379 }x;
380
Joe Perches91cb5192014-04-03 14:49:32 -0700381our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
382
Joe Perchesab7e23f2015-04-16 12:44:22 -0700383our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800384our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700385our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700386our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800387our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700388our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800389our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700390our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800391
Joe Perches15662b32011-10-31 17:13:12 -0700392our $NON_ASCII_UTF8 = qr{
393 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700394 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
395 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
396 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
397 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
398 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
399 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
400}x;
401
Joe Perches15662b32011-10-31 17:13:12 -0700402our $UTF8 = qr{
403 [\x09\x0A\x0D\x20-\x7E] # ASCII
404 | $NON_ASCII_UTF8
405}x;
406
Joe Perchese6176fa2015-06-25 15:02:49 -0700407our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800408our $typeOtherOSTypedefs = qr{(?x:
409 u_(?:char|short|int|long) | # bsd
410 u(?:nchar|short|int|long) # sysv
411)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700412our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700413 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700414 atomic_t
415)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700416our $typeTypedefs = qr{(?x:
417 $typeC99Typedefs\b|
418 $typeOtherOSTypedefs\b|
419 $typeKernelTypedefs\b
420)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700421
Joe Perches6d32f7a2015-11-06 16:31:37 -0800422our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
423
Joe Perches691e6692010-03-05 13:43:51 -0800424our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700425 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700426 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700427 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700428 panic|
Joe Perches06668722013-11-12 15:10:07 -0800429 MODULE_[A-Z_]+|
430 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800431)};
432
Joe Perches20112472011-07-25 17:13:23 -0700433our $signature_tags = qr{(?xi:
434 Signed-off-by:|
435 Acked-by:|
436 Tested-by:|
437 Reviewed-by:|
438 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700439 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700440 To:|
441 Cc:
442)};
443
Joe Perches18130872014-08-06 16:11:22 -0700444our @typeListMisordered = (
445 qr{char\s+(?:un)?signed},
446 qr{int\s+(?:(?:un)?signed\s+)?short\s},
447 qr{int\s+short(?:\s+(?:un)?signed)},
448 qr{short\s+int(?:\s+(?:un)?signed)},
449 qr{(?:un)?signed\s+int\s+short},
450 qr{short\s+(?:un)?signed},
451 qr{long\s+int\s+(?:un)?signed},
452 qr{int\s+long\s+(?:un)?signed},
453 qr{long\s+(?:un)?signed\s+int},
454 qr{int\s+(?:un)?signed\s+long},
455 qr{int\s+(?:un)?signed},
456 qr{int\s+long\s+long\s+(?:un)?signed},
457 qr{long\s+long\s+int\s+(?:un)?signed},
458 qr{long\s+long\s+(?:un)?signed\s+int},
459 qr{long\s+long\s+(?:un)?signed},
460 qr{long\s+(?:un)?signed},
461);
462
Andy Whitcroft8905a672007-11-28 16:21:06 -0800463our @typeList = (
464 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700465 qr{(?:(?:un)?signed\s+)?char},
466 qr{(?:(?:un)?signed\s+)?short\s+int},
467 qr{(?:(?:un)?signed\s+)?short},
468 qr{(?:(?:un)?signed\s+)?int},
469 qr{(?:(?:un)?signed\s+)?long\s+int},
470 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
471 qr{(?:(?:un)?signed\s+)?long\s+long},
472 qr{(?:(?:un)?signed\s+)?long},
473 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800474 qr{float},
475 qr{double},
476 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800477 qr{struct\s+$Ident},
478 qr{union\s+$Ident},
479 qr{enum\s+$Ident},
480 qr{${Ident}_t},
481 qr{${Ident}_handler},
482 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700483 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800484);
Joe Perches938224b2016-01-20 14:59:15 -0800485
486our $C90_int_types = qr{(?x:
487 long\s+long\s+int\s+(?:un)?signed|
488 long\s+long\s+(?:un)?signed\s+int|
489 long\s+long\s+(?:un)?signed|
490 (?:(?:un)?signed\s+)?long\s+long\s+int|
491 (?:(?:un)?signed\s+)?long\s+long|
492 int\s+long\s+long\s+(?:un)?signed|
493 int\s+(?:(?:un)?signed\s+)?long\s+long|
494
495 long\s+int\s+(?:un)?signed|
496 long\s+(?:un)?signed\s+int|
497 long\s+(?:un)?signed|
498 (?:(?:un)?signed\s+)?long\s+int|
499 (?:(?:un)?signed\s+)?long|
500 int\s+long\s+(?:un)?signed|
501 int\s+(?:(?:un)?signed\s+)?long|
502
503 int\s+(?:un)?signed|
504 (?:(?:un)?signed\s+)?int
505)};
506
Alex Dowad485ff232015-06-25 15:02:52 -0700507our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700508our @typeListWithAttr = (
509 @typeList,
510 qr{struct\s+$InitAttribute\s+$Ident},
511 qr{union\s+$InitAttribute\s+$Ident},
512);
513
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700514our @modifierList = (
515 qr{fastcall},
516);
Alex Dowad485ff232015-06-25 15:02:52 -0700517our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800518
Joe Perches24358802014-04-03 14:49:13 -0700519our @mode_permission_funcs = (
520 ["module_param", 3],
521 ["module_param_(?:array|named|string)", 4],
522 ["module_param_array_named", 5],
523 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
524 ["proc_create(?:_data|)", 2],
525 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
526);
527
Joe Perches515a2352014-04-03 14:49:24 -0700528#Create a search pattern for all these functions to speed up a loop below
529our $mode_perms_search = "";
530foreach my $entry (@mode_permission_funcs) {
531 $mode_perms_search .= '|' if ($mode_perms_search ne "");
532 $mode_perms_search .= $entry->[0];
533}
534
Joe Perchesb392c642015-04-16 12:44:16 -0700535our $mode_perms_world_writable = qr{
536 S_IWUGO |
537 S_IWOTH |
538 S_IRWXUGO |
539 S_IALLUGO |
540 0[0-7][0-7][2367]
541}x;
542
Wolfram Sang7840a942010-08-09 17:20:57 -0700543our $allowed_asm_includes = qr{(?x:
544 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700545 memory|
546 time|
547 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700548)};
549# memory.h: ARM has a custom one
550
Kees Cook66b47b42014-10-13 15:51:57 -0700551# Load common spelling mistakes and build regular expression list.
552my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700553my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700554
Joe Perches36061e32014-12-10 15:51:43 -0800555if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800556 while (<$spelling>) {
557 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700558
Joe Perches36061e32014-12-10 15:51:43 -0800559 $line =~ s/\s*\n?$//g;
560 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700561
Joe Perches36061e32014-12-10 15:51:43 -0800562 next if ($line =~ m/^\s*#/);
563 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700564
Joe Perches36061e32014-12-10 15:51:43 -0800565 my ($suspect, $fix) = split(/\|\|/, $line);
566
Joe Perches36061e32014-12-10 15:51:43 -0800567 $spelling_fix{$suspect} = $fix;
568 }
569 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800570} else {
571 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700572}
Kees Cook66b47b42014-10-13 15:51:57 -0700573
Joe Perchesebfd7d62015-04-16 12:44:14 -0700574if ($codespell) {
575 if (open(my $spelling, '<', $codespellfile)) {
576 while (<$spelling>) {
577 my $line = $_;
578
579 $line =~ s/\s*\n?$//g;
580 $line =~ s/^\s*//g;
581
582 next if ($line =~ m/^\s*#/);
583 next if ($line =~ m/^\s*$/);
584 next if ($line =~ m/, disabled/i);
585
586 $line =~ s/,.*$//;
587
588 my ($suspect, $fix) = split(/->/, $line);
589
590 $spelling_fix{$suspect} = $fix;
591 }
592 close($spelling);
593 } else {
594 warn "No codespell typos will be found - file '$codespellfile': $!\n";
595 }
596}
597
598$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
599
Andy Whitcroft8905a672007-11-28 16:21:06 -0800600sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700601 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
602 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700603 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700604 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700605 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700606 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700607 (?:$typeTypedefs\b)|
608 (?:${all}\b)
609 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800610 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700611 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800612 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800613 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700614 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700615 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800616 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700617 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800618 }x;
Joe Perches18130872014-08-06 16:11:22 -0700619 $NonptrTypeMisordered = qr{
620 (?:$Modifier\s+|const\s+)*
621 (?:
622 (?:${Misordered}\b)
623 )
624 (?:\s+$Modifier|\s+const)*
625 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700626 $NonptrTypeWithAttr = qr{
627 (?:$Modifier\s+|const\s+)*
628 (?:
629 (?:typeof|__typeof__)\s*\([^\)]*\)|
630 (?:$typeTypedefs\b)|
631 (?:${allWithAttr}\b)
632 )
633 (?:\s+$Modifier|\s+const)*
634 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800635 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700636 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700637 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700638 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800639 }x;
Joe Perches18130872014-08-06 16:11:22 -0700640 $TypeMisordered = qr{
641 $NonptrTypeMisordered
642 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
643 (?:\s+$Inline|\s+$Modifier)*
644 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700645 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700646 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800647}
648build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700649
Joe Perches7d2367a2011-07-25 17:13:22 -0700650our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700651
652# Using $balanced_parens, $LvalOrFunc, or $FuncArg
653# requires at least perl version v5.10.0
654# Any use must be runtime checked with $^V
655
656our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700657our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800658our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700659
Joe Perchesf8422302014-08-06 16:11:31 -0700660our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700661 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700662 (?:$Storage\s+)?LIST_HEAD\s*\(|
663 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
664)};
665
Joe Perches7d2367a2011-07-25 17:13:22 -0700666sub deparenthesize {
667 my ($string) = @_;
668 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700669
670 while ($string =~ /^\s*\(.*\)\s*$/) {
671 $string =~ s@^\s*\(\s*@@;
672 $string =~ s@\s*\)\s*$@@;
673 }
674
Joe Perches7d2367a2011-07-25 17:13:22 -0700675 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700676
Joe Perches7d2367a2011-07-25 17:13:22 -0700677 return $string;
678}
679
Joe Perches34456862013-07-03 15:05:34 -0700680sub seed_camelcase_file {
681 my ($file) = @_;
682
683 return if (!(-f $file));
684
685 local $/;
686
687 open(my $include_file, '<', "$file")
688 or warn "$P: Can't read '$file' $!\n";
689 my $text = <$include_file>;
690 close($include_file);
691
692 my @lines = split('\n', $text);
693
694 foreach my $line (@lines) {
695 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
696 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
697 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800698 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
699 $camelcase{$1} = 1;
700 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700701 $camelcase{$1} = 1;
702 }
703 }
704}
705
706my $camelcase_seeded = 0;
707sub seed_camelcase_includes {
708 return if ($camelcase_seeded);
709
710 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700711 my $camelcase_cache = "";
712 my @include_files = ();
713
714 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700715
Richard Genoud3645e322014-02-10 14:25:32 -0800716 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700717 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
718 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700719 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700720 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700721 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700722 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700723 @include_files = split('\n', $files);
724 foreach my $file (@include_files) {
725 my $date = POSIX::strftime("%Y%m%d%H%M",
726 localtime((stat $file)[9]));
727 $last_mod_date = $date if ($last_mod_date < $date);
728 }
729 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700730 }
Joe Perchesc707a812013-07-08 16:00:43 -0700731
732 if ($camelcase_cache ne "" && -f $camelcase_cache) {
733 open(my $camelcase_file, '<', "$camelcase_cache")
734 or warn "$P: Can't read '$camelcase_cache' $!\n";
735 while (<$camelcase_file>) {
736 chomp;
737 $camelcase{$_} = 1;
738 }
739 close($camelcase_file);
740
741 return;
742 }
743
Richard Genoud3645e322014-02-10 14:25:32 -0800744 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700745 $files = `git ls-files "include/*.h"`;
746 @include_files = split('\n', $files);
747 }
748
Joe Perches34456862013-07-03 15:05:34 -0700749 foreach my $file (@include_files) {
750 seed_camelcase_file($file);
751 }
Joe Perches351b2a12013-07-03 15:05:36 -0700752
Joe Perchesc707a812013-07-08 16:00:43 -0700753 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700754 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700755 open(my $camelcase_file, '>', "$camelcase_cache")
756 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700757 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
758 print $camelcase_file ("$_\n");
759 }
760 close($camelcase_file);
761 }
Joe Perches34456862013-07-03 15:05:34 -0700762}
763
Joe Perchesd311cd42014-08-06 16:10:57 -0700764sub git_commit_info {
765 my ($commit, $id, $desc) = @_;
766
767 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
768
769 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
770 $output =~ s/^\s*//gm;
771 my @lines = split("\n", $output);
772
Joe Perches0d7835f2015-02-13 14:38:35 -0800773 return ($id, $desc) if ($#lines < 0);
774
Joe Perchesd311cd42014-08-06 16:10:57 -0700775 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
776# Maybe one day convert this block of bash into something that returns
777# all matching commit ids, but it's very slow...
778#
779# echo "checking commits $1..."
780# git rev-list --remotes | grep -i "^$1" |
781# while read line ; do
782# git log --format='%H %s' -1 $line |
783# echo "commit $(cut -c 1-12,41-)"
784# done
785 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
786 } else {
787 $id = substr($lines[0], 0, 12);
788 $desc = substr($lines[0], 41);
789 }
790
791 return ($id, $desc);
792}
793
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700794$chk_signoff = 0 if ($file);
795
Andy Whitcroft00df3442007-06-08 13:47:06 -0700796my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800797my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700798my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700799my @fixed_inserted = ();
800my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700801my $fixlinenr = -1;
802
Du, Changbin4a593c32016-05-20 17:04:16 -0700803# If input is git commits, extract all commits from the commit expressions.
804# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
805die "$P: No git repository found\n" if ($git && !-e ".git");
806
807if ($git) {
808 my @commits = ();
809 for my $commit_expr (@ARGV) {
810 my $git_range;
811 if ($commit_expr =~ m/-/) {
812 my @tmp = split(/-/, $commit_expr);
813 die "$P: incorrect git commits expression $commit_expr$!\n"
814 if (@tmp != 2);
815 $git_range = "-$tmp[1] $tmp[0]";
816 } elsif ($commit_expr =~ m/\.\./) {
817 $git_range = "$commit_expr";
818 }
819 if (defined $git_range) {
820 my $lines = `git log --no-merges --pretty=format:'%H' $git_range`;
821 foreach my $line (split(/\n/, $lines)) {
822 unshift(@commits, $line);
823 }
824 } else {
825 unshift(@commits, $commit_expr);
826 }
827 }
828 die "$P: no git commits after extraction!\n" if (@commits == 0);
829 @ARGV = @commits;
830}
831
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800832my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700833for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800834 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700835 if ($git) {
836 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
837 die "$P: $filename: git format-patch failed - $!\n";
838 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800839 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700840 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800841 } elsif ($filename eq '-') {
842 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700843 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800844 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700845 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700846 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800847 if ($filename eq '-') {
848 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700849 } elsif ($git) {
850 $vname = "Commit " . substr($filename, 0, 12) . `git log -1 --pretty=format:' ("%s")' $filename`;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800851 } else {
852 $vname = $filename;
853 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800854 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700855 chomp;
856 push(@rawlines, $_);
857 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800858 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700859
860 if ($#ARGV > 0 && $quiet == 0) {
861 print '-' x length($vname) . "\n";
862 print "$vname\n";
863 print '-' x length($vname) . "\n";
864 }
865
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800866 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700867 $exit = 1;
868 }
869 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800870 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700871 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700872 @fixed_inserted = ();
873 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700874 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700875 @modifierListFile = ();
876 @typeListFile = ();
877 build_types();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700878}
879
Joe Perchesd8469f12015-06-25 15:03:00 -0700880if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700881 hash_show_words(\%use_type, "Used");
882 hash_show_words(\%ignore_type, "Ignored");
883
Joe Perchesd8469f12015-06-25 15:03:00 -0700884 if ($^V lt 5.10.0) {
885 print << "EOM"
886
887NOTE: perl $^V is not modern enough to detect all possible issues.
888 An upgrade to at least perl v5.10.0 is suggested.
889EOM
890 }
891 if ($exit) {
892 print << "EOM"
893
894NOTE: If any of the errors are false positives, please report
895 them to the maintainer, see CHECKPATCH in MAINTAINERS.
896EOM
897 }
898}
899
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700900exit($exit);
901
902sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700903 my ($root) = @_;
904
905 my @tree_check = (
906 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
907 "README", "Documentation", "arch", "include", "drivers",
908 "fs", "init", "ipc", "kernel", "lib", "scripts",
909 );
910
911 foreach my $check (@tree_check) {
912 if (! -e $root . '/' . $check) {
913 return 0;
914 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700915 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700916 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700917}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700918
Joe Perches20112472011-07-25 17:13:23 -0700919sub parse_email {
920 my ($formatted_email) = @_;
921
922 my $name = "";
923 my $address = "";
924 my $comment = "";
925
926 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
927 $name = $1;
928 $address = $2;
929 $comment = $3 if defined $3;
930 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
931 $address = $1;
932 $comment = $2 if defined $2;
933 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
934 $address = $1;
935 $comment = $2 if defined $2;
936 $formatted_email =~ s/$address.*$//;
937 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700938 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700939 $name =~ s/^\"|\"$//g;
940 # If there's a name left after stripping spaces and
941 # leading quotes, and the address doesn't have both
942 # leading and trailing angle brackets, the address
943 # is invalid. ie:
944 # "joe smith joe@smith.com" bad
945 # "joe smith <joe@smith.com" bad
946 if ($name ne "" && $address !~ /^<[^>]+>$/) {
947 $name = "";
948 $address = "";
949 $comment = "";
950 }
951 }
952
Joe Perches3705ce52013-07-03 15:05:31 -0700953 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700954 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700955 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700956 $address =~ s/^\<|\>$//g;
957
958 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
959 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
960 $name = "\"$name\"";
961 }
962
963 return ($name, $address, $comment);
964}
965
966sub format_email {
967 my ($name, $address) = @_;
968
969 my $formatted_email;
970
Joe Perches3705ce52013-07-03 15:05:31 -0700971 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700972 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700973 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700974
975 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
976 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
977 $name = "\"$name\"";
978 }
979
980 if ("$name" eq "") {
981 $formatted_email = "$address";
982 } else {
983 $formatted_email = "$name <$address>";
984 }
985
986 return $formatted_email;
987}
988
Joe Perchesd311cd42014-08-06 16:10:57 -0700989sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700990 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700991
Joe Perchesbd474ca2014-08-06 16:11:10 -0700992 foreach my $path (split(/:/, $ENV{PATH})) {
993 if (-e "$path/$bin") {
994 return "$path/$bin";
995 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700996 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700997
Joe Perchesbd474ca2014-08-06 16:11:10 -0700998 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -0700999}
1000
Joe Perches000d1cc12011-07-25 17:13:25 -07001001sub which_conf {
1002 my ($conf) = @_;
1003
1004 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1005 if (-e "$path/$conf") {
1006 return "$path/$conf";
1007 }
1008 }
1009
1010 return "";
1011}
1012
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001013sub expand_tabs {
1014 my ($str) = @_;
1015
1016 my $res = '';
1017 my $n = 0;
1018 for my $c (split(//, $str)) {
1019 if ($c eq "\t") {
1020 $res .= ' ';
1021 $n++;
1022 for (; ($n % 8) != 0; $n++) {
1023 $res .= ' ';
1024 }
1025 next;
1026 }
1027 $res .= $c;
1028 $n++;
1029 }
1030
1031 return $res;
1032}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001033sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001034 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001035 return $res;
1036}
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001037
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001038sub line_stats {
1039 my ($line) = @_;
1040
1041 # Drop the diff line leader and expand tabs
1042 $line =~ s/^.//;
1043 $line = expand_tabs($line);
1044
1045 # Pick the indent from the front of the line.
1046 my ($white) = ($line =~ /^(\s*)/);
1047
1048 return (length($line), length($white));
1049}
1050
Andy Whitcroft773647a2008-03-28 14:15:58 -07001051my $sanitise_quote = '';
1052
1053sub sanitise_line_reset {
1054 my ($in_comment) = @_;
1055
1056 if ($in_comment) {
1057 $sanitise_quote = '*/';
1058 } else {
1059 $sanitise_quote = '';
1060 }
1061}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001062sub sanitise_line {
1063 my ($line) = @_;
1064
1065 my $res = '';
1066 my $l = '';
1067
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001068 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001069 my $off = 0;
1070 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001071
Andy Whitcroft773647a2008-03-28 14:15:58 -07001072 # Always copy over the diff marker.
1073 $res = substr($line, 0, 1);
1074
1075 for ($off = 1; $off < length($line); $off++) {
1076 $c = substr($line, $off, 1);
1077
1078 # Comments we are wacking completly including the begin
1079 # and end, all to $;.
1080 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1081 $sanitise_quote = '*/';
1082
1083 substr($res, $off, 2, "$;$;");
1084 $off++;
1085 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001086 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001087 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001088 $sanitise_quote = '';
1089 substr($res, $off, 2, "$;$;");
1090 $off++;
1091 next;
1092 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001093 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1094 $sanitise_quote = '//';
1095
1096 substr($res, $off, 2, $sanitise_quote);
1097 $off++;
1098 next;
1099 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001100
1101 # A \ in a string means ignore the next character.
1102 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1103 $c eq "\\") {
1104 substr($res, $off, 2, 'XX');
1105 $off++;
1106 next;
1107 }
1108 # Regular quotes.
1109 if ($c eq "'" || $c eq '"') {
1110 if ($sanitise_quote eq '') {
1111 $sanitise_quote = $c;
1112
1113 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001114 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001115 } elsif ($sanitise_quote eq $c) {
1116 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001117 }
1118 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001119
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001120 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001121 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1122 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001123 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1124 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001125 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1126 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001127 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001128 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001129 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001130 }
1131
Daniel Walker113f04a2009-09-21 17:04:35 -07001132 if ($sanitise_quote eq '//') {
1133 $sanitise_quote = '';
1134 }
1135
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001136 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001137 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001138 my $clean = 'X' x length($1);
1139 $res =~ s@\<.*\>@<$clean>@;
1140
1141 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001142 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001143 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001144 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001145 }
1146
Andy Whitcroft00df3442007-06-08 13:47:06 -07001147 return $res;
1148}
1149
Joe Perchesa6962d72013-04-29 16:18:13 -07001150sub get_quoted_string {
1151 my ($line, $rawline) = @_;
1152
Joe Perches33acb542015-06-25 15:02:54 -07001153 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001154 return substr($rawline, $-[0], $+[0] - $-[0]);
1155}
1156
Andy Whitcroft8905a672007-11-28 16:21:06 -08001157sub ctx_statement_block {
1158 my ($linenr, $remain, $off) = @_;
1159 my $line = $linenr - 1;
1160 my $blk = '';
1161 my $soff = $off;
1162 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001163 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001164
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001165 my $loff = 0;
1166
Andy Whitcroft8905a672007-11-28 16:21:06 -08001167 my $type = '';
1168 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001169 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001170 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001171 my $c;
1172 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001173
1174 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001175 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001176 @stack = (['', 0]) if ($#stack == -1);
1177
Andy Whitcroft773647a2008-03-28 14:15:58 -07001178 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001179 # If we are about to drop off the end, pull in more
1180 # context.
1181 if ($off >= $len) {
1182 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001183 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001184 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001185 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001186 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001187 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001188 $len = length($blk);
1189 $line++;
1190 last;
1191 }
1192 # Bail if there is no further context.
1193 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001194 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001195 last;
1196 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001197 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1198 $level++;
1199 $type = '#';
1200 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001201 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001202 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001203 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001204 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001205
Andy Whitcroft773647a2008-03-28 14:15:58 -07001206 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001207
1208 # Handle nested #if/#else.
1209 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1210 push(@stack, [ $type, $level ]);
1211 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1212 ($type, $level) = @{$stack[$#stack - 1]};
1213 } elsif ($remainder =~ /^#\s*endif\b/) {
1214 ($type, $level) = @{pop(@stack)};
1215 }
1216
Andy Whitcroft8905a672007-11-28 16:21:06 -08001217 # Statement ends at the ';' or a close '}' at the
1218 # outermost level.
1219 if ($level == 0 && $c eq ';') {
1220 last;
1221 }
1222
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001223 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001224 if ($level == 0 && $coff_set == 0 &&
1225 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1226 $remainder =~ /^(else)(?:\s|{)/ &&
1227 $remainder !~ /^else\s+if\b/) {
1228 $coff = $off + length($1) - 1;
1229 $coff_set = 1;
1230 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1231 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001232 }
1233
Andy Whitcroft8905a672007-11-28 16:21:06 -08001234 if (($type eq '' || $type eq '(') && $c eq '(') {
1235 $level++;
1236 $type = '(';
1237 }
1238 if ($type eq '(' && $c eq ')') {
1239 $level--;
1240 $type = ($level != 0)? '(' : '';
1241
1242 if ($level == 0 && $coff < $soff) {
1243 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001244 $coff_set = 1;
1245 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001246 }
1247 }
1248 if (($type eq '' || $type eq '{') && $c eq '{') {
1249 $level++;
1250 $type = '{';
1251 }
1252 if ($type eq '{' && $c eq '}') {
1253 $level--;
1254 $type = ($level != 0)? '{' : '';
1255
1256 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001257 if (substr($blk, $off + 1, 1) eq ';') {
1258 $off++;
1259 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001260 last;
1261 }
1262 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001263 # Preprocessor commands end at the newline unless escaped.
1264 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1265 $level--;
1266 $type = '';
1267 $off++;
1268 last;
1269 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001270 $off++;
1271 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001272 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001273 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001274 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001275 $line++;
1276 $remain--;
1277 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001278
1279 my $statement = substr($blk, $soff, $off - $soff + 1);
1280 my $condition = substr($blk, $soff, $coff - $soff + 1);
1281
1282 #warn "STATEMENT<$statement>\n";
1283 #warn "CONDITION<$condition>\n";
1284
Andy Whitcroft773647a2008-03-28 14:15:58 -07001285 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001286
1287 return ($statement, $condition,
1288 $line, $remain + 1, $off - $loff + 1, $level);
1289}
1290
Andy Whitcroftcf655042008-03-04 14:28:20 -08001291sub statement_lines {
1292 my ($stmt) = @_;
1293
1294 # Strip the diff line prefixes and rip blank lines at start and end.
1295 $stmt =~ s/(^|\n)./$1/g;
1296 $stmt =~ s/^\s*//;
1297 $stmt =~ s/\s*$//;
1298
1299 my @stmt_lines = ($stmt =~ /\n/g);
1300
1301 return $#stmt_lines + 2;
1302}
1303
1304sub statement_rawlines {
1305 my ($stmt) = @_;
1306
1307 my @stmt_lines = ($stmt =~ /\n/g);
1308
1309 return $#stmt_lines + 2;
1310}
1311
1312sub statement_block_size {
1313 my ($stmt) = @_;
1314
1315 $stmt =~ s/(^|\n)./$1/g;
1316 $stmt =~ s/^\s*{//;
1317 $stmt =~ s/}\s*$//;
1318 $stmt =~ s/^\s*//;
1319 $stmt =~ s/\s*$//;
1320
1321 my @stmt_lines = ($stmt =~ /\n/g);
1322 my @stmt_statements = ($stmt =~ /;/g);
1323
1324 my $stmt_lines = $#stmt_lines + 2;
1325 my $stmt_statements = $#stmt_statements + 1;
1326
1327 if ($stmt_lines > $stmt_statements) {
1328 return $stmt_lines;
1329 } else {
1330 return $stmt_statements;
1331 }
1332}
1333
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001334sub ctx_statement_full {
1335 my ($linenr, $remain, $off) = @_;
1336 my ($statement, $condition, $level);
1337
1338 my (@chunks);
1339
Andy Whitcroftcf655042008-03-04 14:28:20 -08001340 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001341 ($statement, $condition, $linenr, $remain, $off, $level) =
1342 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001343 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001344 push(@chunks, [ $condition, $statement ]);
1345 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1346 return ($level, $linenr, @chunks);
1347 }
1348
1349 # Pull in the following conditional/block pairs and see if they
1350 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001351 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001352 ($statement, $condition, $linenr, $remain, $off, $level) =
1353 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001354 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001355 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001356 #print "C: push\n";
1357 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001358 }
1359
1360 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001361}
1362
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001363sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001364 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001365 my $line;
1366 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001367 my $blk = '';
1368 my @o;
1369 my @c;
1370 my @res = ();
1371
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001372 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001373 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001374 for ($line = $start; $remain > 0; $line++) {
1375 next if ($rawlines[$line] =~ /^-/);
1376 $remain--;
1377
1378 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001379
1380 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001381 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001382 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001383 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001384 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001385 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001386 $level = pop(@stack);
1387 }
1388
Andy Whitcroft01464f32010-10-26 14:23:19 -07001389 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001390 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1391 if ($off > 0) {
1392 $off--;
1393 next;
1394 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001395
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001396 if ($c eq $close && $level > 0) {
1397 $level--;
1398 last if ($level == 0);
1399 } elsif ($c eq $open) {
1400 $level++;
1401 }
1402 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001403
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001404 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001405 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001406 }
1407
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001408 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001409 }
1410
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001411 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001412}
1413sub ctx_block_outer {
1414 my ($linenr, $remain) = @_;
1415
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001416 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1417 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001418}
1419sub ctx_block {
1420 my ($linenr, $remain) = @_;
1421
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001422 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1423 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001424}
1425sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001426 my ($linenr, $remain, $off) = @_;
1427
1428 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1429 return @r;
1430}
1431sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001432 my ($linenr, $remain) = @_;
1433
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001434 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001435}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001436sub ctx_statement_level {
1437 my ($linenr, $remain, $off) = @_;
1438
1439 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1440}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001441
1442sub ctx_locate_comment {
1443 my ($first_line, $end_line) = @_;
1444
1445 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001446 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001447 return $current_comment if (defined $current_comment);
1448
1449 # Look through the context and try and figure out if there is a
1450 # comment.
1451 my $in_comment = 0;
1452 $current_comment = '';
1453 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001454 my $line = $rawlines[$linenr - 1];
1455 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001456 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1457 $in_comment = 1;
1458 }
1459 if ($line =~ m@/\*@) {
1460 $in_comment = 1;
1461 }
1462 if (!$in_comment && $current_comment ne '') {
1463 $current_comment = '';
1464 }
1465 $current_comment .= $line . "\n" if ($in_comment);
1466 if ($line =~ m@\*/@) {
1467 $in_comment = 0;
1468 }
1469 }
1470
1471 chomp($current_comment);
1472 return($current_comment);
1473}
1474sub ctx_has_comment {
1475 my ($first_line, $end_line) = @_;
1476 my $cmt = ctx_locate_comment($first_line, $end_line);
1477
Andy Whitcroft00df3442007-06-08 13:47:06 -07001478 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001479 ##print "CMMT: $cmt\n";
1480
1481 return ($cmt ne '');
1482}
1483
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001484sub raw_line {
1485 my ($linenr, $cnt) = @_;
1486
1487 my $offset = $linenr - 1;
1488 $cnt++;
1489
1490 my $line;
1491 while ($cnt) {
1492 $line = $rawlines[$offset++];
1493 next if (defined($line) && $line =~ /^-/);
1494 $cnt--;
1495 }
1496
1497 return $line;
1498}
1499
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001500sub cat_vet {
1501 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001502 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001503
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001504 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001505 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1506 $res .= $1;
1507 if ($2 ne '') {
1508 $coded = sprintf("^%c", unpack('C', $2) + 64);
1509 $res .= $coded;
1510 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001511 }
1512 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001513
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001514 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001515}
1516
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001517my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001518my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001519my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001520my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001521
1522sub annotate_reset {
1523 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001524 $av_pending = '_';
1525 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001526 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001527}
1528
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001529sub annotate_values {
1530 my ($stream, $type) = @_;
1531
1532 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001533 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001534 my $cur = $stream;
1535
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001536 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001537
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001538 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001539 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001540 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001541 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001542 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001543 print "WS($1)\n" if ($dbg_values > 1);
1544 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001545 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001546 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001547 }
1548
Florian Micklerc023e4732011-01-12 16:59:58 -08001549 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001550 print "CAST($1)\n" if ($dbg_values > 1);
1551 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001552 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001553
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001554 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001555 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001556 $type = 'T';
1557
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001558 } elsif ($cur =~ /^($Modifier)\s*/) {
1559 print "MODIFIER($1)\n" if ($dbg_values > 1);
1560 $type = 'T';
1561
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001562 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001563 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001564 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001565 push(@av_paren_type, $type);
1566 if ($2 ne '') {
1567 $av_pending = 'N';
1568 }
1569 $type = 'E';
1570
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001571 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001572 print "UNDEF($1)\n" if ($dbg_values > 1);
1573 $av_preprocessor = 1;
1574 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001575
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001576 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001577 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001578 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001579
1580 push(@av_paren_type, $type);
1581 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001582 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001583
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001584 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001585 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1586 $av_preprocessor = 1;
1587
1588 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1589
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001590 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001591
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001592 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001593 print "PRE_END($1)\n" if ($dbg_values > 1);
1594
1595 $av_preprocessor = 1;
1596
1597 # Assume all arms of the conditional end as this
1598 # one does, and continue as if the #endif was not here.
1599 pop(@av_paren_type);
1600 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001601 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001602
1603 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001604 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001605
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001606 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1607 print "ATTR($1)\n" if ($dbg_values > 1);
1608 $av_pending = $type;
1609 $type = 'N';
1610
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001611 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001612 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001613 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001614 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001615 }
1616 $type = 'N';
1617
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001618 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001619 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001620 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001621 $type = 'N';
1622
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001623 } elsif ($cur =~/^(case)/o) {
1624 print "CASE($1)\n" if ($dbg_values > 1);
1625 $av_pend_colon = 'C';
1626 $type = 'N';
1627
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001628 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001629 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001630 $type = 'N';
1631
1632 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001633 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001634 push(@av_paren_type, $av_pending);
1635 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001636 $type = 'N';
1637
1638 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001639 my $new_type = pop(@av_paren_type);
1640 if ($new_type ne '_') {
1641 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001642 print "PAREN('$1') -> $type\n"
1643 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001644 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001645 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001646 }
1647
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001648 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001649 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001650 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001651 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001653 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1654 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001655 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001656 } elsif ($type eq 'E') {
1657 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001658 }
1659 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1660 $type = 'V';
1661
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001662 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001663 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001664 $type = 'V';
1665
1666 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001667 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001668 $type = 'N';
1669
Andy Whitcroftcf655042008-03-04 14:28:20 -08001670 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001671 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001672 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001673 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001674
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001675 } elsif ($cur =~/^(,)/) {
1676 print "COMMA($1)\n" if ($dbg_values > 1);
1677 $type = 'C';
1678
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001679 } elsif ($cur =~ /^(\?)/o) {
1680 print "QUESTION($1)\n" if ($dbg_values > 1);
1681 $type = 'N';
1682
1683 } elsif ($cur =~ /^(:)/o) {
1684 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1685
1686 substr($var, length($res), 1, $av_pend_colon);
1687 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1688 $type = 'E';
1689 } else {
1690 $type = 'N';
1691 }
1692 $av_pend_colon = 'O';
1693
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001694 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001695 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001696 $type = 'N';
1697
Andy Whitcroft0d413862008-10-15 22:02:16 -07001698 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001699 my $variant;
1700
1701 print "OPV($1)\n" if ($dbg_values > 1);
1702 if ($type eq 'V') {
1703 $variant = 'B';
1704 } else {
1705 $variant = 'U';
1706 }
1707
1708 substr($var, length($res), 1, $variant);
1709 $type = 'N';
1710
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001711 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001712 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001713 if ($1 ne '++' && $1 ne '--') {
1714 $type = 'N';
1715 }
1716
1717 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001719 }
1720 if (defined $1) {
1721 $cur = substr($cur, length($1));
1722 $res .= $type x length($1);
1723 }
1724 }
1725
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001726 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001727}
1728
Andy Whitcroft8905a672007-11-28 16:21:06 -08001729sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001730 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001731 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001732 ^(?:
1733 $Modifier|
1734 $Storage|
1735 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001736 DEFINE_\S+
1737 )$|
1738 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001739 goto|
1740 return|
1741 case|
1742 else|
1743 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001744 do|
1745 \#|
1746 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001747 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001748 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001749 )}x;
1750 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1751 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001752 # Check for modifiers.
1753 $possible =~ s/\s*$Storage\s*//g;
1754 $possible =~ s/\s*$Sparse\s*//g;
1755 if ($possible =~ /^\s*$/) {
1756
1757 } elsif ($possible =~ /\s/) {
1758 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001759 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001760 if ($modifier !~ $notPermitted) {
1761 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001762 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001763 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001764 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001765
1766 } else {
1767 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001768 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001769 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001770 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001771 } else {
1772 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001773 }
1774}
1775
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001776my $prefix = '';
1777
Joe Perches000d1cc12011-07-25 17:13:25 -07001778sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001779 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001780
Joe Perchescbec18a2014-04-03 14:49:19 -07001781 return defined $use_type{$type} if (scalar keys %use_type > 0);
1782
1783 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001784}
1785
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001786sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001787 my ($level, $type, $msg) = @_;
1788
1789 if (!show_type($type) ||
1790 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001791 return 0;
1792 }
Joe Perches57230292015-06-25 15:03:03 -07001793 my $output = '';
1794 if (-t STDOUT && $color) {
1795 if ($level eq 'ERROR') {
1796 $output .= RED;
1797 } elsif ($level eq 'WARNING') {
1798 $output .= YELLOW;
1799 } else {
1800 $output .= GREEN;
1801 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001802 }
Joe Perches57230292015-06-25 15:03:03 -07001803 $output .= $prefix . $level . ':';
1804 if ($show_types) {
1805 $output .= BLUE if (-t STDOUT && $color);
1806 $output .= "$type:";
1807 }
1808 $output .= RESET if (-t STDOUT && $color);
1809 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001810
1811 if ($showfile) {
1812 my @lines = split("\n", $output, -1);
1813 splice(@lines, 1, 1);
1814 $output = join("\n", @lines);
1815 }
Joe Perches57230292015-06-25 15:03:03 -07001816 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001817
Joe Perches57230292015-06-25 15:03:03 -07001818 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001819
1820 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001821}
Joe Perchescbec18a2014-04-03 14:49:19 -07001822
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001823sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001824 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001825}
Joe Perches000d1cc12011-07-25 17:13:25 -07001826
Joe Perchesd752fcc2014-08-06 16:11:05 -07001827sub fixup_current_range {
1828 my ($lineRef, $offset, $length) = @_;
1829
1830 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1831 my $o = $1;
1832 my $l = $2;
1833 my $no = $o + $offset;
1834 my $nl = $l + $length;
1835 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1836 }
1837}
1838
1839sub fix_inserted_deleted_lines {
1840 my ($linesRef, $insertedRef, $deletedRef) = @_;
1841
1842 my $range_last_linenr = 0;
1843 my $delta_offset = 0;
1844
1845 my $old_linenr = 0;
1846 my $new_linenr = 0;
1847
1848 my $next_insert = 0;
1849 my $next_delete = 0;
1850
1851 my @lines = ();
1852
1853 my $inserted = @{$insertedRef}[$next_insert++];
1854 my $deleted = @{$deletedRef}[$next_delete++];
1855
1856 foreach my $old_line (@{$linesRef}) {
1857 my $save_line = 1;
1858 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001859 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001860 $delta_offset = 0;
1861 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1862 $range_last_linenr = $new_linenr;
1863 fixup_current_range(\$line, $delta_offset, 0);
1864 }
1865
1866 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1867 $deleted = @{$deletedRef}[$next_delete++];
1868 $save_line = 0;
1869 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1870 }
1871
1872 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1873 push(@lines, ${$inserted}{'LINE'});
1874 $inserted = @{$insertedRef}[$next_insert++];
1875 $new_linenr++;
1876 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1877 }
1878
1879 if ($save_line) {
1880 push(@lines, $line);
1881 $new_linenr++;
1882 }
1883
1884 $old_linenr++;
1885 }
1886
1887 return @lines;
1888}
1889
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001890sub fix_insert_line {
1891 my ($linenr, $line) = @_;
1892
1893 my $inserted = {
1894 LINENR => $linenr,
1895 LINE => $line,
1896 };
1897 push(@fixed_inserted, $inserted);
1898}
1899
1900sub fix_delete_line {
1901 my ($linenr, $line) = @_;
1902
1903 my $deleted = {
1904 LINENR => $linenr,
1905 LINE => $line,
1906 };
1907
1908 push(@fixed_deleted, $deleted);
1909}
1910
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001911sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001912 my ($type, $msg) = @_;
1913
1914 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001915 our $clean = 0;
1916 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001917 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001918 }
Joe Perches3705ce52013-07-03 15:05:31 -07001919 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001920}
1921sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001922 my ($type, $msg) = @_;
1923
1924 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001925 our $clean = 0;
1926 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001927 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001928 }
Joe Perches3705ce52013-07-03 15:05:31 -07001929 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001930}
1931sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001932 my ($type, $msg) = @_;
1933
1934 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001935 our $clean = 0;
1936 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001937 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001938 }
Joe Perches3705ce52013-07-03 15:05:31 -07001939 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001940}
1941
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001942sub check_absolute_file {
1943 my ($absolute, $herecurr) = @_;
1944 my $file = $absolute;
1945
1946 ##print "absolute<$absolute>\n";
1947
1948 # See if any suffix of this path is a path within the tree.
1949 while ($file =~ s@^[^/]*/@@) {
1950 if (-f "$root/$file") {
1951 ##print "file<$file>\n";
1952 last;
1953 }
1954 }
1955 if (! -f _) {
1956 return 0;
1957 }
1958
1959 # It is, so see if the prefix is acceptable.
1960 my $prefix = $absolute;
1961 substr($prefix, -length($file)) = '';
1962
1963 ##print "prefix<$prefix>\n";
1964 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001965 WARN("USE_RELATIVE_PATH",
1966 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001967 }
1968}
1969
Joe Perches3705ce52013-07-03 15:05:31 -07001970sub trim {
1971 my ($string) = @_;
1972
Joe Perchesb34c6482013-09-11 14:24:01 -07001973 $string =~ s/^\s+|\s+$//g;
1974
1975 return $string;
1976}
1977
1978sub ltrim {
1979 my ($string) = @_;
1980
1981 $string =~ s/^\s+//;
1982
1983 return $string;
1984}
1985
1986sub rtrim {
1987 my ($string) = @_;
1988
1989 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001990
1991 return $string;
1992}
1993
Joe Perches52ea8502013-11-12 15:10:09 -08001994sub string_find_replace {
1995 my ($string, $find, $replace) = @_;
1996
1997 $string =~ s/$find/$replace/g;
1998
1999 return $string;
2000}
2001
Joe Perches3705ce52013-07-03 15:05:31 -07002002sub tabify {
2003 my ($leading) = @_;
2004
2005 my $source_indent = 8;
2006 my $max_spaces_before_tab = $source_indent - 1;
2007 my $spaces_to_tab = " " x $source_indent;
2008
2009 #convert leading spaces to tabs
2010 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2011 #Remove spaces before a tab
2012 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2013
2014 return "$leading";
2015}
2016
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002017sub pos_last_openparen {
2018 my ($line) = @_;
2019
2020 my $pos = 0;
2021
2022 my $opens = $line =~ tr/\(/\(/;
2023 my $closes = $line =~ tr/\)/\)/;
2024
2025 my $last_openparen = 0;
2026
2027 if (($opens == 0) || ($closes >= $opens)) {
2028 return -1;
2029 }
2030
2031 my $len = length($line);
2032
2033 for ($pos = 0; $pos < $len; $pos++) {
2034 my $string = substr($line, $pos);
2035 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2036 $pos += length($1) - 1;
2037 } elsif (substr($line, $pos, 1) eq '(') {
2038 $last_openparen = $pos;
2039 } elsif (index($string, '(') == -1) {
2040 last;
2041 }
2042 }
2043
Joe Perches91cb5192014-04-03 14:49:32 -07002044 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002045}
2046
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002047sub process {
2048 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002049
2050 my $linenr=0;
2051 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002052 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002053 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002054 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002055
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002056 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002057 my $indent;
2058 my $previndent=0;
2059 my $stashindent=0;
2060
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002061 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002062 my $signoff = 0;
2063 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002064 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002065 my $in_commit_log = 0; #Scanning lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002066 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002067 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002068 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002069 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002070 my $non_utf8_charset = 0;
2071
Joe Perches365dd4e2014-08-06 16:10:42 -07002072 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002073 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002074
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002075 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002076 our $cnt_lines = 0;
2077 our $cnt_error = 0;
2078 our $cnt_warn = 0;
2079 our $cnt_chk = 0;
2080
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002081 # Trace the real file/line as we go.
2082 my $realfile = '';
2083 my $realline = 0;
2084 my $realcnt = 0;
2085 my $here = '';
2086 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002087 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002088 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002089 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002090
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002091 my $prev_values = 'E';
2092
2093 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002094 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002095 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002096 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002097 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002098
Joe Perches7e51f192013-09-11 14:23:57 -07002099 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002100
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002101 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002102 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002103 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002104 my @setup_docs = ();
2105 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002106
Joe Perchesd8b07712013-11-12 15:10:06 -08002107 my $camelcase_file_seeded = 0;
2108
Andy Whitcroft773647a2008-03-28 14:15:58 -07002109 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002110 my $line;
2111 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002112 $linenr++;
2113 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002114
Joe Perches3705ce52013-07-03 15:05:31 -07002115 push(@fixed, $rawline) if ($fix);
2116
Andy Whitcroft773647a2008-03-28 14:15:58 -07002117 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002118 $setup_docs = 0;
2119 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2120 $setup_docs = 1;
2121 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002122 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002123 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002124 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2125 $realline=$1-1;
2126 if (defined $2) {
2127 $realcnt=$3+1;
2128 } else {
2129 $realcnt=1+1;
2130 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002131 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002132
2133 # Guestimate if this is a continuing comment. Run
2134 # the context looking for a comment "edge". If this
2135 # edge is a close comment then we must be in a comment
2136 # at context start.
2137 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002138 my $cnt = $realcnt;
2139 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2140 next if (defined $rawlines[$ln - 1] &&
2141 $rawlines[$ln - 1] =~ /^-/);
2142 $cnt--;
2143 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002144 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002145 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2146 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2147 ($edge) = $1;
2148 last;
2149 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002150 }
2151 if (defined $edge && $edge eq '*/') {
2152 $in_comment = 1;
2153 }
2154
2155 # Guestimate if this is a continuing comment. If this
2156 # is the start of a diff block and this line starts
2157 # ' *' then it is very likely a comment.
2158 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002159 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002160 {
2161 $in_comment = 1;
2162 }
2163
2164 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2165 sanitise_line_reset($in_comment);
2166
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002167 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002168 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002169 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002170 $line = sanitise_line($rawline);
2171 }
2172 push(@lines, $line);
2173
2174 if ($realcnt > 1) {
2175 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2176 } else {
2177 $realcnt = 0;
2178 }
2179
2180 #print "==>$rawline\n";
2181 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002182
2183 if ($setup_docs && $line =~ /^\+/) {
2184 push(@setup_docs, $line);
2185 }
2186 }
2187
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002188 $prefix = '';
2189
Andy Whitcroft773647a2008-03-28 14:15:58 -07002190 $realcnt = 0;
2191 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002192 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002193 foreach my $line (@lines) {
2194 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002195 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002196 my $sline = $line; #copy of $line
2197 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002198
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002199 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002200
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002201#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002202 if (!$in_commit_log &&
2203 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002204 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002205 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002206 $realline=$1-1;
2207 if (defined $2) {
2208 $realcnt=$3+1;
2209 } else {
2210 $realcnt=1+1;
2211 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002212 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002213 $prev_values = 'E';
2214
Andy Whitcroft773647a2008-03-28 14:15:58 -07002215 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002216 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002217 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002218 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002219 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002220
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002221# track the line number as we move through the hunk, note that
2222# new versions of GNU diff omit the leading space on completely
2223# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002224 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002225 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002226 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002227
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002228 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002229 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002230
2231 # Track the previous line.
2232 ($prevline, $stashline) = ($stashline, $line);
2233 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002234 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2235
Andy Whitcroft773647a2008-03-28 14:15:58 -07002236 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002237
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002238 } elsif ($realcnt == 1) {
2239 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002240 }
2241
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002242 my $hunk_line = ($realcnt != 0);
2243
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002244 $here = "#$linenr: " if (!$file);
2245 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002246
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002247 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002248 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002249 if ($line =~ /^diff --git.*?(\S+)$/) {
2250 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002251 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002252 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002253 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002254 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002255 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002256 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002257 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002258
2259 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002260 if (!$file && $tree && $p1_prefix ne '' &&
2261 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002262 WARN("PATCH_PREFIX",
2263 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002264 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002265
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002266 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002267 ERROR("MODIFIED_INCLUDE_ASM",
2268 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
Andy Whitcroft773647a2008-03-28 14:15:58 -07002269 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002270 $found_file = 1;
2271 }
2272
Joe Perches34d88152015-06-25 15:03:05 -07002273#make up the handle for any error we report on this line
2274 if ($showfile) {
2275 $prefix = "$realfile:$realline: "
2276 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002277 if ($file) {
2278 $prefix = "$filename:$realline: ";
2279 } else {
2280 $prefix = "$filename:$linenr: ";
2281 }
Joe Perches34d88152015-06-25 15:03:05 -07002282 }
2283
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002284 if ($found_file) {
Joe Perches7bd7e482015-09-09 15:37:44 -07002285 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002286 $check = 1;
2287 } else {
2288 $check = $check_orig;
2289 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002290 next;
2291 }
2292
Randy Dunlap389834b2007-06-08 13:47:03 -07002293 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002294
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002295 my $hereline = "$here\n$rawline\n";
2296 my $herecurr = "$here\n$rawline\n";
2297 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002298
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002299 $cnt_lines++ if ($realcnt != 0);
2300
Joe Perchese518e9a2015-06-25 15:03:27 -07002301# Check if the commit log has what seems like a diff which can confuse patch
2302 if ($in_commit_log && !$commit_log_has_diff &&
2303 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2304 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2305 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2306 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2307 ERROR("DIFF_IN_COMMIT_MSG",
2308 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2309 $commit_log_has_diff = 1;
2310 }
2311
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002312# Check for incorrect file permissions
2313 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2314 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002315 if ($realfile !~ m@scripts/@ &&
2316 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002317 ERROR("EXECUTE_PERMISSIONS",
2318 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002319 }
2320 }
2321
Joe Perches20112472011-07-25 17:13:23 -07002322# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002323 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002324 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002325 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002326 }
2327
Joe Perchese0d975b2014-12-10 15:51:49 -08002328# Check if MAINTAINERS is being updated. If so, there's probably no need to
2329# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2330 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2331 $reported_maintainer_file = 1;
2332 }
2333
Joe Perches20112472011-07-25 17:13:23 -07002334# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002335 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002336 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002337 my $space_before = $1;
2338 my $sign_off = $2;
2339 my $space_after = $3;
2340 my $email = $4;
2341 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2342
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002343 if ($sign_off !~ /$signature_tags/) {
2344 WARN("BAD_SIGN_OFF",
2345 "Non-standard signature: $sign_off\n" . $herecurr);
2346 }
Joe Perches20112472011-07-25 17:13:23 -07002347 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002348 if (WARN("BAD_SIGN_OFF",
2349 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2350 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002351 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002352 "$ucfirst_sign_off $email";
2353 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002354 }
Joe Perches20112472011-07-25 17:13:23 -07002355 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002356 if (WARN("BAD_SIGN_OFF",
2357 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2358 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002359 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002360 "$ucfirst_sign_off $email";
2361 }
2362
Joe Perches20112472011-07-25 17:13:23 -07002363 }
2364 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002365 if (WARN("BAD_SIGN_OFF",
2366 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2367 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002368 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002369 "$ucfirst_sign_off $email";
2370 }
Joe Perches20112472011-07-25 17:13:23 -07002371 }
2372
2373 my ($email_name, $email_address, $comment) = parse_email($email);
2374 my $suggested_email = format_email(($email_name, $email_address));
2375 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002376 ERROR("BAD_SIGN_OFF",
2377 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002378 } else {
2379 my $dequoted = $suggested_email;
2380 $dequoted =~ s/^"//;
2381 $dequoted =~ s/" </ </;
2382 # Don't force email to have quotes
2383 # Allow just an angle bracketed address
2384 if ("$dequoted$comment" ne $email &&
2385 "<$email_address>$comment" ne $email &&
2386 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002387 WARN("BAD_SIGN_OFF",
2388 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002389 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002390 }
Joe Perches7e51f192013-09-11 14:23:57 -07002391
2392# Check for duplicate signatures
2393 my $sig_nospace = $line;
2394 $sig_nospace =~ s/\s//g;
2395 $sig_nospace = lc($sig_nospace);
2396 if (defined $signatures{$sig_nospace}) {
2397 WARN("BAD_SIGN_OFF",
2398 "Duplicate signature\n" . $herecurr);
2399 } else {
2400 $signatures{$sig_nospace} = 1;
2401 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002402 }
2403
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002404# Check email subject for common tools that don't need to be mentioned
2405 if ($in_header_lines &&
2406 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2407 WARN("EMAIL_SUBJECT",
2408 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2409 }
2410
Joe Perches9b3189e2014-06-04 16:12:10 -07002411# Check for old stable address
2412 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2413 ERROR("STABLE_ADDRESS",
2414 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2415 }
2416
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002417# Check for unwanted Gerrit info
2418 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2419 ERROR("GERRIT_CHANGE_ID",
2420 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2421 }
2422
Joe Perches369c8dd2015-11-06 16:31:34 -08002423# Check if the commit log is in a possible stack dump
2424 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2425 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2426 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2427 # timestamp
2428 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2429 # stack dump address
2430 $commit_log_possible_stack_dump = 1;
2431 }
2432
Joe Perches2a076f42015-04-16 12:44:28 -07002433# Check for line lengths > 75 in commit log, warn once
2434 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002435 length($line) > 75 &&
2436 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2437 # file delta changes
2438 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2439 # filename then :
2440 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2441 # A Fixes: or Link: line
2442 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002443 WARN("COMMIT_LOG_LONG_LINE",
2444 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2445 $commit_log_long_line = 1;
2446 }
2447
Joe Perchesbf4daf12015-09-09 15:37:50 -07002448# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002449 if ($in_commit_log && $commit_log_possible_stack_dump &&
2450 $line =~ /^\s*$/) {
2451 $commit_log_possible_stack_dump = 0;
2452 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002453
Joe Perches0d7835f2015-02-13 14:38:35 -08002454# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002455 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002456 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perches369c8dd2015-11-06 16:31:34 -08002457 ($line =~ /\b[0-9a-f]{12,40}\b/i &&
2458 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2459 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002460 my $init_char = "c";
2461 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002462 my $short = 1;
2463 my $long = 0;
2464 my $case = 1;
2465 my $space = 1;
2466 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002467 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002468 my $id = '0123456789ab';
2469 my $orig_desc = "commit description";
2470 my $description = "";
2471
Joe Perchesfe043ea2015-09-09 15:37:25 -07002472 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2473 $init_char = $1;
2474 $orig_commit = lc($2);
2475 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2476 $orig_commit = lc($1);
2477 }
2478
Joe Perches0d7835f2015-02-13 14:38:35 -08002479 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2480 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2481 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2482 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2483 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2484 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002485 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002486 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2487 defined $rawlines[$linenr] &&
2488 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2489 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002490 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002491 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2492 defined $rawlines[$linenr] &&
2493 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2494 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2495 $orig_desc = $1;
2496 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2497 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002498 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002499 }
2500
2501 ($id, $description) = git_commit_info($orig_commit,
2502 $id, $orig_desc);
2503
Joe Perches19c146a2015-02-13 14:39:00 -08002504 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002505 ERROR("GIT_COMMIT_ID",
2506 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2507 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002508 }
2509
Joe Perches13f19372014-08-06 16:10:59 -07002510# Check for added, moved or deleted files
2511 if (!$reported_maintainer_file && !$in_commit_log &&
2512 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2513 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2514 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2515 (defined($1) || defined($2))))) {
2516 $reported_maintainer_file = 1;
2517 WARN("FILE_PATH_CHANGES",
2518 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2519 }
2520
Andy Whitcroft00df3442007-06-08 13:47:06 -07002521# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002522 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002523 ERROR("CORRUPTED_PATCH",
2524 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002525 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002526 }
2527
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002528# Check for absolute kernel paths.
2529 if ($tree) {
2530 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2531 my $file = $1;
2532
2533 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2534 check_absolute_file($1, $herecurr)) {
2535 #
2536 } else {
2537 check_absolute_file($file, $herecurr);
2538 }
2539 }
2540 }
2541
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002542# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2543 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002544 $rawline !~ m/^$UTF8*$/) {
2545 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2546
2547 my $blank = copy_spacing($rawline);
2548 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2549 my $hereptr = "$hereline$ptr\n";
2550
Joe Perches34d99212011-07-25 17:13:26 -07002551 CHK("INVALID_UTF8",
2552 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002553 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002554
Joe Perches15662b32011-10-31 17:13:12 -07002555# Check if it's the start of a commit log
2556# (not a header line and we haven't seen the patch filename)
2557 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002558 !($rawline =~ /^\s+\S/ ||
2559 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002560 $in_header_lines = 0;
2561 $in_commit_log = 1;
2562 }
2563
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002564# Check if there is UTF-8 in a commit log when a mail header has explicitly
2565# declined it, i.e defined some charset where it is missing.
2566 if ($in_header_lines &&
2567 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2568 $1 !~ /utf-8/i) {
2569 $non_utf8_charset = 1;
2570 }
2571
2572 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002573 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002574 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002575 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2576 }
2577
Kees Cook66b47b42014-10-13 15:51:57 -07002578# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002579 if (defined($misspellings) &&
2580 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002581 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002582 my $typo = $1;
2583 my $typo_fix = $spelling_fix{lc($typo)};
2584 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2585 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2586 my $msg_type = \&WARN;
2587 $msg_type = \&CHK if ($file);
2588 if (&{$msg_type}("TYPO_SPELLING",
2589 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2590 $fix) {
2591 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2592 }
2593 }
2594 }
2595
Andy Whitcroft306708542008-10-15 22:02:28 -07002596# ignore non-hunk lines and lines being removed
2597 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002598
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002599#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002600 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002601 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002602 if (ERROR("DOS_LINE_ENDINGS",
2603 "DOS line endings\n" . $herevet) &&
2604 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002605 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002606 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002607 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2608 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002609 if (ERROR("TRAILING_WHITESPACE",
2610 "trailing whitespace\n" . $herevet) &&
2611 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002612 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002613 }
2614
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002615 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002616 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002617
Josh Triplett4783f892013-11-12 15:10:12 -08002618# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002619 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002620 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2621 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002622 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2623 my $msg_type = \&ERROR;
2624 $msg_type = \&CHK if ($file);
2625 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002626 "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 -08002627 }
2628
Andi Kleen33549572010-05-24 14:33:29 -07002629# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002630# Only applies when adding the entry originally, after that we do not have
2631# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002632 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002633 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002634 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002635 my $cnt = $realcnt;
2636 my $ln = $linenr + 1;
2637 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002638 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002639 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002640 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002641 $f = $lines[$ln - 1];
2642 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2643 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002644
2645 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002646 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002647
Joe Perches8d73e0e2014-08-06 16:10:46 -07002648 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002649 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002650 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002651 $length = -1;
2652 }
2653
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002654 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002655 $f =~ s/#.*//;
2656 $f =~ s/^\s+//;
2657 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002658 if ($f =~ /^\s*config\s/) {
2659 $is_end = 1;
2660 last;
2661 }
Andi Kleen33549572010-05-24 14:33:29 -07002662 $length++;
2663 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002664 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2665 WARN("CONFIG_DESCRIPTION",
2666 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2667 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002668 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002669 }
2670
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002671# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2672 if ($realfile =~ /Kconfig/ &&
2673 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2674 WARN("CONFIG_EXPERIMENTAL",
2675 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2676 }
2677
Christoph Jaeger327953e2015-02-13 14:38:29 -08002678# discourage the use of boolean for type definition attributes of Kconfig options
2679 if ($realfile =~ /Kconfig/ &&
2680 $line =~ /^\+\s*\bboolean\b/) {
2681 WARN("CONFIG_TYPE_BOOLEAN",
2682 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2683 }
2684
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002685 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2686 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2687 my $flag = $1;
2688 my $replacement = {
2689 'EXTRA_AFLAGS' => 'asflags-y',
2690 'EXTRA_CFLAGS' => 'ccflags-y',
2691 'EXTRA_CPPFLAGS' => 'cppflags-y',
2692 'EXTRA_LDFLAGS' => 'ldflags-y',
2693 };
2694
2695 WARN("DEPRECATED_VARIABLE",
2696 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2697 }
2698
Rob Herringbff5da42014-01-23 15:54:51 -08002699# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002700 if (defined $root &&
2701 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2702 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2703
Rob Herringbff5da42014-01-23 15:54:51 -08002704 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2705
Florian Vaussardcc933192014-04-03 14:49:27 -07002706 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2707 my $vp_file = $dt_path . "vendor-prefixes.txt";
2708
Rob Herringbff5da42014-01-23 15:54:51 -08002709 foreach my $compat (@compats) {
2710 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002711 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2712 my $compat3 = $compat;
2713 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2714 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002715 if ( $? >> 8 ) {
2716 WARN("UNDOCUMENTED_DT_STRING",
2717 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2718 }
2719
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002720 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2721 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002722 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002723 if ( $? >> 8 ) {
2724 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002725 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002726 }
2727 }
2728 }
2729
Andy Whitcroft5368df22008-10-15 22:02:27 -07002730# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002731 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002732
Joe Perches47e0c882015-06-25 15:02:57 -07002733# line length limit (with some exclusions)
2734#
2735# There are a few types of lines that may extend beyond $max_line_length:
2736# logging functions like pr_info that end in a string
2737# lines with a single string
2738# #defines that are a single string
2739#
2740# There are 3 different line length message types:
2741# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2742# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2743# LONG_LINE all other lines longer than $max_line_length
2744#
2745# if LONG_LINE is ignored, the other 2 types are also ignored
2746#
2747
Joe Perchesb4749e92015-07-17 16:24:01 -07002748 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002749 my $msg_type = "LONG_LINE";
2750
2751 # Check the allowed long line types first
2752
2753 # logging functions that end in a string that starts
2754 # before $max_line_length
2755 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2756 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2757 $msg_type = "";
2758
2759 # lines with only strings (w/ possible termination)
2760 # #defines with only strings
2761 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2762 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2763 $msg_type = "";
2764
2765 # Otherwise set the alternate message types
2766
2767 # a comment starts before $max_line_length
2768 } elsif ($line =~ /($;[\s$;]*)$/ &&
2769 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2770 $msg_type = "LONG_LINE_COMMENT"
2771
2772 # a quoted string starts before $max_line_length
2773 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2774 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2775 $msg_type = "LONG_LINE_STRING"
2776 }
2777
2778 if ($msg_type ne "" &&
2779 (show_type("LONG_LINE") || show_type($msg_type))) {
2780 WARN($msg_type,
2781 "line over $max_line_length characters\n" . $herecurr);
2782 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002783 }
2784
Andy Whitcroft8905a672007-11-28 16:21:06 -08002785# check for adding lines without a newline.
2786 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002787 WARN("MISSING_EOF_NEWLINE",
2788 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002789 }
2790
Mike Frysinger42e41c52009-09-21 17:04:40 -07002791# Blackfin: use hi/lo macros
2792 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2793 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2794 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002795 ERROR("LO_MACRO",
2796 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002797 }
2798 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2799 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002800 ERROR("HI_MACRO",
2801 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002802 }
2803 }
2804
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002805# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002806 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002807
2808# at the beginning of a line any tabs must come first and anything
2809# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002810 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2811 $rawline =~ /^\+\s* \s*/) {
2812 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002813 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002814 if (ERROR("CODE_INDENT",
2815 "code indent should use tabs where possible\n" . $herevet) &&
2816 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002817 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002818 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002819 }
2820
Alberto Panizzo08e44362010-03-05 13:43:54 -08002821# check for space before tabs.
2822 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2823 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002824 if (WARN("SPACE_BEFORE_TAB",
2825 "please, no space before tabs\n" . $herevet) &&
2826 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002827 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002828 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002829 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002830 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002831 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002832 }
2833
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002834# check for && or || at the start of a line
2835 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2836 CHK("LOGICAL_CONTINUATIONS",
2837 "Logical continuations should be on the previous line\n" . $hereprev);
2838 }
2839
Joe Perchesa91e8992016-05-20 17:04:05 -07002840# check indentation starts on a tab stop
2841 if ($^V && $^V ge 5.10.0 &&
2842 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2843 my $indent = length($1);
2844 if ($indent % 8) {
2845 if (WARN("TABSTOP",
2846 "Statements should start on a tabstop\n" . $herecurr) &&
2847 $fix) {
2848 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2849 }
2850 }
2851 }
2852
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002853# check multi-line statement indentation matches previous line
2854 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002855 $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 -07002856 $prevline =~ /^\+(\t*)(.*)$/;
2857 my $oldindent = $1;
2858 my $rest = $2;
2859
2860 my $pos = pos_last_openparen($rest);
2861 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002862 $line =~ /^(\+| )([ \t]*)/;
2863 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002864
2865 my $goodtabindent = $oldindent .
2866 "\t" x ($pos / 8) .
2867 " " x ($pos % 8);
2868 my $goodspaceindent = $oldindent . " " x $pos;
2869
2870 if ($newindent ne $goodtabindent &&
2871 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002872
2873 if (CHK("PARENTHESIS_ALIGNMENT",
2874 "Alignment should match open parenthesis\n" . $hereprev) &&
2875 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002876 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002877 s/^\+[ \t]*/\+$goodtabindent/;
2878 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002879 }
2880 }
2881 }
2882
Joe Perches6ab3a972015-04-16 12:44:05 -07002883# check for space after cast like "(int) foo" or "(struct foo) bar"
2884# avoid checking a few false positives:
2885# "sizeof(<type>)" or "__alignof__(<type>)"
2886# function pointer declarations like "(*foo)(int) = bar;"
2887# structure definitions like "(struct foo) { 0 };"
2888# multiline macros that define functions
2889# known attributes or the __attribute__ keyword
2890 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2891 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002892 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002893 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002894 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002895 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002896 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002897 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002898 }
2899
Joe Perches86406b12015-09-09 15:37:41 -07002900# Block comment styles
2901# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002902 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002903 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002904 $rawline =~ /^\+[ \t]*\*/ &&
2905 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002906 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2907 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2908 }
2909
Joe Perches86406b12015-09-09 15:37:41 -07002910# Block comments use * on subsequent lines
2911 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2912 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002913 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002914 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002915 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002916 WARN("BLOCK_COMMENT_STYLE",
2917 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002918 }
2919
Joe Perches86406b12015-09-09 15:37:41 -07002920# Block comments use */ on trailing lines
2921 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002922 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2923 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2924 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002925 WARN("BLOCK_COMMENT_STYLE",
2926 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002927 }
2928
Joe Perches7f619192014-08-06 16:10:39 -07002929# check for missing blank lines after struct/union declarations
2930# with exceptions for various attributes and macros
2931 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2932 $line =~ /^\+/ &&
2933 !($line =~ /^\+\s*$/ ||
2934 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2935 $line =~ /^\+\s*MODULE_/i ||
2936 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2937 $line =~ /^\+[a-z_]*init/ ||
2938 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2939 $line =~ /^\+\s*DECLARE/ ||
2940 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002941 if (CHK("LINE_SPACING",
2942 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2943 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002944 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002945 }
Joe Perches7f619192014-08-06 16:10:39 -07002946 }
2947
Joe Perches365dd4e2014-08-06 16:10:42 -07002948# check for multiple consecutive blank lines
2949 if ($prevline =~ /^[\+ ]\s*$/ &&
2950 $line =~ /^\+\s*$/ &&
2951 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002952 if (CHK("LINE_SPACING",
2953 "Please don't use multiple blank lines\n" . $hereprev) &&
2954 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002955 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002956 }
2957
Joe Perches365dd4e2014-08-06 16:10:42 -07002958 $last_blank_line = $linenr;
2959 }
2960
Joe Perches3b617e32014-04-03 14:49:28 -07002961# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002962 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2963 # actual declarations
2964 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002965 # function pointer declarations
2966 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002967 # foo bar; where foo is some local typedef or #define
2968 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2969 # known declaration macros
2970 $prevline =~ /^\+\s+$declaration_macros/) &&
2971 # for "else if" which can look like "$Ident $Ident"
2972 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2973 # other possible extensions of declaration lines
2974 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2975 # not starting a section or a macro "\" extended line
2976 $prevline =~ /(?:\{\s*|\\)$/) &&
2977 # looks like a declaration
2978 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002979 # function pointer declarations
2980 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002981 # foo bar; where foo is some local typedef or #define
2982 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2983 # known declaration macros
2984 $sline =~ /^\+\s+$declaration_macros/ ||
2985 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002986 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002987 # start or end of block or continuation of declaration
2988 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2989 # bitfield continuation
2990 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2991 # other possible extensions of declaration lines
2992 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2993 # indentation of previous and current line are the same
2994 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002995 if (WARN("LINE_SPACING",
2996 "Missing a blank line after declarations\n" . $hereprev) &&
2997 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002998 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002999 }
Joe Perches3b617e32014-04-03 14:49:28 -07003000 }
3001
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003002# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003003# Exceptions:
3004# 1) within comments
3005# 2) indented preprocessor commands
3006# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003007 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003008 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003009 if (WARN("LEADING_SPACE",
3010 "please, no spaces at the start of a line\n" . $herevet) &&
3011 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003012 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003013 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003014 }
3015
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003016# check we are in a valid C source file if not then ignore this hunk
3017 next if ($realfile !~ /\.(h|c)$/);
3018
Joe Perches032a4c02014-08-06 16:10:29 -07003019# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003020# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003021# if the previous line is a break or return and is indented 1 tab more...
3022 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3023 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003024 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3025 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3026 defined $lines[$linenr] &&
3027 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003028 WARN("UNNECESSARY_ELSE",
3029 "else is not generally useful after a break or return\n" . $hereprev);
3030 }
3031 }
3032
Joe Perchesc00df192014-08-06 16:11:01 -07003033# check indentation of a line with a break;
3034# if the previous line is a goto or return and is indented the same # of tabs
3035 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3036 my $tabs = $1;
3037 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3038 WARN("UNNECESSARY_BREAK",
3039 "break is not useful after a goto or return\n" . $hereprev);
3040 }
3041 }
3042
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003043# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3044 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3045 WARN("CONFIG_EXPERIMENTAL",
3046 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3047 }
3048
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003049# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003050 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003051 WARN("CVS_KEYWORD",
3052 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003053 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003054
Mike Frysinger42e41c52009-09-21 17:04:40 -07003055# Blackfin: don't use __builtin_bfin_[cs]sync
3056 if ($line =~ /__builtin_bfin_csync/) {
3057 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003058 ERROR("CSYNC",
3059 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003060 }
3061 if ($line =~ /__builtin_bfin_ssync/) {
3062 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003063 ERROR("SSYNC",
3064 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003065 }
3066
Joe Perches56e77d72013-02-21 16:44:14 -08003067# check for old HOTPLUG __dev<foo> section markings
3068 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3069 WARN("HOTPLUG_SECTION",
3070 "Using $1 is unnecessary\n" . $herecurr);
3071 }
3072
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003073# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003074 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3075 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003076#print "LINE<$line>\n";
3077 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003078 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003079 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003080 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003081 $stat =~ s/\n./\n /g;
3082 $cond =~ s/\n./\n /g;
3083
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003084#print "linenr<$linenr> <$stat>\n";
3085 # If this statement has no statement boundaries within
3086 # it there is no point in retrying a statement scan
3087 # until we hit end of it.
3088 my $frag = $stat; $frag =~ s/;+\s*$//;
3089 if ($frag !~ /(?:{|;)/) {
3090#print "skip<$line_nr_next>\n";
3091 $suppress_statement = $line_nr_next;
3092 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003093
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003094 # Find the real next line.
3095 $realline_next = $line_nr_next;
3096 if (defined $realline_next &&
3097 (!defined $lines[$realline_next - 1] ||
3098 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3099 $realline_next++;
3100 }
3101
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003102 my $s = $stat;
3103 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003104
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003105 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003106 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003107
3108 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003109 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003110
Andy Whitcroft463f2862009-09-21 17:04:34 -07003111 } elsif ($s =~ /^.\s*else\b/s) {
3112
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003113 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003114 } 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 -07003115 my $type = $1;
3116 $type =~ s/\s+/ /g;
3117 possible($type, "A:" . $s);
3118
Andy Whitcroft8905a672007-11-28 16:21:06 -08003119 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003120 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003121 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003122 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003123
3124 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003125 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003126 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003127 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003128
3129 # Check for any sort of function declaration.
3130 # int foo(something bar, other baz);
3131 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003132 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 -08003133 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003134
Andy Whitcroftcf655042008-03-04 14:28:20 -08003135 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003136 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003137 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003138
Andy Whitcroft8905a672007-11-28 16:21:06 -08003139 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003140 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003141
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003142 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003143 }
3144 }
3145 }
3146
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003147 }
3148
Andy Whitcroft653d4872007-06-23 17:16:34 -07003149#
3150# Checks which may be anchored in the context.
3151#
3152
3153# Check for switch () and associated case and default
3154# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003155 if ($line=~/\bswitch\s*\(.*\)/) {
3156 my $err = '';
3157 my $sep = '';
3158 my @ctx = ctx_block_outer($linenr, $realcnt);
3159 shift(@ctx);
3160 for my $ctx (@ctx) {
3161 my ($clen, $cindent) = line_stats($ctx);
3162 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3163 $indent != $cindent) {
3164 $err .= "$sep$ctx\n";
3165 $sep = '';
3166 } else {
3167 $sep = "[...]\n";
3168 }
3169 }
3170 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003171 ERROR("SWITCH_CASE_INDENT_LEVEL",
3172 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003173 }
3174 }
3175
3176# if/while/etc brace do not go on next line, unless defining a do while loop,
3177# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003178 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 -07003179 my $pre_ctx = "$1$2";
3180
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003181 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003182
3183 if ($line =~ /^\+\t{6,}/) {
3184 WARN("DEEP_INDENTATION",
3185 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3186 }
3187
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003188 my $ctx_cnt = $realcnt - $#ctx - 1;
3189 my $ctx = join("\n", @ctx);
3190
Andy Whitcroft548596d2008-07-23 21:29:01 -07003191 my $ctx_ln = $linenr;
3192 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003193
Andy Whitcroft548596d2008-07-23 21:29:01 -07003194 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3195 defined $lines[$ctx_ln - 1] &&
3196 $lines[$ctx_ln - 1] =~ /^-/)) {
3197 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3198 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003199 $ctx_ln++;
3200 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003201
Andy Whitcroft53210162008-07-23 21:29:03 -07003202 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3203 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003204
Joe Perchesd752fcc2014-08-06 16:11:05 -07003205 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003206 ERROR("OPEN_BRACE",
3207 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003208 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003209 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003210 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3211 $ctx =~ /\)\s*\;\s*$/ &&
3212 defined $lines[$ctx_ln - 1])
3213 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003214 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3215 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003216 WARN("TRAILING_SEMICOLON",
3217 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003218 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003219 }
3220 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003221 }
3222
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003223# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003224 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 -08003225 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3226 ctx_statement_block($linenr, $realcnt, 0)
3227 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003228 my ($s, $c) = ($stat, $cond);
3229
3230 substr($s, 0, length($c), '');
3231
Joe Perches9f5af482015-09-09 15:37:30 -07003232 # remove inline comments
3233 $s =~ s/$;/ /g;
3234 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003235
3236 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003237 my @newlines = ($c =~ /\n/gs);
3238 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003239
Joe Perches9f5af482015-09-09 15:37:30 -07003240 # Make sure we remove the line prefixes as we have
3241 # none on the first line, and are going to readd them
3242 # where necessary.
3243 $s =~ s/\n./\n/gs;
3244 while ($s =~ /\n\s+\\\n/) {
3245 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3246 }
3247
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003248 # We want to check the first line inside the block
3249 # starting at the end of the conditional, so remove:
3250 # 1) any blank line termination
3251 # 2) any opening brace { on end of the line
3252 # 3) any do (...) {
3253 my $continuation = 0;
3254 my $check = 0;
3255 $s =~ s/^.*\bdo\b//;
3256 $s =~ s/^\s*{//;
3257 if ($s =~ s/^\s*\\//) {
3258 $continuation = 1;
3259 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003260 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003261 $check = 1;
3262 $cond_lines++;
3263 }
3264
3265 # Also ignore a loop construct at the end of a
3266 # preprocessor statement.
3267 if (($prevline =~ /^.\s*#\s*define\s/ ||
3268 $prevline =~ /\\\s*$/) && $continuation == 0) {
3269 $check = 0;
3270 }
3271
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003272 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003273 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003274 while ($cond_ptr != $cond_lines) {
3275 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003276
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003277 # If we see an #else/#elif then the code
3278 # is not linear.
3279 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3280 $check = 0;
3281 }
3282
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003283 # Ignore:
3284 # 1) blank lines, they should be at 0,
3285 # 2) preprocessor lines, and
3286 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003287 if ($continuation ||
3288 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003289 $s =~ /^\s*#\s*?/ ||
3290 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003291 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003292 if ($s =~ s/^.*?\n//) {
3293 $cond_lines++;
3294 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003295 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003296 }
3297
3298 my (undef, $sindent) = line_stats("+" . $s);
3299 my $stat_real = raw_line($linenr, $cond_lines);
3300
3301 # Check if either of these lines are modified, else
3302 # this is not this patch's fault.
3303 if (!defined($stat_real) ||
3304 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3305 $check = 0;
3306 }
3307 if (defined($stat_real) && $cond_lines > 1) {
3308 $stat_real = "[...]\n$stat_real";
3309 }
3310
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003311 #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 -07003312
Joe Perches9f5af482015-09-09 15:37:30 -07003313 if ($check && $s ne '' &&
3314 (($sindent % 8) != 0 ||
3315 ($sindent < $indent) ||
3316 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003317 WARN("SUSPECT_CODE_INDENT",
3318 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003319 }
3320 }
3321
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003322 # Track the 'values' across context and added lines.
3323 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003324 my ($curr_values, $curr_vars) =
3325 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003326 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003327 if ($dbg_values) {
3328 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003329 print "$linenr > .$outline\n";
3330 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003331 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003332 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003333 $prev_values = substr($curr_values, -1);
3334
Andy Whitcroft00df3442007-06-08 13:47:06 -07003335#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003336 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003337
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003338# check for declarations of signed or unsigned without int
Joe Perches207a8e82016-03-15 14:58:06 -07003339 while ($line =~ m{($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003340 my $type = $1;
3341 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003342 $var = "" if (!defined $var);
3343 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003344 my $sign = $1;
3345 my $pointer = $2;
3346
3347 $pointer = "" if (!defined $pointer);
3348
3349 if (WARN("UNSPECIFIED_INT",
3350 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3351 $fix) {
3352 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003353 my $comp_pointer = $pointer;
3354 $comp_pointer =~ s/\s//g;
3355 $decl .= $comp_pointer;
3356 $decl = rtrim($decl) if ($var eq "");
3357 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003358 }
3359 }
3360 }
3361
Andy Whitcroft653d4872007-06-23 17:16:34 -07003362# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003363 if ($dbg_type) {
3364 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003365 ERROR("TEST_TYPE",
3366 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003367 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003368 ERROR("TEST_NOT_TYPE",
3369 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003370 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003371 next;
3372 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003373# TEST: allow direct testing of the attribute matcher.
3374 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003375 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003376 ERROR("TEST_ATTR",
3377 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003378 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003379 ERROR("TEST_NOT_ATTR",
3380 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003381 }
3382 next;
3383 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003384
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003385# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003386 if ($line =~ /^.\s*{/ &&
3387 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003388 if (ERROR("OPEN_BRACE",
3389 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003390 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3391 fix_delete_line($fixlinenr - 1, $prevrawline);
3392 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003393 my $fixedline = $prevrawline;
3394 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003395 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003396 $fixedline = $line;
3397 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003398 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003399 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003400 }
3401
Andy Whitcroft653d4872007-06-23 17:16:34 -07003402#
3403# Checks which are anchored on the added line.
3404#
3405
3406# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003407 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003408 my $path = $1;
3409 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003410 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003411 "malformed #include filename\n" . $herecurr);
3412 }
3413 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3414 ERROR("UAPI_INCLUDE",
3415 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003416 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003417 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003418
3419# no C99 // comments
3420 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003421 if (ERROR("C99_COMMENTS",
3422 "do not use C99 // comments\n" . $herecurr) &&
3423 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003424 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003425 if ($line =~ /\/\/(.*)$/) {
3426 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003427 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003428 }
3429 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003430 }
3431 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003432 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003433 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003434
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003435# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3436# the whole statement.
3437#print "APW <$lines[$realline_next - 1]>\n";
3438 if (defined $realline_next &&
3439 exists $lines[$realline_next - 1] &&
3440 !defined $suppress_export{$realline_next} &&
3441 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3442 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003443 # Handle definitions which produce identifiers with
3444 # a prefix:
3445 # XXX(foo);
3446 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003447 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003448 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003449 $name =~ /^${Ident}_$2/) {
3450#print "FOO C name<$name>\n";
3451 $suppress_export{$realline_next} = 1;
3452
3453 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003454 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003455 ^.DEFINE_$Ident\(\Q$name\E\)|
3456 ^.DECLARE_$Ident\(\Q$name\E\)|
3457 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003458 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3459 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003460 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003461#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3462 $suppress_export{$realline_next} = 2;
3463 } else {
3464 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003465 }
3466 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003467 if (!defined $suppress_export{$linenr} &&
3468 $prevline =~ /^.\s*$/ &&
3469 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3470 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3471#print "FOO B <$lines[$linenr - 1]>\n";
3472 $suppress_export{$linenr} = 2;
3473 }
3474 if (defined $suppress_export{$linenr} &&
3475 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003476 WARN("EXPORT_SYMBOL",
3477 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003478 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003479
Joe Eloff5150bda2010-08-09 17:21:00 -07003480# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003481 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003482 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003483 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003484 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003485 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003486 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003487 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003488# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003489 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003490 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003491 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003492 $herecurr) &&
3493 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003494 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003495 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003496 }
3497
Joe Perches18130872014-08-06 16:11:22 -07003498# check for misordered declarations of char/short/int/long with signed/unsigned
3499 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3500 my $tmp = trim($1);
3501 WARN("MISORDERED_TYPE",
3502 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3503 }
3504
Joe Perchescb710ec2010-10-26 14:23:20 -07003505# check for static const char * arrays.
3506 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003507 WARN("STATIC_CONST_CHAR_ARRAY",
3508 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003509 $herecurr);
3510 }
3511
3512# check for static char foo[] = "bar" declarations.
3513 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003514 WARN("STATIC_CONST_CHAR_ARRAY",
3515 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003516 $herecurr);
3517 }
3518
Joe Perchesab7e23f2015-04-16 12:44:22 -07003519# check for const <foo> const where <foo> is not a pointer or array type
3520 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3521 my $found = $1;
3522 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3523 WARN("CONST_CONST",
3524 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3525 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3526 WARN("CONST_CONST",
3527 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3528 }
3529 }
3530
Joe Perches9b0fa602014-04-03 14:49:18 -07003531# check for non-global char *foo[] = {"bar", ...} declarations.
3532 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3533 WARN("STATIC_CONST_CHAR_ARRAY",
3534 "char * array declaration might be better as static const\n" .
3535 $herecurr);
3536 }
3537
Joe Perchesb598b672015-04-16 12:44:36 -07003538# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3539 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3540 my $array = $1;
3541 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3542 my $array_div = $1;
3543 if (WARN("ARRAY_SIZE",
3544 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3545 $fix) {
3546 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3547 }
3548 }
3549 }
3550
Joe Perchesb36190c2014-01-27 17:07:18 -08003551# check for function declarations without arguments like "int foo()"
3552 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3553 if (ERROR("FUNCTION_WITHOUT_ARGS",
3554 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3555 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003556 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003557 }
3558 }
3559
Joe Perches92e112f2013-12-13 11:36:22 -07003560# check for uses of DEFINE_PCI_DEVICE_TABLE
3561 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3562 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3563 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3564 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003565 $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 -07003566 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003567 }
3568
Andy Whitcroft653d4872007-06-23 17:16:34 -07003569# check for new typedefs, only function parameters and sparse annotations
3570# make sense.
3571 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003572 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003573 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003574 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003575 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003576 WARN("NEW_TYPEDEFS",
3577 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003578 }
3579
3580# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003581 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003582 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3583 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003584 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003585
Andy Whitcroft65863862009-01-06 14:41:21 -08003586 # Should start with a space.
3587 $to =~ s/^(\S)/ $1/;
3588 # Should not end with a space.
3589 $to =~ s/\s+$//;
3590 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003591 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003592 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003593
Joe Perches3705ce52013-07-03 15:05:31 -07003594## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003595 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003596 if (ERROR("POINTER_LOCATION",
3597 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3598 $fix) {
3599 my $sub_from = $ident;
3600 my $sub_to = $ident;
3601 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003602 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003603 s@\Q$sub_from\E@$sub_to@;
3604 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003605 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003606 }
3607 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3608 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003609 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003610
Andy Whitcroft65863862009-01-06 14:41:21 -08003611 # Should start with a space.
3612 $to =~ s/^(\S)/ $1/;
3613 # Should not end with a space.
3614 $to =~ s/\s+$//;
3615 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003616 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003617 }
3618 # Modifiers should have spaces.
3619 $to =~ s/(\b$Modifier$)/$1 /;
3620
Joe Perches3705ce52013-07-03 15:05:31 -07003621## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003622 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003623 if (ERROR("POINTER_LOCATION",
3624 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3625 $fix) {
3626
3627 my $sub_from = $match;
3628 my $sub_to = $match;
3629 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003630 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003631 s@\Q$sub_from\E@$sub_to@;
3632 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003633 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003634 }
3635
Joe Perches9d3e3c72015-09-09 15:37:27 -07003636# avoid BUG() or BUG_ON()
3637 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3638 my $msg_type = \&WARN;
3639 $msg_type = \&CHK if ($file);
3640 &{$msg_type}("AVOID_BUG",
3641 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3642 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003643
Joe Perches9d3e3c72015-09-09 15:37:27 -07003644# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003645 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003646 WARN("LINUX_VERSION_CODE",
3647 "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 -08003648 }
3649
Joe Perches17441222011-06-15 15:08:17 -07003650# check for uses of printk_ratelimit
3651 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003652 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003653 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003654 }
3655
Andy Whitcroft00df3442007-06-08 13:47:06 -07003656# printk should use KERN_* levels. Note that follow on printk's on the
3657# same line do not need a level, so we use the current block context
3658# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003659# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003660# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003661 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003662 my $ok = 0;
3663 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3664 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003665 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003666 # with "\n" ignore it, else it is to blame
3667 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3668 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3669 $ok = 1;
3670 }
3671 last;
3672 }
3673 }
3674 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003675 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3676 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003677 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003678 }
3679
Joe Perches243f3802012-05-31 16:26:09 -07003680 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3681 my $orig = $1;
3682 my $level = lc($orig);
3683 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003684 my $level2 = $level;
3685 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003686 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003687 "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 -07003688 }
3689
3690 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003691 if (WARN("PREFER_PR_LEVEL",
3692 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3693 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003694 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003695 s/\bpr_warning\b/pr_warn/;
3696 }
Joe Perches243f3802012-05-31 16:26:09 -07003697 }
3698
Joe Perchesdc139312013-02-21 16:44:13 -08003699 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3700 my $orig = $1;
3701 my $level = lc($orig);
3702 $level = "warn" if ($level eq "warning");
3703 $level = "dbg" if ($level eq "debug");
3704 WARN("PREFER_DEV_LEVEL",
3705 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3706 }
3707
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003708# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3709# number of false positives, but assembly files are not checked, so at
3710# least the arch entry code will not trigger this warning.
3711 if ($line =~ /\bENOSYS\b/) {
3712 WARN("ENOSYS",
3713 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3714 }
3715
Andy Whitcroft653d4872007-06-23 17:16:34 -07003716# function brace can't be on same line, except for #defines of do while,
3717# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003718 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003719 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003720 if (ERROR("OPEN_BRACE",
3721 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3722 $fix) {
3723 fix_delete_line($fixlinenr, $rawline);
3724 my $fixed_line = $rawline;
3725 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3726 my $line1 = $1;
3727 my $line2 = $2;
3728 fix_insert_line($fixlinenr, ltrim($line1));
3729 fix_insert_line($fixlinenr, "\+{");
3730 if ($line2 !~ /^\s*$/) {
3731 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3732 }
3733 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003734 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003735
Andy Whitcroft8905a672007-11-28 16:21:06 -08003736# open braces for enum, union and struct go on the same line.
3737 if ($line =~ /^.\s*{/ &&
3738 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003739 if (ERROR("OPEN_BRACE",
3740 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3741 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3742 fix_delete_line($fixlinenr - 1, $prevrawline);
3743 fix_delete_line($fixlinenr, $rawline);
3744 my $fixedline = rtrim($prevrawline) . " {";
3745 fix_insert_line($fixlinenr, $fixedline);
3746 $fixedline = $rawline;
3747 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3748 if ($fixedline !~ /^\+\s*$/) {
3749 fix_insert_line($fixlinenr, $fixedline);
3750 }
3751 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003752 }
3753
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003754# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003755 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3756 if (WARN("SPACING",
3757 "missing space after $1 definition\n" . $herecurr) &&
3758 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003759 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003760 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3761 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003762 }
3763
Joe Perches31070b52014-01-23 15:54:49 -08003764# Function pointer declarations
3765# check spacing between type, funcptr, and args
3766# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003767 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003768 my $declare = $1;
3769 my $pre_pointer_space = $2;
3770 my $post_pointer_space = $3;
3771 my $funcname = $4;
3772 my $post_funcname_space = $5;
3773 my $pre_args_space = $6;
3774
Joe Perches91f72e92014-04-03 14:49:12 -07003775# the $Declare variable will capture all spaces after the type
3776# so check it for a missing trailing missing space but pointer return types
3777# don't need a space so don't warn for those.
3778 my $post_declare_space = "";
3779 if ($declare =~ /(\s+)$/) {
3780 $post_declare_space = $1;
3781 $declare = rtrim($declare);
3782 }
3783 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003784 WARN("SPACING",
3785 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003786 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003787 }
3788
3789# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003790# This test is not currently implemented because these declarations are
3791# equivalent to
3792# int foo(int bar, ...)
3793# and this is form shouldn't/doesn't generate a checkpatch warning.
3794#
3795# elsif ($declare =~ /\s{2,}$/) {
3796# WARN("SPACING",
3797# "Multiple spaces after return type\n" . $herecurr);
3798# }
Joe Perches31070b52014-01-23 15:54:49 -08003799
3800# unnecessary space "type ( *funcptr)(args...)"
3801 if (defined $pre_pointer_space &&
3802 $pre_pointer_space =~ /^\s/) {
3803 WARN("SPACING",
3804 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3805 }
3806
3807# unnecessary space "type (* funcptr)(args...)"
3808 if (defined $post_pointer_space &&
3809 $post_pointer_space =~ /^\s/) {
3810 WARN("SPACING",
3811 "Unnecessary space before function pointer name\n" . $herecurr);
3812 }
3813
3814# unnecessary space "type (*funcptr )(args...)"
3815 if (defined $post_funcname_space &&
3816 $post_funcname_space =~ /^\s/) {
3817 WARN("SPACING",
3818 "Unnecessary space after function pointer name\n" . $herecurr);
3819 }
3820
3821# unnecessary space "type (*funcptr) (args...)"
3822 if (defined $pre_args_space &&
3823 $pre_args_space =~ /^\s/) {
3824 WARN("SPACING",
3825 "Unnecessary space before function pointer arguments\n" . $herecurr);
3826 }
3827
3828 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003829 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003830 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003831 }
3832 }
3833
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003834# check for spacing round square brackets; allowed:
3835# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003836# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3837# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003838 while ($line =~ /(.*?\s)\[/g) {
3839 my ($where, $prefix) = ($-[1], $1);
3840 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003841 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003842 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003843 if (ERROR("BRACKET_SPACE",
3844 "space prohibited before open square bracket '['\n" . $herecurr) &&
3845 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003846 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003847 s/^(\+.*?)\s+\[/$1\[/;
3848 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003849 }
3850 }
3851
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003852# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003853 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003854 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003855 my $ctx_before = substr($line, 0, $-[1]);
3856 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003857
3858 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003859 if ($name =~ /^(?:
3860 if|for|while|switch|return|case|
3861 volatile|__volatile__|
3862 __attribute__|format|__extension__|
3863 asm|__asm__)$/x)
3864 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003865 # cpp #define statements have non-optional spaces, ie
3866 # if there is a space between the name and the open
3867 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003868 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003869
3870 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003871 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003872
3873 # If this whole things ends with a type its most
3874 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003875 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003876
3877 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003878 if (WARN("SPACING",
3879 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3880 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003881 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003882 s/\b$name\s+\(/$name\(/;
3883 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003884 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003885 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003886
Andy Whitcroft653d4872007-06-23 17:16:34 -07003887# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003888 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003889 my $fixed_line = "";
3890 my $line_fixed = 0;
3891
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003892 my $ops = qr{
3893 <<=|>>=|<=|>=|==|!=|
3894 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3895 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003896 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003897 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003898 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003899 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003900
3901## print("element count: <" . $#elements . ">\n");
3902## foreach my $el (@elements) {
3903## print("el: <$el>\n");
3904## }
3905
3906 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003907 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003908
Joe Perches3705ce52013-07-03 15:05:31 -07003909 foreach my $el (@elements) {
3910 push(@fix_elements, substr($rawline, $off, length($el)));
3911 $off += length($el);
3912 }
3913
3914 $off = 0;
3915
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003916 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003917 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003918
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003919 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003920
3921 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3922
3923## print("n: <$n> good: <$good>\n");
3924
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003925 $off += length($elements[$n]);
3926
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003927 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003928 my $ca = substr($opline, 0, $off);
3929 my $cc = '';
3930 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3931 $cc = substr($opline, $off + length($elements[$n + 1]));
3932 }
3933 my $cb = "$ca$;$cc";
3934
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003935 my $a = '';
3936 $a = 'V' if ($elements[$n] ne '');
3937 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003938 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003939 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3940 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003941 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003942
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003943 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003944
3945 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003946 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003947 $c = 'V' if ($elements[$n + 2] ne '');
3948 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003949 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003950 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3951 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003952 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003953 } else {
3954 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003955 }
3956
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003957 my $ctx = "${a}x${c}";
3958
3959 my $at = "(ctx:$ctx)";
3960
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003961 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003962 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003963
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003964 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003965 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003966
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003967 # Get the full operator variant.
3968 my $opv = $op . substr($curr_vars, $off, 1);
3969
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003970 # Ignore operators passed as parameters.
3971 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003972 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003973
Andy Whitcroftcf655042008-03-04 14:28:20 -08003974# # Ignore comments
3975# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003976
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003977 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003978 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003979 if ($ctx !~ /.x[WEBC]/ &&
3980 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003981 if (ERROR("SPACING",
3982 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003983 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003984 $line_fixed = 1;
3985 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003986 }
3987
3988 # // is a comment
3989 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003990
Joe Perchesb00e4812014-04-03 14:49:33 -07003991 # : when part of a bitfield
3992 } elsif ($opv eq ':B') {
3993 # skip the bitfield test for now
3994
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003995 # No spaces for:
3996 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003997 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003998 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003999 if (ERROR("SPACING",
4000 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004001 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004002 if (defined $fix_elements[$n + 2]) {
4003 $fix_elements[$n + 2] =~ s/^\s+//;
4004 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004005 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004006 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004007 }
4008
Joe Perches23810972014-12-10 15:51:32 -08004009 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004010 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004011 my $rtrim_before = 0;
4012 my $space_after = 0;
4013 if ($ctx =~ /Wx./) {
4014 if (ERROR("SPACING",
4015 "space prohibited before that '$op' $at\n" . $hereptr)) {
4016 $line_fixed = 1;
4017 $rtrim_before = 1;
4018 }
4019 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004020 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004021 if (ERROR("SPACING",
4022 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004023 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004024 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004025 $space_after = 1;
4026 }
4027 }
4028 if ($rtrim_before || $space_after) {
4029 if ($rtrim_before) {
4030 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4031 } else {
4032 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4033 }
4034 if ($space_after) {
4035 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004036 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004037 }
4038
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004039 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004040 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004041 #warn "'*' is part of type\n";
4042
4043 # unary operators should have a space before and
4044 # none after. May be left adjacent to another
4045 # unary operator, or a cast
4046 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004047 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004048 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004049 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004050 if (ERROR("SPACING",
4051 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004052 if ($n != $last_after + 2) {
4053 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4054 $line_fixed = 1;
4055 }
Joe Perches3705ce52013-07-03 15:05:31 -07004056 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004057 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004058 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004059 # A unary '*' may be const
4060
4061 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004062 if (ERROR("SPACING",
4063 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004064 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004065 if (defined $fix_elements[$n + 2]) {
4066 $fix_elements[$n + 2] =~ s/^\s+//;
4067 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004068 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004069 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004070 }
4071
4072 # unary ++ and unary -- are allowed no space on one side.
4073 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004074 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004075 if (ERROR("SPACING",
4076 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004077 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004078 $line_fixed = 1;
4079 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004080 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004081 if ($ctx =~ /Wx[BE]/ ||
4082 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004083 if (ERROR("SPACING",
4084 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004085 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004086 $line_fixed = 1;
4087 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004088 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004089 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004090 if (ERROR("SPACING",
4091 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004092 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004093 if (defined $fix_elements[$n + 2]) {
4094 $fix_elements[$n + 2] =~ s/^\s+//;
4095 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004096 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004097 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004098 }
4099
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004100 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004101 } elsif ($op eq '<<' or $op eq '>>' or
4102 $op eq '&' or $op eq '^' or $op eq '|' or
4103 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004104 $op eq '*' or $op eq '/' or
4105 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004106 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004107 if ($check) {
4108 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4109 if (CHK("SPACING",
4110 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4111 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4112 $fix_elements[$n + 2] =~ s/^\s+//;
4113 $line_fixed = 1;
4114 }
4115 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4116 if (CHK("SPACING",
4117 "space preferred before that '$op' $at\n" . $hereptr)) {
4118 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4119 $line_fixed = 1;
4120 }
4121 }
4122 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004123 if (ERROR("SPACING",
4124 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004125 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4126 if (defined $fix_elements[$n + 2]) {
4127 $fix_elements[$n + 2] =~ s/^\s+//;
4128 }
Joe Perches3705ce52013-07-03 15:05:31 -07004129 $line_fixed = 1;
4130 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004131 }
4132
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004133 # A colon needs no spaces before when it is
4134 # terminating a case value or a label.
4135 } elsif ($opv eq ':C' || $opv eq ':L') {
4136 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004137 if (ERROR("SPACING",
4138 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004139 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004140 $line_fixed = 1;
4141 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004142 }
4143
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004144 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004145 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004146 my $ok = 0;
4147
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004148 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004149 if (($op eq '<' &&
4150 $cc =~ /^\S+\@\S+>/) ||
4151 ($op eq '>' &&
4152 $ca =~ /<\S+\@\S+$/))
4153 {
4154 $ok = 1;
4155 }
4156
Joe Perchese0df7e12015-04-16 12:44:53 -07004157 # for asm volatile statements
4158 # ignore a colon with another
4159 # colon immediately before or after
4160 if (($op eq ':') &&
4161 ($ca =~ /:$/ || $cc =~ /^:/)) {
4162 $ok = 1;
4163 }
4164
Joe Perches84731622013-11-12 15:10:05 -08004165 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004166 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004167 my $msg_type = \&ERROR;
4168 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4169
4170 if (&{$msg_type}("SPACING",
4171 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004172 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4173 if (defined $fix_elements[$n + 2]) {
4174 $fix_elements[$n + 2] =~ s/^\s+//;
4175 }
Joe Perches3705ce52013-07-03 15:05:31 -07004176 $line_fixed = 1;
4177 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004178 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004179 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004180 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004181
4182## print("n: <$n> GOOD: <$good>\n");
4183
4184 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004185 }
Joe Perches3705ce52013-07-03 15:05:31 -07004186
4187 if (($#elements % 2) == 0) {
4188 $fixed_line = $fixed_line . $fix_elements[$#elements];
4189 }
4190
Joe Perches194f66f2014-08-06 16:11:03 -07004191 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4192 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004193 }
4194
4195
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004196 }
4197
Joe Perches786b6322013-07-03 15:05:32 -07004198# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004199 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004200 if (WARN("SPACING",
4201 "space prohibited before semicolon\n" . $herecurr) &&
4202 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004203 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004204 s/^(\+.*\S)\s+;/$1;/;
4205 }
4206 }
4207
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004208# check for multiple assignments
4209 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004210 CHK("MULTIPLE_ASSIGNMENTS",
4211 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004212 }
4213
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004214## # check for multiple declarations, allowing for a function declaration
4215## # continuation.
4216## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4217## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4218##
4219## # Remove any bracketed sections to ensure we do not
4220## # falsly report the parameters of functions.
4221## my $ln = $line;
4222## while ($ln =~ s/\([^\(\)]*\)//g) {
4223## }
4224## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004225## WARN("MULTIPLE_DECLARATION",
4226## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004227## }
4228## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004229
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004230#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004231 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004232 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004233 if (ERROR("SPACING",
4234 "space required before the open brace '{'\n" . $herecurr) &&
4235 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004236 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004237 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004238 }
4239
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004240## # check for blank lines before declarations
4241## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4242## $prevrawline =~ /^.\s*$/) {
4243## WARN("SPACING",
4244## "No blank lines before declarations\n" . $hereprev);
4245## }
4246##
4247
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004248# closing brace should have a space following it when it has anything
4249# on the line
4250 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004251 if (ERROR("SPACING",
4252 "space required after that close brace '}'\n" . $herecurr) &&
4253 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004254 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004255 s/}((?!(?:,|;|\)))\S)/} $1/;
4256 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004257 }
4258
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004259# check spacing on square brackets
4260 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004261 if (ERROR("SPACING",
4262 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4263 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004264 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004265 s/\[\s+/\[/;
4266 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004267 }
4268 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004269 if (ERROR("SPACING",
4270 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4271 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004272 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004273 s/\s+\]/\]/;
4274 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004275 }
4276
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004277# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004278 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4279 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004280 if (ERROR("SPACING",
4281 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4282 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004283 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004284 s/\(\s+/\(/;
4285 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004286 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004287 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004288 $line !~ /for\s*\(.*;\s+\)/ &&
4289 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004290 if (ERROR("SPACING",
4291 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4292 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004293 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004294 s/\s+\)/\)/;
4295 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004296 }
4297
Joe Perchese2826fd2014-08-06 16:10:48 -07004298# check unnecessary parentheses around addressof/dereference single $Lvals
4299# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4300
4301 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004302 my $var = $1;
4303 if (CHK("UNNECESSARY_PARENTHESES",
4304 "Unnecessary parentheses around $var\n" . $herecurr) &&
4305 $fix) {
4306 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4307 }
4308 }
4309
4310# check for unnecessary parentheses around function pointer uses
4311# ie: (foo->bar)(); should be foo->bar();
4312# but not "if (foo->bar) (" to avoid some false positives
4313 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4314 my $var = $2;
4315 if (CHK("UNNECESSARY_PARENTHESES",
4316 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4317 $fix) {
4318 my $var2 = deparenthesize($var);
4319 $var2 =~ s/\s//g;
4320 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4321 }
4322 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004323
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004324#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004325 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004326 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004327 if (WARN("INDENTED_LABEL",
4328 "labels should not be indented\n" . $herecurr) &&
4329 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004330 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004331 s/^(.)\s+/$1/;
4332 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004333 }
4334
Joe Perches5b9553a2014-04-03 14:49:21 -07004335# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004336 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004337 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004338 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004339 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4340 my $value = $1;
4341 $value = deparenthesize($value);
4342 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4343 ERROR("RETURN_PARENTHESES",
4344 "return is not a function, parentheses are not required\n" . $herecurr);
4345 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004346 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004347 ERROR("SPACING",
4348 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004349 }
4350 }
Joe Perches507e5142013-11-12 15:10:13 -08004351
Joe Perchesb43ae212014-06-23 13:22:07 -07004352# unnecessary return in a void function
4353# at end-of-function, with the previous line a single leading tab, then return;
4354# and the line before that not a goto label target like "out:"
4355 if ($sline =~ /^[ \+]}\s*$/ &&
4356 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4357 $linenr >= 3 &&
4358 $lines[$linenr - 3] =~ /^[ +]/ &&
4359 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004360 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004361 "void function return statements are not generally useful\n" . $hereprev);
4362 }
Joe Perches9819cf22014-06-04 16:12:09 -07004363
Joe Perches189248d2014-01-23 15:54:47 -08004364# if statements using unnecessary parentheses - ie: if ((foo == bar))
4365 if ($^V && $^V ge 5.10.0 &&
4366 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4367 my $openparens = $1;
4368 my $count = $openparens =~ tr@\(@\(@;
4369 my $msg = "";
4370 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4371 my $comp = $4; #Not $1 because of $LvalOrFunc
4372 $msg = " - maybe == should be = ?" if ($comp eq "==");
4373 WARN("UNNECESSARY_PARENTHESES",
4374 "Unnecessary parentheses$msg\n" . $herecurr);
4375 }
4376 }
4377
Joe Perchesc5595fa2015-09-09 15:37:58 -07004378# comparisons with a constant or upper case identifier on the left
4379# avoid cases like "foo + BAR < baz"
4380# only fix matches surrounded by parentheses to avoid incorrect
4381# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4382 if ($^V && $^V ge 5.10.0 &&
4383 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4384 my $lead = $1;
4385 my $const = $2;
4386 my $comp = $3;
4387 my $to = $4;
4388 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004389 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004390 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4391 WARN("CONSTANT_COMPARISON",
4392 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4393 $fix) {
4394 if ($comp eq "<") {
4395 $newcomp = ">";
4396 } elsif ($comp eq "<=") {
4397 $newcomp = ">=";
4398 } elsif ($comp eq ">") {
4399 $newcomp = "<";
4400 } elsif ($comp eq ">=") {
4401 $newcomp = "<=";
4402 }
4403 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4404 }
4405 }
4406
Joe Perchesf34e4a42015-04-16 12:44:19 -07004407# Return of what appears to be an errno should normally be negative
4408 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004409 my $name = $1;
4410 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004411 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004412 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004413 }
4414 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004415
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004416# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004417 if ($line =~ /\b(if|while|for|switch)\(/) {
4418 if (ERROR("SPACING",
4419 "space required before the open parenthesis '('\n" . $herecurr) &&
4420 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004421 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004422 s/\b(if|while|for|switch)\(/$1 \(/;
4423 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004424 }
4425
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004426# Check for illegal assignment in if conditional -- and check for trailing
4427# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004428 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004429 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4430 ctx_statement_block($linenr, $realcnt, 0)
4431 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004432 my ($stat_next) = ctx_statement_block($line_nr_next,
4433 $remain_next, $off_next);
4434 $stat_next =~ s/\n./\n /g;
4435 ##print "stat<$stat> stat_next<$stat_next>\n";
4436
4437 if ($stat_next =~ /^\s*while\b/) {
4438 # If the statement carries leading newlines,
4439 # then count those as offsets.
4440 my ($whitespace) =
4441 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4442 my $offset =
4443 statement_rawlines($whitespace) - 1;
4444
4445 $suppress_whiletrailers{$line_nr_next +
4446 $offset} = 1;
4447 }
4448 }
4449 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004450 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004451 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004452 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004453
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004454 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004455 ERROR("ASSIGN_IN_IF",
4456 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004457 }
4458
4459 # Find out what is on the end of the line after the
4460 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004461 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004462 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004463 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004464 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4465 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004466 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004467 # Find out how long the conditional actually is.
4468 my @newlines = ($c =~ /\n/gs);
4469 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004470 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004471
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004472 $stat_real = raw_line($linenr, $cond_lines)
4473 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004474 if (defined($stat_real) && $cond_lines > 1) {
4475 $stat_real = "[...]\n$stat_real";
4476 }
4477
Joe Perches000d1cc12011-07-25 17:13:25 -07004478 ERROR("TRAILING_STATEMENTS",
4479 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004480 }
4481 }
4482
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004483# Check for bitwise tests written as boolean
4484 if ($line =~ /
4485 (?:
4486 (?:\[|\(|\&\&|\|\|)
4487 \s*0[xX][0-9]+\s*
4488 (?:\&\&|\|\|)
4489 |
4490 (?:\&\&|\|\|)
4491 \s*0[xX][0-9]+\s*
4492 (?:\&\&|\|\||\)|\])
4493 )/x)
4494 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004495 WARN("HEXADECIMAL_BOOLEAN_TEST",
4496 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004497 }
4498
Andy Whitcroft8905a672007-11-28 16:21:06 -08004499# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004500 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4501 my $s = $1;
4502 $s =~ s/$;//g; # Remove any comments
4503 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004504 ERROR("TRAILING_STATEMENTS",
4505 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004506 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004507 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004508# if should not continue a brace
4509 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004510 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004511 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004512 $herecurr);
4513 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004514# case and default should not have general statements after them
4515 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4516 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004517 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004518 \s*return\s+
4519 )/xg)
4520 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004521 ERROR("TRAILING_STATEMENTS",
4522 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004523 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004524
4525 # Check for }<nl>else {, these must be at the same
4526 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004527 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4528 $previndent == $indent) {
4529 if (ERROR("ELSE_AFTER_BRACE",
4530 "else should follow close brace '}'\n" . $hereprev) &&
4531 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4532 fix_delete_line($fixlinenr - 1, $prevrawline);
4533 fix_delete_line($fixlinenr, $rawline);
4534 my $fixedline = $prevrawline;
4535 $fixedline =~ s/}\s*$//;
4536 if ($fixedline !~ /^\+\s*$/) {
4537 fix_insert_line($fixlinenr, $fixedline);
4538 }
4539 $fixedline = $rawline;
4540 $fixedline =~ s/^(.\s*)else/$1} else/;
4541 fix_insert_line($fixlinenr, $fixedline);
4542 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004543 }
4544
Joe Perches8b8856f2014-08-06 16:11:14 -07004545 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4546 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004547 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4548
4549 # Find out what is on the end of the line after the
4550 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004551 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004552 $s =~ s/\n.*//g;
4553
4554 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004555 if (ERROR("WHILE_AFTER_BRACE",
4556 "while should follow close brace '}'\n" . $hereprev) &&
4557 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4558 fix_delete_line($fixlinenr - 1, $prevrawline);
4559 fix_delete_line($fixlinenr, $rawline);
4560 my $fixedline = $prevrawline;
4561 my $trailing = $rawline;
4562 $trailing =~ s/^\+//;
4563 $trailing = trim($trailing);
4564 $fixedline =~ s/}\s*$/} $trailing/;
4565 fix_insert_line($fixlinenr, $fixedline);
4566 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004567 }
4568 }
4569
Joe Perches95e2c602013-07-03 15:05:20 -07004570#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004571 while ($line =~ m{($Constant|$Lval)}g) {
4572 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004573
4574#gcc binary extension
4575 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004576 if (WARN("GCC_BINARY_CONSTANT",
4577 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4578 $fix) {
4579 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004580 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004581 s/\b$var\b/$hexval/;
4582 }
Joe Perches95e2c602013-07-03 15:05:20 -07004583 }
4584
4585#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004586 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004587 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004588#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004589 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004590#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004591 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4592#Ignore some three character SI units explicitly, like MiB and KHz
4593 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004594 while ($var =~ m{($Ident)}g) {
4595 my $word = $1;
4596 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004597 if ($check) {
4598 seed_camelcase_includes();
4599 if (!$file && !$camelcase_file_seeded) {
4600 seed_camelcase_file($realfile);
4601 $camelcase_file_seeded = 1;
4602 }
4603 }
Joe Perches7e781f62013-09-11 14:23:55 -07004604 if (!defined $camelcase{$word}) {
4605 $camelcase{$word} = 1;
4606 CHK("CAMELCASE",
4607 "Avoid CamelCase: <$word>\n" . $herecurr);
4608 }
Joe Perches34456862013-07-03 15:05:34 -07004609 }
Joe Perches323c1262012-12-17 16:02:07 -08004610 }
4611 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004612
4613#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004614 if ($line =~ /\#\s*define.*\\\s+$/) {
4615 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4616 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4617 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004618 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004619 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004620 }
4621
Fabian Frederick0e212e02015-04-16 12:44:25 -07004622# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4623# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004624 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004625 my $file = "$1.h";
4626 my $checkfile = "include/linux/$file";
4627 if (-f "$root/$checkfile" &&
4628 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004629 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004630 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004631 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4632 if ($asminclude > 0) {
4633 if ($realfile =~ m{^arch/}) {
4634 CHK("ARCH_INCLUDE_LINUX",
4635 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4636 } else {
4637 WARN("INCLUDE_LINUX",
4638 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4639 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004640 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004641 }
4642 }
4643
Andy Whitcroft653d4872007-06-23 17:16:34 -07004644# multi-statement macros should be enclosed in a do while loop, grab the
4645# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004646# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004647 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4648 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004649 my $ln = $linenr;
4650 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004651 my ($off, $dstat, $dcond, $rest);
4652 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004653 my $has_flow_statement = 0;
4654 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004655 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004656 ctx_statement_block($linenr, $realcnt, 0);
4657 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004658 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004659 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004660
Joe Perches08a28432014-10-13 15:51:55 -07004661 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004662 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004663
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004664 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004665 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004666 $dstat =~ s/\\\n.//g;
4667 $dstat =~ s/^\s*//s;
4668 $dstat =~ s/\s*$//s;
4669
4670 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004671 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4672 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004673 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004674 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004675 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004676
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004677 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004678 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4679 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004680 {
4681 }
4682
Joe Perches42e15292016-03-15 14:58:01 -07004683 # Make asm volatile uses seem like a generic function
4684 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4685
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004686 my $exceptions = qr{
4687 $Declare|
4688 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004689 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004690 DECLARE_PER_CPU|
4691 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004692 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004693 union|
4694 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004695 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004696 ^\"|\"$|
4697 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004698 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004699 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004700 if ($dstat ne '' &&
4701 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4702 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004703 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004704 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004705 $dstat !~ /$exceptions/ &&
4706 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004707 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004708 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004709 $dstat !~ /^for\s*$Constant$/ && # for (...)
4710 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4711 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004712 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004713 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004714 {
4715 $ctx =~ s/\n*$//;
4716 my $herectx = $here . "\n";
4717 my $cnt = statement_rawlines($ctx);
4718
4719 for (my $n = 0; $n < $cnt; $n++) {
4720 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004721 }
4722
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004723 if ($dstat =~ /;/) {
4724 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4725 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4726 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004727 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004728 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004729 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004730 }
Joe Perches5023d342012-12-17 16:01:47 -08004731
Joe Perches08a28432014-10-13 15:51:55 -07004732# check for macros with flow control, but without ## concatenation
4733# ## concatenation is commonly a macro that defines a function so ignore those
4734 if ($has_flow_statement && !$has_arg_concat) {
4735 my $herectx = $here . "\n";
4736 my $cnt = statement_rawlines($ctx);
4737
4738 for (my $n = 0; $n < $cnt; $n++) {
4739 $herectx .= raw_line($linenr, $n) . "\n";
4740 }
4741 WARN("MACRO_WITH_FLOW_CONTROL",
4742 "Macros with flow control statements should be avoided\n" . "$herectx");
4743 }
4744
Joe Perches481eb482012-12-17 16:01:56 -08004745# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004746
4747 } else {
4748 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004749 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4750 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004751 $line =~ /^\+.*\\$/) {
4752 WARN("LINE_CONTINUATIONS",
4753 "Avoid unnecessary line continuations\n" . $herecurr);
4754 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004755 }
4756
Joe Perchesb13edf72012-07-30 14:41:24 -07004757# do {} while (0) macro tests:
4758# single-statement macros do not need to be enclosed in do while (0) loop,
4759# macro should not end with a semicolon
4760 if ($^V && $^V ge 5.10.0 &&
4761 $realfile !~ m@/vmlinux.lds.h$@ &&
4762 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4763 my $ln = $linenr;
4764 my $cnt = $realcnt;
4765 my ($off, $dstat, $dcond, $rest);
4766 my $ctx = '';
4767 ($dstat, $dcond, $ln, $cnt, $off) =
4768 ctx_statement_block($linenr, $realcnt, 0);
4769 $ctx = $dstat;
4770
4771 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004772 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004773
4774 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4775 my $stmts = $2;
4776 my $semis = $3;
4777
4778 $ctx =~ s/\n*$//;
4779 my $cnt = statement_rawlines($ctx);
4780 my $herectx = $here . "\n";
4781
4782 for (my $n = 0; $n < $cnt; $n++) {
4783 $herectx .= raw_line($linenr, $n) . "\n";
4784 }
4785
Joe Perchesac8e97f2012-08-21 16:15:53 -07004786 if (($stmts =~ tr/;/;/) == 1 &&
4787 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004788 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4789 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4790 }
4791 if (defined $semis && $semis ne "") {
4792 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4793 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4794 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004795 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4796 $ctx =~ s/\n*$//;
4797 my $cnt = statement_rawlines($ctx);
4798 my $herectx = $here . "\n";
4799
4800 for (my $n = 0; $n < $cnt; $n++) {
4801 $herectx .= raw_line($linenr, $n) . "\n";
4802 }
4803
4804 WARN("TRAILING_SEMICOLON",
4805 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004806 }
4807 }
4808
Mike Frysinger080ba922009-01-06 14:41:25 -08004809# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4810# all assignments may have only one of the following with an assignment:
4811# .
4812# ALIGN(...)
4813# VMLINUX_SYMBOL(...)
4814 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004815 WARN("MISSING_VMLINUX_SYMBOL",
4816 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004817 }
4818
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004819# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004820 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4821 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004822 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004823 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004824 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4825 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004826 my @allowed = ();
4827 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004828 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004829 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004830 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004831 for my $chunk (@chunks) {
4832 my ($cond, $block) = @{$chunk};
4833
Andy Whitcroft773647a2008-03-28 14:15:58 -07004834 # If the condition carries leading newlines, then count those as offsets.
4835 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4836 my $offset = statement_rawlines($whitespace) - 1;
4837
Joe Perchesaad4f612012-03-23 15:02:19 -07004838 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004839 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4840
4841 # We have looked at and allowed this specific line.
4842 $suppress_ifbraces{$ln + $offset} = 1;
4843
4844 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004845 $ln += statement_rawlines($block) - 1;
4846
Andy Whitcroft773647a2008-03-28 14:15:58 -07004847 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004848
4849 $seen++ if ($block =~ /^\s*{/);
4850
Joe Perchesaad4f612012-03-23 15:02:19 -07004851 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004852 if (statement_lines($cond) > 1) {
4853 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004854 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004855 }
4856 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004857 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004858 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004859 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004860 if (statement_block_size($block) > 1) {
4861 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004862 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004863 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004864 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004865 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004866 if ($seen) {
4867 my $sum_allowed = 0;
4868 foreach (@allowed) {
4869 $sum_allowed += $_;
4870 }
4871 if ($sum_allowed == 0) {
4872 WARN("BRACES",
4873 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4874 } elsif ($sum_allowed != $allow &&
4875 $seen != $allow) {
4876 CHK("BRACES",
4877 "braces {} should be used on all arms of this statement\n" . $herectx);
4878 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004879 }
4880 }
4881 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004882 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004883 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004884 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004885
Andy Whitcroftcf655042008-03-04 14:28:20 -08004886 # Check the pre-context.
4887 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4888 #print "APW: ALLOWED: pre<$1>\n";
4889 $allowed = 1;
4890 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004891
4892 my ($level, $endln, @chunks) =
4893 ctx_statement_full($linenr, $realcnt, $-[0]);
4894
Andy Whitcroftcf655042008-03-04 14:28:20 -08004895 # Check the condition.
4896 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004897 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004898 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004899 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004900 }
4901 if (statement_lines($cond) > 1) {
4902 #print "APW: ALLOWED: cond<$cond>\n";
4903 $allowed = 1;
4904 }
4905 if ($block =~/\b(?:if|for|while)\b/) {
4906 #print "APW: ALLOWED: block<$block>\n";
4907 $allowed = 1;
4908 }
4909 if (statement_block_size($block) > 1) {
4910 #print "APW: ALLOWED: lines block<$block>\n";
4911 $allowed = 1;
4912 }
4913 # Check the post-context.
4914 if (defined $chunks[1]) {
4915 my ($cond, $block) = @{$chunks[1]};
4916 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004917 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004918 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004919 if ($block =~ /^\s*\{/) {
4920 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4921 $allowed = 1;
4922 }
4923 }
4924 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004925 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004926 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004927
Andy Whitcroftf0556632008-10-15 22:02:23 -07004928 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004929 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004930 }
4931
Joe Perches000d1cc12011-07-25 17:13:25 -07004932 WARN("BRACES",
4933 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004934 }
4935 }
4936
Joe Perches0979ae62012-12-17 16:01:59 -08004937# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004938 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004939 if (CHK("BRACES",
4940 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4941 $fix && $prevrawline =~ /^\+/) {
4942 fix_delete_line($fixlinenr - 1, $prevrawline);
4943 }
Joe Perches0979ae62012-12-17 16:01:59 -08004944 }
Joe Perches77b9a532013-07-03 15:05:29 -07004945 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004946 if (CHK("BRACES",
4947 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4948 $fix) {
4949 fix_delete_line($fixlinenr, $rawline);
4950 }
Joe Perches0979ae62012-12-17 16:01:59 -08004951 }
4952
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004953# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004954 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4955 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004956 WARN("VOLATILE",
4957 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004958 }
4959
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004960# Check for user-visible strings broken across lines, which breaks the ability
4961# to grep for the string. Make exceptions when the previous string ends in a
4962# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4963# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004964 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004965 $prevline =~ /"\s*$/ &&
4966 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4967 if (WARN("SPLIT_STRING",
4968 "quoted string split across lines\n" . $hereprev) &&
4969 $fix &&
4970 $prevrawline =~ /^\+.*"\s*$/ &&
4971 $last_coalesced_string_linenr != $linenr - 1) {
4972 my $extracted_string = get_quoted_string($line, $rawline);
4973 my $comma_close = "";
4974 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4975 $comma_close = $1;
4976 }
4977
4978 fix_delete_line($fixlinenr - 1, $prevrawline);
4979 fix_delete_line($fixlinenr, $rawline);
4980 my $fixedline = $prevrawline;
4981 $fixedline =~ s/"\s*$//;
4982 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
4983 fix_insert_line($fixlinenr - 1, $fixedline);
4984 $fixedline = $rawline;
4985 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
4986 if ($fixedline !~ /\+\s*$/) {
4987 fix_insert_line($fixlinenr, $fixedline);
4988 }
4989 $last_coalesced_string_linenr = $linenr;
4990 }
4991 }
4992
4993# check for missing a space in a string concatenation
4994 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
4995 WARN('MISSING_SPACE',
4996 "break quoted strings at a space character\n" . $hereprev);
4997 }
4998
4999# check for spaces before a quoted newline
5000 if ($rawline =~ /^.*\".*\s\\n/) {
5001 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5002 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5003 $fix) {
5004 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5005 }
5006
5007 }
5008
Joe Perchesf17dba42014-10-13 15:51:51 -07005009# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005010 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005011 CHK("CONCATENATED_STRING",
5012 "Concatenated strings should use spaces between elements\n" . $herecurr);
5013 }
5014
Joe Perches90ad30e2014-12-10 15:51:59 -08005015# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005016 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005017 WARN("STRING_FRAGMENTS",
5018 "Consecutive strings are generally better as a single string\n" . $herecurr);
5019 }
5020
Joe Perches6e300752015-09-09 15:37:47 -07005021# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005022 my $string;
5023 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5024 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5025 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005026 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005027 WARN("PRINTF_L",
5028 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5029 last;
5030 }
Joe Perches6e300752015-09-09 15:37:47 -07005031 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5032 ERROR("PRINTF_0xDECIMAL",
5033 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5034 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005035 }
5036
5037# check for line continuations in quoted strings with odd counts of "
5038 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5039 WARN("LINE_CONTINUATIONS",
5040 "Avoid line continuations in quoted strings\n" . $herecurr);
5041 }
5042
Andy Whitcroft00df3442007-06-08 13:47:06 -07005043# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005044 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005045 CHK("REDUNDANT_CODE",
5046 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005047 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005048 }
5049
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005050# check for needless "if (<foo>) fn(<foo>)" uses
5051 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005052 my $tested = quotemeta($1);
5053 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5054 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5055 my $func = $1;
5056 if (WARN('NEEDLESS_IF',
5057 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5058 $fix) {
5059 my $do_fix = 1;
5060 my $leading_tabs = "";
5061 my $new_leading_tabs = "";
5062 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5063 $leading_tabs = $1;
5064 } else {
5065 $do_fix = 0;
5066 }
5067 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5068 $new_leading_tabs = $1;
5069 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5070 $do_fix = 0;
5071 }
5072 } else {
5073 $do_fix = 0;
5074 }
5075 if ($do_fix) {
5076 fix_delete_line($fixlinenr - 1, $prevrawline);
5077 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5078 }
5079 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005080 }
5081 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005082
Joe Perchesebfdc402014-08-06 16:10:27 -07005083# check for unnecessary "Out of Memory" messages
5084 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5085 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5086 (defined $1 || defined $3) &&
5087 $linenr > 3) {
5088 my $testval = $2;
5089 my $testline = $lines[$linenr - 3];
5090
5091 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5092# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5093
5094 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5095 WARN("OOM_MESSAGE",
5096 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5097 }
5098 }
5099
Joe Perchesf78d98f2014-10-13 15:52:01 -07005100# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005101 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005102 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5103 my $level = $1;
5104 if (WARN("UNNECESSARY_KERN_LEVEL",
5105 "Possible unnecessary $level\n" . $herecurr) &&
5106 $fix) {
5107 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5108 }
5109 }
5110
Joe Perchesabb08a52014-12-10 15:51:46 -08005111# check for mask then right shift without a parentheses
5112 if ($^V && $^V ge 5.10.0 &&
5113 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5114 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5115 WARN("MASK_THEN_SHIFT",
5116 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5117 }
5118
Joe Perchesb75ac612014-12-10 15:52:02 -08005119# check for pointer comparisons to NULL
5120 if ($^V && $^V ge 5.10.0) {
5121 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5122 my $val = $1;
5123 my $equal = "!";
5124 $equal = "" if ($4 eq "!=");
5125 if (CHK("COMPARISON_TO_NULL",
5126 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5127 $fix) {
5128 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5129 }
5130 }
5131 }
5132
Joe Perches8716de32013-09-11 14:24:05 -07005133# check for bad placement of section $InitAttribute (e.g.: __initdata)
5134 if ($line =~ /(\b$InitAttribute\b)/) {
5135 my $attr = $1;
5136 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5137 my $ptr = $1;
5138 my $var = $2;
5139 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5140 ERROR("MISPLACED_INIT",
5141 "$attr should be placed after $var\n" . $herecurr)) ||
5142 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5143 WARN("MISPLACED_INIT",
5144 "$attr should be placed after $var\n" . $herecurr))) &&
5145 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005146 $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 -07005147 }
5148 }
5149 }
5150
Joe Perchese970b882013-11-12 15:10:10 -08005151# check for $InitAttributeData (ie: __initdata) with const
5152 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5153 my $attr = $1;
5154 $attr =~ /($InitAttributePrefix)(.*)/;
5155 my $attr_prefix = $1;
5156 my $attr_type = $2;
5157 if (ERROR("INIT_ATTRIBUTE",
5158 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5159 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005160 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005161 s/$InitAttributeData/${attr_prefix}initconst/;
5162 }
5163 }
5164
5165# check for $InitAttributeConst (ie: __initconst) without const
5166 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5167 my $attr = $1;
5168 if (ERROR("INIT_ATTRIBUTE",
5169 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5170 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005171 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005172 /(^\+\s*(?:static\s+))/;
5173 $lead = rtrim($1);
5174 $lead = "$lead " if ($lead !~ /^\+$/);
5175 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005176 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08005177 }
5178 }
5179
Joe Perchesc17893c2015-04-16 12:44:42 -07005180# check for __read_mostly with const non-pointer (should just be const)
5181 if ($line =~ /\b__read_mostly\b/ &&
5182 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5183 if (ERROR("CONST_READ_MOSTLY",
5184 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5185 $fix) {
5186 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5187 }
5188 }
5189
Joe Perchesfbdb8132014-04-03 14:49:14 -07005190# don't use __constant_<foo> functions outside of include/uapi/
5191 if ($realfile !~ m@^include/uapi/@ &&
5192 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5193 my $constant_func = $1;
5194 my $func = $constant_func;
5195 $func =~ s/^__constant_//;
5196 if (WARN("CONSTANT_CONVERSION",
5197 "$constant_func should be $func\n" . $herecurr) &&
5198 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005199 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005200 }
5201 }
5202
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005203# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005204 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005205 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005206 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005207 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005208 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005209 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5210 }
5211 if ($delay > 2000) {
5212 WARN("LONG_UDELAY",
5213 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005214 }
5215 }
5216
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005217# warn about unexpectedly long msleep's
5218 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5219 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005220 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005221 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005222 }
5223 }
5224
Joe Perches36ec1932013-07-03 15:05:25 -07005225# check for comparisons of jiffies
5226 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5227 WARN("JIFFIES_COMPARISON",
5228 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5229 }
5230
Joe Perches9d7a34a2013-07-03 15:05:26 -07005231# check for comparisons of get_jiffies_64()
5232 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5233 WARN("JIFFIES_COMPARISON",
5234 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5235 }
5236
Andy Whitcroft00df3442007-06-08 13:47:06 -07005237# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005238# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005239# print "#ifdef in C files should be avoided\n";
5240# print "$herecurr";
5241# $clean = 0;
5242# }
5243
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005244# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005245 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005246 if (ERROR("SPACING",
5247 "exactly one space required after that #$1\n" . $herecurr) &&
5248 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005249 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005250 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5251 }
5252
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005253 }
5254
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005255# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005256 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5257 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005258 my $which = $1;
5259 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005260 CHK("UNCOMMENTED_DEFINITION",
5261 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005262 }
5263 }
5264# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005265
5266 my $barriers = qr{
5267 mb|
5268 rmb|
5269 wmb|
5270 read_barrier_depends
5271 }x;
5272 my $barrier_stems = qr{
5273 mb__before_atomic|
5274 mb__after_atomic|
5275 store_release|
5276 load_acquire|
5277 store_mb|
5278 (?:$barriers)
5279 }x;
5280 my $all_barriers = qr{
5281 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005282 smp_(?:$barrier_stems)|
5283 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005284 }x;
5285
5286 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005287 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005288 WARN("MEMORY_BARRIER",
5289 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005290 }
5291 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005292
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005293 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5294
5295 if ($realfile !~ m@^include/asm-generic/@ &&
5296 $realfile !~ m@/barrier\.h$@ &&
5297 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5298 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5299 WARN("MEMORY_BARRIER",
5300 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5301 }
5302
Joe Perchescb426e92015-06-25 15:02:46 -07005303# check for waitqueue_active without a comment.
5304 if ($line =~ /\bwaitqueue_active\s*\(/) {
5305 if (!ctx_has_comment($first_line, $linenr)) {
5306 WARN("WAITQUEUE_ACTIVE",
5307 "waitqueue_active without comment\n" . $herecurr);
5308 }
5309 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005310
5311# Check for expedited grace periods that interrupt non-idle non-nohz
5312# online CPUs. These expedited can therefore degrade real-time response
5313# if used carelessly, and should be avoided where not absolutely
5314# needed. It is always OK to use synchronize_rcu_expedited() and
5315# synchronize_sched_expedited() at boot time (before real-time applications
5316# start) and in error situations where real-time response is compromised in
5317# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5318# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5319# Of course, nothing comes for free, and srcu_read_lock() and
5320# srcu_read_unlock() do contain full memory barriers in payment for
5321# synchronize_srcu_expedited() non-interruption properties.
5322 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5323 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5324 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5325
5326 }
5327
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005328# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005329 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005330 CHK("ARCH_DEFINES",
5331 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005332 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005333
Tobias Klauserd4977c72010-05-24 14:33:30 -07005334# Check that the storage class is at the beginning of a declaration
5335 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005336 WARN("STORAGE_CLASS",
5337 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005338 }
5339
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005340# check the location of the inline attribute, that it is between
5341# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005342 if ($line =~ /\b$Type\s+$Inline\b/ ||
5343 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005344 ERROR("INLINE_LOCATION",
5345 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005346 }
5347
Andy Whitcroft8905a672007-11-28 16:21:06 -08005348# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005349 if ($realfile !~ m@\binclude/uapi/@ &&
5350 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005351 if (WARN("INLINE",
5352 "plain inline is preferred over $1\n" . $herecurr) &&
5353 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005354 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005355
5356 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005357 }
5358
Joe Perches3d130fd2011-01-12 17:00:00 -08005359# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005360 if ($realfile !~ m@\binclude/uapi/@ &&
5361 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005362 WARN("PREFER_PACKED",
5363 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005364 }
5365
Joe Perches39b7e282011-07-25 17:13:24 -07005366# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005367 if ($realfile !~ m@\binclude/uapi/@ &&
5368 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005369 WARN("PREFER_ALIGNED",
5370 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005371 }
5372
Joe Perches5f14d3b2012-01-10 15:09:52 -08005373# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005374 if ($realfile !~ m@\binclude/uapi/@ &&
5375 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005376 if (WARN("PREFER_PRINTF",
5377 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5378 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005379 $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 -07005380
5381 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005382 }
5383
Joe Perches6061d942012-03-23 15:02:16 -07005384# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005385 if ($realfile !~ m@\binclude/uapi/@ &&
5386 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005387 if (WARN("PREFER_SCANF",
5388 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5389 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005390 $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 -07005391 }
Joe Perches6061d942012-03-23 15:02:16 -07005392 }
5393
Joe Perches619a9082014-12-10 15:51:35 -08005394# Check for __attribute__ weak, or __weak declarations (may have link issues)
5395 if ($^V && $^V ge 5.10.0 &&
5396 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5397 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5398 $line =~ /\b__weak\b/)) {
5399 ERROR("WEAK_DECLARATION",
5400 "Using weak declarations can have unintended link defects\n" . $herecurr);
5401 }
5402
Joe Perchese6176fa2015-06-25 15:02:49 -07005403# check for c99 types like uint8_t used outside of uapi/
5404 if ($realfile !~ m@\binclude/uapi/@ &&
5405 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5406 my $type = $1;
5407 if ($type =~ /\b($typeC99Typedefs)\b/) {
5408 $type = $1;
5409 my $kernel_type = 'u';
5410 $kernel_type = 's' if ($type =~ /^_*[si]/);
5411 $type =~ /(\d+)/;
5412 $kernel_type .= $1;
5413 if (CHK("PREFER_KERNEL_TYPES",
5414 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5415 $fix) {
5416 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5417 }
5418 }
5419 }
5420
Joe Perches938224b2016-01-20 14:59:15 -08005421# check for cast of C90 native int or longer types constants
5422 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5423 my $cast = $1;
5424 my $const = $2;
5425 if (WARN("TYPECAST_INT_CONSTANT",
5426 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5427 $fix) {
5428 my $suffix = "";
5429 my $newconst = $const;
5430 $newconst =~ s/${Int_type}$//;
5431 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5432 if ($cast =~ /\blong\s+long\b/) {
5433 $suffix .= 'LL';
5434 } elsif ($cast =~ /\blong\b/) {
5435 $suffix .= 'L';
5436 }
5437 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5438 }
5439 }
5440
Joe Perches8f53a9b2010-03-05 13:43:48 -08005441# check for sizeof(&)
5442 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005443 WARN("SIZEOF_ADDRESS",
5444 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005445 }
5446
Joe Perches66c80b62012-07-30 14:41:22 -07005447# check for sizeof without parenthesis
5448 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005449 if (WARN("SIZEOF_PARENTHESIS",
5450 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5451 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005452 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005453 }
Joe Perches66c80b62012-07-30 14:41:22 -07005454 }
5455
Joe Perches88982fe2012-12-17 16:02:00 -08005456# check for struct spinlock declarations
5457 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5458 WARN("USE_SPINLOCK_T",
5459 "struct spinlock should be spinlock_t\n" . $herecurr);
5460 }
5461
Joe Perchesa6962d72013-04-29 16:18:13 -07005462# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005463 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005464 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005465 $fmt =~ s/%%//g;
5466 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005467 if (WARN("PREFER_SEQ_PUTS",
5468 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5469 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005470 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005471 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005472 }
5473 }
5474
Andy Whitcroft554e1652012-01-10 15:09:57 -08005475# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005476 if ($^V && $^V ge 5.10.0 &&
5477 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005478 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005479
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005480 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005481 my $ms_val = $7;
5482 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005483
Andy Whitcroft554e1652012-01-10 15:09:57 -08005484 if ($ms_size =~ /^(0x|)0$/i) {
5485 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005486 "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 -08005487 } elsif ($ms_size =~ /^(0x|)1$/i) {
5488 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005489 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5490 }
5491 }
5492
Joe Perches98a9bba2014-01-23 15:54:52 -08005493# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5494 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005495 defined $stat &&
5496 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005497 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005498 "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 -08005499 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005500 $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 -08005501 }
5502 }
5503
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005504# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5505 if ($^V && $^V ge 5.10.0 &&
5506 defined $stat &&
5507 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5508 WARN("PREFER_ETHER_ADDR_EQUAL",
5509 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5510 }
5511
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005512# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5513# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5514 if ($^V && $^V ge 5.10.0 &&
5515 defined $stat &&
5516 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5517
5518 my $ms_val = $7;
5519
5520 if ($ms_val =~ /^(?:0x|)0+$/i) {
5521 if (WARN("PREFER_ETH_ZERO_ADDR",
5522 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5523 $fix) {
5524 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5525 }
5526 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5527 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5528 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5529 $fix) {
5530 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5531 }
5532 }
5533 }
5534
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005535# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005536 if ($^V && $^V ge 5.10.0 &&
5537 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005538 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005539 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005540 my $call = $1;
5541 my $cast1 = deparenthesize($2);
5542 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005543 my $cast2 = deparenthesize($7);
5544 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005545 my $cast;
5546
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005547 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005548 $cast = "$cast1 or $cast2";
5549 } elsif ($cast1 ne "") {
5550 $cast = $cast1;
5551 } else {
5552 $cast = $cast2;
5553 }
5554 WARN("MINMAX",
5555 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005556 }
5557 }
5558
Joe Perches4a273192012-07-30 14:41:20 -07005559# check usleep_range arguments
5560 if ($^V && $^V ge 5.10.0 &&
5561 defined $stat &&
5562 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5563 my $min = $1;
5564 my $max = $7;
5565 if ($min eq $max) {
5566 WARN("USLEEP_RANGE",
5567 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5568 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5569 $min > $max) {
5570 WARN("USLEEP_RANGE",
5571 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5572 }
5573 }
5574
Joe Perches823b7942013-11-12 15:10:15 -08005575# check for naked sscanf
5576 if ($^V && $^V ge 5.10.0 &&
5577 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005578 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005579 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5580 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5581 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5582 my $lc = $stat =~ tr@\n@@;
5583 $lc = $lc + $linenr;
5584 my $stat_real = raw_line($linenr, 0);
5585 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5586 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5587 }
5588 WARN("NAKED_SSCANF",
5589 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5590 }
5591
Joe Perchesafc819a2014-06-04 16:12:08 -07005592# check for simple sscanf that should be kstrto<foo>
5593 if ($^V && $^V ge 5.10.0 &&
5594 defined $stat &&
5595 $line =~ /\bsscanf\b/) {
5596 my $lc = $stat =~ tr@\n@@;
5597 $lc = $lc + $linenr;
5598 my $stat_real = raw_line($linenr, 0);
5599 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5600 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5601 }
5602 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5603 my $format = $6;
5604 my $count = $format =~ tr@%@%@;
5605 if ($count == 1 &&
5606 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5607 WARN("SSCANF_TO_KSTRTO",
5608 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5609 }
5610 }
5611 }
5612
Joe Perches70dc8a42013-09-11 14:23:58 -07005613# check for new externs in .h files.
5614 if ($realfile =~ /\.h$/ &&
5615 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005616 if (CHK("AVOID_EXTERNS",
5617 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005618 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005619 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005620 }
5621 }
5622
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005623# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005624 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005625 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005626 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005627 my $function_name = $1;
5628 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005629
5630 my $s = $stat;
5631 if (defined $cond) {
5632 substr($s, 0, length($cond), '');
5633 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005634 if ($s =~ /^\s*;/ &&
5635 $function_name ne 'uninitialized_var')
5636 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005637 WARN("AVOID_EXTERNS",
5638 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005639 }
5640
5641 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005642 WARN("FUNCTION_ARGUMENTS",
5643 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005644 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005645
5646 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5647 $stat =~ /^.\s*extern\s+/)
5648 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005649 WARN("AVOID_EXTERNS",
5650 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005651 }
5652
5653# checks for new __setup's
5654 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5655 my $name = $1;
5656
5657 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005658 CHK("UNDOCUMENTED_SETUP",
5659 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005660 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005661 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005662
5663# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005664 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005665 WARN("UNNECESSARY_CASTS",
5666 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005667 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005668
Joe Perchesa640d252013-07-03 15:05:21 -07005669# alloc style
5670# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5671 if ($^V && $^V ge 5.10.0 &&
5672 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5673 CHK("ALLOC_SIZEOF_STRUCT",
5674 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5675 }
5676
Joe Perches60a55362014-06-04 16:12:07 -07005677# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5678 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005679 $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 -07005680 my $oldfunc = $3;
5681 my $a1 = $4;
5682 my $a2 = $10;
5683 my $newfunc = "kmalloc_array";
5684 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005685 my $r1 = $a1;
5686 my $r2 = $a2;
5687 if ($a1 =~ /^sizeof\s*\S/) {
5688 $r1 = $a2;
5689 $r2 = $a1;
5690 }
5691 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5692 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005693 if (WARN("ALLOC_WITH_MULTIPLY",
5694 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5695 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005696 $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 -07005697
5698 }
5699 }
5700 }
5701
Joe Perches972fdea2013-04-29 16:18:12 -07005702# check for krealloc arg reuse
5703 if ($^V && $^V ge 5.10.0 &&
5704 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5705 WARN("KREALLOC_ARG_REUSE",
5706 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5707 }
5708
Joe Perches5ce59ae2013-02-21 16:44:18 -08005709# check for alloc argument mismatch
5710 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5711 WARN("ALLOC_ARRAY_ARGS",
5712 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5713 }
5714
Joe Perchescaf2a542011-01-12 16:59:56 -08005715# check for multiple semicolons
5716 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005717 if (WARN("ONE_SEMICOLON",
5718 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5719 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005720 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005721 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005722 }
5723
Joe Perches0ab90192014-12-10 15:51:57 -08005724# check for #defines like: 1 << <digit> that could be BIT(digit)
5725 if ($line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
5726 my $ull = "";
5727 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5728 if (CHK("BIT_MACRO",
5729 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5730 $fix) {
5731 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5732 }
5733 }
5734
Joe Perches2d632742016-05-20 17:04:00 -07005735# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5736 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5737 my $config = $1;
5738 if (WARN("PREFER_IS_ENABLED",
5739 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5740 $fix) {
5741 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5742 }
5743 }
5744
Joe Perchese81f2392014-08-06 16:11:25 -07005745# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005746 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5747 my $has_break = 0;
5748 my $has_statement = 0;
5749 my $count = 0;
5750 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005751 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005752 $prevline--;
5753 my $rline = $rawlines[$prevline - 1];
5754 my $fline = $lines[$prevline - 1];
5755 last if ($fline =~ /^\@\@/);
5756 next if ($fline =~ /^\-/);
5757 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5758 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5759 next if ($fline =~ /^.[\s$;]*$/);
5760 $has_statement = 1;
5761 $count++;
5762 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5763 }
5764 if (!$has_break && $has_statement) {
5765 WARN("MISSING_BREAK",
5766 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5767 }
5768 }
5769
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005770# check for switch/default statements without a break;
5771 if ($^V && $^V ge 5.10.0 &&
5772 defined $stat &&
5773 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5774 my $ctx = '';
5775 my $herectx = $here . "\n";
5776 my $cnt = statement_rawlines($stat);
5777 for (my $n = 0; $n < $cnt; $n++) {
5778 $herectx .= raw_line($linenr, $n) . "\n";
5779 }
5780 WARN("DEFAULT_NO_BREAK",
5781 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005782 }
5783
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005784# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005785 if ($line =~ /\b__FUNCTION__\b/) {
5786 if (WARN("USE_FUNC",
5787 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5788 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005789 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005790 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005791 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005792
Joe Perches62ec8182015-02-13 14:38:18 -08005793# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5794 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5795 ERROR("DATE_TIME",
5796 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5797 }
5798
Joe Perches2c924882012-03-23 15:02:20 -07005799# check for use of yield()
5800 if ($line =~ /\byield\s*\(\s*\)/) {
5801 WARN("YIELD",
5802 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5803 }
5804
Joe Perches179f8f42013-07-03 15:05:30 -07005805# check for comparisons against true and false
5806 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5807 my $lead = $1;
5808 my $arg = $2;
5809 my $test = $3;
5810 my $otype = $4;
5811 my $trail = $5;
5812 my $op = "!";
5813
5814 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5815
5816 my $type = lc($otype);
5817 if ($type =~ /^(?:true|false)$/) {
5818 if (("$test" eq "==" && "$type" eq "true") ||
5819 ("$test" eq "!=" && "$type" eq "false")) {
5820 $op = "";
5821 }
5822
5823 CHK("BOOL_COMPARISON",
5824 "Using comparison to $otype is error prone\n" . $herecurr);
5825
5826## maybe suggesting a correct construct would better
5827## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5828
5829 }
5830 }
5831
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005832# check for semaphores initialized locked
5833 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005834 WARN("CONSIDER_COMPLETION",
5835 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005836 }
Joe Perches6712d852012-03-23 15:02:20 -07005837
Joe Perches67d0a072011-10-31 17:13:10 -07005838# recommend kstrto* over simple_strto* and strict_strto*
5839 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005840 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005841 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005842 }
Joe Perches6712d852012-03-23 15:02:20 -07005843
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005844# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005845 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005846 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005847 "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 -07005848 }
Joe Perches6712d852012-03-23 15:02:20 -07005849
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005850# check for various structs that are normally const (ops, kgdb, device_tree)
5851 my $const_structs = qr{
5852 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005853 address_space_operations|
5854 backlight_ops|
5855 block_device_operations|
5856 dentry_operations|
5857 dev_pm_ops|
5858 dma_map_ops|
5859 extent_io_ops|
5860 file_lock_operations|
5861 file_operations|
5862 hv_ops|
5863 ide_dma_ops|
5864 intel_dvo_dev_ops|
5865 item_operations|
5866 iwl_ops|
5867 kgdb_arch|
5868 kgdb_io|
5869 kset_uevent_ops|
5870 lock_manager_operations|
5871 microcode_ops|
5872 mtrr_ops|
5873 neigh_ops|
5874 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005875 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005876 pci_raw_ops|
5877 pipe_buf_operations|
5878 platform_hibernation_ops|
5879 platform_suspend_ops|
5880 proto_ops|
5881 rpc_pipe_ops|
5882 seq_operations|
5883 snd_ac97_build_ops|
5884 soc_pcmcia_socket_ops|
5885 stacktrace_ops|
5886 sysfs_ops|
5887 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005888 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005889 usb_mon_operations|
5890 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005891 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005892 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005893 WARN("CONST_STRUCT",
5894 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005895 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005896 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005897
5898# use of NR_CPUS is usually wrong
5899# ignore definitions of NR_CPUS and usage to define arrays as likely right
5900 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005901 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5902 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005903 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5904 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5905 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005906 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005907 WARN("NR_CPUS",
5908 "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 -07005909 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005910
Joe Perches52ea8502013-11-12 15:10:09 -08005911# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5912 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5913 ERROR("DEFINE_ARCH_HAS",
5914 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5915 }
5916
Joe Perchesacd93622015-02-13 14:38:38 -08005917# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5918 if ($^V && $^V ge 5.10.0 &&
5919 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5920 WARN("LIKELY_MISUSE",
5921 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5922 }
5923
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005924# whine mightly about in_atomic
5925 if ($line =~ /\bin_atomic\s*\(/) {
5926 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005927 ERROR("IN_ATOMIC",
5928 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005929 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005930 WARN("IN_ATOMIC",
5931 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005932 }
5933 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005934
Joe Perches481aea52016-05-20 17:04:08 -07005935# whine about ACCESS_ONCE
5936 if ($^V && $^V ge 5.10.0 &&
5937 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
5938 my $par = $1;
5939 my $eq = $2;
5940 my $fun = $3;
5941 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
5942 if (defined($eq)) {
5943 if (WARN("PREFER_WRITE_ONCE",
5944 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
5945 $fix) {
5946 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5947 }
5948 } else {
5949 if (WARN("PREFER_READ_ONCE",
5950 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
5951 $fix) {
5952 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
5953 }
5954 }
5955 }
5956
Peter Zijlstra1704f472010-03-19 01:37:42 +01005957# check for lockdep_set_novalidate_class
5958 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5959 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5960 if ($realfile !~ m@^kernel/lockdep@ &&
5961 $realfile !~ m@^include/linux/lockdep@ &&
5962 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005963 ERROR("LOCKDEP",
5964 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005965 }
5966 }
Dave Jones88f88312011-01-12 16:59:59 -08005967
Joe Perchesb392c642015-04-16 12:44:16 -07005968 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5969 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005970 WARN("EXPORTED_WORLD_WRITABLE",
5971 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005972 }
Joe Perches24358802014-04-03 14:49:13 -07005973
Joe Perches515a2352014-04-03 14:49:24 -07005974# Mode permission misuses where it seems decimal should be octal
5975# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5976 if ($^V && $^V ge 5.10.0 &&
5977 $line =~ /$mode_perms_search/) {
5978 foreach my $entry (@mode_permission_funcs) {
5979 my $func = $entry->[0];
5980 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07005981
Joe Perches515a2352014-04-03 14:49:24 -07005982 my $skip_args = "";
5983 if ($arg_pos > 1) {
5984 $arg_pos--;
5985 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
5986 }
5987 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
5988 if ($line =~ /$test/) {
5989 my $val = $1;
5990 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07005991
Joe Perches515a2352014-04-03 14:49:24 -07005992 if ($val !~ /^0$/ &&
5993 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
5994 length($val) ne 4)) {
5995 ERROR("NON_OCTAL_PERMISSIONS",
5996 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08005997 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
5998 ERROR("EXPORTED_WORLD_WRITABLE",
5999 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006000 }
Joe Perches24358802014-04-03 14:49:13 -07006001 }
6002 }
6003 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006004
6005# validate content of MODULE_LICENSE against list from include/linux/module.h
6006 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6007 my $extracted_string = get_quoted_string($line, $rawline);
6008 my $valid_licenses = qr{
6009 GPL|
6010 GPL\ v2|
6011 GPL\ and\ additional\ rights|
6012 Dual\ BSD/GPL|
6013 Dual\ MIT/GPL|
6014 Dual\ MPL/GPL|
6015 Proprietary
6016 }x;
6017 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6018 WARN("MODULE_LICENSE",
6019 "unknown module license " . $extracted_string . "\n" . $herecurr);
6020 }
6021 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006022 }
6023
6024 # If we have no input at all, then there is nothing to report on
6025 # so just keep quiet.
6026 if ($#rawlines == -1) {
6027 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006028 }
6029
Andy Whitcroft8905a672007-11-28 16:21:06 -08006030 # In mailback mode only produce a report in the negative, for
6031 # things that appear to be patches.
6032 if ($mailback && ($clean == 1 || !$is_patch)) {
6033 exit(0);
6034 }
6035
6036 # This is not a patch, and we are are in 'no-patch' mode so
6037 # just keep quiet.
6038 if (!$chk_patch && !$is_patch) {
6039 exit(0);
6040 }
6041
Joe Perches06330fc2015-06-25 15:03:11 -07006042 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006043 ERROR("NOT_UNIFIED_DIFF",
6044 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006045 }
Joe Perches34d88152015-06-25 15:03:05 -07006046 if ($is_patch && $filename ne '-' && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006047 ERROR("MISSING_SIGN_OFF",
6048 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006049 }
6050
Andy Whitcroft8905a672007-11-28 16:21:06 -08006051 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006052 if ($summary && !($clean == 1 && $quiet == 1)) {
6053 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006054 print "total: $cnt_error errors, $cnt_warn warnings, " .
6055 (($check)? "$cnt_chk checks, " : "") .
6056 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006057 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006058
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006059 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006060 # If there were any defects found and not already fixing them
6061 if (!$clean and !$fix) {
6062 print << "EOM"
6063
6064NOTE: For some of the reported defects, checkpatch may be able to
6065 mechanically convert to the typical style using --fix or --fix-inplace.
6066EOM
6067 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006068 # If there were whitespace errors which cleanpatch can fix
6069 # then suggest that.
6070 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006071 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006072 print << "EOM"
6073
6074NOTE: Whitespace errors detected.
6075 You may wish to use scripts/cleanpatch or scripts/cleanfile
6076EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006077 }
6078 }
6079
Joe Perchesd752fcc2014-08-06 16:11:05 -07006080 if ($clean == 0 && $fix &&
6081 ("@rawlines" ne "@fixed" ||
6082 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006083 my $newfile = $filename;
6084 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006085 my $linecount = 0;
6086 my $f;
6087
Joe Perchesd752fcc2014-08-06 16:11:05 -07006088 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6089
Joe Perches3705ce52013-07-03 15:05:31 -07006090 open($f, '>', $newfile)
6091 or die "$P: Can't open $newfile for write\n";
6092 foreach my $fixed_line (@fixed) {
6093 $linecount++;
6094 if ($file) {
6095 if ($linecount > 3) {
6096 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006097 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006098 }
6099 } else {
6100 print $f $fixed_line . "\n";
6101 }
6102 }
6103 close($f);
6104
6105 if (!$quiet) {
6106 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006107
Joe Perches3705ce52013-07-03 15:05:31 -07006108Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6109
6110Do _NOT_ trust the results written to this file.
6111Do _NOT_ submit these changes without inspecting them for correctness.
6112
6113This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6114No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006115EOM
6116 }
6117 }
6118
Joe Perchesd8469f12015-06-25 15:03:00 -07006119 if ($quiet == 0) {
6120 print "\n";
6121 if ($clean == 1) {
6122 print "$vname has no obvious style problems and is ready for submission.\n";
6123 } else {
6124 print "$vname has style problems, please review.\n";
6125 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006126 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006127 return $clean;
6128}