blob: c12276c9c421e45cc3877569b29bb7b31a08b229 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070030my $git = 0;
Joe Perches0dea9f12016-05-20 17:04:19 -070031my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070033my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080034my $summary = 1;
35my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080036my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070037my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070038my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070039my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080040my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070041my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080042my %debug;
Joe Perches34456862013-07-03 15:05:34 -070043my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070044my %use_type = ();
45my @use = ();
46my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070047my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070048my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070049my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080050my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070051my $ignore_perl_version = 0;
52my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070053my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070054my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070055my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070056my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perches57230292015-06-25 15:03:03 -070057my $color = 1;
Joe Perchesdadf6802016-08-02 14:04:33 -070058my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070059
60sub help {
61 my ($exitcode) = @_;
62
63 print << "EOM";
64Usage: $P [OPTION]... [FILE]...
65Version: $V
66
67Options:
68 -q, --quiet quiet
69 --no-tree run without a kernel tree
70 --no-signoff do not check for 'Signed-off-by' line
71 --patch treat FILE as patchfile (default)
72 --emacs emacs compile window format
73 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070074 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070075 -g, --git treat FILE as a single commit or git revision range
76 single git commit with:
77 <rev>
78 <rev>^
79 <rev>~n
80 multiple git commits with:
81 <rev1>..<rev2>
82 <rev1>...<rev2>
83 <rev>-<count>
84 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070085 -f, --file treat FILE as regular source file
86 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070087 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070088 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070089 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070090 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -080091 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -070092 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -070093 --root=PATH PATH to the kernel tree root
94 --no-summary suppress the per-file summary
95 --mailback only produce a report in case of warnings/errors
96 --summary-file include the filename in summary
97 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
98 'values', 'possible', 'type', and 'attr' (default
99 is all off)
100 --test-only=WORD report only warnings/errors containing WORD
101 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700102 --fix EXPERIMENTAL - may create horrible results
103 If correctable single-line errors exist, create
104 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
105 with potential errors corrected to the preferred
106 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800107 --fix-inplace EXPERIMENTAL - may create horrible results
108 Is the same as --fix, but overwrites the input
109 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700110 --ignore-perl-version override checking of perl version. expect
111 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700112 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700113 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700114 --codespellfile Use this codespell dictionary
Joe Perches57230292015-06-25 15:03:03 -0700115 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700116 -h, --help, --version display this help and exit
117
118When FILE is - read standard input.
119EOM
120
121 exit($exitcode);
122}
123
Joe Perches3beb42e2016-05-20 17:04:14 -0700124sub uniq {
125 my %seen;
126 return grep { !$seen{$_}++ } @_;
127}
128
129sub list_types {
130 my ($exitcode) = @_;
131
132 my $count = 0;
133
134 local $/ = undef;
135
136 open(my $script, '<', abs_path($P)) or
137 die "$P: Can't read '$P' $!\n";
138
139 my $text = <$script>;
140 close($script);
141
142 my @types = ();
143 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
144 push (@types, $_);
145 }
146 @types = sort(uniq(@types));
147 print("#\tMessage type\n\n");
148 foreach my $type (@types) {
149 print(++$count . "\t" . $type . "\n");
150 }
151
152 exit($exitcode);
153}
154
Joe Perches000d1cc12011-07-25 17:13:25 -0700155my $conf = which_conf($configuration_file);
156if (-f $conf) {
157 my @conf_args;
158 open(my $conffile, '<', "$conf")
159 or warn "$P: Can't find a readable $configuration_file file $!\n";
160
161 while (<$conffile>) {
162 my $line = $_;
163
164 $line =~ s/\s*\n?$//g;
165 $line =~ s/^\s*//g;
166 $line =~ s/\s+/ /g;
167
168 next if ($line =~ m/^\s*#/);
169 next if ($line =~ m/^\s*$/);
170
171 my @words = split(" ", $line);
172 foreach my $word (@words) {
173 last if ($word =~ m/^#/);
174 push (@conf_args, $word);
175 }
176 }
177 close($conffile);
178 unshift(@ARGV, @conf_args) if @conf_args;
179}
180
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700181GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700182 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700183 'tree!' => \$tree,
184 'signoff!' => \$chk_signoff,
185 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700186 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800187 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700188 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700189 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700190 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700191 'subjective!' => \$check,
192 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700193 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700194 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700195 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700196 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800197 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700198 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700199 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800200 'summary!' => \$summary,
201 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800202 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700203 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800204 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700205 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800206 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700207 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700208 'codespell!' => \$codespell,
209 'codespellfile=s' => \$codespellfile,
Joe Perches57230292015-06-25 15:03:03 -0700210 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700211 'h|help' => \$help,
212 'version' => \$help
213) or help(1);
214
215help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700216
Joe Perches3beb42e2016-05-20 17:04:14 -0700217list_types(0) if ($list_types);
218
Joe Perches9624b8d2014-01-23 15:54:44 -0800219$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700220$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800221
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700222my $exit = 0;
223
Dave Hansend62a2012013-09-11 14:23:56 -0700224if ($^V && $^V lt $minimum_perl_version) {
225 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
226 if (!$ignore_perl_version) {
227 exit(1);
228 }
229}
230
Allen Hubbe45107ff2016-08-02 14:04:47 -0700231#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700232if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700233 push(@ARGV, '-');
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700234}
235
Joe Perches91bfe482013-09-11 14:23:59 -0700236sub hash_save_array_words {
237 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700238
Joe Perches91bfe482013-09-11 14:23:59 -0700239 my @array = split(/,/, join(',', @$arrayRef));
240 foreach my $word (@array) {
241 $word =~ s/\s*\n?$//g;
242 $word =~ s/^\s*//g;
243 $word =~ s/\s+/ /g;
244 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700245
Joe Perches91bfe482013-09-11 14:23:59 -0700246 next if ($word =~ m/^\s*#/);
247 next if ($word =~ m/^\s*$/);
248
249 $hashRef->{$word}++;
250 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700251}
252
Joe Perches91bfe482013-09-11 14:23:59 -0700253sub hash_show_words {
254 my ($hashRef, $prefix) = @_;
255
Joe Perches3c816e42015-06-25 15:03:29 -0700256 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700257 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700258 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700259 print " $word";
260 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700261 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700262 }
263}
264
265hash_save_array_words(\%ignore_type, \@ignore);
266hash_save_array_words(\%use_type, \@use);
267
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800268my $dbg_values = 0;
269my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700270my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700271my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800272for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800273 ## no critic
274 eval "\${dbg_$key} = '$debug{$key}';";
275 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800276}
277
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700278my $rpt_cleaners = 0;
279
Andy Whitcroft8905a672007-11-28 16:21:06 -0800280if ($terse) {
281 $emacs = 1;
282 $quiet++;
283}
284
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700285if ($tree) {
286 if (defined $root) {
287 if (!top_of_kernel_tree($root)) {
288 die "$P: $root: --root does not point at a valid tree\n";
289 }
290 } else {
291 if (top_of_kernel_tree('.')) {
292 $root = '.';
293 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
294 top_of_kernel_tree($1)) {
295 $root = $1;
296 }
297 }
298
299 if (!defined $root) {
300 print "Must be run from the top-level dir. of a kernel tree\n";
301 exit(2);
302 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700303}
304
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700305my $emitted_corrupt = 0;
306
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700307our $Ident = qr{
308 [A-Za-z_][A-Za-z\d_]*
309 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
310 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700311our $Storage = qr{extern|static|asmlinkage};
312our $Sparse = qr{
313 __user|
314 __kernel|
315 __force|
316 __iomem|
317 __must_check|
318 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800319 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700320 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800321 __rcu|
322 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700323 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800324our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
325our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
326our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
327our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
328our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700329
Wolfram Sang52131292010-03-05 13:43:51 -0800330# Notes to $Attribute:
331# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700332our $Attribute = qr{
333 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700334 __percpu|
335 __nocast|
336 __safe|
337 __bitwise__|
338 __packed__|
339 __packed2__|
340 __naked|
341 __maybe_unused|
342 __always_unused|
343 __noreturn|
344 __used|
345 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800346 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700347 __noclone|
348 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700349 __read_mostly|
350 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700351 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700352 ____cacheline_aligned|
353 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800354 ____cacheline_internodealigned_in_smp|
355 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700356 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700357our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700358our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700359our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
360our $Lval = qr{$Ident(?:$Member)*};
361
Joe Perches95e2c602013-07-03 15:05:20 -0700362our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
363our $Binary = qr{(?i)0b[01]+$Int_type?};
364our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
365our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700366our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800367our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800368our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
369our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
370our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800371our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700372our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800373our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700374our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700375our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700376our $Operators = qr{
377 <=|>=|==|!=|
378 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700379 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700380 }x;
381
Joe Perches91cb5192014-04-03 14:49:32 -0700382our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
383
Joe Perchesab7e23f2015-04-16 12:44:22 -0700384our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700386our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700387our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700389our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800390our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700391our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392
Joe Perches15662b32011-10-31 17:13:12 -0700393our $NON_ASCII_UTF8 = qr{
394 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700395 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
396 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
397 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
398 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
399 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
400 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
401}x;
402
Joe Perches15662b32011-10-31 17:13:12 -0700403our $UTF8 = qr{
404 [\x09\x0A\x0D\x20-\x7E] # ASCII
405 | $NON_ASCII_UTF8
406}x;
407
Joe Perchese6176fa2015-06-25 15:02:49 -0700408our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800409our $typeOtherOSTypedefs = qr{(?x:
410 u_(?:char|short|int|long) | # bsd
411 u(?:nchar|short|int|long) # sysv
412)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700413our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700414 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700415 atomic_t
416)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700417our $typeTypedefs = qr{(?x:
418 $typeC99Typedefs\b|
419 $typeOtherOSTypedefs\b|
420 $typeKernelTypedefs\b
421)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700422
Joe Perches6d32f7a2015-11-06 16:31:37 -0800423our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
424
Joe Perches691e6692010-03-05 13:43:51 -0800425our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700426 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700427 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700428 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700429 panic|
Joe Perches06668722013-11-12 15:10:07 -0800430 MODULE_[A-Z_]+|
431 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800432)};
433
Joe Perches20112472011-07-25 17:13:23 -0700434our $signature_tags = qr{(?xi:
435 Signed-off-by:|
436 Acked-by:|
437 Tested-by:|
438 Reviewed-by:|
439 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700440 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700441 To:|
442 Cc:
443)};
444
Joe Perches18130872014-08-06 16:11:22 -0700445our @typeListMisordered = (
446 qr{char\s+(?:un)?signed},
447 qr{int\s+(?:(?:un)?signed\s+)?short\s},
448 qr{int\s+short(?:\s+(?:un)?signed)},
449 qr{short\s+int(?:\s+(?:un)?signed)},
450 qr{(?:un)?signed\s+int\s+short},
451 qr{short\s+(?:un)?signed},
452 qr{long\s+int\s+(?:un)?signed},
453 qr{int\s+long\s+(?:un)?signed},
454 qr{long\s+(?:un)?signed\s+int},
455 qr{int\s+(?:un)?signed\s+long},
456 qr{int\s+(?:un)?signed},
457 qr{int\s+long\s+long\s+(?:un)?signed},
458 qr{long\s+long\s+int\s+(?:un)?signed},
459 qr{long\s+long\s+(?:un)?signed\s+int},
460 qr{long\s+long\s+(?:un)?signed},
461 qr{long\s+(?:un)?signed},
462);
463
Andy Whitcroft8905a672007-11-28 16:21:06 -0800464our @typeList = (
465 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700466 qr{(?:(?:un)?signed\s+)?char},
467 qr{(?:(?:un)?signed\s+)?short\s+int},
468 qr{(?:(?:un)?signed\s+)?short},
469 qr{(?:(?:un)?signed\s+)?int},
470 qr{(?:(?:un)?signed\s+)?long\s+int},
471 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long},
473 qr{(?:(?:un)?signed\s+)?long},
474 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800475 qr{float},
476 qr{double},
477 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800478 qr{struct\s+$Ident},
479 qr{union\s+$Ident},
480 qr{enum\s+$Ident},
481 qr{${Ident}_t},
482 qr{${Ident}_handler},
483 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700484 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800485);
Joe Perches938224b2016-01-20 14:59:15 -0800486
487our $C90_int_types = qr{(?x:
488 long\s+long\s+int\s+(?:un)?signed|
489 long\s+long\s+(?:un)?signed\s+int|
490 long\s+long\s+(?:un)?signed|
491 (?:(?:un)?signed\s+)?long\s+long\s+int|
492 (?:(?:un)?signed\s+)?long\s+long|
493 int\s+long\s+long\s+(?:un)?signed|
494 int\s+(?:(?:un)?signed\s+)?long\s+long|
495
496 long\s+int\s+(?:un)?signed|
497 long\s+(?:un)?signed\s+int|
498 long\s+(?:un)?signed|
499 (?:(?:un)?signed\s+)?long\s+int|
500 (?:(?:un)?signed\s+)?long|
501 int\s+long\s+(?:un)?signed|
502 int\s+(?:(?:un)?signed\s+)?long|
503
504 int\s+(?:un)?signed|
505 (?:(?:un)?signed\s+)?int
506)};
507
Alex Dowad485ff232015-06-25 15:02:52 -0700508our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700509our @typeListWithAttr = (
510 @typeList,
511 qr{struct\s+$InitAttribute\s+$Ident},
512 qr{union\s+$InitAttribute\s+$Ident},
513);
514
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700515our @modifierList = (
516 qr{fastcall},
517);
Alex Dowad485ff232015-06-25 15:02:52 -0700518our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800519
Joe Perches24358802014-04-03 14:49:13 -0700520our @mode_permission_funcs = (
521 ["module_param", 3],
522 ["module_param_(?:array|named|string)", 4],
523 ["module_param_array_named", 5],
524 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
525 ["proc_create(?:_data|)", 2],
526 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
527);
528
Joe Perches515a2352014-04-03 14:49:24 -0700529#Create a search pattern for all these functions to speed up a loop below
530our $mode_perms_search = "";
531foreach my $entry (@mode_permission_funcs) {
532 $mode_perms_search .= '|' if ($mode_perms_search ne "");
533 $mode_perms_search .= $entry->[0];
534}
535
Joe Perchesb392c642015-04-16 12:44:16 -0700536our $mode_perms_world_writable = qr{
537 S_IWUGO |
538 S_IWOTH |
539 S_IRWXUGO |
540 S_IALLUGO |
541 0[0-7][0-7][2367]
542}x;
543
Wolfram Sang7840a942010-08-09 17:20:57 -0700544our $allowed_asm_includes = qr{(?x:
545 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700546 memory|
547 time|
548 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700549)};
550# memory.h: ARM has a custom one
551
Kees Cook66b47b42014-10-13 15:51:57 -0700552# Load common spelling mistakes and build regular expression list.
553my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700554my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700555
Joe Perches36061e32014-12-10 15:51:43 -0800556if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800557 while (<$spelling>) {
558 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700559
Joe Perches36061e32014-12-10 15:51:43 -0800560 $line =~ s/\s*\n?$//g;
561 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700562
Joe Perches36061e32014-12-10 15:51:43 -0800563 next if ($line =~ m/^\s*#/);
564 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700565
Joe Perches36061e32014-12-10 15:51:43 -0800566 my ($suspect, $fix) = split(/\|\|/, $line);
567
Joe Perches36061e32014-12-10 15:51:43 -0800568 $spelling_fix{$suspect} = $fix;
569 }
570 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800571} else {
572 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700573}
Kees Cook66b47b42014-10-13 15:51:57 -0700574
Joe Perchesebfd7d62015-04-16 12:44:14 -0700575if ($codespell) {
576 if (open(my $spelling, '<', $codespellfile)) {
577 while (<$spelling>) {
578 my $line = $_;
579
580 $line =~ s/\s*\n?$//g;
581 $line =~ s/^\s*//g;
582
583 next if ($line =~ m/^\s*#/);
584 next if ($line =~ m/^\s*$/);
585 next if ($line =~ m/, disabled/i);
586
587 $line =~ s/,.*$//;
588
589 my ($suspect, $fix) = split(/->/, $line);
590
591 $spelling_fix{$suspect} = $fix;
592 }
593 close($spelling);
594 } else {
595 warn "No codespell typos will be found - file '$codespellfile': $!\n";
596 }
597}
598
599$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
600
Andy Whitcroft8905a672007-11-28 16:21:06 -0800601sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700602 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
603 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700604 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700605 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700606 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700607 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700608 (?:$typeTypedefs\b)|
609 (?:${all}\b)
610 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800611 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700612 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800613 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800614 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700615 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700616 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800617 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700618 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800619 }x;
Joe Perches18130872014-08-06 16:11:22 -0700620 $NonptrTypeMisordered = qr{
621 (?:$Modifier\s+|const\s+)*
622 (?:
623 (?:${Misordered}\b)
624 )
625 (?:\s+$Modifier|\s+const)*
626 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700627 $NonptrTypeWithAttr = qr{
628 (?:$Modifier\s+|const\s+)*
629 (?:
630 (?:typeof|__typeof__)\s*\([^\)]*\)|
631 (?:$typeTypedefs\b)|
632 (?:${allWithAttr}\b)
633 )
634 (?:\s+$Modifier|\s+const)*
635 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800636 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700637 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700638 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700639 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800640 }x;
Joe Perches18130872014-08-06 16:11:22 -0700641 $TypeMisordered = qr{
642 $NonptrTypeMisordered
643 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
644 (?:\s+$Inline|\s+$Modifier)*
645 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700646 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700647 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800648}
649build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700650
Joe Perches7d2367a2011-07-25 17:13:22 -0700651our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700652
653# Using $balanced_parens, $LvalOrFunc, or $FuncArg
654# requires at least perl version v5.10.0
655# Any use must be runtime checked with $^V
656
657our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700658our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800659our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700660
Joe Perchesf8422302014-08-06 16:11:31 -0700661our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700662 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700663 (?:$Storage\s+)?LIST_HEAD\s*\(|
664 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
665)};
666
Joe Perches7d2367a2011-07-25 17:13:22 -0700667sub deparenthesize {
668 my ($string) = @_;
669 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700670
671 while ($string =~ /^\s*\(.*\)\s*$/) {
672 $string =~ s@^\s*\(\s*@@;
673 $string =~ s@\s*\)\s*$@@;
674 }
675
Joe Perches7d2367a2011-07-25 17:13:22 -0700676 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700677
Joe Perches7d2367a2011-07-25 17:13:22 -0700678 return $string;
679}
680
Joe Perches34456862013-07-03 15:05:34 -0700681sub seed_camelcase_file {
682 my ($file) = @_;
683
684 return if (!(-f $file));
685
686 local $/;
687
688 open(my $include_file, '<', "$file")
689 or warn "$P: Can't read '$file' $!\n";
690 my $text = <$include_file>;
691 close($include_file);
692
693 my @lines = split('\n', $text);
694
695 foreach my $line (@lines) {
696 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
697 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
698 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800699 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
700 $camelcase{$1} = 1;
701 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700702 $camelcase{$1} = 1;
703 }
704 }
705}
706
707my $camelcase_seeded = 0;
708sub seed_camelcase_includes {
709 return if ($camelcase_seeded);
710
711 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700712 my $camelcase_cache = "";
713 my @include_files = ();
714
715 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700716
Richard Genoud3645e322014-02-10 14:25:32 -0800717 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700718 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
719 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700720 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700721 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700722 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700723 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700724 @include_files = split('\n', $files);
725 foreach my $file (@include_files) {
726 my $date = POSIX::strftime("%Y%m%d%H%M",
727 localtime((stat $file)[9]));
728 $last_mod_date = $date if ($last_mod_date < $date);
729 }
730 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700731 }
Joe Perchesc707a812013-07-08 16:00:43 -0700732
733 if ($camelcase_cache ne "" && -f $camelcase_cache) {
734 open(my $camelcase_file, '<', "$camelcase_cache")
735 or warn "$P: Can't read '$camelcase_cache' $!\n";
736 while (<$camelcase_file>) {
737 chomp;
738 $camelcase{$_} = 1;
739 }
740 close($camelcase_file);
741
742 return;
743 }
744
Richard Genoud3645e322014-02-10 14:25:32 -0800745 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700746 $files = `git ls-files "include/*.h"`;
747 @include_files = split('\n', $files);
748 }
749
Joe Perches34456862013-07-03 15:05:34 -0700750 foreach my $file (@include_files) {
751 seed_camelcase_file($file);
752 }
Joe Perches351b2a12013-07-03 15:05:36 -0700753
Joe Perchesc707a812013-07-08 16:00:43 -0700754 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700755 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700756 open(my $camelcase_file, '>', "$camelcase_cache")
757 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700758 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
759 print $camelcase_file ("$_\n");
760 }
761 close($camelcase_file);
762 }
Joe Perches34456862013-07-03 15:05:34 -0700763}
764
Joe Perchesd311cd42014-08-06 16:10:57 -0700765sub git_commit_info {
766 my ($commit, $id, $desc) = @_;
767
768 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
769
770 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
771 $output =~ s/^\s*//gm;
772 my @lines = split("\n", $output);
773
Joe Perches0d7835f2015-02-13 14:38:35 -0800774 return ($id, $desc) if ($#lines < 0);
775
Joe Perchesd311cd42014-08-06 16:10:57 -0700776 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
777# Maybe one day convert this block of bash into something that returns
778# all matching commit ids, but it's very slow...
779#
780# echo "checking commits $1..."
781# git rev-list --remotes | grep -i "^$1" |
782# while read line ; do
783# git log --format='%H %s' -1 $line |
784# echo "commit $(cut -c 1-12,41-)"
785# done
786 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
787 } else {
788 $id = substr($lines[0], 0, 12);
789 $desc = substr($lines[0], 41);
790 }
791
792 return ($id, $desc);
793}
794
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700795$chk_signoff = 0 if ($file);
796
Andy Whitcroft00df3442007-06-08 13:47:06 -0700797my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800798my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700799my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700800my @fixed_inserted = ();
801my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700802my $fixlinenr = -1;
803
Du, Changbin4a593c32016-05-20 17:04:16 -0700804# If input is git commits, extract all commits from the commit expressions.
805# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
806die "$P: No git repository found\n" if ($git && !-e ".git");
807
808if ($git) {
809 my @commits = ();
Joe Perches0dea9f12016-05-20 17:04:19 -0700810 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700811 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700812 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
813 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700814 } elsif ($commit_expr =~ m/\.\./) {
815 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700816 } else {
Joe Perches0dea9f12016-05-20 17:04:19 -0700817 $git_range = "-1 $commit_expr";
818 }
819 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
820 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700821 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
822 next if (!defined($1) || !defined($2));
Joe Perches0dea9f12016-05-20 17:04:19 -0700823 my $sha1 = $1;
824 my $subject = $2;
825 unshift(@commits, $sha1);
826 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700827 }
828 }
829 die "$P: no git commits after extraction!\n" if (@commits == 0);
830 @ARGV = @commits;
831}
832
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800833my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700834for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800835 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700836 if ($git) {
837 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
838 die "$P: $filename: git format-patch failed - $!\n";
839 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800840 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700841 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800842 } elsif ($filename eq '-') {
843 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700844 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800845 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700846 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700847 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800848 if ($filename eq '-') {
849 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700850 } elsif ($git) {
Joe Perches0dea9f12016-05-20 17:04:19 -0700851 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800852 } else {
853 $vname = $filename;
854 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800855 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 chomp;
857 push(@rawlines, $_);
858 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800859 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700860
861 if ($#ARGV > 0 && $quiet == 0) {
862 print '-' x length($vname) . "\n";
863 print "$vname\n";
864 print '-' x length($vname) . "\n";
865 }
866
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800867 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700868 $exit = 1;
869 }
870 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800871 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700872 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700873 @fixed_inserted = ();
874 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700875 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700876 @modifierListFile = ();
877 @typeListFile = ();
878 build_types();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700879}
880
Joe Perchesd8469f12015-06-25 15:03:00 -0700881if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700882 hash_show_words(\%use_type, "Used");
883 hash_show_words(\%ignore_type, "Ignored");
884
Joe Perchesd8469f12015-06-25 15:03:00 -0700885 if ($^V lt 5.10.0) {
886 print << "EOM"
887
888NOTE: perl $^V is not modern enough to detect all possible issues.
889 An upgrade to at least perl v5.10.0 is suggested.
890EOM
891 }
892 if ($exit) {
893 print << "EOM"
894
895NOTE: If any of the errors are false positives, please report
896 them to the maintainer, see CHECKPATCH in MAINTAINERS.
897EOM
898 }
899}
900
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700901exit($exit);
902
903sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904 my ($root) = @_;
905
906 my @tree_check = (
907 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
908 "README", "Documentation", "arch", "include", "drivers",
909 "fs", "init", "ipc", "kernel", "lib", "scripts",
910 );
911
912 foreach my $check (@tree_check) {
913 if (! -e $root . '/' . $check) {
914 return 0;
915 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700916 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700917 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700918}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700919
Joe Perches20112472011-07-25 17:13:23 -0700920sub parse_email {
921 my ($formatted_email) = @_;
922
923 my $name = "";
924 my $address = "";
925 my $comment = "";
926
927 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
928 $name = $1;
929 $address = $2;
930 $comment = $3 if defined $3;
931 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
932 $address = $1;
933 $comment = $2 if defined $2;
934 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
935 $address = $1;
936 $comment = $2 if defined $2;
937 $formatted_email =~ s/$address.*$//;
938 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700939 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700940 $name =~ s/^\"|\"$//g;
941 # If there's a name left after stripping spaces and
942 # leading quotes, and the address doesn't have both
943 # leading and trailing angle brackets, the address
944 # is invalid. ie:
945 # "joe smith joe@smith.com" bad
946 # "joe smith <joe@smith.com" bad
947 if ($name ne "" && $address !~ /^<[^>]+>$/) {
948 $name = "";
949 $address = "";
950 $comment = "";
951 }
952 }
953
Joe Perches3705ce52013-07-03 15:05:31 -0700954 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700955 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700956 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700957 $address =~ s/^\<|\>$//g;
958
959 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
960 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
961 $name = "\"$name\"";
962 }
963
964 return ($name, $address, $comment);
965}
966
967sub format_email {
968 my ($name, $address) = @_;
969
970 my $formatted_email;
971
Joe Perches3705ce52013-07-03 15:05:31 -0700972 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700973 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700974 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700975
976 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
977 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
978 $name = "\"$name\"";
979 }
980
981 if ("$name" eq "") {
982 $formatted_email = "$address";
983 } else {
984 $formatted_email = "$name <$address>";
985 }
986
987 return $formatted_email;
988}
989
Joe Perchesd311cd42014-08-06 16:10:57 -0700990sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -0700991 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -0700992
Joe Perchesbd474ca2014-08-06 16:11:10 -0700993 foreach my $path (split(/:/, $ENV{PATH})) {
994 if (-e "$path/$bin") {
995 return "$path/$bin";
996 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700997 }
Joe Perchesd311cd42014-08-06 16:10:57 -0700998
Joe Perchesbd474ca2014-08-06 16:11:10 -0700999 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001000}
1001
Joe Perches000d1cc12011-07-25 17:13:25 -07001002sub which_conf {
1003 my ($conf) = @_;
1004
1005 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1006 if (-e "$path/$conf") {
1007 return "$path/$conf";
1008 }
1009 }
1010
1011 return "";
1012}
1013
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001014sub expand_tabs {
1015 my ($str) = @_;
1016
1017 my $res = '';
1018 my $n = 0;
1019 for my $c (split(//, $str)) {
1020 if ($c eq "\t") {
1021 $res .= ' ';
1022 $n++;
1023 for (; ($n % 8) != 0; $n++) {
1024 $res .= ' ';
1025 }
1026 next;
1027 }
1028 $res .= $c;
1029 $n++;
1030 }
1031
1032 return $res;
1033}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001034sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001035 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001036 return $res;
1037}
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001038
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001039sub line_stats {
1040 my ($line) = @_;
1041
1042 # Drop the diff line leader and expand tabs
1043 $line =~ s/^.//;
1044 $line = expand_tabs($line);
1045
1046 # Pick the indent from the front of the line.
1047 my ($white) = ($line =~ /^(\s*)/);
1048
1049 return (length($line), length($white));
1050}
1051
Andy Whitcroft773647a2008-03-28 14:15:58 -07001052my $sanitise_quote = '';
1053
1054sub sanitise_line_reset {
1055 my ($in_comment) = @_;
1056
1057 if ($in_comment) {
1058 $sanitise_quote = '*/';
1059 } else {
1060 $sanitise_quote = '';
1061 }
1062}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001063sub sanitise_line {
1064 my ($line) = @_;
1065
1066 my $res = '';
1067 my $l = '';
1068
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001069 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001070 my $off = 0;
1071 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001072
Andy Whitcroft773647a2008-03-28 14:15:58 -07001073 # Always copy over the diff marker.
1074 $res = substr($line, 0, 1);
1075
1076 for ($off = 1; $off < length($line); $off++) {
1077 $c = substr($line, $off, 1);
1078
1079 # Comments we are wacking completly including the begin
1080 # and end, all to $;.
1081 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1082 $sanitise_quote = '*/';
1083
1084 substr($res, $off, 2, "$;$;");
1085 $off++;
1086 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001087 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001088 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001089 $sanitise_quote = '';
1090 substr($res, $off, 2, "$;$;");
1091 $off++;
1092 next;
1093 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001094 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1095 $sanitise_quote = '//';
1096
1097 substr($res, $off, 2, $sanitise_quote);
1098 $off++;
1099 next;
1100 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001101
1102 # A \ in a string means ignore the next character.
1103 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1104 $c eq "\\") {
1105 substr($res, $off, 2, 'XX');
1106 $off++;
1107 next;
1108 }
1109 # Regular quotes.
1110 if ($c eq "'" || $c eq '"') {
1111 if ($sanitise_quote eq '') {
1112 $sanitise_quote = $c;
1113
1114 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001115 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001116 } elsif ($sanitise_quote eq $c) {
1117 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001118 }
1119 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001120
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001121 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001122 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1123 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001124 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1125 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001126 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1127 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001128 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001129 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001130 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001131 }
1132
Daniel Walker113f04a2009-09-21 17:04:35 -07001133 if ($sanitise_quote eq '//') {
1134 $sanitise_quote = '';
1135 }
1136
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001137 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001138 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001139 my $clean = 'X' x length($1);
1140 $res =~ s@\<.*\>@<$clean>@;
1141
1142 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001143 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001144 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001145 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001146 }
1147
Joe Perchesdadf6802016-08-02 14:04:33 -07001148 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1149 my $match = $1;
1150 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1151 }
1152
Andy Whitcroft00df3442007-06-08 13:47:06 -07001153 return $res;
1154}
1155
Joe Perchesa6962d72013-04-29 16:18:13 -07001156sub get_quoted_string {
1157 my ($line, $rawline) = @_;
1158
Joe Perches33acb542015-06-25 15:02:54 -07001159 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001160 return substr($rawline, $-[0], $+[0] - $-[0]);
1161}
1162
Andy Whitcroft8905a672007-11-28 16:21:06 -08001163sub ctx_statement_block {
1164 my ($linenr, $remain, $off) = @_;
1165 my $line = $linenr - 1;
1166 my $blk = '';
1167 my $soff = $off;
1168 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001169 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001170
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001171 my $loff = 0;
1172
Andy Whitcroft8905a672007-11-28 16:21:06 -08001173 my $type = '';
1174 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001175 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001176 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001177 my $c;
1178 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001179
1180 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001181 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001182 @stack = (['', 0]) if ($#stack == -1);
1183
Andy Whitcroft773647a2008-03-28 14:15:58 -07001184 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001185 # If we are about to drop off the end, pull in more
1186 # context.
1187 if ($off >= $len) {
1188 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001189 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001190 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001191 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001192 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001193 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001194 $len = length($blk);
1195 $line++;
1196 last;
1197 }
1198 # Bail if there is no further context.
1199 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001200 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001201 last;
1202 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001203 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1204 $level++;
1205 $type = '#';
1206 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001207 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001208 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001209 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001210 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001211
Andy Whitcroft773647a2008-03-28 14:15:58 -07001212 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001213
1214 # Handle nested #if/#else.
1215 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1216 push(@stack, [ $type, $level ]);
1217 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1218 ($type, $level) = @{$stack[$#stack - 1]};
1219 } elsif ($remainder =~ /^#\s*endif\b/) {
1220 ($type, $level) = @{pop(@stack)};
1221 }
1222
Andy Whitcroft8905a672007-11-28 16:21:06 -08001223 # Statement ends at the ';' or a close '}' at the
1224 # outermost level.
1225 if ($level == 0 && $c eq ';') {
1226 last;
1227 }
1228
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001229 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001230 if ($level == 0 && $coff_set == 0 &&
1231 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1232 $remainder =~ /^(else)(?:\s|{)/ &&
1233 $remainder !~ /^else\s+if\b/) {
1234 $coff = $off + length($1) - 1;
1235 $coff_set = 1;
1236 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1237 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001238 }
1239
Andy Whitcroft8905a672007-11-28 16:21:06 -08001240 if (($type eq '' || $type eq '(') && $c eq '(') {
1241 $level++;
1242 $type = '(';
1243 }
1244 if ($type eq '(' && $c eq ')') {
1245 $level--;
1246 $type = ($level != 0)? '(' : '';
1247
1248 if ($level == 0 && $coff < $soff) {
1249 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001250 $coff_set = 1;
1251 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001252 }
1253 }
1254 if (($type eq '' || $type eq '{') && $c eq '{') {
1255 $level++;
1256 $type = '{';
1257 }
1258 if ($type eq '{' && $c eq '}') {
1259 $level--;
1260 $type = ($level != 0)? '{' : '';
1261
1262 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001263 if (substr($blk, $off + 1, 1) eq ';') {
1264 $off++;
1265 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001266 last;
1267 }
1268 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001269 # Preprocessor commands end at the newline unless escaped.
1270 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1271 $level--;
1272 $type = '';
1273 $off++;
1274 last;
1275 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001276 $off++;
1277 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001278 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001279 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001280 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001281 $line++;
1282 $remain--;
1283 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001284
1285 my $statement = substr($blk, $soff, $off - $soff + 1);
1286 my $condition = substr($blk, $soff, $coff - $soff + 1);
1287
1288 #warn "STATEMENT<$statement>\n";
1289 #warn "CONDITION<$condition>\n";
1290
Andy Whitcroft773647a2008-03-28 14:15:58 -07001291 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001292
1293 return ($statement, $condition,
1294 $line, $remain + 1, $off - $loff + 1, $level);
1295}
1296
Andy Whitcroftcf655042008-03-04 14:28:20 -08001297sub statement_lines {
1298 my ($stmt) = @_;
1299
1300 # Strip the diff line prefixes and rip blank lines at start and end.
1301 $stmt =~ s/(^|\n)./$1/g;
1302 $stmt =~ s/^\s*//;
1303 $stmt =~ s/\s*$//;
1304
1305 my @stmt_lines = ($stmt =~ /\n/g);
1306
1307 return $#stmt_lines + 2;
1308}
1309
1310sub statement_rawlines {
1311 my ($stmt) = @_;
1312
1313 my @stmt_lines = ($stmt =~ /\n/g);
1314
1315 return $#stmt_lines + 2;
1316}
1317
1318sub statement_block_size {
1319 my ($stmt) = @_;
1320
1321 $stmt =~ s/(^|\n)./$1/g;
1322 $stmt =~ s/^\s*{//;
1323 $stmt =~ s/}\s*$//;
1324 $stmt =~ s/^\s*//;
1325 $stmt =~ s/\s*$//;
1326
1327 my @stmt_lines = ($stmt =~ /\n/g);
1328 my @stmt_statements = ($stmt =~ /;/g);
1329
1330 my $stmt_lines = $#stmt_lines + 2;
1331 my $stmt_statements = $#stmt_statements + 1;
1332
1333 if ($stmt_lines > $stmt_statements) {
1334 return $stmt_lines;
1335 } else {
1336 return $stmt_statements;
1337 }
1338}
1339
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001340sub ctx_statement_full {
1341 my ($linenr, $remain, $off) = @_;
1342 my ($statement, $condition, $level);
1343
1344 my (@chunks);
1345
Andy Whitcroftcf655042008-03-04 14:28:20 -08001346 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001347 ($statement, $condition, $linenr, $remain, $off, $level) =
1348 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001349 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001350 push(@chunks, [ $condition, $statement ]);
1351 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1352 return ($level, $linenr, @chunks);
1353 }
1354
1355 # Pull in the following conditional/block pairs and see if they
1356 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001357 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001358 ($statement, $condition, $linenr, $remain, $off, $level) =
1359 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001360 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001361 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001362 #print "C: push\n";
1363 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001364 }
1365
1366 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001367}
1368
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001369sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001370 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001371 my $line;
1372 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001373 my $blk = '';
1374 my @o;
1375 my @c;
1376 my @res = ();
1377
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001378 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001379 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001380 for ($line = $start; $remain > 0; $line++) {
1381 next if ($rawlines[$line] =~ /^-/);
1382 $remain--;
1383
1384 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001385
1386 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001387 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001388 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001389 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001390 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001391 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001392 $level = pop(@stack);
1393 }
1394
Andy Whitcroft01464f32010-10-26 14:23:19 -07001395 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001396 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1397 if ($off > 0) {
1398 $off--;
1399 next;
1400 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001401
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001402 if ($c eq $close && $level > 0) {
1403 $level--;
1404 last if ($level == 0);
1405 } elsif ($c eq $open) {
1406 $level++;
1407 }
1408 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001409
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001410 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001411 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001412 }
1413
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001414 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001415 }
1416
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001417 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001418}
1419sub ctx_block_outer {
1420 my ($linenr, $remain) = @_;
1421
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001422 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1423 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001424}
1425sub ctx_block {
1426 my ($linenr, $remain) = @_;
1427
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001428 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1429 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001430}
1431sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001432 my ($linenr, $remain, $off) = @_;
1433
1434 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1435 return @r;
1436}
1437sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001438 my ($linenr, $remain) = @_;
1439
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001440 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001441}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001442sub ctx_statement_level {
1443 my ($linenr, $remain, $off) = @_;
1444
1445 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1446}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001447
1448sub ctx_locate_comment {
1449 my ($first_line, $end_line) = @_;
1450
1451 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001452 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001453 return $current_comment if (defined $current_comment);
1454
1455 # Look through the context and try and figure out if there is a
1456 # comment.
1457 my $in_comment = 0;
1458 $current_comment = '';
1459 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001460 my $line = $rawlines[$linenr - 1];
1461 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001462 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1463 $in_comment = 1;
1464 }
1465 if ($line =~ m@/\*@) {
1466 $in_comment = 1;
1467 }
1468 if (!$in_comment && $current_comment ne '') {
1469 $current_comment = '';
1470 }
1471 $current_comment .= $line . "\n" if ($in_comment);
1472 if ($line =~ m@\*/@) {
1473 $in_comment = 0;
1474 }
1475 }
1476
1477 chomp($current_comment);
1478 return($current_comment);
1479}
1480sub ctx_has_comment {
1481 my ($first_line, $end_line) = @_;
1482 my $cmt = ctx_locate_comment($first_line, $end_line);
1483
Andy Whitcroft00df3442007-06-08 13:47:06 -07001484 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001485 ##print "CMMT: $cmt\n";
1486
1487 return ($cmt ne '');
1488}
1489
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001490sub raw_line {
1491 my ($linenr, $cnt) = @_;
1492
1493 my $offset = $linenr - 1;
1494 $cnt++;
1495
1496 my $line;
1497 while ($cnt) {
1498 $line = $rawlines[$offset++];
1499 next if (defined($line) && $line =~ /^-/);
1500 $cnt--;
1501 }
1502
1503 return $line;
1504}
1505
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001506sub cat_vet {
1507 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001508 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001509
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001510 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001511 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1512 $res .= $1;
1513 if ($2 ne '') {
1514 $coded = sprintf("^%c", unpack('C', $2) + 64);
1515 $res .= $coded;
1516 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001517 }
1518 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001519
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001520 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001521}
1522
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001523my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001524my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001525my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001526my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001527
1528sub annotate_reset {
1529 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001530 $av_pending = '_';
1531 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001532 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001533}
1534
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001535sub annotate_values {
1536 my ($stream, $type) = @_;
1537
1538 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001539 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001540 my $cur = $stream;
1541
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001542 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001543
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001544 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001545 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001546 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001547 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001548 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001549 print "WS($1)\n" if ($dbg_values > 1);
1550 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001551 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001552 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001553 }
1554
Florian Micklerc023e4732011-01-12 16:59:58 -08001555 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001556 print "CAST($1)\n" if ($dbg_values > 1);
1557 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001558 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001559
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001560 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001561 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001562 $type = 'T';
1563
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001564 } elsif ($cur =~ /^($Modifier)\s*/) {
1565 print "MODIFIER($1)\n" if ($dbg_values > 1);
1566 $type = 'T';
1567
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001568 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001569 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001570 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001571 push(@av_paren_type, $type);
1572 if ($2 ne '') {
1573 $av_pending = 'N';
1574 }
1575 $type = 'E';
1576
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001577 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001578 print "UNDEF($1)\n" if ($dbg_values > 1);
1579 $av_preprocessor = 1;
1580 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001581
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001582 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001583 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001584 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001585
1586 push(@av_paren_type, $type);
1587 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001588 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001589
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001590 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001591 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1592 $av_preprocessor = 1;
1593
1594 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1595
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001596 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001597
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001598 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001599 print "PRE_END($1)\n" if ($dbg_values > 1);
1600
1601 $av_preprocessor = 1;
1602
1603 # Assume all arms of the conditional end as this
1604 # one does, and continue as if the #endif was not here.
1605 pop(@av_paren_type);
1606 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001607 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001608
1609 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001610 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001611
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001612 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1613 print "ATTR($1)\n" if ($dbg_values > 1);
1614 $av_pending = $type;
1615 $type = 'N';
1616
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001617 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001618 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001619 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001620 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001621 }
1622 $type = 'N';
1623
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001624 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001625 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001626 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001627 $type = 'N';
1628
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001629 } elsif ($cur =~/^(case)/o) {
1630 print "CASE($1)\n" if ($dbg_values > 1);
1631 $av_pend_colon = 'C';
1632 $type = 'N';
1633
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001634 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001635 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001636 $type = 'N';
1637
1638 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001639 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001640 push(@av_paren_type, $av_pending);
1641 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001642 $type = 'N';
1643
1644 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001645 my $new_type = pop(@av_paren_type);
1646 if ($new_type ne '_') {
1647 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001648 print "PAREN('$1') -> $type\n"
1649 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001650 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001651 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652 }
1653
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001654 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001655 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001656 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001657 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001658
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001659 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1660 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001661 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001662 } elsif ($type eq 'E') {
1663 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001664 }
1665 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1666 $type = 'V';
1667
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001668 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001669 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001670 $type = 'V';
1671
1672 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001673 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001674 $type = 'N';
1675
Andy Whitcroftcf655042008-03-04 14:28:20 -08001676 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001677 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001678 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001679 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001680
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001681 } elsif ($cur =~/^(,)/) {
1682 print "COMMA($1)\n" if ($dbg_values > 1);
1683 $type = 'C';
1684
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001685 } elsif ($cur =~ /^(\?)/o) {
1686 print "QUESTION($1)\n" if ($dbg_values > 1);
1687 $type = 'N';
1688
1689 } elsif ($cur =~ /^(:)/o) {
1690 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1691
1692 substr($var, length($res), 1, $av_pend_colon);
1693 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1694 $type = 'E';
1695 } else {
1696 $type = 'N';
1697 }
1698 $av_pend_colon = 'O';
1699
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001700 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001701 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001702 $type = 'N';
1703
Andy Whitcroft0d413862008-10-15 22:02:16 -07001704 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001705 my $variant;
1706
1707 print "OPV($1)\n" if ($dbg_values > 1);
1708 if ($type eq 'V') {
1709 $variant = 'B';
1710 } else {
1711 $variant = 'U';
1712 }
1713
1714 substr($var, length($res), 1, $variant);
1715 $type = 'N';
1716
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001717 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001719 if ($1 ne '++' && $1 ne '--') {
1720 $type = 'N';
1721 }
1722
1723 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001724 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001725 }
1726 if (defined $1) {
1727 $cur = substr($cur, length($1));
1728 $res .= $type x length($1);
1729 }
1730 }
1731
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001732 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001733}
1734
Andy Whitcroft8905a672007-11-28 16:21:06 -08001735sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001736 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001737 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001738 ^(?:
1739 $Modifier|
1740 $Storage|
1741 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001742 DEFINE_\S+
1743 )$|
1744 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001745 goto|
1746 return|
1747 case|
1748 else|
1749 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001750 do|
1751 \#|
1752 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001753 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001754 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001755 )}x;
1756 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1757 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001758 # Check for modifiers.
1759 $possible =~ s/\s*$Storage\s*//g;
1760 $possible =~ s/\s*$Sparse\s*//g;
1761 if ($possible =~ /^\s*$/) {
1762
1763 } elsif ($possible =~ /\s/) {
1764 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001765 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001766 if ($modifier !~ $notPermitted) {
1767 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001768 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001769 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001770 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001771
1772 } else {
1773 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001774 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001775 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001776 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001777 } else {
1778 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001779 }
1780}
1781
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001782my $prefix = '';
1783
Joe Perches000d1cc12011-07-25 17:13:25 -07001784sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001785 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001786
Joe Perchescbec18a2014-04-03 14:49:19 -07001787 return defined $use_type{$type} if (scalar keys %use_type > 0);
1788
1789 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001790}
1791
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001792sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001793 my ($level, $type, $msg) = @_;
1794
1795 if (!show_type($type) ||
1796 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001797 return 0;
1798 }
Joe Perches57230292015-06-25 15:03:03 -07001799 my $output = '';
1800 if (-t STDOUT && $color) {
1801 if ($level eq 'ERROR') {
1802 $output .= RED;
1803 } elsif ($level eq 'WARNING') {
1804 $output .= YELLOW;
1805 } else {
1806 $output .= GREEN;
1807 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001808 }
Joe Perches57230292015-06-25 15:03:03 -07001809 $output .= $prefix . $level . ':';
1810 if ($show_types) {
1811 $output .= BLUE if (-t STDOUT && $color);
1812 $output .= "$type:";
1813 }
1814 $output .= RESET if (-t STDOUT && $color);
1815 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001816
1817 if ($showfile) {
1818 my @lines = split("\n", $output, -1);
1819 splice(@lines, 1, 1);
1820 $output = join("\n", @lines);
1821 }
Joe Perches57230292015-06-25 15:03:03 -07001822 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001823
Joe Perches57230292015-06-25 15:03:03 -07001824 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001825
1826 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001827}
Joe Perchescbec18a2014-04-03 14:49:19 -07001828
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001829sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001830 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001831}
Joe Perches000d1cc12011-07-25 17:13:25 -07001832
Joe Perchesd752fcc2014-08-06 16:11:05 -07001833sub fixup_current_range {
1834 my ($lineRef, $offset, $length) = @_;
1835
1836 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1837 my $o = $1;
1838 my $l = $2;
1839 my $no = $o + $offset;
1840 my $nl = $l + $length;
1841 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1842 }
1843}
1844
1845sub fix_inserted_deleted_lines {
1846 my ($linesRef, $insertedRef, $deletedRef) = @_;
1847
1848 my $range_last_linenr = 0;
1849 my $delta_offset = 0;
1850
1851 my $old_linenr = 0;
1852 my $new_linenr = 0;
1853
1854 my $next_insert = 0;
1855 my $next_delete = 0;
1856
1857 my @lines = ();
1858
1859 my $inserted = @{$insertedRef}[$next_insert++];
1860 my $deleted = @{$deletedRef}[$next_delete++];
1861
1862 foreach my $old_line (@{$linesRef}) {
1863 my $save_line = 1;
1864 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001865 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001866 $delta_offset = 0;
1867 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1868 $range_last_linenr = $new_linenr;
1869 fixup_current_range(\$line, $delta_offset, 0);
1870 }
1871
1872 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1873 $deleted = @{$deletedRef}[$next_delete++];
1874 $save_line = 0;
1875 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1876 }
1877
1878 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1879 push(@lines, ${$inserted}{'LINE'});
1880 $inserted = @{$insertedRef}[$next_insert++];
1881 $new_linenr++;
1882 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1883 }
1884
1885 if ($save_line) {
1886 push(@lines, $line);
1887 $new_linenr++;
1888 }
1889
1890 $old_linenr++;
1891 }
1892
1893 return @lines;
1894}
1895
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001896sub fix_insert_line {
1897 my ($linenr, $line) = @_;
1898
1899 my $inserted = {
1900 LINENR => $linenr,
1901 LINE => $line,
1902 };
1903 push(@fixed_inserted, $inserted);
1904}
1905
1906sub fix_delete_line {
1907 my ($linenr, $line) = @_;
1908
1909 my $deleted = {
1910 LINENR => $linenr,
1911 LINE => $line,
1912 };
1913
1914 push(@fixed_deleted, $deleted);
1915}
1916
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001917sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001918 my ($type, $msg) = @_;
1919
1920 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001921 our $clean = 0;
1922 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001923 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001924 }
Joe Perches3705ce52013-07-03 15:05:31 -07001925 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001926}
1927sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001928 my ($type, $msg) = @_;
1929
1930 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001931 our $clean = 0;
1932 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001933 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001934 }
Joe Perches3705ce52013-07-03 15:05:31 -07001935 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001936}
1937sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001938 my ($type, $msg) = @_;
1939
1940 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001941 our $clean = 0;
1942 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001943 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001944 }
Joe Perches3705ce52013-07-03 15:05:31 -07001945 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001946}
1947
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001948sub check_absolute_file {
1949 my ($absolute, $herecurr) = @_;
1950 my $file = $absolute;
1951
1952 ##print "absolute<$absolute>\n";
1953
1954 # See if any suffix of this path is a path within the tree.
1955 while ($file =~ s@^[^/]*/@@) {
1956 if (-f "$root/$file") {
1957 ##print "file<$file>\n";
1958 last;
1959 }
1960 }
1961 if (! -f _) {
1962 return 0;
1963 }
1964
1965 # It is, so see if the prefix is acceptable.
1966 my $prefix = $absolute;
1967 substr($prefix, -length($file)) = '';
1968
1969 ##print "prefix<$prefix>\n";
1970 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001971 WARN("USE_RELATIVE_PATH",
1972 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001973 }
1974}
1975
Joe Perches3705ce52013-07-03 15:05:31 -07001976sub trim {
1977 my ($string) = @_;
1978
Joe Perchesb34c6482013-09-11 14:24:01 -07001979 $string =~ s/^\s+|\s+$//g;
1980
1981 return $string;
1982}
1983
1984sub ltrim {
1985 my ($string) = @_;
1986
1987 $string =~ s/^\s+//;
1988
1989 return $string;
1990}
1991
1992sub rtrim {
1993 my ($string) = @_;
1994
1995 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001996
1997 return $string;
1998}
1999
Joe Perches52ea8502013-11-12 15:10:09 -08002000sub string_find_replace {
2001 my ($string, $find, $replace) = @_;
2002
2003 $string =~ s/$find/$replace/g;
2004
2005 return $string;
2006}
2007
Joe Perches3705ce52013-07-03 15:05:31 -07002008sub tabify {
2009 my ($leading) = @_;
2010
2011 my $source_indent = 8;
2012 my $max_spaces_before_tab = $source_indent - 1;
2013 my $spaces_to_tab = " " x $source_indent;
2014
2015 #convert leading spaces to tabs
2016 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2017 #Remove spaces before a tab
2018 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2019
2020 return "$leading";
2021}
2022
Gregory Beanf07523e2011-07-06 15:36:58 -07002023sub cleanup_continuation_headers {
2024 # Collapse any header-continuation lines into a single line so they
2025 # can be parsed meaningfully, as the parser only has one line
2026 # of context to work with.
2027 my $again;
2028 do {
2029 $again = 0;
2030 foreach my $n (0 .. scalar(@rawlines) - 2) {
2031 if ($rawlines[$n]=~/^\s*$/) {
2032 # A blank line means there's no more chance
2033 # of finding headers. Shortcut to done.
2034 return;
2035 }
2036 if ($rawlines[$n]=~/^[\x21-\x39\x3b-\x7e]+:/ &&
2037 $rawlines[$n+1]=~/^\s+/) {
2038 # Continuation header. Collapse it.
2039 my $line = splice @rawlines, $n+1, 1;
2040 $line=~s/^\s+/ /;
2041 $rawlines[$n] .= $line;
2042 # We've 'destabilized' the list, so restart.
2043 $again = 1;
2044 last;
2045 }
2046 }
2047 } while ($again);
2048}
2049
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002050sub pos_last_openparen {
2051 my ($line) = @_;
2052
2053 my $pos = 0;
2054
2055 my $opens = $line =~ tr/\(/\(/;
2056 my $closes = $line =~ tr/\)/\)/;
2057
2058 my $last_openparen = 0;
2059
2060 if (($opens == 0) || ($closes >= $opens)) {
2061 return -1;
2062 }
2063
2064 my $len = length($line);
2065
2066 for ($pos = 0; $pos < $len; $pos++) {
2067 my $string = substr($line, $pos);
2068 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2069 $pos += length($1) - 1;
2070 } elsif (substr($line, $pos, 1) eq '(') {
2071 $last_openparen = $pos;
2072 } elsif (index($string, '(') == -1) {
2073 last;
2074 }
2075 }
2076
Joe Perches91cb5192014-04-03 14:49:32 -07002077 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002078}
2079
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002080sub process {
2081 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002082
2083 my $linenr=0;
2084 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002085 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002086 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002087 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002088
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002089 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002090 my $indent;
2091 my $previndent=0;
2092 my $stashindent=0;
2093
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002094 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002095 my $signoff = 0;
2096 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002097 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002098 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002099 my $has_commit_log = 0; #Encountered lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002100 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002101 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002102 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002103 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002104 my $non_utf8_charset = 0;
2105
Joe Perches365dd4e2014-08-06 16:10:42 -07002106 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002107 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002108
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002109 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002110 our $cnt_lines = 0;
2111 our $cnt_error = 0;
2112 our $cnt_warn = 0;
2113 our $cnt_chk = 0;
2114
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002115 # Trace the real file/line as we go.
2116 my $realfile = '';
2117 my $realline = 0;
2118 my $realcnt = 0;
2119 my $here = '';
2120 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002121 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002122 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002123 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002124
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002125 my $prev_values = 'E';
2126
2127 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002128 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002129 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002130 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002131 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002132
Joe Perches7e51f192013-09-11 14:23:57 -07002133 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002134
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002135 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002136 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002137 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002138 my @setup_docs = ();
2139 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002140
Joe Perchesd8b07712013-11-12 15:10:06 -08002141 my $camelcase_file_seeded = 0;
2142
Andy Whitcroft773647a2008-03-28 14:15:58 -07002143 sanitise_line_reset();
Gregory Beanf07523e2011-07-06 15:36:58 -07002144 cleanup_continuation_headers();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002145 my $line;
Gregory Beanf07523e2011-07-06 15:36:58 -07002146
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002147 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002148 $linenr++;
2149 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002150
Joe Perches3705ce52013-07-03 15:05:31 -07002151 push(@fixed, $rawline) if ($fix);
2152
Andy Whitcroft773647a2008-03-28 14:15:58 -07002153 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002154 $setup_docs = 0;
2155 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2156 $setup_docs = 1;
2157 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002158 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002159 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002160 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2161 $realline=$1-1;
2162 if (defined $2) {
2163 $realcnt=$3+1;
2164 } else {
2165 $realcnt=1+1;
2166 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002167 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002168
2169 # Guestimate if this is a continuing comment. Run
2170 # the context looking for a comment "edge". If this
2171 # edge is a close comment then we must be in a comment
2172 # at context start.
2173 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002174 my $cnt = $realcnt;
2175 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2176 next if (defined $rawlines[$ln - 1] &&
2177 $rawlines[$ln - 1] =~ /^-/);
2178 $cnt--;
2179 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002180 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002181 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2182 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2183 ($edge) = $1;
2184 last;
2185 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002186 }
2187 if (defined $edge && $edge eq '*/') {
2188 $in_comment = 1;
2189 }
2190
2191 # Guestimate if this is a continuing comment. If this
2192 # is the start of a diff block and this line starts
2193 # ' *' then it is very likely a comment.
2194 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002195 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002196 {
2197 $in_comment = 1;
2198 }
2199
2200 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2201 sanitise_line_reset($in_comment);
2202
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002203 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002204 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002205 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002206 $line = sanitise_line($rawline);
2207 }
2208 push(@lines, $line);
2209
2210 if ($realcnt > 1) {
2211 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2212 } else {
2213 $realcnt = 0;
2214 }
2215
2216 #print "==>$rawline\n";
2217 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002218
2219 if ($setup_docs && $line =~ /^\+/) {
2220 push(@setup_docs, $line);
2221 }
2222 }
2223
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002224 $prefix = '';
2225
Andy Whitcroft773647a2008-03-28 14:15:58 -07002226 $realcnt = 0;
2227 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002228 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002229 foreach my $line (@lines) {
2230 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002231 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002232 my $sline = $line; #copy of $line
2233 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002234
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002235 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002236
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002237#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002238 if (!$in_commit_log &&
2239 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002240 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002241 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002242 $realline=$1-1;
2243 if (defined $2) {
2244 $realcnt=$3+1;
2245 } else {
2246 $realcnt=1+1;
2247 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002248 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002249 $prev_values = 'E';
2250
Andy Whitcroft773647a2008-03-28 14:15:58 -07002251 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002252 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002253 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002254 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002255 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002256
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002257# track the line number as we move through the hunk, note that
2258# new versions of GNU diff omit the leading space on completely
2259# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002260 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002261 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002262 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002263
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002264 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002265 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002266
2267 # Track the previous line.
2268 ($prevline, $stashline) = ($stashline, $line);
2269 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002270 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2271
Andy Whitcroft773647a2008-03-28 14:15:58 -07002272 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002273
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002274 } elsif ($realcnt == 1) {
2275 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002276 }
2277
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002278 my $hunk_line = ($realcnt != 0);
2279
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002280 $here = "#$linenr: " if (!$file);
2281 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002282
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002283 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002284 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002285 if ($line =~ /^diff --git.*?(\S+)$/) {
2286 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002287 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002288 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002289 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002290 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002291 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002292 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002293 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002294
2295 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002296 if (!$file && $tree && $p1_prefix ne '' &&
2297 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002298 WARN("PATCH_PREFIX",
2299 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002300 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002301
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002302 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002303 ERROR("MODIFIED_INCLUDE_ASM",
2304 "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 -07002305 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002306 $found_file = 1;
2307 }
2308
Joe Perches34d88152015-06-25 15:03:05 -07002309#make up the handle for any error we report on this line
2310 if ($showfile) {
2311 $prefix = "$realfile:$realline: "
2312 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002313 if ($file) {
2314 $prefix = "$filename:$realline: ";
2315 } else {
2316 $prefix = "$filename:$linenr: ";
2317 }
Joe Perches34d88152015-06-25 15:03:05 -07002318 }
2319
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002320 if ($found_file) {
Joe Perches7bd7e482015-09-09 15:37:44 -07002321 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002322 $check = 1;
2323 } else {
2324 $check = $check_orig;
2325 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002326 next;
2327 }
2328
Randy Dunlap389834b2007-06-08 13:47:03 -07002329 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002330
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002331 my $hereline = "$here\n$rawline\n";
2332 my $herecurr = "$here\n$rawline\n";
2333 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002334
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002335 $cnt_lines++ if ($realcnt != 0);
2336
Joe Perchese518e9a2015-06-25 15:03:27 -07002337# Check if the commit log has what seems like a diff which can confuse patch
2338 if ($in_commit_log && !$commit_log_has_diff &&
2339 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2340 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2341 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2342 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2343 ERROR("DIFF_IN_COMMIT_MSG",
2344 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2345 $commit_log_has_diff = 1;
2346 }
2347
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002348# Check for incorrect file permissions
2349 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2350 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002351 if ($realfile !~ m@scripts/@ &&
2352 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002353 ERROR("EXECUTE_PERMISSIONS",
2354 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002355 }
2356 }
2357
Joe Perches20112472011-07-25 17:13:23 -07002358# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002359 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002360 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002361 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002362 }
2363
Joe Perchese0d975b2014-12-10 15:51:49 -08002364# Check if MAINTAINERS is being updated. If so, there's probably no need to
2365# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2366 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2367 $reported_maintainer_file = 1;
2368 }
2369
Joe Perches20112472011-07-25 17:13:23 -07002370# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002371 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002372 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002373 my $space_before = $1;
2374 my $sign_off = $2;
2375 my $space_after = $3;
2376 my $email = $4;
2377 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2378
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002379 if ($sign_off !~ /$signature_tags/) {
2380 WARN("BAD_SIGN_OFF",
2381 "Non-standard signature: $sign_off\n" . $herecurr);
2382 }
Joe Perches20112472011-07-25 17:13:23 -07002383 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002384 if (WARN("BAD_SIGN_OFF",
2385 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2386 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002387 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002388 "$ucfirst_sign_off $email";
2389 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002390 }
Joe Perches20112472011-07-25 17:13:23 -07002391 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002392 if (WARN("BAD_SIGN_OFF",
2393 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2394 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002395 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002396 "$ucfirst_sign_off $email";
2397 }
2398
Joe Perches20112472011-07-25 17:13:23 -07002399 }
2400 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002401 if (WARN("BAD_SIGN_OFF",
2402 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2403 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002404 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002405 "$ucfirst_sign_off $email";
2406 }
Joe Perches20112472011-07-25 17:13:23 -07002407 }
2408
2409 my ($email_name, $email_address, $comment) = parse_email($email);
2410 my $suggested_email = format_email(($email_name, $email_address));
2411 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002412 ERROR("BAD_SIGN_OFF",
2413 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002414 } else {
2415 my $dequoted = $suggested_email;
2416 $dequoted =~ s/^"//;
2417 $dequoted =~ s/" </ </;
2418 # Don't force email to have quotes
2419 # Allow just an angle bracketed address
2420 if ("$dequoted$comment" ne $email &&
2421 "<$email_address>$comment" ne $email &&
2422 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002423 WARN("BAD_SIGN_OFF",
2424 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002425 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002426 }
Bryan Huntsmanb000c782010-05-04 17:31:32 -07002427 if ($line =~ /^\s*signed-off-by:.*(quicinc|qualcomm)\.com/i) {
2428 WARN("BAD_SIGN_OFF",
2429 "invalid Signed-off-by identity\n" . $line );
2430 }
Joe Perches7e51f192013-09-11 14:23:57 -07002431
2432# Check for duplicate signatures
2433 my $sig_nospace = $line;
2434 $sig_nospace =~ s/\s//g;
2435 $sig_nospace = lc($sig_nospace);
2436 if (defined $signatures{$sig_nospace}) {
2437 WARN("BAD_SIGN_OFF",
2438 "Duplicate signature\n" . $herecurr);
2439 } else {
2440 $signatures{$sig_nospace} = 1;
2441 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002442 }
2443
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002444# Check email subject for common tools that don't need to be mentioned
2445 if ($in_header_lines &&
2446 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2447 WARN("EMAIL_SUBJECT",
2448 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2449 }
2450
Joe Perches9b3189e2014-06-04 16:12:10 -07002451# Check for old stable address
2452 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2453 ERROR("STABLE_ADDRESS",
2454 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2455 }
2456
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002457# Check for unwanted Gerrit info
2458 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2459 ERROR("GERRIT_CHANGE_ID",
2460 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2461 }
2462
Joe Perches369c8dd2015-11-06 16:31:34 -08002463# Check if the commit log is in a possible stack dump
2464 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2465 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2466 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2467 # timestamp
2468 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2469 # stack dump address
2470 $commit_log_possible_stack_dump = 1;
2471 }
2472
Joe Perches2a076f42015-04-16 12:44:28 -07002473# Check for line lengths > 75 in commit log, warn once
2474 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002475 length($line) > 75 &&
2476 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2477 # file delta changes
2478 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2479 # filename then :
2480 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2481 # A Fixes: or Link: line
2482 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002483 WARN("COMMIT_LOG_LONG_LINE",
2484 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2485 $commit_log_long_line = 1;
2486 }
2487
Joe Perchesbf4daf12015-09-09 15:37:50 -07002488# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002489 if ($in_commit_log && $commit_log_possible_stack_dump &&
2490 $line =~ /^\s*$/) {
2491 $commit_log_possible_stack_dump = 0;
2492 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002493
Joe Perches0d7835f2015-02-13 14:38:35 -08002494# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002495 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002496 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002497 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002498 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002499 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2500 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002501 my $init_char = "c";
2502 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002503 my $short = 1;
2504 my $long = 0;
2505 my $case = 1;
2506 my $space = 1;
2507 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002508 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002509 my $id = '0123456789ab';
2510 my $orig_desc = "commit description";
2511 my $description = "";
2512
Joe Perchesfe043ea2015-09-09 15:37:25 -07002513 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2514 $init_char = $1;
2515 $orig_commit = lc($2);
2516 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2517 $orig_commit = lc($1);
2518 }
2519
Joe Perches0d7835f2015-02-13 14:38:35 -08002520 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2521 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2522 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2523 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2524 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2525 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002526 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002527 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2528 defined $rawlines[$linenr] &&
2529 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2530 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002531 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002532 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2533 defined $rawlines[$linenr] &&
2534 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2535 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2536 $orig_desc = $1;
2537 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2538 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002539 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002540 }
2541
2542 ($id, $description) = git_commit_info($orig_commit,
2543 $id, $orig_desc);
2544
Joe Perches19c146a2015-02-13 14:39:00 -08002545 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002546 ERROR("GIT_COMMIT_ID",
2547 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2548 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002549 }
2550
Joe Perches13f19372014-08-06 16:10:59 -07002551# Check for added, moved or deleted files
2552 if (!$reported_maintainer_file && !$in_commit_log &&
2553 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2554 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2555 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2556 (defined($1) || defined($2))))) {
2557 $reported_maintainer_file = 1;
2558 WARN("FILE_PATH_CHANGES",
2559 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2560 }
2561
Bryan Huntsmanb000c782010-05-04 17:31:32 -07002562#check the patch for invalid author credentials
2563 if ($line =~ /^From:.*(quicinc|qualcomm)\.com/) {
2564 WARN("BAD_AUTHOR", "invalid author identity\n" . $line );
2565 }
2566
Andy Whitcroft00df3442007-06-08 13:47:06 -07002567# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002568 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002569 ERROR("CORRUPTED_PATCH",
2570 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002571 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002572 }
2573
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002574# Check for absolute kernel paths.
2575 if ($tree) {
2576 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2577 my $file = $1;
2578
2579 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2580 check_absolute_file($1, $herecurr)) {
2581 #
2582 } else {
2583 check_absolute_file($file, $herecurr);
2584 }
2585 }
2586 }
2587
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002588# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2589 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002590 $rawline !~ m/^$UTF8*$/) {
2591 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2592
2593 my $blank = copy_spacing($rawline);
2594 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2595 my $hereptr = "$hereline$ptr\n";
2596
Joe Perches34d99212011-07-25 17:13:26 -07002597 CHK("INVALID_UTF8",
2598 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002599 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002600
Joe Perches15662b32011-10-31 17:13:12 -07002601# Check if it's the start of a commit log
2602# (not a header line and we haven't seen the patch filename)
2603 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002604 !($rawline =~ /^\s+\S/ ||
2605 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002606 $in_header_lines = 0;
2607 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002608 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002609 }
2610
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002611# Check if there is UTF-8 in a commit log when a mail header has explicitly
2612# declined it, i.e defined some charset where it is missing.
2613 if ($in_header_lines &&
2614 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2615 $1 !~ /utf-8/i) {
2616 $non_utf8_charset = 1;
2617 }
2618
2619 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002620 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002621 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002622 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2623 }
2624
Kees Cook66b47b42014-10-13 15:51:57 -07002625# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002626 if (defined($misspellings) &&
2627 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002628 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002629 my $typo = $1;
2630 my $typo_fix = $spelling_fix{lc($typo)};
2631 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2632 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2633 my $msg_type = \&WARN;
2634 $msg_type = \&CHK if ($file);
2635 if (&{$msg_type}("TYPO_SPELLING",
2636 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2637 $fix) {
2638 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2639 }
2640 }
2641 }
2642
Andy Whitcroft306708542008-10-15 22:02:28 -07002643# ignore non-hunk lines and lines being removed
2644 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002645
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002646#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002647 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002648 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002649 if (ERROR("DOS_LINE_ENDINGS",
2650 "DOS line endings\n" . $herevet) &&
2651 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002652 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002653 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002654 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2655 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002656 if (ERROR("TRAILING_WHITESPACE",
2657 "trailing whitespace\n" . $herevet) &&
2658 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002659 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002660 }
2661
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002662 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002663 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002664
Josh Triplett4783f892013-11-12 15:10:12 -08002665# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002666 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002667 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2668 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002669 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2670 my $msg_type = \&ERROR;
2671 $msg_type = \&CHK if ($file);
2672 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002673 "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 -08002674 }
2675
Andi Kleen33549572010-05-24 14:33:29 -07002676# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002677# Only applies when adding the entry originally, after that we do not have
2678# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002679 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002680 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002681 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002682 my $cnt = $realcnt;
2683 my $ln = $linenr + 1;
2684 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002685 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002686 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002687 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002688 $f = $lines[$ln - 1];
2689 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2690 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002691
2692 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002693 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002694
Joe Perches8d73e0e2014-08-06 16:10:46 -07002695 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002696 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002697 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002698 $length = -1;
2699 }
2700
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002701 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002702 $f =~ s/#.*//;
2703 $f =~ s/^\s+//;
2704 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002705 if ($f =~ /^\s*config\s/) {
2706 $is_end = 1;
2707 last;
2708 }
Andi Kleen33549572010-05-24 14:33:29 -07002709 $length++;
2710 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002711 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2712 WARN("CONFIG_DESCRIPTION",
2713 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2714 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002715 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002716 }
2717
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002718# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2719 if ($realfile =~ /Kconfig/ &&
2720 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2721 WARN("CONFIG_EXPERIMENTAL",
2722 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2723 }
2724
Christoph Jaeger327953e2015-02-13 14:38:29 -08002725# discourage the use of boolean for type definition attributes of Kconfig options
2726 if ($realfile =~ /Kconfig/ &&
2727 $line =~ /^\+\s*\bboolean\b/) {
2728 WARN("CONFIG_TYPE_BOOLEAN",
2729 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2730 }
2731
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002732 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2733 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2734 my $flag = $1;
2735 my $replacement = {
2736 'EXTRA_AFLAGS' => 'asflags-y',
2737 'EXTRA_CFLAGS' => 'ccflags-y',
2738 'EXTRA_CPPFLAGS' => 'cppflags-y',
2739 'EXTRA_LDFLAGS' => 'ldflags-y',
2740 };
2741
2742 WARN("DEPRECATED_VARIABLE",
2743 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2744 }
2745
Rob Herringbff5da42014-01-23 15:54:51 -08002746# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002747 if (defined $root &&
2748 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2749 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2750
Rob Herringbff5da42014-01-23 15:54:51 -08002751 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2752
Florian Vaussardcc933192014-04-03 14:49:27 -07002753 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2754 my $vp_file = $dt_path . "vendor-prefixes.txt";
2755
Rob Herringbff5da42014-01-23 15:54:51 -08002756 foreach my $compat (@compats) {
2757 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002758 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2759 my $compat3 = $compat;
2760 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2761 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002762 if ( $? >> 8 ) {
2763 WARN("UNDOCUMENTED_DT_STRING",
2764 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2765 }
2766
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002767 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2768 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002769 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002770 if ( $? >> 8 ) {
2771 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002772 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002773 }
2774 }
2775 }
2776
Andy Whitcroft5368df22008-10-15 22:02:27 -07002777# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002778 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002779
Joe Perches47e0c882015-06-25 15:02:57 -07002780# line length limit (with some exclusions)
2781#
2782# There are a few types of lines that may extend beyond $max_line_length:
2783# logging functions like pr_info that end in a string
2784# lines with a single string
2785# #defines that are a single string
2786#
2787# There are 3 different line length message types:
2788# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2789# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2790# LONG_LINE all other lines longer than $max_line_length
2791#
2792# if LONG_LINE is ignored, the other 2 types are also ignored
2793#
Israel Schlesingerc5955792010-07-27 13:28:26 -07002794 if ($line =~ /^\+/ && $length > $max_line_length && $realfile ne "scripts/checkpatch.pl") {
Joe Perches47e0c882015-06-25 15:02:57 -07002795 my $msg_type = "LONG_LINE";
2796
2797 # Check the allowed long line types first
2798
2799 # logging functions that end in a string that starts
2800 # before $max_line_length
2801 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2802 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2803 $msg_type = "";
2804
2805 # lines with only strings (w/ possible termination)
2806 # #defines with only strings
2807 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2808 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2809 $msg_type = "";
2810
Joe Perchesd560a5f2016-08-02 14:04:31 -07002811 # EFI_GUID is another special case
2812 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2813 $msg_type = "";
2814
Joe Perches47e0c882015-06-25 15:02:57 -07002815 # Otherwise set the alternate message types
2816
2817 # a comment starts before $max_line_length
2818 } elsif ($line =~ /($;[\s$;]*)$/ &&
2819 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2820 $msg_type = "LONG_LINE_COMMENT"
2821
2822 # a quoted string starts before $max_line_length
2823 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2824 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2825 $msg_type = "LONG_LINE_STRING"
2826 }
2827
2828 if ($msg_type ne "" &&
2829 (show_type("LONG_LINE") || show_type($msg_type))) {
2830 WARN($msg_type,
2831 "line over $max_line_length characters\n" . $herecurr);
2832 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002833 }
2834
Andy Whitcroft8905a672007-11-28 16:21:06 -08002835# check for adding lines without a newline.
2836 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002837 WARN("MISSING_EOF_NEWLINE",
2838 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002839 }
2840
Mike Frysinger42e41c52009-09-21 17:04:40 -07002841# Blackfin: use hi/lo macros
2842 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2843 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2844 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002845 ERROR("LO_MACRO",
2846 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002847 }
2848 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2849 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002850 ERROR("HI_MACRO",
2851 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002852 }
2853 }
2854
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002855# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002856 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002857
2858# at the beginning of a line any tabs must come first and anything
2859# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002860 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2861 $rawline =~ /^\+\s* \s*/) {
2862 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002863 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002864 if (ERROR("CODE_INDENT",
2865 "code indent should use tabs where possible\n" . $herevet) &&
2866 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002867 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002868 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002869 }
2870
Alberto Panizzo08e44362010-03-05 13:43:54 -08002871# check for space before tabs.
2872 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2873 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002874 if (WARN("SPACE_BEFORE_TAB",
2875 "please, no space before tabs\n" . $herevet) &&
2876 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002877 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002878 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002879 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002880 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002881 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002882 }
2883
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002884# check for && or || at the start of a line
2885 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2886 CHK("LOGICAL_CONTINUATIONS",
2887 "Logical continuations should be on the previous line\n" . $hereprev);
2888 }
2889
Joe Perchesa91e8992016-05-20 17:04:05 -07002890# check indentation starts on a tab stop
2891 if ($^V && $^V ge 5.10.0 &&
2892 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2893 my $indent = length($1);
2894 if ($indent % 8) {
2895 if (WARN("TABSTOP",
2896 "Statements should start on a tabstop\n" . $herecurr) &&
2897 $fix) {
2898 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2899 }
2900 }
2901 }
2902
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002903# check multi-line statement indentation matches previous line
2904 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002905 $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 -07002906 $prevline =~ /^\+(\t*)(.*)$/;
2907 my $oldindent = $1;
2908 my $rest = $2;
2909
2910 my $pos = pos_last_openparen($rest);
2911 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002912 $line =~ /^(\+| )([ \t]*)/;
2913 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002914
2915 my $goodtabindent = $oldindent .
2916 "\t" x ($pos / 8) .
2917 " " x ($pos % 8);
2918 my $goodspaceindent = $oldindent . " " x $pos;
2919
2920 if ($newindent ne $goodtabindent &&
2921 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002922
2923 if (CHK("PARENTHESIS_ALIGNMENT",
2924 "Alignment should match open parenthesis\n" . $hereprev) &&
2925 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002926 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002927 s/^\+[ \t]*/\+$goodtabindent/;
2928 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002929 }
2930 }
2931 }
2932
Joe Perches6ab3a972015-04-16 12:44:05 -07002933# check for space after cast like "(int) foo" or "(struct foo) bar"
2934# avoid checking a few false positives:
2935# "sizeof(<type>)" or "__alignof__(<type>)"
2936# function pointer declarations like "(*foo)(int) = bar;"
2937# structure definitions like "(struct foo) { 0 };"
2938# multiline macros that define functions
2939# known attributes or the __attribute__ keyword
2940 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2941 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002942 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002943 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002944 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002945 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002946 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002947 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002948 }
2949
Joe Perches86406b12015-09-09 15:37:41 -07002950# Block comment styles
2951# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002952 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002953 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002954 $rawline =~ /^\+[ \t]*\*/ &&
2955 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002956 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2957 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2958 }
2959
Joe Perches86406b12015-09-09 15:37:41 -07002960# Block comments use * on subsequent lines
2961 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2962 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002963 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002964 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002965 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002966 WARN("BLOCK_COMMENT_STYLE",
2967 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002968 }
2969
Joe Perches86406b12015-09-09 15:37:41 -07002970# Block comments use */ on trailing lines
2971 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002972 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2973 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2974 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002975 WARN("BLOCK_COMMENT_STYLE",
2976 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002977 }
2978
Joe Perches7f619192014-08-06 16:10:39 -07002979# check for missing blank lines after struct/union declarations
2980# with exceptions for various attributes and macros
2981 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2982 $line =~ /^\+/ &&
2983 !($line =~ /^\+\s*$/ ||
2984 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2985 $line =~ /^\+\s*MODULE_/i ||
2986 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2987 $line =~ /^\+[a-z_]*init/ ||
2988 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2989 $line =~ /^\+\s*DECLARE/ ||
2990 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002991 if (CHK("LINE_SPACING",
2992 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2993 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002994 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002995 }
Joe Perches7f619192014-08-06 16:10:39 -07002996 }
2997
Joe Perches365dd4e2014-08-06 16:10:42 -07002998# check for multiple consecutive blank lines
2999 if ($prevline =~ /^[\+ ]\s*$/ &&
3000 $line =~ /^\+\s*$/ &&
3001 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003002 if (CHK("LINE_SPACING",
3003 "Please don't use multiple blank lines\n" . $hereprev) &&
3004 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003005 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003006 }
3007
Joe Perches365dd4e2014-08-06 16:10:42 -07003008 $last_blank_line = $linenr;
3009 }
3010
Joe Perches3b617e32014-04-03 14:49:28 -07003011# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003012 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3013 # actual declarations
3014 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003015 # function pointer declarations
3016 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003017 # foo bar; where foo is some local typedef or #define
3018 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3019 # known declaration macros
3020 $prevline =~ /^\+\s+$declaration_macros/) &&
3021 # for "else if" which can look like "$Ident $Ident"
3022 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3023 # other possible extensions of declaration lines
3024 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3025 # not starting a section or a macro "\" extended line
3026 $prevline =~ /(?:\{\s*|\\)$/) &&
3027 # looks like a declaration
3028 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003029 # function pointer declarations
3030 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003031 # foo bar; where foo is some local typedef or #define
3032 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3033 # known declaration macros
3034 $sline =~ /^\+\s+$declaration_macros/ ||
3035 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003036 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003037 # start or end of block or continuation of declaration
3038 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3039 # bitfield continuation
3040 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3041 # other possible extensions of declaration lines
3042 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3043 # indentation of previous and current line are the same
3044 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003045 if (WARN("LINE_SPACING",
3046 "Missing a blank line after declarations\n" . $hereprev) &&
3047 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003048 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003049 }
Joe Perches3b617e32014-04-03 14:49:28 -07003050 }
3051
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003052# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003053# Exceptions:
3054# 1) within comments
3055# 2) indented preprocessor commands
3056# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003057 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003058 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003059 if (WARN("LEADING_SPACE",
3060 "please, no spaces at the start of a line\n" . $herevet) &&
3061 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003062 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003063 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003064 }
3065
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003066# check we are in a valid C source file if not then ignore this hunk
3067 next if ($realfile !~ /\.(h|c)$/);
3068
Joe Perches032a4c02014-08-06 16:10:29 -07003069# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003070# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003071# if the previous line is a break or return and is indented 1 tab more...
3072 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3073 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003074 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3075 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3076 defined $lines[$linenr] &&
3077 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003078 WARN("UNNECESSARY_ELSE",
3079 "else is not generally useful after a break or return\n" . $hereprev);
3080 }
3081 }
3082
Joe Perchesc00df192014-08-06 16:11:01 -07003083# check indentation of a line with a break;
3084# if the previous line is a goto or return and is indented the same # of tabs
3085 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3086 my $tabs = $1;
3087 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3088 WARN("UNNECESSARY_BREAK",
3089 "break is not useful after a goto or return\n" . $hereprev);
3090 }
3091 }
3092
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003093# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3094 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3095 WARN("CONFIG_EXPERIMENTAL",
3096 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3097 }
3098
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003099# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003100 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003101 WARN("CVS_KEYWORD",
3102 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003103 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003104
Mike Frysinger42e41c52009-09-21 17:04:40 -07003105# Blackfin: don't use __builtin_bfin_[cs]sync
3106 if ($line =~ /__builtin_bfin_csync/) {
3107 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003108 ERROR("CSYNC",
3109 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003110 }
3111 if ($line =~ /__builtin_bfin_ssync/) {
3112 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003113 ERROR("SSYNC",
3114 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003115 }
3116
Joe Perches56e77d72013-02-21 16:44:14 -08003117# check for old HOTPLUG __dev<foo> section markings
3118 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3119 WARN("HOTPLUG_SECTION",
3120 "Using $1 is unnecessary\n" . $herecurr);
3121 }
3122
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003123# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003124 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3125 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003126#print "LINE<$line>\n";
3127 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003128 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003129 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003130 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003131 $stat =~ s/\n./\n /g;
3132 $cond =~ s/\n./\n /g;
3133
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003134#print "linenr<$linenr> <$stat>\n";
3135 # If this statement has no statement boundaries within
3136 # it there is no point in retrying a statement scan
3137 # until we hit end of it.
3138 my $frag = $stat; $frag =~ s/;+\s*$//;
3139 if ($frag !~ /(?:{|;)/) {
3140#print "skip<$line_nr_next>\n";
3141 $suppress_statement = $line_nr_next;
3142 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003143
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003144 # Find the real next line.
3145 $realline_next = $line_nr_next;
3146 if (defined $realline_next &&
3147 (!defined $lines[$realline_next - 1] ||
3148 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3149 $realline_next++;
3150 }
3151
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003152 my $s = $stat;
3153 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003154
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003155 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003156 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003157
3158 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003159 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003160
Andy Whitcroft463f2862009-09-21 17:04:34 -07003161 } elsif ($s =~ /^.\s*else\b/s) {
3162
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003163 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003164 } 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 -07003165 my $type = $1;
3166 $type =~ s/\s+/ /g;
3167 possible($type, "A:" . $s);
3168
Andy Whitcroft8905a672007-11-28 16:21:06 -08003169 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003170 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003171 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003172 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003173
3174 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003175 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003176 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003177 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003178
3179 # Check for any sort of function declaration.
3180 # int foo(something bar, other baz);
3181 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003182 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 -08003183 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003184
Andy Whitcroftcf655042008-03-04 14:28:20 -08003185 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003186 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003187 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003188
Andy Whitcroft8905a672007-11-28 16:21:06 -08003189 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003190 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003191
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003192 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003193 }
3194 }
3195 }
3196
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003197 }
3198
Andy Whitcroft653d4872007-06-23 17:16:34 -07003199#
3200# Checks which may be anchored in the context.
3201#
3202
3203# Check for switch () and associated case and default
3204# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003205 if ($line=~/\bswitch\s*\(.*\)/) {
3206 my $err = '';
3207 my $sep = '';
3208 my @ctx = ctx_block_outer($linenr, $realcnt);
3209 shift(@ctx);
3210 for my $ctx (@ctx) {
3211 my ($clen, $cindent) = line_stats($ctx);
3212 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3213 $indent != $cindent) {
3214 $err .= "$sep$ctx\n";
3215 $sep = '';
3216 } else {
3217 $sep = "[...]\n";
3218 }
3219 }
3220 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003221 ERROR("SWITCH_CASE_INDENT_LEVEL",
3222 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003223 }
3224 }
3225
3226# if/while/etc brace do not go on next line, unless defining a do while loop,
3227# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003228 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 -07003229 my $pre_ctx = "$1$2";
3230
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003231 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003232
3233 if ($line =~ /^\+\t{6,}/) {
3234 WARN("DEEP_INDENTATION",
3235 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3236 }
3237
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003238 my $ctx_cnt = $realcnt - $#ctx - 1;
3239 my $ctx = join("\n", @ctx);
3240
Andy Whitcroft548596d2008-07-23 21:29:01 -07003241 my $ctx_ln = $linenr;
3242 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003243
Andy Whitcroft548596d2008-07-23 21:29:01 -07003244 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3245 defined $lines[$ctx_ln - 1] &&
3246 $lines[$ctx_ln - 1] =~ /^-/)) {
3247 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3248 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003249 $ctx_ln++;
3250 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003251
Andy Whitcroft53210162008-07-23 21:29:03 -07003252 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3253 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003254
Joe Perchesd752fcc2014-08-06 16:11:05 -07003255 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003256 ERROR("OPEN_BRACE",
3257 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003258 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003259 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003260 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3261 $ctx =~ /\)\s*\;\s*$/ &&
3262 defined $lines[$ctx_ln - 1])
3263 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003264 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3265 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003266 WARN("TRAILING_SEMICOLON",
3267 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003268 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003269 }
3270 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003271 }
3272
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003273# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003274 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 -08003275 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3276 ctx_statement_block($linenr, $realcnt, 0)
3277 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003278 my ($s, $c) = ($stat, $cond);
3279
3280 substr($s, 0, length($c), '');
3281
Joe Perches9f5af482015-09-09 15:37:30 -07003282 # remove inline comments
3283 $s =~ s/$;/ /g;
3284 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003285
3286 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003287 my @newlines = ($c =~ /\n/gs);
3288 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003289
Joe Perches9f5af482015-09-09 15:37:30 -07003290 # Make sure we remove the line prefixes as we have
3291 # none on the first line, and are going to readd them
3292 # where necessary.
3293 $s =~ s/\n./\n/gs;
3294 while ($s =~ /\n\s+\\\n/) {
3295 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3296 }
3297
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003298 # We want to check the first line inside the block
3299 # starting at the end of the conditional, so remove:
3300 # 1) any blank line termination
3301 # 2) any opening brace { on end of the line
3302 # 3) any do (...) {
3303 my $continuation = 0;
3304 my $check = 0;
3305 $s =~ s/^.*\bdo\b//;
3306 $s =~ s/^\s*{//;
3307 if ($s =~ s/^\s*\\//) {
3308 $continuation = 1;
3309 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003310 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003311 $check = 1;
3312 $cond_lines++;
3313 }
3314
3315 # Also ignore a loop construct at the end of a
3316 # preprocessor statement.
3317 if (($prevline =~ /^.\s*#\s*define\s/ ||
3318 $prevline =~ /\\\s*$/) && $continuation == 0) {
3319 $check = 0;
3320 }
3321
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003322 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003323 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003324 while ($cond_ptr != $cond_lines) {
3325 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003326
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003327 # If we see an #else/#elif then the code
3328 # is not linear.
3329 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3330 $check = 0;
3331 }
3332
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003333 # Ignore:
3334 # 1) blank lines, they should be at 0,
3335 # 2) preprocessor lines, and
3336 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003337 if ($continuation ||
3338 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003339 $s =~ /^\s*#\s*?/ ||
3340 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003341 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003342 if ($s =~ s/^.*?\n//) {
3343 $cond_lines++;
3344 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003345 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003346 }
3347
3348 my (undef, $sindent) = line_stats("+" . $s);
3349 my $stat_real = raw_line($linenr, $cond_lines);
3350
3351 # Check if either of these lines are modified, else
3352 # this is not this patch's fault.
3353 if (!defined($stat_real) ||
3354 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3355 $check = 0;
3356 }
3357 if (defined($stat_real) && $cond_lines > 1) {
3358 $stat_real = "[...]\n$stat_real";
3359 }
3360
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003361 #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 -07003362
Joe Perches9f5af482015-09-09 15:37:30 -07003363 if ($check && $s ne '' &&
3364 (($sindent % 8) != 0 ||
3365 ($sindent < $indent) ||
3366 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003367 WARN("SUSPECT_CODE_INDENT",
3368 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003369 }
3370 }
3371
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003372 # Track the 'values' across context and added lines.
3373 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003374 my ($curr_values, $curr_vars) =
3375 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003376 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003377 if ($dbg_values) {
3378 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003379 print "$linenr > .$outline\n";
3380 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003381 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003382 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003383 $prev_values = substr($curr_values, -1);
3384
Andy Whitcroft00df3442007-06-08 13:47:06 -07003385#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003386 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003387
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003388# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003389 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003390 my $type = $1;
3391 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003392 $var = "" if (!defined $var);
3393 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003394 my $sign = $1;
3395 my $pointer = $2;
3396
3397 $pointer = "" if (!defined $pointer);
3398
3399 if (WARN("UNSPECIFIED_INT",
3400 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3401 $fix) {
3402 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003403 my $comp_pointer = $pointer;
3404 $comp_pointer =~ s/\s//g;
3405 $decl .= $comp_pointer;
3406 $decl = rtrim($decl) if ($var eq "");
3407 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003408 }
3409 }
3410 }
3411
Andy Whitcroft653d4872007-06-23 17:16:34 -07003412# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003413 if ($dbg_type) {
3414 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003415 ERROR("TEST_TYPE",
3416 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003417 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003418 ERROR("TEST_NOT_TYPE",
3419 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003420 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003421 next;
3422 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003423# TEST: allow direct testing of the attribute matcher.
3424 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003425 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003426 ERROR("TEST_ATTR",
3427 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003428 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003429 ERROR("TEST_NOT_ATTR",
3430 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003431 }
3432 next;
3433 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003434
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003435# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003436 if ($line =~ /^.\s*{/ &&
3437 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003438 if (ERROR("OPEN_BRACE",
3439 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003440 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3441 fix_delete_line($fixlinenr - 1, $prevrawline);
3442 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003443 my $fixedline = $prevrawline;
3444 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003445 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003446 $fixedline = $line;
3447 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003448 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003449 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003450 }
3451
Andy Whitcroft653d4872007-06-23 17:16:34 -07003452#
3453# Checks which are anchored on the added line.
3454#
3455
3456# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003457 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003458 my $path = $1;
3459 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003460 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003461 "malformed #include filename\n" . $herecurr);
3462 }
3463 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3464 ERROR("UAPI_INCLUDE",
3465 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003466 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003467 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003468
3469# no C99 // comments
3470 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003471 if (ERROR("C99_COMMENTS",
3472 "do not use C99 // comments\n" . $herecurr) &&
3473 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003474 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003475 if ($line =~ /\/\/(.*)$/) {
3476 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003477 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003478 }
3479 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003480 }
3481 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003482 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003483 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003484
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003485# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3486# the whole statement.
3487#print "APW <$lines[$realline_next - 1]>\n";
3488 if (defined $realline_next &&
3489 exists $lines[$realline_next - 1] &&
3490 !defined $suppress_export{$realline_next} &&
3491 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3492 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003493 # Handle definitions which produce identifiers with
3494 # a prefix:
3495 # XXX(foo);
3496 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003497 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003498 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003499 $name =~ /^${Ident}_$2/) {
3500#print "FOO C name<$name>\n";
3501 $suppress_export{$realline_next} = 1;
3502
3503 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003504 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003505 ^.DEFINE_$Ident\(\Q$name\E\)|
3506 ^.DECLARE_$Ident\(\Q$name\E\)|
3507 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003508 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3509 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003510 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003511#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3512 $suppress_export{$realline_next} = 2;
3513 } else {
3514 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003515 }
3516 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003517 if (!defined $suppress_export{$linenr} &&
3518 $prevline =~ /^.\s*$/ &&
3519 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3520 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3521#print "FOO B <$lines[$linenr - 1]>\n";
3522 $suppress_export{$linenr} = 2;
3523 }
3524 if (defined $suppress_export{$linenr} &&
3525 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003526 WARN("EXPORT_SYMBOL",
3527 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003528 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003529
Joe Eloff5150bda2010-08-09 17:21:00 -07003530# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003531 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003532 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003533 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003534 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003535 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003536 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003537 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003538# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003539 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003540 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003541 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003542 $herecurr) &&
3543 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003544 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003545 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003546 }
3547
Joe Perches18130872014-08-06 16:11:22 -07003548# check for misordered declarations of char/short/int/long with signed/unsigned
3549 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3550 my $tmp = trim($1);
3551 WARN("MISORDERED_TYPE",
3552 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3553 }
3554
Joe Perchescb710ec2010-10-26 14:23:20 -07003555# check for static const char * arrays.
3556 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003557 WARN("STATIC_CONST_CHAR_ARRAY",
3558 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003559 $herecurr);
3560 }
3561
3562# check for static char foo[] = "bar" declarations.
3563 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003564 WARN("STATIC_CONST_CHAR_ARRAY",
3565 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003566 $herecurr);
3567 }
3568
Joe Perchesab7e23f2015-04-16 12:44:22 -07003569# check for const <foo> const where <foo> is not a pointer or array type
3570 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3571 my $found = $1;
3572 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3573 WARN("CONST_CONST",
3574 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3575 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3576 WARN("CONST_CONST",
3577 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3578 }
3579 }
3580
Joe Perches9b0fa602014-04-03 14:49:18 -07003581# check for non-global char *foo[] = {"bar", ...} declarations.
3582 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3583 WARN("STATIC_CONST_CHAR_ARRAY",
3584 "char * array declaration might be better as static const\n" .
3585 $herecurr);
3586 }
3587
Joe Perchesb598b672015-04-16 12:44:36 -07003588# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3589 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3590 my $array = $1;
3591 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3592 my $array_div = $1;
3593 if (WARN("ARRAY_SIZE",
3594 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3595 $fix) {
3596 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3597 }
3598 }
3599 }
3600
Joe Perchesb36190c2014-01-27 17:07:18 -08003601# check for function declarations without arguments like "int foo()"
3602 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3603 if (ERROR("FUNCTION_WITHOUT_ARGS",
3604 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3605 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003606 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003607 }
3608 }
3609
Joe Perches92e112f2013-12-13 11:36:22 -07003610# check for uses of DEFINE_PCI_DEVICE_TABLE
3611 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3612 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3613 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3614 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003615 $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 -07003616 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003617 }
3618
Andy Whitcroft653d4872007-06-23 17:16:34 -07003619# check for new typedefs, only function parameters and sparse annotations
3620# make sense.
3621 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003622 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003623 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003624 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003625 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003626 WARN("NEW_TYPEDEFS",
3627 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003628 }
3629
3630# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003631 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003632 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3633 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003634 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003635
Andy Whitcroft65863862009-01-06 14:41:21 -08003636 # Should start with a space.
3637 $to =~ s/^(\S)/ $1/;
3638 # Should not end with a space.
3639 $to =~ s/\s+$//;
3640 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003641 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003642 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003643
Joe Perches3705ce52013-07-03 15:05:31 -07003644## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003645 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003646 if (ERROR("POINTER_LOCATION",
3647 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3648 $fix) {
3649 my $sub_from = $ident;
3650 my $sub_to = $ident;
3651 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003652 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003653 s@\Q$sub_from\E@$sub_to@;
3654 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003655 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003656 }
3657 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3658 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003659 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003660
Andy Whitcroft65863862009-01-06 14:41:21 -08003661 # Should start with a space.
3662 $to =~ s/^(\S)/ $1/;
3663 # Should not end with a space.
3664 $to =~ s/\s+$//;
3665 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003666 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003667 }
3668 # Modifiers should have spaces.
3669 $to =~ s/(\b$Modifier$)/$1 /;
3670
Joe Perches3705ce52013-07-03 15:05:31 -07003671## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003672 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003673 if (ERROR("POINTER_LOCATION",
3674 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3675 $fix) {
3676
3677 my $sub_from = $match;
3678 my $sub_to = $match;
3679 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003680 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003681 s@\Q$sub_from\E@$sub_to@;
3682 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003683 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003684 }
3685
Joe Perches9d3e3c72015-09-09 15:37:27 -07003686# avoid BUG() or BUG_ON()
3687 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3688 my $msg_type = \&WARN;
3689 $msg_type = \&CHK if ($file);
3690 &{$msg_type}("AVOID_BUG",
3691 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3692 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003693
Joe Perches9d3e3c72015-09-09 15:37:27 -07003694# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003695 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003696 WARN("LINUX_VERSION_CODE",
3697 "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 -08003698 }
3699
Joe Perches17441222011-06-15 15:08:17 -07003700# check for uses of printk_ratelimit
3701 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003702 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003703 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003704 }
3705
Andy Whitcroft00df3442007-06-08 13:47:06 -07003706# printk should use KERN_* levels. Note that follow on printk's on the
3707# same line do not need a level, so we use the current block context
3708# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003709# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003710# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003711 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003712 my $ok = 0;
3713 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3714 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003715 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003716 # with "\n" ignore it, else it is to blame
3717 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3718 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3719 $ok = 1;
3720 }
3721 last;
3722 }
3723 }
3724 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003725 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3726 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003727 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003728 }
3729
Joe Perches243f3802012-05-31 16:26:09 -07003730 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3731 my $orig = $1;
3732 my $level = lc($orig);
3733 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003734 my $level2 = $level;
3735 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003736 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003737 "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 -07003738 }
3739
3740 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003741 if (WARN("PREFER_PR_LEVEL",
3742 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3743 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003744 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003745 s/\bpr_warning\b/pr_warn/;
3746 }
Joe Perches243f3802012-05-31 16:26:09 -07003747 }
3748
Joe Perchesdc139312013-02-21 16:44:13 -08003749 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3750 my $orig = $1;
3751 my $level = lc($orig);
3752 $level = "warn" if ($level eq "warning");
3753 $level = "dbg" if ($level eq "debug");
3754 WARN("PREFER_DEV_LEVEL",
3755 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3756 }
3757
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003758# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3759# number of false positives, but assembly files are not checked, so at
3760# least the arch entry code will not trigger this warning.
3761 if ($line =~ /\bENOSYS\b/) {
3762 WARN("ENOSYS",
3763 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3764 }
3765
Andy Whitcroft653d4872007-06-23 17:16:34 -07003766# function brace can't be on same line, except for #defines of do while,
3767# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003768 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003769 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003770 if (ERROR("OPEN_BRACE",
3771 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3772 $fix) {
3773 fix_delete_line($fixlinenr, $rawline);
3774 my $fixed_line = $rawline;
3775 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3776 my $line1 = $1;
3777 my $line2 = $2;
3778 fix_insert_line($fixlinenr, ltrim($line1));
3779 fix_insert_line($fixlinenr, "\+{");
3780 if ($line2 !~ /^\s*$/) {
3781 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3782 }
3783 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003784 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003785
Andy Whitcroft8905a672007-11-28 16:21:06 -08003786# open braces for enum, union and struct go on the same line.
3787 if ($line =~ /^.\s*{/ &&
3788 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003789 if (ERROR("OPEN_BRACE",
3790 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3791 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3792 fix_delete_line($fixlinenr - 1, $prevrawline);
3793 fix_delete_line($fixlinenr, $rawline);
3794 my $fixedline = rtrim($prevrawline) . " {";
3795 fix_insert_line($fixlinenr, $fixedline);
3796 $fixedline = $rawline;
3797 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3798 if ($fixedline !~ /^\+\s*$/) {
3799 fix_insert_line($fixlinenr, $fixedline);
3800 }
3801 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003802 }
3803
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003804# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003805 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3806 if (WARN("SPACING",
3807 "missing space after $1 definition\n" . $herecurr) &&
3808 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003809 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003810 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3811 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003812 }
3813
Joe Perches31070b52014-01-23 15:54:49 -08003814# Function pointer declarations
3815# check spacing between type, funcptr, and args
3816# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003817 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003818 my $declare = $1;
3819 my $pre_pointer_space = $2;
3820 my $post_pointer_space = $3;
3821 my $funcname = $4;
3822 my $post_funcname_space = $5;
3823 my $pre_args_space = $6;
3824
Joe Perches91f72e92014-04-03 14:49:12 -07003825# the $Declare variable will capture all spaces after the type
3826# so check it for a missing trailing missing space but pointer return types
3827# don't need a space so don't warn for those.
3828 my $post_declare_space = "";
3829 if ($declare =~ /(\s+)$/) {
3830 $post_declare_space = $1;
3831 $declare = rtrim($declare);
3832 }
3833 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003834 WARN("SPACING",
3835 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003836 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003837 }
3838
3839# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003840# This test is not currently implemented because these declarations are
3841# equivalent to
3842# int foo(int bar, ...)
3843# and this is form shouldn't/doesn't generate a checkpatch warning.
3844#
3845# elsif ($declare =~ /\s{2,}$/) {
3846# WARN("SPACING",
3847# "Multiple spaces after return type\n" . $herecurr);
3848# }
Joe Perches31070b52014-01-23 15:54:49 -08003849
3850# unnecessary space "type ( *funcptr)(args...)"
3851 if (defined $pre_pointer_space &&
3852 $pre_pointer_space =~ /^\s/) {
3853 WARN("SPACING",
3854 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3855 }
3856
3857# unnecessary space "type (* funcptr)(args...)"
3858 if (defined $post_pointer_space &&
3859 $post_pointer_space =~ /^\s/) {
3860 WARN("SPACING",
3861 "Unnecessary space before function pointer name\n" . $herecurr);
3862 }
3863
3864# unnecessary space "type (*funcptr )(args...)"
3865 if (defined $post_funcname_space &&
3866 $post_funcname_space =~ /^\s/) {
3867 WARN("SPACING",
3868 "Unnecessary space after function pointer name\n" . $herecurr);
3869 }
3870
3871# unnecessary space "type (*funcptr) (args...)"
3872 if (defined $pre_args_space &&
3873 $pre_args_space =~ /^\s/) {
3874 WARN("SPACING",
3875 "Unnecessary space before function pointer arguments\n" . $herecurr);
3876 }
3877
3878 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003879 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003880 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003881 }
3882 }
3883
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003884# check for spacing round square brackets; allowed:
3885# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003886# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3887# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003888 while ($line =~ /(.*?\s)\[/g) {
3889 my ($where, $prefix) = ($-[1], $1);
3890 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003891 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003892 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003893 if (ERROR("BRACKET_SPACE",
3894 "space prohibited before open square bracket '['\n" . $herecurr) &&
3895 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003896 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003897 s/^(\+.*?)\s+\[/$1\[/;
3898 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003899 }
3900 }
3901
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003902# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003903 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003904 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003905 my $ctx_before = substr($line, 0, $-[1]);
3906 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003907
3908 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003909 if ($name =~ /^(?:
3910 if|for|while|switch|return|case|
3911 volatile|__volatile__|
3912 __attribute__|format|__extension__|
3913 asm|__asm__)$/x)
3914 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003915 # cpp #define statements have non-optional spaces, ie
3916 # if there is a space between the name and the open
3917 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003918 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003919
3920 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003921 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003922
3923 # If this whole things ends with a type its most
3924 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003925 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003926
3927 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003928 if (WARN("SPACING",
3929 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3930 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003931 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003932 s/\b$name\s+\(/$name\(/;
3933 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003934 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003935 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003936
Andy Whitcroft653d4872007-06-23 17:16:34 -07003937# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003938 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003939 my $fixed_line = "";
3940 my $line_fixed = 0;
3941
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003942 my $ops = qr{
3943 <<=|>>=|<=|>=|==|!=|
3944 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3945 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003946 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003947 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003948 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003949 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003950
3951## print("element count: <" . $#elements . ">\n");
3952## foreach my $el (@elements) {
3953## print("el: <$el>\n");
3954## }
3955
3956 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003957 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003958
Joe Perches3705ce52013-07-03 15:05:31 -07003959 foreach my $el (@elements) {
3960 push(@fix_elements, substr($rawline, $off, length($el)));
3961 $off += length($el);
3962 }
3963
3964 $off = 0;
3965
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003966 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003967 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003968
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003969 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003970
3971 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3972
3973## print("n: <$n> good: <$good>\n");
3974
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003975 $off += length($elements[$n]);
3976
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003977 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003978 my $ca = substr($opline, 0, $off);
3979 my $cc = '';
3980 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3981 $cc = substr($opline, $off + length($elements[$n + 1]));
3982 }
3983 my $cb = "$ca$;$cc";
3984
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003985 my $a = '';
3986 $a = 'V' if ($elements[$n] ne '');
3987 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003988 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003989 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3990 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003991 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003992
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003993 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003994
3995 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003996 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003997 $c = 'V' if ($elements[$n + 2] ne '');
3998 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003999 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004000 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4001 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004002 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004003 } else {
4004 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004005 }
4006
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004007 my $ctx = "${a}x${c}";
4008
4009 my $at = "(ctx:$ctx)";
4010
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004011 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004012 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004013
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004014 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004015 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004016
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004017 # Get the full operator variant.
4018 my $opv = $op . substr($curr_vars, $off, 1);
4019
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004020 # Ignore operators passed as parameters.
4021 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004022 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004023
Andy Whitcroftcf655042008-03-04 14:28:20 -08004024# # Ignore comments
4025# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004026
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004027 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004028 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004029 if ($ctx !~ /.x[WEBC]/ &&
4030 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004031 if (ERROR("SPACING",
4032 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004033 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004034 $line_fixed = 1;
4035 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004036 }
4037
4038 # // is a comment
4039 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004040
Joe Perchesb00e4812014-04-03 14:49:33 -07004041 # : when part of a bitfield
4042 } elsif ($opv eq ':B') {
4043 # skip the bitfield test for now
4044
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004045 # No spaces for:
4046 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004047 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004048 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004049 if (ERROR("SPACING",
4050 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004051 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004052 if (defined $fix_elements[$n + 2]) {
4053 $fix_elements[$n + 2] =~ s/^\s+//;
4054 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004055 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004056 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004057 }
4058
Joe Perches23810972014-12-10 15:51:32 -08004059 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004060 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004061 my $rtrim_before = 0;
4062 my $space_after = 0;
4063 if ($ctx =~ /Wx./) {
4064 if (ERROR("SPACING",
4065 "space prohibited before that '$op' $at\n" . $hereptr)) {
4066 $line_fixed = 1;
4067 $rtrim_before = 1;
4068 }
4069 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004070 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004071 if (ERROR("SPACING",
4072 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004073 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004074 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004075 $space_after = 1;
4076 }
4077 }
4078 if ($rtrim_before || $space_after) {
4079 if ($rtrim_before) {
4080 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4081 } else {
4082 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4083 }
4084 if ($space_after) {
4085 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004086 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004087 }
4088
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004089 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004090 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004091 #warn "'*' is part of type\n";
4092
4093 # unary operators should have a space before and
4094 # none after. May be left adjacent to another
4095 # unary operator, or a cast
4096 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004097 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004098 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004099 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004100 if (ERROR("SPACING",
4101 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004102 if ($n != $last_after + 2) {
4103 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4104 $line_fixed = 1;
4105 }
Joe Perches3705ce52013-07-03 15:05:31 -07004106 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004107 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004108 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004109 # A unary '*' may be const
4110
4111 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004112 if (ERROR("SPACING",
4113 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004114 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004115 if (defined $fix_elements[$n + 2]) {
4116 $fix_elements[$n + 2] =~ s/^\s+//;
4117 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004118 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004119 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004120 }
4121
4122 # unary ++ and unary -- are allowed no space on one side.
4123 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004124 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004125 if (ERROR("SPACING",
4126 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004127 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004128 $line_fixed = 1;
4129 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004130 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004131 if ($ctx =~ /Wx[BE]/ ||
4132 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004133 if (ERROR("SPACING",
4134 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004135 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004136 $line_fixed = 1;
4137 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004138 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004139 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004140 if (ERROR("SPACING",
4141 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004142 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004143 if (defined $fix_elements[$n + 2]) {
4144 $fix_elements[$n + 2] =~ s/^\s+//;
4145 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004146 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004147 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004148 }
4149
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004150 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004151 } elsif ($op eq '<<' or $op eq '>>' or
4152 $op eq '&' or $op eq '^' or $op eq '|' or
4153 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004154 $op eq '*' or $op eq '/' or
4155 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004156 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004157 if ($check) {
4158 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4159 if (CHK("SPACING",
4160 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4161 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4162 $fix_elements[$n + 2] =~ s/^\s+//;
4163 $line_fixed = 1;
4164 }
4165 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4166 if (CHK("SPACING",
4167 "space preferred before that '$op' $at\n" . $hereptr)) {
4168 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4169 $line_fixed = 1;
4170 }
4171 }
4172 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004173 if (ERROR("SPACING",
4174 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004175 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4176 if (defined $fix_elements[$n + 2]) {
4177 $fix_elements[$n + 2] =~ s/^\s+//;
4178 }
Joe Perches3705ce52013-07-03 15:05:31 -07004179 $line_fixed = 1;
4180 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004181 }
4182
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004183 # A colon needs no spaces before when it is
4184 # terminating a case value or a label.
4185 } elsif ($opv eq ':C' || $opv eq ':L') {
4186 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004187 if (ERROR("SPACING",
4188 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004189 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004190 $line_fixed = 1;
4191 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004192 }
4193
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004194 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004195 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004196 my $ok = 0;
4197
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004198 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004199 if (($op eq '<' &&
4200 $cc =~ /^\S+\@\S+>/) ||
4201 ($op eq '>' &&
4202 $ca =~ /<\S+\@\S+$/))
4203 {
4204 $ok = 1;
4205 }
4206
Joe Perchese0df7e12015-04-16 12:44:53 -07004207 # for asm volatile statements
4208 # ignore a colon with another
4209 # colon immediately before or after
4210 if (($op eq ':') &&
4211 ($ca =~ /:$/ || $cc =~ /^:/)) {
4212 $ok = 1;
4213 }
4214
Joe Perches84731622013-11-12 15:10:05 -08004215 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004216 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004217 my $msg_type = \&ERROR;
4218 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4219
4220 if (&{$msg_type}("SPACING",
4221 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004222 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4223 if (defined $fix_elements[$n + 2]) {
4224 $fix_elements[$n + 2] =~ s/^\s+//;
4225 }
Joe Perches3705ce52013-07-03 15:05:31 -07004226 $line_fixed = 1;
4227 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004228 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004229 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004230 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004231
4232## print("n: <$n> GOOD: <$good>\n");
4233
4234 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004235 }
Joe Perches3705ce52013-07-03 15:05:31 -07004236
4237 if (($#elements % 2) == 0) {
4238 $fixed_line = $fixed_line . $fix_elements[$#elements];
4239 }
4240
Joe Perches194f66f2014-08-06 16:11:03 -07004241 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4242 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004243 }
4244
4245
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004246 }
4247
Joe Perches786b6322013-07-03 15:05:32 -07004248# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004249 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004250 if (WARN("SPACING",
4251 "space prohibited before semicolon\n" . $herecurr) &&
4252 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004253 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004254 s/^(\+.*\S)\s+;/$1;/;
4255 }
4256 }
4257
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004258# check for multiple assignments
4259 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004260 CHK("MULTIPLE_ASSIGNMENTS",
4261 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004262 }
4263
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004264## # check for multiple declarations, allowing for a function declaration
4265## # continuation.
4266## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4267## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4268##
4269## # Remove any bracketed sections to ensure we do not
4270## # falsly report the parameters of functions.
4271## my $ln = $line;
4272## while ($ln =~ s/\([^\(\)]*\)//g) {
4273## }
4274## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004275## WARN("MULTIPLE_DECLARATION",
4276## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004277## }
4278## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004279
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004280#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004281 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004282 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004283 if (ERROR("SPACING",
4284 "space required before the open brace '{'\n" . $herecurr) &&
4285 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004286 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004287 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004288 }
4289
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004290## # check for blank lines before declarations
4291## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4292## $prevrawline =~ /^.\s*$/) {
4293## WARN("SPACING",
4294## "No blank lines before declarations\n" . $hereprev);
4295## }
4296##
4297
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004298# closing brace should have a space following it when it has anything
4299# on the line
4300 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004301 if (ERROR("SPACING",
4302 "space required after that close brace '}'\n" . $herecurr) &&
4303 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004304 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004305 s/}((?!(?:,|;|\)))\S)/} $1/;
4306 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004307 }
4308
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004309# check spacing on square brackets
4310 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004311 if (ERROR("SPACING",
4312 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4313 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004314 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004315 s/\[\s+/\[/;
4316 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004317 }
4318 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004319 if (ERROR("SPACING",
4320 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4321 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004322 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004323 s/\s+\]/\]/;
4324 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004325 }
4326
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004327# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004328 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
Matt Wagantall54afcc62010-06-03 12:28:18 -07004329 $line !~ /for\s*\(\s+;/ && $line !~ /^\+\s*[A-Z_][A-Z\d_]*\(\s*\d+(\,.*)?\)\,?$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004330 if (ERROR("SPACING",
4331 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4332 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004333 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004334 s/\(\s+/\(/;
4335 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004336 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004337 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004338 $line !~ /for\s*\(.*;\s+\)/ &&
4339 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004340 if (ERROR("SPACING",
4341 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4342 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004343 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004344 s/\s+\)/\)/;
4345 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004346 }
4347
Joe Perchese2826fd2014-08-06 16:10:48 -07004348# check unnecessary parentheses around addressof/dereference single $Lvals
4349# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4350
4351 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004352 my $var = $1;
4353 if (CHK("UNNECESSARY_PARENTHESES",
4354 "Unnecessary parentheses around $var\n" . $herecurr) &&
4355 $fix) {
4356 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4357 }
4358 }
4359
4360# check for unnecessary parentheses around function pointer uses
4361# ie: (foo->bar)(); should be foo->bar();
4362# but not "if (foo->bar) (" to avoid some false positives
4363 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4364 my $var = $2;
4365 if (CHK("UNNECESSARY_PARENTHESES",
4366 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4367 $fix) {
4368 my $var2 = deparenthesize($var);
4369 $var2 =~ s/\s//g;
4370 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4371 }
4372 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004373
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004374#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004375 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004376 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004377 if (WARN("INDENTED_LABEL",
4378 "labels should not be indented\n" . $herecurr) &&
4379 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004380 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004381 s/^(.)\s+/$1/;
4382 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004383 }
4384
Joe Perches5b9553a2014-04-03 14:49:21 -07004385# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004386 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004387 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004388 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004389 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4390 my $value = $1;
4391 $value = deparenthesize($value);
4392 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4393 ERROR("RETURN_PARENTHESES",
4394 "return is not a function, parentheses are not required\n" . $herecurr);
4395 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004396 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004397 ERROR("SPACING",
4398 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004399 }
4400 }
Joe Perches507e5142013-11-12 15:10:13 -08004401
Joe Perchesb43ae212014-06-23 13:22:07 -07004402# unnecessary return in a void function
4403# at end-of-function, with the previous line a single leading tab, then return;
4404# and the line before that not a goto label target like "out:"
4405 if ($sline =~ /^[ \+]}\s*$/ &&
4406 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4407 $linenr >= 3 &&
4408 $lines[$linenr - 3] =~ /^[ +]/ &&
4409 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004410 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004411 "void function return statements are not generally useful\n" . $hereprev);
4412 }
Joe Perches9819cf22014-06-04 16:12:09 -07004413
Joe Perches189248d2014-01-23 15:54:47 -08004414# if statements using unnecessary parentheses - ie: if ((foo == bar))
4415 if ($^V && $^V ge 5.10.0 &&
4416 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4417 my $openparens = $1;
4418 my $count = $openparens =~ tr@\(@\(@;
4419 my $msg = "";
4420 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4421 my $comp = $4; #Not $1 because of $LvalOrFunc
4422 $msg = " - maybe == should be = ?" if ($comp eq "==");
4423 WARN("UNNECESSARY_PARENTHESES",
4424 "Unnecessary parentheses$msg\n" . $herecurr);
4425 }
4426 }
4427
Joe Perchesc5595fa2015-09-09 15:37:58 -07004428# comparisons with a constant or upper case identifier on the left
4429# avoid cases like "foo + BAR < baz"
4430# only fix matches surrounded by parentheses to avoid incorrect
4431# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4432 if ($^V && $^V ge 5.10.0 &&
4433 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4434 my $lead = $1;
4435 my $const = $2;
4436 my $comp = $3;
4437 my $to = $4;
4438 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004439 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004440 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4441 WARN("CONSTANT_COMPARISON",
4442 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4443 $fix) {
4444 if ($comp eq "<") {
4445 $newcomp = ">";
4446 } elsif ($comp eq "<=") {
4447 $newcomp = ">=";
4448 } elsif ($comp eq ">") {
4449 $newcomp = "<";
4450 } elsif ($comp eq ">=") {
4451 $newcomp = "<=";
4452 }
4453 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4454 }
4455 }
4456
Joe Perchesf34e4a42015-04-16 12:44:19 -07004457# Return of what appears to be an errno should normally be negative
4458 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004459 my $name = $1;
4460 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004461 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004462 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004463 }
4464 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004465
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004466# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004467 if ($line =~ /\b(if|while|for|switch)\(/) {
4468 if (ERROR("SPACING",
4469 "space required before the open parenthesis '('\n" . $herecurr) &&
4470 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004471 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004472 s/\b(if|while|for|switch)\(/$1 \(/;
4473 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004474 }
4475
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004476# Check for illegal assignment in if conditional -- and check for trailing
4477# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004478 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004479 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4480 ctx_statement_block($linenr, $realcnt, 0)
4481 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004482 my ($stat_next) = ctx_statement_block($line_nr_next,
4483 $remain_next, $off_next);
4484 $stat_next =~ s/\n./\n /g;
4485 ##print "stat<$stat> stat_next<$stat_next>\n";
4486
4487 if ($stat_next =~ /^\s*while\b/) {
4488 # If the statement carries leading newlines,
4489 # then count those as offsets.
4490 my ($whitespace) =
4491 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4492 my $offset =
4493 statement_rawlines($whitespace) - 1;
4494
4495 $suppress_whiletrailers{$line_nr_next +
4496 $offset} = 1;
4497 }
4498 }
4499 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004500 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004501 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004502 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004503
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004504 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004505 ERROR("ASSIGN_IN_IF",
4506 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004507 }
4508
4509 # Find out what is on the end of the line after the
4510 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004511 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004512 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004513 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004514 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4515 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004516 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004517 # Find out how long the conditional actually is.
4518 my @newlines = ($c =~ /\n/gs);
4519 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004520 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004521
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004522 $stat_real = raw_line($linenr, $cond_lines)
4523 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004524 if (defined($stat_real) && $cond_lines > 1) {
4525 $stat_real = "[...]\n$stat_real";
4526 }
4527
Joe Perches000d1cc12011-07-25 17:13:25 -07004528 ERROR("TRAILING_STATEMENTS",
4529 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004530 }
4531 }
4532
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004533# Check for bitwise tests written as boolean
4534 if ($line =~ /
4535 (?:
4536 (?:\[|\(|\&\&|\|\|)
4537 \s*0[xX][0-9]+\s*
4538 (?:\&\&|\|\|)
4539 |
4540 (?:\&\&|\|\|)
4541 \s*0[xX][0-9]+\s*
4542 (?:\&\&|\|\||\)|\])
4543 )/x)
4544 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004545 WARN("HEXADECIMAL_BOOLEAN_TEST",
4546 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004547 }
4548
Andy Whitcroft8905a672007-11-28 16:21:06 -08004549# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004550 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4551 my $s = $1;
4552 $s =~ s/$;//g; # Remove any comments
4553 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004554 ERROR("TRAILING_STATEMENTS",
4555 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004556 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004557 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004558# if should not continue a brace
4559 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004560 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004561 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004562 $herecurr);
4563 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004564# case and default should not have general statements after them
4565 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4566 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004567 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004568 \s*return\s+
4569 )/xg)
4570 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004571 ERROR("TRAILING_STATEMENTS",
4572 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004573 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004574
4575 # Check for }<nl>else {, these must be at the same
4576 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004577 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4578 $previndent == $indent) {
4579 if (ERROR("ELSE_AFTER_BRACE",
4580 "else should follow close brace '}'\n" . $hereprev) &&
4581 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4582 fix_delete_line($fixlinenr - 1, $prevrawline);
4583 fix_delete_line($fixlinenr, $rawline);
4584 my $fixedline = $prevrawline;
4585 $fixedline =~ s/}\s*$//;
4586 if ($fixedline !~ /^\+\s*$/) {
4587 fix_insert_line($fixlinenr, $fixedline);
4588 }
4589 $fixedline = $rawline;
4590 $fixedline =~ s/^(.\s*)else/$1} else/;
4591 fix_insert_line($fixlinenr, $fixedline);
4592 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004593 }
4594
Joe Perches8b8856f2014-08-06 16:11:14 -07004595 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4596 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004597 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4598
4599 # Find out what is on the end of the line after the
4600 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004601 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004602 $s =~ s/\n.*//g;
4603
4604 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004605 if (ERROR("WHILE_AFTER_BRACE",
4606 "while should follow close brace '}'\n" . $hereprev) &&
4607 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4608 fix_delete_line($fixlinenr - 1, $prevrawline);
4609 fix_delete_line($fixlinenr, $rawline);
4610 my $fixedline = $prevrawline;
4611 my $trailing = $rawline;
4612 $trailing =~ s/^\+//;
4613 $trailing = trim($trailing);
4614 $fixedline =~ s/}\s*$/} $trailing/;
4615 fix_insert_line($fixlinenr, $fixedline);
4616 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004617 }
4618 }
4619
Joe Perches95e2c602013-07-03 15:05:20 -07004620#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004621 while ($line =~ m{($Constant|$Lval)}g) {
4622 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004623
4624#gcc binary extension
4625 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004626 if (WARN("GCC_BINARY_CONSTANT",
4627 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4628 $fix) {
4629 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004630 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004631 s/\b$var\b/$hexval/;
4632 }
Joe Perches95e2c602013-07-03 15:05:20 -07004633 }
4634
4635#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004636 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004637 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004638#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004639 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004640#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004641 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4642#Ignore some three character SI units explicitly, like MiB and KHz
4643 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004644 while ($var =~ m{($Ident)}g) {
4645 my $word = $1;
4646 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004647 if ($check) {
4648 seed_camelcase_includes();
4649 if (!$file && !$camelcase_file_seeded) {
4650 seed_camelcase_file($realfile);
4651 $camelcase_file_seeded = 1;
4652 }
4653 }
Joe Perches7e781f62013-09-11 14:23:55 -07004654 if (!defined $camelcase{$word}) {
4655 $camelcase{$word} = 1;
4656 CHK("CAMELCASE",
4657 "Avoid CamelCase: <$word>\n" . $herecurr);
4658 }
Joe Perches34456862013-07-03 15:05:34 -07004659 }
Joe Perches323c1262012-12-17 16:02:07 -08004660 }
4661 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004662
4663#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004664 if ($line =~ /\#\s*define.*\\\s+$/) {
4665 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4666 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4667 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004668 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004669 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004670 }
4671
Fabian Frederick0e212e02015-04-16 12:44:25 -07004672# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4673# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004674 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004675 my $file = "$1.h";
4676 my $checkfile = "include/linux/$file";
4677 if (-f "$root/$checkfile" &&
4678 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004679 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004680 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004681 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4682 if ($asminclude > 0) {
4683 if ($realfile =~ m{^arch/}) {
4684 CHK("ARCH_INCLUDE_LINUX",
4685 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4686 } else {
4687 WARN("INCLUDE_LINUX",
4688 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4689 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004690 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004691 }
4692 }
4693
Andy Whitcroft653d4872007-06-23 17:16:34 -07004694# multi-statement macros should be enclosed in a do while loop, grab the
4695# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004696# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004697 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4698 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004699 my $ln = $linenr;
Gregory Bean02870be2011-05-11 09:11:12 -07004700 my $cnt = $realcnt - 1;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004701 my ($off, $dstat, $dcond, $rest);
4702 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004703 my $has_flow_statement = 0;
4704 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004705 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004706 ctx_statement_block($linenr, $realcnt, 0);
4707 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004708 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004709 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004710
Joe Perches08a28432014-10-13 15:51:55 -07004711 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004712 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004713
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004714 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004715 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004716 $dstat =~ s/\\\n.//g;
4717 $dstat =~ s/^\s*//s;
4718 $dstat =~ s/\s*$//s;
4719
4720 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004721 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4722 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004723 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004724 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004725 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004726
Gregory Bean02870be2011-05-11 09:11:12 -07004727 # Extremely long macros may fall off the end of the
4728 # available context without closing. Give a dangling
4729 # backslash the benefit of the doubt and allow it
4730 # to gobble any hanging open-parens.
4731 $dstat =~ s/\(.+\\$/1/;
4732
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004733 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004734 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4735 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004736 {
4737 }
4738
Joe Perches42e15292016-03-15 14:58:01 -07004739 # Make asm volatile uses seem like a generic function
4740 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4741
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004742 my $exceptions = qr{
4743 $Declare|
4744 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004745 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004746 DECLARE_PER_CPU|
4747 DEFINE_PER_CPU|
Matt Wagantall54afcc62010-06-03 12:28:18 -07004748 CLK_[A-Z\d_]+|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004749 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004750 union|
4751 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004752 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004753 ^\"|\"$|
4754 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004755 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004756 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004757 if ($dstat ne '' &&
4758 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4759 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004760 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004761 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004762 $dstat !~ /$exceptions/ &&
4763 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004764 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004765 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004766 $dstat !~ /^for\s*$Constant$/ && # for (...)
4767 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4768 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004769 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004770 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004771 {
4772 $ctx =~ s/\n*$//;
4773 my $herectx = $here . "\n";
4774 my $cnt = statement_rawlines($ctx);
4775
4776 for (my $n = 0; $n < $cnt; $n++) {
4777 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004778 }
4779
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004780 if ($dstat =~ /;/) {
4781 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4782 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4783 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004784 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004785 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004786 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004787 }
Joe Perches5023d342012-12-17 16:01:47 -08004788
Joe Perches08a28432014-10-13 15:51:55 -07004789# check for macros with flow control, but without ## concatenation
4790# ## concatenation is commonly a macro that defines a function so ignore those
4791 if ($has_flow_statement && !$has_arg_concat) {
4792 my $herectx = $here . "\n";
4793 my $cnt = statement_rawlines($ctx);
4794
4795 for (my $n = 0; $n < $cnt; $n++) {
4796 $herectx .= raw_line($linenr, $n) . "\n";
4797 }
4798 WARN("MACRO_WITH_FLOW_CONTROL",
4799 "Macros with flow control statements should be avoided\n" . "$herectx");
4800 }
4801
Joe Perches481eb482012-12-17 16:01:56 -08004802# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004803
4804 } else {
4805 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004806 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4807 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004808 $line =~ /^\+.*\\$/) {
4809 WARN("LINE_CONTINUATIONS",
4810 "Avoid unnecessary line continuations\n" . $herecurr);
4811 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004812 }
4813
Joe Perchesb13edf72012-07-30 14:41:24 -07004814# do {} while (0) macro tests:
4815# single-statement macros do not need to be enclosed in do while (0) loop,
4816# macro should not end with a semicolon
4817 if ($^V && $^V ge 5.10.0 &&
4818 $realfile !~ m@/vmlinux.lds.h$@ &&
4819 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4820 my $ln = $linenr;
4821 my $cnt = $realcnt;
4822 my ($off, $dstat, $dcond, $rest);
4823 my $ctx = '';
4824 ($dstat, $dcond, $ln, $cnt, $off) =
4825 ctx_statement_block($linenr, $realcnt, 0);
4826 $ctx = $dstat;
4827
4828 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004829 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004830
4831 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4832 my $stmts = $2;
4833 my $semis = $3;
4834
4835 $ctx =~ s/\n*$//;
4836 my $cnt = statement_rawlines($ctx);
4837 my $herectx = $here . "\n";
4838
4839 for (my $n = 0; $n < $cnt; $n++) {
4840 $herectx .= raw_line($linenr, $n) . "\n";
4841 }
4842
Joe Perchesac8e97f2012-08-21 16:15:53 -07004843 if (($stmts =~ tr/;/;/) == 1 &&
4844 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004845 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4846 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4847 }
4848 if (defined $semis && $semis ne "") {
4849 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4850 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4851 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004852 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4853 $ctx =~ s/\n*$//;
4854 my $cnt = statement_rawlines($ctx);
4855 my $herectx = $here . "\n";
4856
4857 for (my $n = 0; $n < $cnt; $n++) {
4858 $herectx .= raw_line($linenr, $n) . "\n";
4859 }
4860
4861 WARN("TRAILING_SEMICOLON",
4862 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004863 }
4864 }
4865
Mike Frysinger080ba922009-01-06 14:41:25 -08004866# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4867# all assignments may have only one of the following with an assignment:
4868# .
4869# ALIGN(...)
4870# VMLINUX_SYMBOL(...)
4871 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004872 WARN("MISSING_VMLINUX_SYMBOL",
4873 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004874 }
4875
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004876# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004877 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4878 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004879 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004880 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004881 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4882 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004883 my @allowed = ();
4884 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004885 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004886 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004887 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004888 for my $chunk (@chunks) {
4889 my ($cond, $block) = @{$chunk};
4890
Andy Whitcroft773647a2008-03-28 14:15:58 -07004891 # If the condition carries leading newlines, then count those as offsets.
4892 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4893 my $offset = statement_rawlines($whitespace) - 1;
4894
Joe Perchesaad4f612012-03-23 15:02:19 -07004895 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004896 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4897
4898 # We have looked at and allowed this specific line.
4899 $suppress_ifbraces{$ln + $offset} = 1;
4900
4901 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004902 $ln += statement_rawlines($block) - 1;
4903
Andy Whitcroft773647a2008-03-28 14:15:58 -07004904 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004905
4906 $seen++ if ($block =~ /^\s*{/);
4907
Joe Perchesaad4f612012-03-23 15:02:19 -07004908 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004909 if (statement_lines($cond) > 1) {
4910 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004911 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004912 }
4913 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004914 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004915 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004916 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004917 if (statement_block_size($block) > 1) {
4918 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004919 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004920 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004921 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004922 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004923 if ($seen) {
4924 my $sum_allowed = 0;
4925 foreach (@allowed) {
4926 $sum_allowed += $_;
4927 }
4928 if ($sum_allowed == 0) {
4929 WARN("BRACES",
4930 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4931 } elsif ($sum_allowed != $allow &&
4932 $seen != $allow) {
4933 CHK("BRACES",
4934 "braces {} should be used on all arms of this statement\n" . $herectx);
4935 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004936 }
4937 }
4938 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004939 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004940 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004941 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004942
Andy Whitcroftcf655042008-03-04 14:28:20 -08004943 # Check the pre-context.
4944 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4945 #print "APW: ALLOWED: pre<$1>\n";
4946 $allowed = 1;
4947 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004948
4949 my ($level, $endln, @chunks) =
4950 ctx_statement_full($linenr, $realcnt, $-[0]);
4951
Andy Whitcroftcf655042008-03-04 14:28:20 -08004952 # Check the condition.
4953 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004954 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004955 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004956 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004957 }
4958 if (statement_lines($cond) > 1) {
4959 #print "APW: ALLOWED: cond<$cond>\n";
4960 $allowed = 1;
4961 }
4962 if ($block =~/\b(?:if|for|while)\b/) {
4963 #print "APW: ALLOWED: block<$block>\n";
4964 $allowed = 1;
4965 }
4966 if (statement_block_size($block) > 1) {
4967 #print "APW: ALLOWED: lines block<$block>\n";
4968 $allowed = 1;
4969 }
4970 # Check the post-context.
4971 if (defined $chunks[1]) {
4972 my ($cond, $block) = @{$chunks[1]};
4973 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004974 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004975 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004976 if ($block =~ /^\s*\{/) {
4977 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4978 $allowed = 1;
4979 }
4980 }
4981 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004982 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004983 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004984
Andy Whitcroftf0556632008-10-15 22:02:23 -07004985 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004986 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004987 }
4988
Joe Perches000d1cc12011-07-25 17:13:25 -07004989 WARN("BRACES",
4990 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004991 }
4992 }
4993
Joe Perches0979ae62012-12-17 16:01:59 -08004994# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004995 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004996 if (CHK("BRACES",
4997 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4998 $fix && $prevrawline =~ /^\+/) {
4999 fix_delete_line($fixlinenr - 1, $prevrawline);
5000 }
Joe Perches0979ae62012-12-17 16:01:59 -08005001 }
Joe Perches77b9a532013-07-03 15:05:29 -07005002 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005003 if (CHK("BRACES",
5004 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5005 $fix) {
5006 fix_delete_line($fixlinenr, $rawline);
5007 }
Joe Perches0979ae62012-12-17 16:01:59 -08005008 }
5009
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005010# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005011 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5012 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005013 WARN("VOLATILE",
5014 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005015 }
5016
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005017# Check for user-visible strings broken across lines, which breaks the ability
5018# to grep for the string. Make exceptions when the previous string ends in a
5019# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5020# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005021 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005022 $prevline =~ /"\s*$/ &&
5023 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5024 if (WARN("SPLIT_STRING",
5025 "quoted string split across lines\n" . $hereprev) &&
5026 $fix &&
5027 $prevrawline =~ /^\+.*"\s*$/ &&
5028 $last_coalesced_string_linenr != $linenr - 1) {
5029 my $extracted_string = get_quoted_string($line, $rawline);
5030 my $comma_close = "";
5031 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5032 $comma_close = $1;
5033 }
5034
5035 fix_delete_line($fixlinenr - 1, $prevrawline);
5036 fix_delete_line($fixlinenr, $rawline);
5037 my $fixedline = $prevrawline;
5038 $fixedline =~ s/"\s*$//;
5039 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5040 fix_insert_line($fixlinenr - 1, $fixedline);
5041 $fixedline = $rawline;
5042 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5043 if ($fixedline !~ /\+\s*$/) {
5044 fix_insert_line($fixlinenr, $fixedline);
5045 }
5046 $last_coalesced_string_linenr = $linenr;
5047 }
5048 }
5049
5050# check for missing a space in a string concatenation
5051 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5052 WARN('MISSING_SPACE',
5053 "break quoted strings at a space character\n" . $hereprev);
5054 }
5055
5056# check for spaces before a quoted newline
5057 if ($rawline =~ /^.*\".*\s\\n/) {
5058 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5059 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5060 $fix) {
5061 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5062 }
5063
5064 }
5065
Joe Perchesf17dba42014-10-13 15:51:51 -07005066# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005067 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005068 CHK("CONCATENATED_STRING",
5069 "Concatenated strings should use spaces between elements\n" . $herecurr);
5070 }
5071
Joe Perches90ad30e2014-12-10 15:51:59 -08005072# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005073 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005074 WARN("STRING_FRAGMENTS",
5075 "Consecutive strings are generally better as a single string\n" . $herecurr);
5076 }
5077
Joe Perches6e300752015-09-09 15:37:47 -07005078# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005079 my $string;
5080 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5081 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5082 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005083 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005084 WARN("PRINTF_L",
5085 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5086 last;
5087 }
Joe Perches6e300752015-09-09 15:37:47 -07005088 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5089 ERROR("PRINTF_0xDECIMAL",
5090 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5091 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005092 }
5093
5094# check for line continuations in quoted strings with odd counts of "
5095 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5096 WARN("LINE_CONTINUATIONS",
5097 "Avoid line continuations in quoted strings\n" . $herecurr);
5098 }
5099
Gregory Bean6c9c6842011-03-17 14:18:20 -07005100# sys_open/read/write/close are not allowed in the kernel
5101 if ($line =~ /\b(sys_(?:open|read|write|close))\b/) {
5102 ERROR("FILE_OPS",
5103 "$1 is inappropriate in kernel code.\n" .
5104 $herecurr);
5105 }
5106
Gregory Beana7cce0a2011-06-07 08:06:45 -07005107# filp_open is a backdoor for sys_open
5108 if ($line =~ /\b(filp_open)\b/) {
5109 ERROR("FILE_OPS",
5110 "$1 is inappropriate in kernel code.\n" .
5111 $herecurr);
5112 }
5113
Gregory Bean3f6f2dd2011-05-02 13:50:35 -07005114# read[bwl] & write[bwl] use too many barriers, use the _relaxed variants
5115 if ($line =~ /\b((?:read|write)[bwl])\b/) {
5116 ERROR("NON_RELAXED_IO",
5117 "Use of $1 is deprecated: use $1_relaxed\n\t" .
5118 "with appropriate memory barriers instead.\n" .
5119 $herecurr);
5120 }
5121
5122# likewise, in/out[bwl] should be __raw_read/write[bwl]...
5123 if ($line =~ /\b((in|out)([bwl]))\b/) {
5124 my ($all, $pref, $suf) = ($1, $2, $3);
5125 $pref =~ s/in/read/;
5126 $pref =~ s/out/write/;
5127 ERROR("NON_RELAXED_IO",
5128 "Use of $all is deprecated: use " .
5129 "__raw_$pref$suf\n\t" .
5130 "with appropriate memory barriers instead.\n" .
5131 $herecurr);
5132 }
5133
Gregory Bean438bf5f2011-06-15 09:32:38 -07005134# dsb is too ARMish, and should usually be mb.
5135 if ($line =~ /\bdsb\b/) {
5136 WARN("ARM_BARRIER",
5137 "Use of dsb is discouranged: prefer mb.\n" .
5138 $herecurr);
5139 }
5140
Gregory Beandf3a3ee2011-05-10 12:34:09 -07005141# unbounded string functions are overflow risks
5142 my %str_fns = (
5143 "sprintf" => "snprintf",
5144 "strcpy" => "strlcpy",
5145 "strncpy" => "strlcpy",
5146 "strcat" => "strlcat",
5147 "strncat" => "strlcat",
5148 "vsprintf" => "vsnprintf",
5149 "strchr" => "strnchr",
5150 "strstr" => "strnstr",
5151 );
5152 foreach my $k (keys %str_fns) {
5153 if ($line =~ /\b$k\b/) {
5154 ERROR("UNBOUNDED_STRING_FNS",
5155 "Use of $k is deprecated: " .
5156 "use $str_fns{$k} instead.\n" .
5157 $herecurr);
5158 }
5159 }
5160
Andy Whitcroft00df3442007-06-08 13:47:06 -07005161# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005162 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Abhijeet Dharmapurikar800a3132009-10-01 12:01:44 -07005163 WARN("IF_0",
5164 "if this code is redundant consider removing it\n"
5165 . $herecurr);
5166 }
5167
5168# warn about #if 1
5169 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5170 WARN("IF_1",
5171 "if this code is required consider removing"
5172 . " #if 1\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005173 }
5174
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005175# check for needless "if (<foo>) fn(<foo>)" uses
5176 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005177 my $tested = quotemeta($1);
5178 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5179 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5180 my $func = $1;
5181 if (WARN('NEEDLESS_IF',
5182 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5183 $fix) {
5184 my $do_fix = 1;
5185 my $leading_tabs = "";
5186 my $new_leading_tabs = "";
5187 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5188 $leading_tabs = $1;
5189 } else {
5190 $do_fix = 0;
5191 }
5192 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5193 $new_leading_tabs = $1;
5194 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5195 $do_fix = 0;
5196 }
5197 } else {
5198 $do_fix = 0;
5199 }
5200 if ($do_fix) {
5201 fix_delete_line($fixlinenr - 1, $prevrawline);
5202 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5203 }
5204 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005205 }
5206 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005207
Joe Perchesebfdc402014-08-06 16:10:27 -07005208# check for unnecessary "Out of Memory" messages
5209 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5210 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5211 (defined $1 || defined $3) &&
5212 $linenr > 3) {
5213 my $testval = $2;
5214 my $testline = $lines[$linenr - 3];
5215
5216 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5217# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5218
5219 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5220 WARN("OOM_MESSAGE",
5221 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5222 }
5223 }
5224
Joe Perchesf78d98f2014-10-13 15:52:01 -07005225# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005226 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005227 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5228 my $level = $1;
5229 if (WARN("UNNECESSARY_KERN_LEVEL",
5230 "Possible unnecessary $level\n" . $herecurr) &&
5231 $fix) {
5232 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5233 }
5234 }
5235
Joe Perchesabb08a52014-12-10 15:51:46 -08005236# check for mask then right shift without a parentheses
5237 if ($^V && $^V ge 5.10.0 &&
5238 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5239 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5240 WARN("MASK_THEN_SHIFT",
5241 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5242 }
5243
Joe Perchesb75ac612014-12-10 15:52:02 -08005244# check for pointer comparisons to NULL
5245 if ($^V && $^V ge 5.10.0) {
5246 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5247 my $val = $1;
5248 my $equal = "!";
5249 $equal = "" if ($4 eq "!=");
5250 if (CHK("COMPARISON_TO_NULL",
5251 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5252 $fix) {
5253 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5254 }
5255 }
5256 }
5257
Joe Perches8716de32013-09-11 14:24:05 -07005258# check for bad placement of section $InitAttribute (e.g.: __initdata)
5259 if ($line =~ /(\b$InitAttribute\b)/) {
5260 my $attr = $1;
5261 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5262 my $ptr = $1;
5263 my $var = $2;
5264 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5265 ERROR("MISPLACED_INIT",
5266 "$attr should be placed after $var\n" . $herecurr)) ||
5267 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5268 WARN("MISPLACED_INIT",
5269 "$attr should be placed after $var\n" . $herecurr))) &&
5270 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005271 $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 -07005272 }
5273 }
5274 }
5275
Joe Perchese970b882013-11-12 15:10:10 -08005276# check for $InitAttributeData (ie: __initdata) with const
5277 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5278 my $attr = $1;
5279 $attr =~ /($InitAttributePrefix)(.*)/;
5280 my $attr_prefix = $1;
5281 my $attr_type = $2;
5282 if (ERROR("INIT_ATTRIBUTE",
5283 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5284 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005285 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005286 s/$InitAttributeData/${attr_prefix}initconst/;
5287 }
5288 }
5289
5290# check for $InitAttributeConst (ie: __initconst) without const
5291 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5292 my $attr = $1;
5293 if (ERROR("INIT_ATTRIBUTE",
5294 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5295 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005296 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005297 /(^\+\s*(?:static\s+))/;
5298 $lead = rtrim($1);
5299 $lead = "$lead " if ($lead !~ /^\+$/);
5300 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005301 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08005302 }
5303 }
5304
Joe Perchesc17893c2015-04-16 12:44:42 -07005305# check for __read_mostly with const non-pointer (should just be const)
5306 if ($line =~ /\b__read_mostly\b/ &&
5307 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5308 if (ERROR("CONST_READ_MOSTLY",
5309 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5310 $fix) {
5311 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5312 }
5313 }
5314
Joe Perchesfbdb8132014-04-03 14:49:14 -07005315# don't use __constant_<foo> functions outside of include/uapi/
5316 if ($realfile !~ m@^include/uapi/@ &&
5317 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5318 my $constant_func = $1;
5319 my $func = $constant_func;
5320 $func =~ s/^__constant_//;
5321 if (WARN("CONSTANT_CONVERSION",
5322 "$constant_func should be $func\n" . $herecurr) &&
5323 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005324 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005325 }
5326 }
5327
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005328# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005329 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005330 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005331 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005332 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005333 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005334 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5335 }
5336 if ($delay > 2000) {
5337 WARN("LONG_UDELAY",
5338 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005339 }
5340 }
5341
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005342# warn about unexpectedly long msleep's
5343 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5344 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005345 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005346 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005347 }
5348 }
5349
Joe Perches36ec1932013-07-03 15:05:25 -07005350# check for comparisons of jiffies
5351 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5352 WARN("JIFFIES_COMPARISON",
5353 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5354 }
5355
Joe Perches9d7a34a2013-07-03 15:05:26 -07005356# check for comparisons of get_jiffies_64()
5357 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5358 WARN("JIFFIES_COMPARISON",
5359 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5360 }
5361
Israel Schlesinger5f8c9a22010-07-21 13:34:18 -07005362# check the patch for use of mdelay
5363 if ($line =~ /\bmdelay\s*\(/) {
5364 WARN("MDELAY",
5365 "use of mdelay() found: msleep() is the preferred API.\n" . $herecurr );
5366 }
5367
Andy Whitcroft00df3442007-06-08 13:47:06 -07005368# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005369# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005370# print "#ifdef in C files should be avoided\n";
5371# print "$herecurr";
5372# $clean = 0;
5373# }
5374
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005375# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005376 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005377 if (ERROR("SPACING",
5378 "exactly one space required after that #$1\n" . $herecurr) &&
5379 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005380 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005381 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5382 }
5383
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005384 }
5385
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005386# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005387 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5388 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005389 my $which = $1;
5390 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005391 CHK("UNCOMMENTED_DEFINITION",
5392 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005393 }
5394 }
5395# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005396
5397 my $barriers = qr{
5398 mb|
5399 rmb|
5400 wmb|
5401 read_barrier_depends
5402 }x;
5403 my $barrier_stems = qr{
5404 mb__before_atomic|
5405 mb__after_atomic|
5406 store_release|
5407 load_acquire|
5408 store_mb|
5409 (?:$barriers)
5410 }x;
5411 my $all_barriers = qr{
5412 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005413 smp_(?:$barrier_stems)|
5414 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005415 }x;
5416
5417 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005418 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005419 WARN("MEMORY_BARRIER",
5420 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005421 }
5422 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005423
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005424 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5425
5426 if ($realfile !~ m@^include/asm-generic/@ &&
5427 $realfile !~ m@/barrier\.h$@ &&
5428 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5429 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5430 WARN("MEMORY_BARRIER",
5431 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5432 }
5433
Joe Perchescb426e92015-06-25 15:02:46 -07005434# check for waitqueue_active without a comment.
5435 if ($line =~ /\bwaitqueue_active\s*\(/) {
5436 if (!ctx_has_comment($first_line, $linenr)) {
5437 WARN("WAITQUEUE_ACTIVE",
5438 "waitqueue_active without comment\n" . $herecurr);
5439 }
5440 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005441
5442# Check for expedited grace periods that interrupt non-idle non-nohz
5443# online CPUs. These expedited can therefore degrade real-time response
5444# if used carelessly, and should be avoided where not absolutely
5445# needed. It is always OK to use synchronize_rcu_expedited() and
5446# synchronize_sched_expedited() at boot time (before real-time applications
5447# start) and in error situations where real-time response is compromised in
5448# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5449# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5450# Of course, nothing comes for free, and srcu_read_lock() and
5451# srcu_read_unlock() do contain full memory barriers in payment for
5452# synchronize_srcu_expedited() non-interruption properties.
5453 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5454 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5455 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5456
5457 }
5458
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005459# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005460 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005461 CHK("ARCH_DEFINES",
5462 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005463 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005464
Tobias Klauserd4977c72010-05-24 14:33:30 -07005465# Check that the storage class is at the beginning of a declaration
5466 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005467 WARN("STORAGE_CLASS",
5468 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005469 }
5470
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005471# check the location of the inline attribute, that it is between
5472# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005473 if ($line =~ /\b$Type\s+$Inline\b/ ||
5474 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005475 ERROR("INLINE_LOCATION",
5476 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005477 }
5478
Andy Whitcroft8905a672007-11-28 16:21:06 -08005479# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005480 if ($realfile !~ m@\binclude/uapi/@ &&
5481 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005482 if (WARN("INLINE",
5483 "plain inline is preferred over $1\n" . $herecurr) &&
5484 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005485 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005486
5487 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005488 }
5489
Joe Perches3d130fd2011-01-12 17:00:00 -08005490# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005491 if ($realfile !~ m@\binclude/uapi/@ &&
5492 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005493 WARN("PREFER_PACKED",
5494 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005495 }
5496
Joe Perches39b7e282011-07-25 17:13:24 -07005497# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005498 if ($realfile !~ m@\binclude/uapi/@ &&
5499 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005500 WARN("PREFER_ALIGNED",
5501 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005502 }
5503
Joe Perches5f14d3b2012-01-10 15:09:52 -08005504# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005505 if ($realfile !~ m@\binclude/uapi/@ &&
5506 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005507 if (WARN("PREFER_PRINTF",
5508 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5509 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005510 $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 -07005511
5512 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005513 }
5514
Joe Perches6061d942012-03-23 15:02:16 -07005515# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005516 if ($realfile !~ m@\binclude/uapi/@ &&
5517 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005518 if (WARN("PREFER_SCANF",
5519 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5520 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005521 $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 -07005522 }
Joe Perches6061d942012-03-23 15:02:16 -07005523 }
5524
Joe Perches619a9082014-12-10 15:51:35 -08005525# Check for __attribute__ weak, or __weak declarations (may have link issues)
5526 if ($^V && $^V ge 5.10.0 &&
5527 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5528 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5529 $line =~ /\b__weak\b/)) {
5530 ERROR("WEAK_DECLARATION",
5531 "Using weak declarations can have unintended link defects\n" . $herecurr);
5532 }
5533
Joe Perchese6176fa2015-06-25 15:02:49 -07005534# check for c99 types like uint8_t used outside of uapi/
5535 if ($realfile !~ m@\binclude/uapi/@ &&
5536 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5537 my $type = $1;
5538 if ($type =~ /\b($typeC99Typedefs)\b/) {
5539 $type = $1;
5540 my $kernel_type = 'u';
5541 $kernel_type = 's' if ($type =~ /^_*[si]/);
5542 $type =~ /(\d+)/;
5543 $kernel_type .= $1;
5544 if (CHK("PREFER_KERNEL_TYPES",
5545 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5546 $fix) {
5547 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5548 }
5549 }
5550 }
5551
Joe Perches938224b2016-01-20 14:59:15 -08005552# check for cast of C90 native int or longer types constants
5553 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5554 my $cast = $1;
5555 my $const = $2;
5556 if (WARN("TYPECAST_INT_CONSTANT",
5557 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5558 $fix) {
5559 my $suffix = "";
5560 my $newconst = $const;
5561 $newconst =~ s/${Int_type}$//;
5562 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5563 if ($cast =~ /\blong\s+long\b/) {
5564 $suffix .= 'LL';
5565 } elsif ($cast =~ /\blong\b/) {
5566 $suffix .= 'L';
5567 }
5568 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5569 }
5570 }
5571
Joe Perches8f53a9b2010-03-05 13:43:48 -08005572# check for sizeof(&)
5573 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005574 WARN("SIZEOF_ADDRESS",
5575 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005576 }
5577
Joe Perches66c80b62012-07-30 14:41:22 -07005578# check for sizeof without parenthesis
5579 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005580 if (WARN("SIZEOF_PARENTHESIS",
5581 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5582 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005583 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005584 }
Joe Perches66c80b62012-07-30 14:41:22 -07005585 }
5586
Joe Perches88982fe2012-12-17 16:02:00 -08005587# check for struct spinlock declarations
5588 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5589 WARN("USE_SPINLOCK_T",
5590 "struct spinlock should be spinlock_t\n" . $herecurr);
5591 }
5592
Joe Perchesa6962d72013-04-29 16:18:13 -07005593# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005594 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005595 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005596 $fmt =~ s/%%//g;
5597 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005598 if (WARN("PREFER_SEQ_PUTS",
5599 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5600 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005601 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005602 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005603 }
5604 }
5605
Andy Whitcroft554e1652012-01-10 15:09:57 -08005606# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005607 if ($^V && $^V ge 5.10.0 &&
5608 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005609 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005610
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005611 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005612 my $ms_val = $7;
5613 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005614
Andy Whitcroft554e1652012-01-10 15:09:57 -08005615 if ($ms_size =~ /^(0x|)0$/i) {
5616 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005617 "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 -08005618 } elsif ($ms_size =~ /^(0x|)1$/i) {
5619 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005620 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5621 }
5622 }
5623
Joe Perches98a9bba2014-01-23 15:54:52 -08005624# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5625 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005626 defined $stat &&
5627 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005628 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005629 "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 -08005630 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005631 $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 -08005632 }
5633 }
5634
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005635# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5636 if ($^V && $^V ge 5.10.0 &&
5637 defined $stat &&
5638 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5639 WARN("PREFER_ETHER_ADDR_EQUAL",
5640 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5641 }
5642
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005643# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5644# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5645 if ($^V && $^V ge 5.10.0 &&
5646 defined $stat &&
5647 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5648
5649 my $ms_val = $7;
5650
5651 if ($ms_val =~ /^(?:0x|)0+$/i) {
5652 if (WARN("PREFER_ETH_ZERO_ADDR",
5653 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5654 $fix) {
5655 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5656 }
5657 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5658 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5659 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5660 $fix) {
5661 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5662 }
5663 }
5664 }
5665
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005666# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005667 if ($^V && $^V ge 5.10.0 &&
5668 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005669 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005670 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005671 my $call = $1;
5672 my $cast1 = deparenthesize($2);
5673 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005674 my $cast2 = deparenthesize($7);
5675 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005676 my $cast;
5677
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005678 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005679 $cast = "$cast1 or $cast2";
5680 } elsif ($cast1 ne "") {
5681 $cast = $cast1;
5682 } else {
5683 $cast = $cast2;
5684 }
5685 WARN("MINMAX",
5686 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005687 }
5688 }
5689
Joe Perches4a273192012-07-30 14:41:20 -07005690# check usleep_range arguments
5691 if ($^V && $^V ge 5.10.0 &&
5692 defined $stat &&
5693 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5694 my $min = $1;
5695 my $max = $7;
5696 if ($min eq $max) {
5697 WARN("USLEEP_RANGE",
5698 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5699 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5700 $min > $max) {
5701 WARN("USLEEP_RANGE",
5702 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5703 }
5704 }
5705
Joe Perches823b7942013-11-12 15:10:15 -08005706# check for naked sscanf
5707 if ($^V && $^V ge 5.10.0 &&
5708 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005709 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005710 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5711 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5712 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5713 my $lc = $stat =~ tr@\n@@;
5714 $lc = $lc + $linenr;
5715 my $stat_real = raw_line($linenr, 0);
5716 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5717 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5718 }
5719 WARN("NAKED_SSCANF",
5720 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5721 }
5722
Joe Perchesafc819a2014-06-04 16:12:08 -07005723# check for simple sscanf that should be kstrto<foo>
5724 if ($^V && $^V ge 5.10.0 &&
5725 defined $stat &&
5726 $line =~ /\bsscanf\b/) {
5727 my $lc = $stat =~ tr@\n@@;
5728 $lc = $lc + $linenr;
5729 my $stat_real = raw_line($linenr, 0);
5730 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5731 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5732 }
5733 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5734 my $format = $6;
5735 my $count = $format =~ tr@%@%@;
5736 if ($count == 1 &&
5737 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5738 WARN("SSCANF_TO_KSTRTO",
5739 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5740 }
5741 }
5742 }
5743
Joe Perches70dc8a42013-09-11 14:23:58 -07005744# check for new externs in .h files.
5745 if ($realfile =~ /\.h$/ &&
5746 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005747 if (CHK("AVOID_EXTERNS",
5748 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005749 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005750 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005751 }
5752 }
5753
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005754# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005755 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005756 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005757 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005758 my $function_name = $1;
5759 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005760
5761 my $s = $stat;
5762 if (defined $cond) {
5763 substr($s, 0, length($cond), '');
5764 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005765 if ($s =~ /^\s*;/ &&
5766 $function_name ne 'uninitialized_var')
5767 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005768 WARN("AVOID_EXTERNS",
5769 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005770 }
5771
5772 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005773 WARN("FUNCTION_ARGUMENTS",
5774 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005775 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005776
5777 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5778 $stat =~ /^.\s*extern\s+/)
5779 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005780 WARN("AVOID_EXTERNS",
5781 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005782 }
5783
5784# checks for new __setup's
5785 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5786 my $name = $1;
5787
5788 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005789 CHK("UNDOCUMENTED_SETUP",
5790 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005791 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005792 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005793
5794# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005795 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005796 WARN("UNNECESSARY_CASTS",
5797 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005798 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005799
Joe Perchesa640d252013-07-03 15:05:21 -07005800# alloc style
5801# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5802 if ($^V && $^V ge 5.10.0 &&
5803 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5804 CHK("ALLOC_SIZEOF_STRUCT",
5805 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5806 }
5807
Joe Perches60a55362014-06-04 16:12:07 -07005808# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5809 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005810 $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 -07005811 my $oldfunc = $3;
5812 my $a1 = $4;
5813 my $a2 = $10;
5814 my $newfunc = "kmalloc_array";
5815 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005816 my $r1 = $a1;
5817 my $r2 = $a2;
5818 if ($a1 =~ /^sizeof\s*\S/) {
5819 $r1 = $a2;
5820 $r2 = $a1;
5821 }
5822 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5823 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005824 if (WARN("ALLOC_WITH_MULTIPLY",
5825 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5826 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005827 $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 -07005828
5829 }
5830 }
5831 }
5832
Joe Perches972fdea2013-04-29 16:18:12 -07005833# check for krealloc arg reuse
5834 if ($^V && $^V ge 5.10.0 &&
5835 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5836 WARN("KREALLOC_ARG_REUSE",
5837 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5838 }
5839
Joe Perches5ce59ae2013-02-21 16:44:18 -08005840# check for alloc argument mismatch
5841 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5842 WARN("ALLOC_ARRAY_ARGS",
5843 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5844 }
5845
Joe Perchescaf2a542011-01-12 16:59:56 -08005846# check for multiple semicolons
5847 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005848 if (WARN("ONE_SEMICOLON",
5849 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5850 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005851 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005852 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005853 }
5854
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005855# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5856 if ($realfile !~ m@^include/uapi/@ &&
5857 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08005858 my $ull = "";
5859 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5860 if (CHK("BIT_MACRO",
5861 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5862 $fix) {
5863 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5864 }
5865 }
5866
Joe Perches2d632742016-05-20 17:04:00 -07005867# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5868 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5869 my $config = $1;
5870 if (WARN("PREFER_IS_ENABLED",
5871 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5872 $fix) {
5873 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5874 }
5875 }
5876
Joe Perchese81f2392014-08-06 16:11:25 -07005877# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005878 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5879 my $has_break = 0;
5880 my $has_statement = 0;
5881 my $count = 0;
5882 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005883 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005884 $prevline--;
5885 my $rline = $rawlines[$prevline - 1];
5886 my $fline = $lines[$prevline - 1];
5887 last if ($fline =~ /^\@\@/);
5888 next if ($fline =~ /^\-/);
5889 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5890 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5891 next if ($fline =~ /^.[\s$;]*$/);
5892 $has_statement = 1;
5893 $count++;
5894 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5895 }
5896 if (!$has_break && $has_statement) {
5897 WARN("MISSING_BREAK",
5898 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5899 }
5900 }
5901
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005902# check for switch/default statements without a break;
5903 if ($^V && $^V ge 5.10.0 &&
5904 defined $stat &&
5905 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5906 my $ctx = '';
5907 my $herectx = $here . "\n";
5908 my $cnt = statement_rawlines($stat);
5909 for (my $n = 0; $n < $cnt; $n++) {
5910 $herectx .= raw_line($linenr, $n) . "\n";
5911 }
5912 WARN("DEFAULT_NO_BREAK",
5913 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005914 }
5915
Patrick Pannutof370e252010-07-23 13:34:18 -07005916# check for return codes on error paths
5917 if ($line =~ /\breturn\s+-\d+/) {
5918 ERROR("NO_ERROR_CODE",
Patrick Pannutoe50031c2010-08-04 14:30:59 -07005919 "illegal return value, please use an error code\n" . $herecurr);
Patrick Pannutof370e252010-07-23 13:34:18 -07005920 }
5921
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005922# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005923 if ($line =~ /\b__FUNCTION__\b/) {
5924 if (WARN("USE_FUNC",
5925 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5926 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005927 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005928 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005929 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005930
Joe Perches62ec8182015-02-13 14:38:18 -08005931# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5932 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5933 ERROR("DATE_TIME",
5934 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5935 }
5936
Joe Perches2c924882012-03-23 15:02:20 -07005937# check for use of yield()
5938 if ($line =~ /\byield\s*\(\s*\)/) {
5939 WARN("YIELD",
5940 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5941 }
5942
Joe Perches179f8f42013-07-03 15:05:30 -07005943# check for comparisons against true and false
5944 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5945 my $lead = $1;
5946 my $arg = $2;
5947 my $test = $3;
5948 my $otype = $4;
5949 my $trail = $5;
5950 my $op = "!";
5951
5952 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5953
5954 my $type = lc($otype);
5955 if ($type =~ /^(?:true|false)$/) {
5956 if (("$test" eq "==" && "$type" eq "true") ||
5957 ("$test" eq "!=" && "$type" eq "false")) {
5958 $op = "";
5959 }
5960
5961 CHK("BOOL_COMPARISON",
5962 "Using comparison to $otype is error prone\n" . $herecurr);
5963
5964## maybe suggesting a correct construct would better
5965## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5966
5967 }
5968 }
5969
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005970# check for semaphores initialized locked
5971 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005972 WARN("CONSIDER_COMPLETION",
5973 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005974 }
Joe Perches6712d852012-03-23 15:02:20 -07005975
Joe Perches67d0a072011-10-31 17:13:10 -07005976# recommend kstrto* over simple_strto* and strict_strto*
5977 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005978 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005979 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005980 }
Joe Perches6712d852012-03-23 15:02:20 -07005981
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005982# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005983 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005984 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005985 "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 -07005986 }
Joe Perches6712d852012-03-23 15:02:20 -07005987
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005988# check for various structs that are normally const (ops, kgdb, device_tree)
5989 my $const_structs = qr{
5990 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005991 address_space_operations|
5992 backlight_ops|
5993 block_device_operations|
5994 dentry_operations|
5995 dev_pm_ops|
5996 dma_map_ops|
5997 extent_io_ops|
5998 file_lock_operations|
5999 file_operations|
6000 hv_ops|
6001 ide_dma_ops|
6002 intel_dvo_dev_ops|
6003 item_operations|
6004 iwl_ops|
6005 kgdb_arch|
6006 kgdb_io|
6007 kset_uevent_ops|
6008 lock_manager_operations|
6009 microcode_ops|
6010 mtrr_ops|
6011 neigh_ops|
6012 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006013 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08006014 pci_raw_ops|
6015 pipe_buf_operations|
6016 platform_hibernation_ops|
6017 platform_suspend_ops|
6018 proto_ops|
6019 rpc_pipe_ops|
6020 seq_operations|
6021 snd_ac97_build_ops|
6022 soc_pcmcia_socket_ops|
6023 stacktrace_ops|
6024 sysfs_ops|
6025 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07006026 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08006027 usb_mon_operations|
6028 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006029 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006030 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006031 WARN("CONST_STRUCT",
6032 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006033 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006034 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006035
6036# use of NR_CPUS is usually wrong
6037# ignore definitions of NR_CPUS and usage to define arrays as likely right
6038 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006039 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6040 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006041 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6042 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6043 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006044 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006045 WARN("NR_CPUS",
6046 "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 -07006047 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006048
Joe Perches52ea8502013-11-12 15:10:09 -08006049# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6050 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6051 ERROR("DEFINE_ARCH_HAS",
6052 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6053 }
6054
Joe Perchesacd93622015-02-13 14:38:38 -08006055# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6056 if ($^V && $^V ge 5.10.0 &&
6057 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6058 WARN("LIKELY_MISUSE",
6059 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6060 }
6061
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006062# whine mightly about in_atomic
6063 if ($line =~ /\bin_atomic\s*\(/) {
6064 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006065 ERROR("IN_ATOMIC",
6066 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006067 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006068 WARN("IN_ATOMIC",
6069 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006070 }
6071 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006072
Joe Perches481aea52016-05-20 17:04:08 -07006073# whine about ACCESS_ONCE
6074 if ($^V && $^V ge 5.10.0 &&
6075 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6076 my $par = $1;
6077 my $eq = $2;
6078 my $fun = $3;
6079 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6080 if (defined($eq)) {
6081 if (WARN("PREFER_WRITE_ONCE",
6082 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6083 $fix) {
6084 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6085 }
6086 } else {
6087 if (WARN("PREFER_READ_ONCE",
6088 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6089 $fix) {
6090 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6091 }
6092 }
6093 }
6094
Peter Zijlstra1704f472010-03-19 01:37:42 +01006095# check for lockdep_set_novalidate_class
6096 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6097 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6098 if ($realfile !~ m@^kernel/lockdep@ &&
6099 $realfile !~ m@^include/linux/lockdep@ &&
6100 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006101 ERROR("LOCKDEP",
6102 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006103 }
6104 }
Dave Jones88f88312011-01-12 16:59:59 -08006105
Joe Perchesb392c642015-04-16 12:44:16 -07006106 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6107 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006108 WARN("EXPORTED_WORLD_WRITABLE",
6109 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006110 }
Joe Perches24358802014-04-03 14:49:13 -07006111
Joe Perches515a2352014-04-03 14:49:24 -07006112# Mode permission misuses where it seems decimal should be octal
6113# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6114 if ($^V && $^V ge 5.10.0 &&
6115 $line =~ /$mode_perms_search/) {
6116 foreach my $entry (@mode_permission_funcs) {
6117 my $func = $entry->[0];
6118 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006119
Joe Perches515a2352014-04-03 14:49:24 -07006120 my $skip_args = "";
6121 if ($arg_pos > 1) {
6122 $arg_pos--;
6123 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6124 }
6125 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
6126 if ($line =~ /$test/) {
6127 my $val = $1;
6128 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07006129
Joe Perches515a2352014-04-03 14:49:24 -07006130 if ($val !~ /^0$/ &&
6131 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6132 length($val) ne 4)) {
6133 ERROR("NON_OCTAL_PERMISSIONS",
6134 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08006135 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6136 ERROR("EXPORTED_WORLD_WRITABLE",
6137 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006138 }
Joe Perches24358802014-04-03 14:49:13 -07006139 }
6140 }
6141 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006142
6143# validate content of MODULE_LICENSE against list from include/linux/module.h
6144 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6145 my $extracted_string = get_quoted_string($line, $rawline);
6146 my $valid_licenses = qr{
6147 GPL|
6148 GPL\ v2|
6149 GPL\ and\ additional\ rights|
6150 Dual\ BSD/GPL|
6151 Dual\ MIT/GPL|
6152 Dual\ MPL/GPL|
6153 Proprietary
6154 }x;
6155 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6156 WARN("MODULE_LICENSE",
6157 "unknown module license " . $extracted_string . "\n" . $herecurr);
6158 }
6159 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006160 }
6161
6162 # If we have no input at all, then there is nothing to report on
6163 # so just keep quiet.
6164 if ($#rawlines == -1) {
6165 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006166 }
6167
Andy Whitcroft8905a672007-11-28 16:21:06 -08006168 # In mailback mode only produce a report in the negative, for
6169 # things that appear to be patches.
6170 if ($mailback && ($clean == 1 || !$is_patch)) {
6171 exit(0);
6172 }
6173
6174 # This is not a patch, and we are are in 'no-patch' mode so
6175 # just keep quiet.
6176 if (!$chk_patch && !$is_patch) {
6177 exit(0);
6178 }
6179
Joe Perches06330fc2015-06-25 15:03:11 -07006180 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006181 ERROR("NOT_UNIFIED_DIFF",
6182 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006183 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006184 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006185 ERROR("MISSING_SIGN_OFF",
6186 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006187 }
6188
Andy Whitcroft8905a672007-11-28 16:21:06 -08006189 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006190 if ($summary && !($clean == 1 && $quiet == 1)) {
6191 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006192 print "total: $cnt_error errors, $cnt_warn warnings, " .
6193 (($check)? "$cnt_chk checks, " : "") .
6194 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006195 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006196
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006197 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006198 # If there were any defects found and not already fixing them
6199 if (!$clean and !$fix) {
6200 print << "EOM"
6201
6202NOTE: For some of the reported defects, checkpatch may be able to
6203 mechanically convert to the typical style using --fix or --fix-inplace.
6204EOM
6205 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006206 # If there were whitespace errors which cleanpatch can fix
6207 # then suggest that.
6208 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006209 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006210 print << "EOM"
6211
6212NOTE: Whitespace errors detected.
6213 You may wish to use scripts/cleanpatch or scripts/cleanfile
6214EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006215 }
6216 }
6217
Joe Perchesd752fcc2014-08-06 16:11:05 -07006218 if ($clean == 0 && $fix &&
6219 ("@rawlines" ne "@fixed" ||
6220 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006221 my $newfile = $filename;
6222 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006223 my $linecount = 0;
6224 my $f;
6225
Joe Perchesd752fcc2014-08-06 16:11:05 -07006226 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6227
Joe Perches3705ce52013-07-03 15:05:31 -07006228 open($f, '>', $newfile)
6229 or die "$P: Can't open $newfile for write\n";
6230 foreach my $fixed_line (@fixed) {
6231 $linecount++;
6232 if ($file) {
6233 if ($linecount > 3) {
6234 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006235 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006236 }
6237 } else {
6238 print $f $fixed_line . "\n";
6239 }
6240 }
6241 close($f);
6242
6243 if (!$quiet) {
6244 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006245
Joe Perches3705ce52013-07-03 15:05:31 -07006246Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6247
6248Do _NOT_ trust the results written to this file.
6249Do _NOT_ submit these changes without inspecting them for correctness.
6250
6251This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6252No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006253EOM
6254 }
6255 }
6256
Joe Perchesd8469f12015-06-25 15:03:00 -07006257 if ($quiet == 0) {
6258 print "\n";
6259 if ($clean == 1) {
6260 print "$vname has no obvious style problems and is ready for submission.\n";
6261 } else {
6262 print "$vname has style problems, please review.\n";
6263 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006264 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006265 return $clean;
6266}