blob: 10f3a3e5aa89e27009a32a1e91fe0d22be845863 [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 }
Joe Perches7e51f192013-09-11 14:23:57 -07002427
2428# Check for duplicate signatures
2429 my $sig_nospace = $line;
2430 $sig_nospace =~ s/\s//g;
2431 $sig_nospace = lc($sig_nospace);
2432 if (defined $signatures{$sig_nospace}) {
2433 WARN("BAD_SIGN_OFF",
2434 "Duplicate signature\n" . $herecurr);
2435 } else {
2436 $signatures{$sig_nospace} = 1;
2437 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002438 }
2439
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002440# Check email subject for common tools that don't need to be mentioned
2441 if ($in_header_lines &&
2442 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2443 WARN("EMAIL_SUBJECT",
2444 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2445 }
2446
Joe Perches9b3189e2014-06-04 16:12:10 -07002447# Check for old stable address
2448 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2449 ERROR("STABLE_ADDRESS",
2450 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2451 }
2452
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002453# Check for unwanted Gerrit info
2454 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2455 ERROR("GERRIT_CHANGE_ID",
2456 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2457 }
2458
Joe Perches369c8dd2015-11-06 16:31:34 -08002459# Check if the commit log is in a possible stack dump
2460 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2461 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2462 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2463 # timestamp
2464 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2465 # stack dump address
2466 $commit_log_possible_stack_dump = 1;
2467 }
2468
Joe Perches2a076f42015-04-16 12:44:28 -07002469# Check for line lengths > 75 in commit log, warn once
2470 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002471 length($line) > 75 &&
2472 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2473 # file delta changes
2474 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2475 # filename then :
2476 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2477 # A Fixes: or Link: line
2478 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002479 WARN("COMMIT_LOG_LONG_LINE",
2480 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2481 $commit_log_long_line = 1;
2482 }
2483
Joe Perchesbf4daf12015-09-09 15:37:50 -07002484# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002485 if ($in_commit_log && $commit_log_possible_stack_dump &&
2486 $line =~ /^\s*$/) {
2487 $commit_log_possible_stack_dump = 0;
2488 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002489
Joe Perches0d7835f2015-02-13 14:38:35 -08002490# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002491 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002492 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002493 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002494 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002495 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2496 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002497 my $init_char = "c";
2498 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002499 my $short = 1;
2500 my $long = 0;
2501 my $case = 1;
2502 my $space = 1;
2503 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002504 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002505 my $id = '0123456789ab';
2506 my $orig_desc = "commit description";
2507 my $description = "";
2508
Joe Perchesfe043ea2015-09-09 15:37:25 -07002509 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2510 $init_char = $1;
2511 $orig_commit = lc($2);
2512 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2513 $orig_commit = lc($1);
2514 }
2515
Joe Perches0d7835f2015-02-13 14:38:35 -08002516 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2517 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2518 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2519 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2520 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2521 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002522 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002523 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2524 defined $rawlines[$linenr] &&
2525 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2526 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002527 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002528 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2529 defined $rawlines[$linenr] &&
2530 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2531 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2532 $orig_desc = $1;
2533 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2534 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002535 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002536 }
2537
2538 ($id, $description) = git_commit_info($orig_commit,
2539 $id, $orig_desc);
2540
Joe Perches19c146a2015-02-13 14:39:00 -08002541 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002542 ERROR("GIT_COMMIT_ID",
2543 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2544 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002545 }
2546
Joe Perches13f19372014-08-06 16:10:59 -07002547# Check for added, moved or deleted files
2548 if (!$reported_maintainer_file && !$in_commit_log &&
2549 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2550 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2551 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2552 (defined($1) || defined($2))))) {
2553 $reported_maintainer_file = 1;
2554 WARN("FILE_PATH_CHANGES",
2555 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2556 }
2557
Andy Whitcroft00df3442007-06-08 13:47:06 -07002558# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002559 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002560 ERROR("CORRUPTED_PATCH",
2561 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002562 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002563 }
2564
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002565# Check for absolute kernel paths.
2566 if ($tree) {
2567 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2568 my $file = $1;
2569
2570 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2571 check_absolute_file($1, $herecurr)) {
2572 #
2573 } else {
2574 check_absolute_file($file, $herecurr);
2575 }
2576 }
2577 }
2578
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002579# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2580 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002581 $rawline !~ m/^$UTF8*$/) {
2582 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2583
2584 my $blank = copy_spacing($rawline);
2585 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2586 my $hereptr = "$hereline$ptr\n";
2587
Joe Perches34d99212011-07-25 17:13:26 -07002588 CHK("INVALID_UTF8",
2589 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002590 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002591
Joe Perches15662b32011-10-31 17:13:12 -07002592# Check if it's the start of a commit log
2593# (not a header line and we haven't seen the patch filename)
2594 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002595 !($rawline =~ /^\s+\S/ ||
2596 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002597 $in_header_lines = 0;
2598 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002599 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002600 }
2601
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002602# Check if there is UTF-8 in a commit log when a mail header has explicitly
2603# declined it, i.e defined some charset where it is missing.
2604 if ($in_header_lines &&
2605 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2606 $1 !~ /utf-8/i) {
2607 $non_utf8_charset = 1;
2608 }
2609
2610 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002611 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002612 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002613 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2614 }
2615
Kees Cook66b47b42014-10-13 15:51:57 -07002616# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002617 if (defined($misspellings) &&
2618 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002619 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002620 my $typo = $1;
2621 my $typo_fix = $spelling_fix{lc($typo)};
2622 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2623 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2624 my $msg_type = \&WARN;
2625 $msg_type = \&CHK if ($file);
2626 if (&{$msg_type}("TYPO_SPELLING",
2627 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2628 $fix) {
2629 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2630 }
2631 }
2632 }
2633
Andy Whitcroft306708542008-10-15 22:02:28 -07002634# ignore non-hunk lines and lines being removed
2635 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002636
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002637#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002638 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002639 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002640 if (ERROR("DOS_LINE_ENDINGS",
2641 "DOS line endings\n" . $herevet) &&
2642 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002643 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002644 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002645 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2646 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002647 if (ERROR("TRAILING_WHITESPACE",
2648 "trailing whitespace\n" . $herevet) &&
2649 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002650 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002651 }
2652
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002653 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002654 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002655
Josh Triplett4783f892013-11-12 15:10:12 -08002656# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002657 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002658 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2659 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002660 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2661 my $msg_type = \&ERROR;
2662 $msg_type = \&CHK if ($file);
2663 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002664 "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 -08002665 }
2666
Andi Kleen33549572010-05-24 14:33:29 -07002667# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002668# Only applies when adding the entry originally, after that we do not have
2669# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002670 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002671 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002672 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002673 my $cnt = $realcnt;
2674 my $ln = $linenr + 1;
2675 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002676 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002677 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002678 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002679 $f = $lines[$ln - 1];
2680 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2681 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002682
2683 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002684 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002685
Joe Perches8d73e0e2014-08-06 16:10:46 -07002686 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002687 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002688 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002689 $length = -1;
2690 }
2691
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002692 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002693 $f =~ s/#.*//;
2694 $f =~ s/^\s+//;
2695 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002696 if ($f =~ /^\s*config\s/) {
2697 $is_end = 1;
2698 last;
2699 }
Andi Kleen33549572010-05-24 14:33:29 -07002700 $length++;
2701 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002702 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2703 WARN("CONFIG_DESCRIPTION",
2704 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2705 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002706 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002707 }
2708
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002709# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2710 if ($realfile =~ /Kconfig/ &&
2711 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2712 WARN("CONFIG_EXPERIMENTAL",
2713 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2714 }
2715
Christoph Jaeger327953e2015-02-13 14:38:29 -08002716# discourage the use of boolean for type definition attributes of Kconfig options
2717 if ($realfile =~ /Kconfig/ &&
2718 $line =~ /^\+\s*\bboolean\b/) {
2719 WARN("CONFIG_TYPE_BOOLEAN",
2720 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2721 }
2722
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002723 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2724 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2725 my $flag = $1;
2726 my $replacement = {
2727 'EXTRA_AFLAGS' => 'asflags-y',
2728 'EXTRA_CFLAGS' => 'ccflags-y',
2729 'EXTRA_CPPFLAGS' => 'cppflags-y',
2730 'EXTRA_LDFLAGS' => 'ldflags-y',
2731 };
2732
2733 WARN("DEPRECATED_VARIABLE",
2734 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2735 }
2736
Rob Herringbff5da42014-01-23 15:54:51 -08002737# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002738 if (defined $root &&
2739 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2740 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2741
Rob Herringbff5da42014-01-23 15:54:51 -08002742 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2743
Florian Vaussardcc933192014-04-03 14:49:27 -07002744 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2745 my $vp_file = $dt_path . "vendor-prefixes.txt";
2746
Rob Herringbff5da42014-01-23 15:54:51 -08002747 foreach my $compat (@compats) {
2748 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002749 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2750 my $compat3 = $compat;
2751 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2752 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002753 if ( $? >> 8 ) {
2754 WARN("UNDOCUMENTED_DT_STRING",
2755 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2756 }
2757
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002758 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2759 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002760 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002761 if ( $? >> 8 ) {
2762 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002763 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002764 }
2765 }
2766 }
2767
Andy Whitcroft5368df22008-10-15 22:02:27 -07002768# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002769 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002770
Joe Perches47e0c882015-06-25 15:02:57 -07002771# line length limit (with some exclusions)
2772#
2773# There are a few types of lines that may extend beyond $max_line_length:
2774# logging functions like pr_info that end in a string
2775# lines with a single string
2776# #defines that are a single string
2777#
2778# There are 3 different line length message types:
2779# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2780# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2781# LONG_LINE all other lines longer than $max_line_length
2782#
2783# if LONG_LINE is ignored, the other 2 types are also ignored
2784#
Israel Schlesingerc5955792010-07-27 13:28:26 -07002785 if ($line =~ /^\+/ && $length > $max_line_length && $realfile ne "scripts/checkpatch.pl") {
Joe Perches47e0c882015-06-25 15:02:57 -07002786 my $msg_type = "LONG_LINE";
2787
2788 # Check the allowed long line types first
2789
2790 # logging functions that end in a string that starts
2791 # before $max_line_length
2792 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2793 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2794 $msg_type = "";
2795
2796 # lines with only strings (w/ possible termination)
2797 # #defines with only strings
2798 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2799 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2800 $msg_type = "";
2801
Joe Perchesd560a5f2016-08-02 14:04:31 -07002802 # EFI_GUID is another special case
2803 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2804 $msg_type = "";
2805
Joe Perches47e0c882015-06-25 15:02:57 -07002806 # Otherwise set the alternate message types
2807
2808 # a comment starts before $max_line_length
2809 } elsif ($line =~ /($;[\s$;]*)$/ &&
2810 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2811 $msg_type = "LONG_LINE_COMMENT"
2812
2813 # a quoted string starts before $max_line_length
2814 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2815 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2816 $msg_type = "LONG_LINE_STRING"
2817 }
2818
2819 if ($msg_type ne "" &&
2820 (show_type("LONG_LINE") || show_type($msg_type))) {
2821 WARN($msg_type,
2822 "line over $max_line_length characters\n" . $herecurr);
2823 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002824 }
2825
Andy Whitcroft8905a672007-11-28 16:21:06 -08002826# check for adding lines without a newline.
2827 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002828 WARN("MISSING_EOF_NEWLINE",
2829 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002830 }
2831
Mike Frysinger42e41c52009-09-21 17:04:40 -07002832# Blackfin: use hi/lo macros
2833 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2834 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2835 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002836 ERROR("LO_MACRO",
2837 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002838 }
2839 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2840 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002841 ERROR("HI_MACRO",
2842 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002843 }
2844 }
2845
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002846# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002847 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002848
2849# at the beginning of a line any tabs must come first and anything
2850# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002851 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2852 $rawline =~ /^\+\s* \s*/) {
2853 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002854 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002855 if (ERROR("CODE_INDENT",
2856 "code indent should use tabs where possible\n" . $herevet) &&
2857 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002858 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002859 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002860 }
2861
Alberto Panizzo08e44362010-03-05 13:43:54 -08002862# check for space before tabs.
2863 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2864 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002865 if (WARN("SPACE_BEFORE_TAB",
2866 "please, no space before tabs\n" . $herevet) &&
2867 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002868 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002869 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002870 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002871 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002872 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002873 }
2874
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002875# check for && or || at the start of a line
2876 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2877 CHK("LOGICAL_CONTINUATIONS",
2878 "Logical continuations should be on the previous line\n" . $hereprev);
2879 }
2880
Joe Perchesa91e8992016-05-20 17:04:05 -07002881# check indentation starts on a tab stop
2882 if ($^V && $^V ge 5.10.0 &&
2883 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2884 my $indent = length($1);
2885 if ($indent % 8) {
2886 if (WARN("TABSTOP",
2887 "Statements should start on a tabstop\n" . $herecurr) &&
2888 $fix) {
2889 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2890 }
2891 }
2892 }
2893
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002894# check multi-line statement indentation matches previous line
2895 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002896 $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 -07002897 $prevline =~ /^\+(\t*)(.*)$/;
2898 my $oldindent = $1;
2899 my $rest = $2;
2900
2901 my $pos = pos_last_openparen($rest);
2902 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002903 $line =~ /^(\+| )([ \t]*)/;
2904 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002905
2906 my $goodtabindent = $oldindent .
2907 "\t" x ($pos / 8) .
2908 " " x ($pos % 8);
2909 my $goodspaceindent = $oldindent . " " x $pos;
2910
2911 if ($newindent ne $goodtabindent &&
2912 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002913
2914 if (CHK("PARENTHESIS_ALIGNMENT",
2915 "Alignment should match open parenthesis\n" . $hereprev) &&
2916 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002917 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002918 s/^\+[ \t]*/\+$goodtabindent/;
2919 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002920 }
2921 }
2922 }
2923
Joe Perches6ab3a972015-04-16 12:44:05 -07002924# check for space after cast like "(int) foo" or "(struct foo) bar"
2925# avoid checking a few false positives:
2926# "sizeof(<type>)" or "__alignof__(<type>)"
2927# function pointer declarations like "(*foo)(int) = bar;"
2928# structure definitions like "(struct foo) { 0 };"
2929# multiline macros that define functions
2930# known attributes or the __attribute__ keyword
2931 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2932 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002933 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002934 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002935 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002936 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002937 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002938 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002939 }
2940
Joe Perches86406b12015-09-09 15:37:41 -07002941# Block comment styles
2942# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002943 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002944 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002945 $rawline =~ /^\+[ \t]*\*/ &&
2946 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002947 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2948 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2949 }
2950
Joe Perches86406b12015-09-09 15:37:41 -07002951# Block comments use * on subsequent lines
2952 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2953 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002954 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002955 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002956 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002957 WARN("BLOCK_COMMENT_STYLE",
2958 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002959 }
2960
Joe Perches86406b12015-09-09 15:37:41 -07002961# Block comments use */ on trailing lines
2962 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002963 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2964 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2965 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002966 WARN("BLOCK_COMMENT_STYLE",
2967 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002968 }
2969
Joe Perches7f619192014-08-06 16:10:39 -07002970# check for missing blank lines after struct/union declarations
2971# with exceptions for various attributes and macros
2972 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2973 $line =~ /^\+/ &&
2974 !($line =~ /^\+\s*$/ ||
2975 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2976 $line =~ /^\+\s*MODULE_/i ||
2977 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2978 $line =~ /^\+[a-z_]*init/ ||
2979 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2980 $line =~ /^\+\s*DECLARE/ ||
2981 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002982 if (CHK("LINE_SPACING",
2983 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2984 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002985 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002986 }
Joe Perches7f619192014-08-06 16:10:39 -07002987 }
2988
Joe Perches365dd4e2014-08-06 16:10:42 -07002989# check for multiple consecutive blank lines
2990 if ($prevline =~ /^[\+ ]\s*$/ &&
2991 $line =~ /^\+\s*$/ &&
2992 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002993 if (CHK("LINE_SPACING",
2994 "Please don't use multiple blank lines\n" . $hereprev) &&
2995 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002996 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002997 }
2998
Joe Perches365dd4e2014-08-06 16:10:42 -07002999 $last_blank_line = $linenr;
3000 }
3001
Joe Perches3b617e32014-04-03 14:49:28 -07003002# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003003 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3004 # actual declarations
3005 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003006 # function pointer declarations
3007 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003008 # foo bar; where foo is some local typedef or #define
3009 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3010 # known declaration macros
3011 $prevline =~ /^\+\s+$declaration_macros/) &&
3012 # for "else if" which can look like "$Ident $Ident"
3013 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3014 # other possible extensions of declaration lines
3015 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3016 # not starting a section or a macro "\" extended line
3017 $prevline =~ /(?:\{\s*|\\)$/) &&
3018 # looks like a declaration
3019 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003020 # function pointer declarations
3021 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003022 # foo bar; where foo is some local typedef or #define
3023 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3024 # known declaration macros
3025 $sline =~ /^\+\s+$declaration_macros/ ||
3026 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003027 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003028 # start or end of block or continuation of declaration
3029 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3030 # bitfield continuation
3031 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3032 # other possible extensions of declaration lines
3033 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3034 # indentation of previous and current line are the same
3035 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003036 if (WARN("LINE_SPACING",
3037 "Missing a blank line after declarations\n" . $hereprev) &&
3038 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003039 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003040 }
Joe Perches3b617e32014-04-03 14:49:28 -07003041 }
3042
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003043# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003044# Exceptions:
3045# 1) within comments
3046# 2) indented preprocessor commands
3047# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003048 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003049 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003050 if (WARN("LEADING_SPACE",
3051 "please, no spaces at the start of a line\n" . $herevet) &&
3052 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003053 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003054 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003055 }
3056
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003057# check we are in a valid C source file if not then ignore this hunk
3058 next if ($realfile !~ /\.(h|c)$/);
3059
Joe Perches032a4c02014-08-06 16:10:29 -07003060# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003061# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003062# if the previous line is a break or return and is indented 1 tab more...
3063 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3064 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003065 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3066 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3067 defined $lines[$linenr] &&
3068 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003069 WARN("UNNECESSARY_ELSE",
3070 "else is not generally useful after a break or return\n" . $hereprev);
3071 }
3072 }
3073
Joe Perchesc00df192014-08-06 16:11:01 -07003074# check indentation of a line with a break;
3075# if the previous line is a goto or return and is indented the same # of tabs
3076 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3077 my $tabs = $1;
3078 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3079 WARN("UNNECESSARY_BREAK",
3080 "break is not useful after a goto or return\n" . $hereprev);
3081 }
3082 }
3083
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003084# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3085 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3086 WARN("CONFIG_EXPERIMENTAL",
3087 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3088 }
3089
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003090# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003091 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003092 WARN("CVS_KEYWORD",
3093 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003094 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003095
Mike Frysinger42e41c52009-09-21 17:04:40 -07003096# Blackfin: don't use __builtin_bfin_[cs]sync
3097 if ($line =~ /__builtin_bfin_csync/) {
3098 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003099 ERROR("CSYNC",
3100 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003101 }
3102 if ($line =~ /__builtin_bfin_ssync/) {
3103 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003104 ERROR("SSYNC",
3105 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003106 }
3107
Joe Perches56e77d72013-02-21 16:44:14 -08003108# check for old HOTPLUG __dev<foo> section markings
3109 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3110 WARN("HOTPLUG_SECTION",
3111 "Using $1 is unnecessary\n" . $herecurr);
3112 }
3113
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003114# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003115 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3116 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003117#print "LINE<$line>\n";
3118 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003119 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003120 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003121 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003122 $stat =~ s/\n./\n /g;
3123 $cond =~ s/\n./\n /g;
3124
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003125#print "linenr<$linenr> <$stat>\n";
3126 # If this statement has no statement boundaries within
3127 # it there is no point in retrying a statement scan
3128 # until we hit end of it.
3129 my $frag = $stat; $frag =~ s/;+\s*$//;
3130 if ($frag !~ /(?:{|;)/) {
3131#print "skip<$line_nr_next>\n";
3132 $suppress_statement = $line_nr_next;
3133 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003134
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003135 # Find the real next line.
3136 $realline_next = $line_nr_next;
3137 if (defined $realline_next &&
3138 (!defined $lines[$realline_next - 1] ||
3139 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3140 $realline_next++;
3141 }
3142
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003143 my $s = $stat;
3144 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003145
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003146 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003147 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003148
3149 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003150 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003151
Andy Whitcroft463f2862009-09-21 17:04:34 -07003152 } elsif ($s =~ /^.\s*else\b/s) {
3153
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003154 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003155 } 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 -07003156 my $type = $1;
3157 $type =~ s/\s+/ /g;
3158 possible($type, "A:" . $s);
3159
Andy Whitcroft8905a672007-11-28 16:21:06 -08003160 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003161 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003162 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003163 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003164
3165 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003166 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003167 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003168 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003169
3170 # Check for any sort of function declaration.
3171 # int foo(something bar, other baz);
3172 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003173 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 -08003174 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003175
Andy Whitcroftcf655042008-03-04 14:28:20 -08003176 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003177 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003178 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003179
Andy Whitcroft8905a672007-11-28 16:21:06 -08003180 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003181 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003182
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003183 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003184 }
3185 }
3186 }
3187
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003188 }
3189
Andy Whitcroft653d4872007-06-23 17:16:34 -07003190#
3191# Checks which may be anchored in the context.
3192#
3193
3194# Check for switch () and associated case and default
3195# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003196 if ($line=~/\bswitch\s*\(.*\)/) {
3197 my $err = '';
3198 my $sep = '';
3199 my @ctx = ctx_block_outer($linenr, $realcnt);
3200 shift(@ctx);
3201 for my $ctx (@ctx) {
3202 my ($clen, $cindent) = line_stats($ctx);
3203 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3204 $indent != $cindent) {
3205 $err .= "$sep$ctx\n";
3206 $sep = '';
3207 } else {
3208 $sep = "[...]\n";
3209 }
3210 }
3211 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003212 ERROR("SWITCH_CASE_INDENT_LEVEL",
3213 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003214 }
3215 }
3216
3217# if/while/etc brace do not go on next line, unless defining a do while loop,
3218# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003219 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 -07003220 my $pre_ctx = "$1$2";
3221
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003222 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003223
3224 if ($line =~ /^\+\t{6,}/) {
3225 WARN("DEEP_INDENTATION",
3226 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3227 }
3228
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003229 my $ctx_cnt = $realcnt - $#ctx - 1;
3230 my $ctx = join("\n", @ctx);
3231
Andy Whitcroft548596d2008-07-23 21:29:01 -07003232 my $ctx_ln = $linenr;
3233 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003234
Andy Whitcroft548596d2008-07-23 21:29:01 -07003235 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3236 defined $lines[$ctx_ln - 1] &&
3237 $lines[$ctx_ln - 1] =~ /^-/)) {
3238 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3239 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003240 $ctx_ln++;
3241 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003242
Andy Whitcroft53210162008-07-23 21:29:03 -07003243 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3244 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003245
Joe Perchesd752fcc2014-08-06 16:11:05 -07003246 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003247 ERROR("OPEN_BRACE",
3248 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003249 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003250 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003251 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3252 $ctx =~ /\)\s*\;\s*$/ &&
3253 defined $lines[$ctx_ln - 1])
3254 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003255 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3256 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003257 WARN("TRAILING_SEMICOLON",
3258 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003259 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003260 }
3261 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003262 }
3263
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003264# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003265 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 -08003266 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3267 ctx_statement_block($linenr, $realcnt, 0)
3268 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003269 my ($s, $c) = ($stat, $cond);
3270
3271 substr($s, 0, length($c), '');
3272
Joe Perches9f5af482015-09-09 15:37:30 -07003273 # remove inline comments
3274 $s =~ s/$;/ /g;
3275 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003276
3277 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003278 my @newlines = ($c =~ /\n/gs);
3279 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003280
Joe Perches9f5af482015-09-09 15:37:30 -07003281 # Make sure we remove the line prefixes as we have
3282 # none on the first line, and are going to readd them
3283 # where necessary.
3284 $s =~ s/\n./\n/gs;
3285 while ($s =~ /\n\s+\\\n/) {
3286 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3287 }
3288
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003289 # We want to check the first line inside the block
3290 # starting at the end of the conditional, so remove:
3291 # 1) any blank line termination
3292 # 2) any opening brace { on end of the line
3293 # 3) any do (...) {
3294 my $continuation = 0;
3295 my $check = 0;
3296 $s =~ s/^.*\bdo\b//;
3297 $s =~ s/^\s*{//;
3298 if ($s =~ s/^\s*\\//) {
3299 $continuation = 1;
3300 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003301 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003302 $check = 1;
3303 $cond_lines++;
3304 }
3305
3306 # Also ignore a loop construct at the end of a
3307 # preprocessor statement.
3308 if (($prevline =~ /^.\s*#\s*define\s/ ||
3309 $prevline =~ /\\\s*$/) && $continuation == 0) {
3310 $check = 0;
3311 }
3312
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003313 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003314 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003315 while ($cond_ptr != $cond_lines) {
3316 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003317
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003318 # If we see an #else/#elif then the code
3319 # is not linear.
3320 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3321 $check = 0;
3322 }
3323
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003324 # Ignore:
3325 # 1) blank lines, they should be at 0,
3326 # 2) preprocessor lines, and
3327 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003328 if ($continuation ||
3329 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003330 $s =~ /^\s*#\s*?/ ||
3331 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003332 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003333 if ($s =~ s/^.*?\n//) {
3334 $cond_lines++;
3335 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003336 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003337 }
3338
3339 my (undef, $sindent) = line_stats("+" . $s);
3340 my $stat_real = raw_line($linenr, $cond_lines);
3341
3342 # Check if either of these lines are modified, else
3343 # this is not this patch's fault.
3344 if (!defined($stat_real) ||
3345 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3346 $check = 0;
3347 }
3348 if (defined($stat_real) && $cond_lines > 1) {
3349 $stat_real = "[...]\n$stat_real";
3350 }
3351
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003352 #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 -07003353
Joe Perches9f5af482015-09-09 15:37:30 -07003354 if ($check && $s ne '' &&
3355 (($sindent % 8) != 0 ||
3356 ($sindent < $indent) ||
3357 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003358 WARN("SUSPECT_CODE_INDENT",
3359 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003360 }
3361 }
3362
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003363 # Track the 'values' across context and added lines.
3364 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003365 my ($curr_values, $curr_vars) =
3366 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003367 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003368 if ($dbg_values) {
3369 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003370 print "$linenr > .$outline\n";
3371 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003372 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003373 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003374 $prev_values = substr($curr_values, -1);
3375
Andy Whitcroft00df3442007-06-08 13:47:06 -07003376#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003377 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003378
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003379# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003380 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 -07003381 my $type = $1;
3382 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003383 $var = "" if (!defined $var);
3384 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003385 my $sign = $1;
3386 my $pointer = $2;
3387
3388 $pointer = "" if (!defined $pointer);
3389
3390 if (WARN("UNSPECIFIED_INT",
3391 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3392 $fix) {
3393 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003394 my $comp_pointer = $pointer;
3395 $comp_pointer =~ s/\s//g;
3396 $decl .= $comp_pointer;
3397 $decl = rtrim($decl) if ($var eq "");
3398 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003399 }
3400 }
3401 }
3402
Andy Whitcroft653d4872007-06-23 17:16:34 -07003403# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003404 if ($dbg_type) {
3405 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003406 ERROR("TEST_TYPE",
3407 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003408 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003409 ERROR("TEST_NOT_TYPE",
3410 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003411 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003412 next;
3413 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003414# TEST: allow direct testing of the attribute matcher.
3415 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003416 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003417 ERROR("TEST_ATTR",
3418 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003419 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003420 ERROR("TEST_NOT_ATTR",
3421 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003422 }
3423 next;
3424 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003425
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003426# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003427 if ($line =~ /^.\s*{/ &&
3428 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003429 if (ERROR("OPEN_BRACE",
3430 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003431 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3432 fix_delete_line($fixlinenr - 1, $prevrawline);
3433 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003434 my $fixedline = $prevrawline;
3435 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003436 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003437 $fixedline = $line;
3438 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003439 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003440 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003441 }
3442
Andy Whitcroft653d4872007-06-23 17:16:34 -07003443#
3444# Checks which are anchored on the added line.
3445#
3446
3447# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003448 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003449 my $path = $1;
3450 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003451 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003452 "malformed #include filename\n" . $herecurr);
3453 }
3454 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3455 ERROR("UAPI_INCLUDE",
3456 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003457 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003458 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003459
3460# no C99 // comments
3461 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003462 if (ERROR("C99_COMMENTS",
3463 "do not use C99 // comments\n" . $herecurr) &&
3464 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003465 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003466 if ($line =~ /\/\/(.*)$/) {
3467 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003468 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003469 }
3470 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003471 }
3472 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003473 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003474 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003475
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003476# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3477# the whole statement.
3478#print "APW <$lines[$realline_next - 1]>\n";
3479 if (defined $realline_next &&
3480 exists $lines[$realline_next - 1] &&
3481 !defined $suppress_export{$realline_next} &&
3482 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3483 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003484 # Handle definitions which produce identifiers with
3485 # a prefix:
3486 # XXX(foo);
3487 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003488 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003489 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003490 $name =~ /^${Ident}_$2/) {
3491#print "FOO C name<$name>\n";
3492 $suppress_export{$realline_next} = 1;
3493
3494 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003495 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003496 ^.DEFINE_$Ident\(\Q$name\E\)|
3497 ^.DECLARE_$Ident\(\Q$name\E\)|
3498 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003499 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3500 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003501 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003502#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3503 $suppress_export{$realline_next} = 2;
3504 } else {
3505 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003506 }
3507 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003508 if (!defined $suppress_export{$linenr} &&
3509 $prevline =~ /^.\s*$/ &&
3510 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3511 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3512#print "FOO B <$lines[$linenr - 1]>\n";
3513 $suppress_export{$linenr} = 2;
3514 }
3515 if (defined $suppress_export{$linenr} &&
3516 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003517 WARN("EXPORT_SYMBOL",
3518 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003519 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003520
Joe Eloff5150bda2010-08-09 17:21:00 -07003521# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003522 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003523 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003524 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003525 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003526 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003527 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003528 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003529# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003530 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003531 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003532 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003533 $herecurr) &&
3534 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003535 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003536 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003537 }
3538
Joe Perches18130872014-08-06 16:11:22 -07003539# check for misordered declarations of char/short/int/long with signed/unsigned
3540 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3541 my $tmp = trim($1);
3542 WARN("MISORDERED_TYPE",
3543 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3544 }
3545
Joe Perchescb710ec2010-10-26 14:23:20 -07003546# check for static const char * arrays.
3547 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003548 WARN("STATIC_CONST_CHAR_ARRAY",
3549 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003550 $herecurr);
3551 }
3552
3553# check for static char foo[] = "bar" declarations.
3554 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003555 WARN("STATIC_CONST_CHAR_ARRAY",
3556 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003557 $herecurr);
3558 }
3559
Joe Perchesab7e23f2015-04-16 12:44:22 -07003560# check for const <foo> const where <foo> is not a pointer or array type
3561 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3562 my $found = $1;
3563 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3564 WARN("CONST_CONST",
3565 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3566 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3567 WARN("CONST_CONST",
3568 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3569 }
3570 }
3571
Joe Perches9b0fa602014-04-03 14:49:18 -07003572# check for non-global char *foo[] = {"bar", ...} declarations.
3573 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3574 WARN("STATIC_CONST_CHAR_ARRAY",
3575 "char * array declaration might be better as static const\n" .
3576 $herecurr);
3577 }
3578
Joe Perchesb598b672015-04-16 12:44:36 -07003579# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3580 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3581 my $array = $1;
3582 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3583 my $array_div = $1;
3584 if (WARN("ARRAY_SIZE",
3585 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3586 $fix) {
3587 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3588 }
3589 }
3590 }
3591
Joe Perchesb36190c2014-01-27 17:07:18 -08003592# check for function declarations without arguments like "int foo()"
3593 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3594 if (ERROR("FUNCTION_WITHOUT_ARGS",
3595 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3596 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003597 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003598 }
3599 }
3600
Joe Perches92e112f2013-12-13 11:36:22 -07003601# check for uses of DEFINE_PCI_DEVICE_TABLE
3602 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3603 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3604 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3605 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003606 $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 -07003607 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003608 }
3609
Andy Whitcroft653d4872007-06-23 17:16:34 -07003610# check for new typedefs, only function parameters and sparse annotations
3611# make sense.
3612 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003613 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003614 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003615 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003616 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003617 WARN("NEW_TYPEDEFS",
3618 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003619 }
3620
3621# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003622 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003623 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3624 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003625 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003626
Andy Whitcroft65863862009-01-06 14:41:21 -08003627 # Should start with a space.
3628 $to =~ s/^(\S)/ $1/;
3629 # Should not end with a space.
3630 $to =~ s/\s+$//;
3631 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003632 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003633 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003634
Joe Perches3705ce52013-07-03 15:05:31 -07003635## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003636 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003637 if (ERROR("POINTER_LOCATION",
3638 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3639 $fix) {
3640 my $sub_from = $ident;
3641 my $sub_to = $ident;
3642 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003643 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003644 s@\Q$sub_from\E@$sub_to@;
3645 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003646 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003647 }
3648 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3649 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003650 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003651
Andy Whitcroft65863862009-01-06 14:41:21 -08003652 # Should start with a space.
3653 $to =~ s/^(\S)/ $1/;
3654 # Should not end with a space.
3655 $to =~ s/\s+$//;
3656 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003657 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003658 }
3659 # Modifiers should have spaces.
3660 $to =~ s/(\b$Modifier$)/$1 /;
3661
Joe Perches3705ce52013-07-03 15:05:31 -07003662## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003663 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003664 if (ERROR("POINTER_LOCATION",
3665 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3666 $fix) {
3667
3668 my $sub_from = $match;
3669 my $sub_to = $match;
3670 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003671 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003672 s@\Q$sub_from\E@$sub_to@;
3673 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003674 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003675 }
3676
Joe Perches9d3e3c72015-09-09 15:37:27 -07003677# avoid BUG() or BUG_ON()
3678 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3679 my $msg_type = \&WARN;
3680 $msg_type = \&CHK if ($file);
3681 &{$msg_type}("AVOID_BUG",
3682 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3683 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003684
Joe Perches9d3e3c72015-09-09 15:37:27 -07003685# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003686 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003687 WARN("LINUX_VERSION_CODE",
3688 "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 -08003689 }
3690
Joe Perches17441222011-06-15 15:08:17 -07003691# check for uses of printk_ratelimit
3692 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003693 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003694 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003695 }
3696
Andy Whitcroft00df3442007-06-08 13:47:06 -07003697# printk should use KERN_* levels. Note that follow on printk's on the
3698# same line do not need a level, so we use the current block context
3699# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003700# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003701# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003702 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003703 my $ok = 0;
3704 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3705 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003706 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003707 # with "\n" ignore it, else it is to blame
3708 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3709 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3710 $ok = 1;
3711 }
3712 last;
3713 }
3714 }
3715 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003716 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3717 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003718 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003719 }
3720
Joe Perches243f3802012-05-31 16:26:09 -07003721 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3722 my $orig = $1;
3723 my $level = lc($orig);
3724 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003725 my $level2 = $level;
3726 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003727 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003728 "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 -07003729 }
3730
3731 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003732 if (WARN("PREFER_PR_LEVEL",
3733 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3734 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003735 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003736 s/\bpr_warning\b/pr_warn/;
3737 }
Joe Perches243f3802012-05-31 16:26:09 -07003738 }
3739
Joe Perchesdc139312013-02-21 16:44:13 -08003740 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3741 my $orig = $1;
3742 my $level = lc($orig);
3743 $level = "warn" if ($level eq "warning");
3744 $level = "dbg" if ($level eq "debug");
3745 WARN("PREFER_DEV_LEVEL",
3746 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3747 }
3748
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003749# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3750# number of false positives, but assembly files are not checked, so at
3751# least the arch entry code will not trigger this warning.
3752 if ($line =~ /\bENOSYS\b/) {
3753 WARN("ENOSYS",
3754 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3755 }
3756
Andy Whitcroft653d4872007-06-23 17:16:34 -07003757# function brace can't be on same line, except for #defines of do while,
3758# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003759 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003760 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003761 if (ERROR("OPEN_BRACE",
3762 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3763 $fix) {
3764 fix_delete_line($fixlinenr, $rawline);
3765 my $fixed_line = $rawline;
3766 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3767 my $line1 = $1;
3768 my $line2 = $2;
3769 fix_insert_line($fixlinenr, ltrim($line1));
3770 fix_insert_line($fixlinenr, "\+{");
3771 if ($line2 !~ /^\s*$/) {
3772 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3773 }
3774 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003775 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003776
Andy Whitcroft8905a672007-11-28 16:21:06 -08003777# open braces for enum, union and struct go on the same line.
3778 if ($line =~ /^.\s*{/ &&
3779 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003780 if (ERROR("OPEN_BRACE",
3781 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3782 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3783 fix_delete_line($fixlinenr - 1, $prevrawline);
3784 fix_delete_line($fixlinenr, $rawline);
3785 my $fixedline = rtrim($prevrawline) . " {";
3786 fix_insert_line($fixlinenr, $fixedline);
3787 $fixedline = $rawline;
3788 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3789 if ($fixedline !~ /^\+\s*$/) {
3790 fix_insert_line($fixlinenr, $fixedline);
3791 }
3792 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003793 }
3794
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003795# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003796 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3797 if (WARN("SPACING",
3798 "missing space after $1 definition\n" . $herecurr) &&
3799 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003800 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003801 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3802 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003803 }
3804
Joe Perches31070b52014-01-23 15:54:49 -08003805# Function pointer declarations
3806# check spacing between type, funcptr, and args
3807# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003808 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003809 my $declare = $1;
3810 my $pre_pointer_space = $2;
3811 my $post_pointer_space = $3;
3812 my $funcname = $4;
3813 my $post_funcname_space = $5;
3814 my $pre_args_space = $6;
3815
Joe Perches91f72e92014-04-03 14:49:12 -07003816# the $Declare variable will capture all spaces after the type
3817# so check it for a missing trailing missing space but pointer return types
3818# don't need a space so don't warn for those.
3819 my $post_declare_space = "";
3820 if ($declare =~ /(\s+)$/) {
3821 $post_declare_space = $1;
3822 $declare = rtrim($declare);
3823 }
3824 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003825 WARN("SPACING",
3826 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003827 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003828 }
3829
3830# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003831# This test is not currently implemented because these declarations are
3832# equivalent to
3833# int foo(int bar, ...)
3834# and this is form shouldn't/doesn't generate a checkpatch warning.
3835#
3836# elsif ($declare =~ /\s{2,}$/) {
3837# WARN("SPACING",
3838# "Multiple spaces after return type\n" . $herecurr);
3839# }
Joe Perches31070b52014-01-23 15:54:49 -08003840
3841# unnecessary space "type ( *funcptr)(args...)"
3842 if (defined $pre_pointer_space &&
3843 $pre_pointer_space =~ /^\s/) {
3844 WARN("SPACING",
3845 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3846 }
3847
3848# unnecessary space "type (* funcptr)(args...)"
3849 if (defined $post_pointer_space &&
3850 $post_pointer_space =~ /^\s/) {
3851 WARN("SPACING",
3852 "Unnecessary space before function pointer name\n" . $herecurr);
3853 }
3854
3855# unnecessary space "type (*funcptr )(args...)"
3856 if (defined $post_funcname_space &&
3857 $post_funcname_space =~ /^\s/) {
3858 WARN("SPACING",
3859 "Unnecessary space after function pointer name\n" . $herecurr);
3860 }
3861
3862# unnecessary space "type (*funcptr) (args...)"
3863 if (defined $pre_args_space &&
3864 $pre_args_space =~ /^\s/) {
3865 WARN("SPACING",
3866 "Unnecessary space before function pointer arguments\n" . $herecurr);
3867 }
3868
3869 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003870 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003871 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003872 }
3873 }
3874
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003875# check for spacing round square brackets; allowed:
3876# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003877# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3878# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003879 while ($line =~ /(.*?\s)\[/g) {
3880 my ($where, $prefix) = ($-[1], $1);
3881 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003882 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003883 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003884 if (ERROR("BRACKET_SPACE",
3885 "space prohibited before open square bracket '['\n" . $herecurr) &&
3886 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003887 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003888 s/^(\+.*?)\s+\[/$1\[/;
3889 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003890 }
3891 }
3892
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003893# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003894 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003895 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003896 my $ctx_before = substr($line, 0, $-[1]);
3897 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003898
3899 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003900 if ($name =~ /^(?:
3901 if|for|while|switch|return|case|
3902 volatile|__volatile__|
3903 __attribute__|format|__extension__|
3904 asm|__asm__)$/x)
3905 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003906 # cpp #define statements have non-optional spaces, ie
3907 # if there is a space between the name and the open
3908 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003909 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003910
3911 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003912 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003913
3914 # If this whole things ends with a type its most
3915 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003916 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003917
3918 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003919 if (WARN("SPACING",
3920 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3921 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003922 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003923 s/\b$name\s+\(/$name\(/;
3924 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003925 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003926 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003927
Andy Whitcroft653d4872007-06-23 17:16:34 -07003928# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003929 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003930 my $fixed_line = "";
3931 my $line_fixed = 0;
3932
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003933 my $ops = qr{
3934 <<=|>>=|<=|>=|==|!=|
3935 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3936 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003937 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003938 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003939 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003940 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003941
3942## print("element count: <" . $#elements . ">\n");
3943## foreach my $el (@elements) {
3944## print("el: <$el>\n");
3945## }
3946
3947 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003948 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003949
Joe Perches3705ce52013-07-03 15:05:31 -07003950 foreach my $el (@elements) {
3951 push(@fix_elements, substr($rawline, $off, length($el)));
3952 $off += length($el);
3953 }
3954
3955 $off = 0;
3956
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003957 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003958 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003959
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003960 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003961
3962 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3963
3964## print("n: <$n> good: <$good>\n");
3965
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003966 $off += length($elements[$n]);
3967
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003968 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003969 my $ca = substr($opline, 0, $off);
3970 my $cc = '';
3971 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3972 $cc = substr($opline, $off + length($elements[$n + 1]));
3973 }
3974 my $cb = "$ca$;$cc";
3975
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003976 my $a = '';
3977 $a = 'V' if ($elements[$n] ne '');
3978 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003979 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003980 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3981 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003982 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003983
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003984 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003985
3986 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003987 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003988 $c = 'V' if ($elements[$n + 2] ne '');
3989 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003990 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003991 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3992 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003993 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003994 } else {
3995 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003996 }
3997
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003998 my $ctx = "${a}x${c}";
3999
4000 my $at = "(ctx:$ctx)";
4001
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004002 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004003 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004004
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004005 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004006 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004007
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004008 # Get the full operator variant.
4009 my $opv = $op . substr($curr_vars, $off, 1);
4010
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004011 # Ignore operators passed as parameters.
4012 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004013 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004014
Andy Whitcroftcf655042008-03-04 14:28:20 -08004015# # Ignore comments
4016# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004017
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004018 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004019 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004020 if ($ctx !~ /.x[WEBC]/ &&
4021 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004022 if (ERROR("SPACING",
4023 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004024 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004025 $line_fixed = 1;
4026 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004027 }
4028
4029 # // is a comment
4030 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004031
Joe Perchesb00e4812014-04-03 14:49:33 -07004032 # : when part of a bitfield
4033 } elsif ($opv eq ':B') {
4034 # skip the bitfield test for now
4035
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004036 # No spaces for:
4037 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004038 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004039 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004040 if (ERROR("SPACING",
4041 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004042 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004043 if (defined $fix_elements[$n + 2]) {
4044 $fix_elements[$n + 2] =~ s/^\s+//;
4045 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004046 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004047 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004048 }
4049
Joe Perches23810972014-12-10 15:51:32 -08004050 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004051 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004052 my $rtrim_before = 0;
4053 my $space_after = 0;
4054 if ($ctx =~ /Wx./) {
4055 if (ERROR("SPACING",
4056 "space prohibited before that '$op' $at\n" . $hereptr)) {
4057 $line_fixed = 1;
4058 $rtrim_before = 1;
4059 }
4060 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004061 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004062 if (ERROR("SPACING",
4063 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004064 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004065 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004066 $space_after = 1;
4067 }
4068 }
4069 if ($rtrim_before || $space_after) {
4070 if ($rtrim_before) {
4071 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4072 } else {
4073 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4074 }
4075 if ($space_after) {
4076 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004077 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004078 }
4079
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004080 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004081 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004082 #warn "'*' is part of type\n";
4083
4084 # unary operators should have a space before and
4085 # none after. May be left adjacent to another
4086 # unary operator, or a cast
4087 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004088 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004089 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004090 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004091 if (ERROR("SPACING",
4092 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004093 if ($n != $last_after + 2) {
4094 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4095 $line_fixed = 1;
4096 }
Joe Perches3705ce52013-07-03 15:05:31 -07004097 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004098 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004099 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004100 # A unary '*' may be const
4101
4102 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004103 if (ERROR("SPACING",
4104 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004105 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004106 if (defined $fix_elements[$n + 2]) {
4107 $fix_elements[$n + 2] =~ s/^\s+//;
4108 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004109 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004110 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004111 }
4112
4113 # unary ++ and unary -- are allowed no space on one side.
4114 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004115 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004116 if (ERROR("SPACING",
4117 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004118 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004119 $line_fixed = 1;
4120 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004121 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004122 if ($ctx =~ /Wx[BE]/ ||
4123 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004124 if (ERROR("SPACING",
4125 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004126 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004127 $line_fixed = 1;
4128 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004129 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004130 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004131 if (ERROR("SPACING",
4132 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004133 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004134 if (defined $fix_elements[$n + 2]) {
4135 $fix_elements[$n + 2] =~ s/^\s+//;
4136 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004137 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004138 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004139 }
4140
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004141 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004142 } elsif ($op eq '<<' or $op eq '>>' or
4143 $op eq '&' or $op eq '^' or $op eq '|' or
4144 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004145 $op eq '*' or $op eq '/' or
4146 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004147 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004148 if ($check) {
4149 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4150 if (CHK("SPACING",
4151 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4152 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4153 $fix_elements[$n + 2] =~ s/^\s+//;
4154 $line_fixed = 1;
4155 }
4156 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4157 if (CHK("SPACING",
4158 "space preferred before that '$op' $at\n" . $hereptr)) {
4159 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4160 $line_fixed = 1;
4161 }
4162 }
4163 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004164 if (ERROR("SPACING",
4165 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004166 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4167 if (defined $fix_elements[$n + 2]) {
4168 $fix_elements[$n + 2] =~ s/^\s+//;
4169 }
Joe Perches3705ce52013-07-03 15:05:31 -07004170 $line_fixed = 1;
4171 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004172 }
4173
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004174 # A colon needs no spaces before when it is
4175 # terminating a case value or a label.
4176 } elsif ($opv eq ':C' || $opv eq ':L') {
4177 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004178 if (ERROR("SPACING",
4179 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004180 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004181 $line_fixed = 1;
4182 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004183 }
4184
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004185 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004186 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004187 my $ok = 0;
4188
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004189 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004190 if (($op eq '<' &&
4191 $cc =~ /^\S+\@\S+>/) ||
4192 ($op eq '>' &&
4193 $ca =~ /<\S+\@\S+$/))
4194 {
4195 $ok = 1;
4196 }
4197
Joe Perchese0df7e12015-04-16 12:44:53 -07004198 # for asm volatile statements
4199 # ignore a colon with another
4200 # colon immediately before or after
4201 if (($op eq ':') &&
4202 ($ca =~ /:$/ || $cc =~ /^:/)) {
4203 $ok = 1;
4204 }
4205
Joe Perches84731622013-11-12 15:10:05 -08004206 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004207 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004208 my $msg_type = \&ERROR;
4209 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4210
4211 if (&{$msg_type}("SPACING",
4212 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004213 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4214 if (defined $fix_elements[$n + 2]) {
4215 $fix_elements[$n + 2] =~ s/^\s+//;
4216 }
Joe Perches3705ce52013-07-03 15:05:31 -07004217 $line_fixed = 1;
4218 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004219 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004220 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004221 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004222
4223## print("n: <$n> GOOD: <$good>\n");
4224
4225 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004226 }
Joe Perches3705ce52013-07-03 15:05:31 -07004227
4228 if (($#elements % 2) == 0) {
4229 $fixed_line = $fixed_line . $fix_elements[$#elements];
4230 }
4231
Joe Perches194f66f2014-08-06 16:11:03 -07004232 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4233 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004234 }
4235
4236
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004237 }
4238
Joe Perches786b6322013-07-03 15:05:32 -07004239# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004240 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004241 if (WARN("SPACING",
4242 "space prohibited before semicolon\n" . $herecurr) &&
4243 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004244 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004245 s/^(\+.*\S)\s+;/$1;/;
4246 }
4247 }
4248
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004249# check for multiple assignments
4250 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004251 CHK("MULTIPLE_ASSIGNMENTS",
4252 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004253 }
4254
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004255## # check for multiple declarations, allowing for a function declaration
4256## # continuation.
4257## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4258## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4259##
4260## # Remove any bracketed sections to ensure we do not
4261## # falsly report the parameters of functions.
4262## my $ln = $line;
4263## while ($ln =~ s/\([^\(\)]*\)//g) {
4264## }
4265## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004266## WARN("MULTIPLE_DECLARATION",
4267## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004268## }
4269## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004270
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004271#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004272 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004273 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004274 if (ERROR("SPACING",
4275 "space required before the open brace '{'\n" . $herecurr) &&
4276 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004277 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004278 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004279 }
4280
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004281## # check for blank lines before declarations
4282## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4283## $prevrawline =~ /^.\s*$/) {
4284## WARN("SPACING",
4285## "No blank lines before declarations\n" . $hereprev);
4286## }
4287##
4288
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004289# closing brace should have a space following it when it has anything
4290# on the line
4291 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004292 if (ERROR("SPACING",
4293 "space required after that close brace '}'\n" . $herecurr) &&
4294 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004295 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004296 s/}((?!(?:,|;|\)))\S)/} $1/;
4297 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004298 }
4299
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004300# check spacing on square brackets
4301 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004302 if (ERROR("SPACING",
4303 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4304 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004305 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004306 s/\[\s+/\[/;
4307 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004308 }
4309 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004310 if (ERROR("SPACING",
4311 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4312 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004313 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004314 s/\s+\]/\]/;
4315 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004316 }
4317
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004318# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004319 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
Matt Wagantall54afcc62010-06-03 12:28:18 -07004320 $line !~ /for\s*\(\s+;/ && $line !~ /^\+\s*[A-Z_][A-Z\d_]*\(\s*\d+(\,.*)?\)\,?$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004321 if (ERROR("SPACING",
4322 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4323 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004324 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004325 s/\(\s+/\(/;
4326 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004327 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004328 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004329 $line !~ /for\s*\(.*;\s+\)/ &&
4330 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004331 if (ERROR("SPACING",
4332 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4333 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004334 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004335 s/\s+\)/\)/;
4336 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004337 }
4338
Joe Perchese2826fd2014-08-06 16:10:48 -07004339# check unnecessary parentheses around addressof/dereference single $Lvals
4340# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4341
4342 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004343 my $var = $1;
4344 if (CHK("UNNECESSARY_PARENTHESES",
4345 "Unnecessary parentheses around $var\n" . $herecurr) &&
4346 $fix) {
4347 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4348 }
4349 }
4350
4351# check for unnecessary parentheses around function pointer uses
4352# ie: (foo->bar)(); should be foo->bar();
4353# but not "if (foo->bar) (" to avoid some false positives
4354 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4355 my $var = $2;
4356 if (CHK("UNNECESSARY_PARENTHESES",
4357 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4358 $fix) {
4359 my $var2 = deparenthesize($var);
4360 $var2 =~ s/\s//g;
4361 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4362 }
4363 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004364
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004365#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004366 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004367 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004368 if (WARN("INDENTED_LABEL",
4369 "labels should not be indented\n" . $herecurr) &&
4370 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004371 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004372 s/^(.)\s+/$1/;
4373 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004374 }
4375
Joe Perches5b9553a2014-04-03 14:49:21 -07004376# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004377 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004378 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004379 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004380 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4381 my $value = $1;
4382 $value = deparenthesize($value);
4383 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4384 ERROR("RETURN_PARENTHESES",
4385 "return is not a function, parentheses are not required\n" . $herecurr);
4386 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004387 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004388 ERROR("SPACING",
4389 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004390 }
4391 }
Joe Perches507e5142013-11-12 15:10:13 -08004392
Joe Perchesb43ae212014-06-23 13:22:07 -07004393# unnecessary return in a void function
4394# at end-of-function, with the previous line a single leading tab, then return;
4395# and the line before that not a goto label target like "out:"
4396 if ($sline =~ /^[ \+]}\s*$/ &&
4397 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4398 $linenr >= 3 &&
4399 $lines[$linenr - 3] =~ /^[ +]/ &&
4400 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004401 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004402 "void function return statements are not generally useful\n" . $hereprev);
4403 }
Joe Perches9819cf22014-06-04 16:12:09 -07004404
Joe Perches189248d2014-01-23 15:54:47 -08004405# if statements using unnecessary parentheses - ie: if ((foo == bar))
4406 if ($^V && $^V ge 5.10.0 &&
4407 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4408 my $openparens = $1;
4409 my $count = $openparens =~ tr@\(@\(@;
4410 my $msg = "";
4411 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4412 my $comp = $4; #Not $1 because of $LvalOrFunc
4413 $msg = " - maybe == should be = ?" if ($comp eq "==");
4414 WARN("UNNECESSARY_PARENTHESES",
4415 "Unnecessary parentheses$msg\n" . $herecurr);
4416 }
4417 }
4418
Joe Perchesc5595fa2015-09-09 15:37:58 -07004419# comparisons with a constant or upper case identifier on the left
4420# avoid cases like "foo + BAR < baz"
4421# only fix matches surrounded by parentheses to avoid incorrect
4422# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4423 if ($^V && $^V ge 5.10.0 &&
4424 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4425 my $lead = $1;
4426 my $const = $2;
4427 my $comp = $3;
4428 my $to = $4;
4429 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004430 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004431 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4432 WARN("CONSTANT_COMPARISON",
4433 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4434 $fix) {
4435 if ($comp eq "<") {
4436 $newcomp = ">";
4437 } elsif ($comp eq "<=") {
4438 $newcomp = ">=";
4439 } elsif ($comp eq ">") {
4440 $newcomp = "<";
4441 } elsif ($comp eq ">=") {
4442 $newcomp = "<=";
4443 }
4444 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4445 }
4446 }
4447
Joe Perchesf34e4a42015-04-16 12:44:19 -07004448# Return of what appears to be an errno should normally be negative
4449 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004450 my $name = $1;
4451 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004452 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004453 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004454 }
4455 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004456
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004457# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004458 if ($line =~ /\b(if|while|for|switch)\(/) {
4459 if (ERROR("SPACING",
4460 "space required before the open parenthesis '('\n" . $herecurr) &&
4461 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004462 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004463 s/\b(if|while|for|switch)\(/$1 \(/;
4464 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004465 }
4466
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004467# Check for illegal assignment in if conditional -- and check for trailing
4468# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004469 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004470 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4471 ctx_statement_block($linenr, $realcnt, 0)
4472 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004473 my ($stat_next) = ctx_statement_block($line_nr_next,
4474 $remain_next, $off_next);
4475 $stat_next =~ s/\n./\n /g;
4476 ##print "stat<$stat> stat_next<$stat_next>\n";
4477
4478 if ($stat_next =~ /^\s*while\b/) {
4479 # If the statement carries leading newlines,
4480 # then count those as offsets.
4481 my ($whitespace) =
4482 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4483 my $offset =
4484 statement_rawlines($whitespace) - 1;
4485
4486 $suppress_whiletrailers{$line_nr_next +
4487 $offset} = 1;
4488 }
4489 }
4490 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004491 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004492 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004493 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004494
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004495 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004496 ERROR("ASSIGN_IN_IF",
4497 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004498 }
4499
4500 # Find out what is on the end of the line after the
4501 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004502 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004503 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004504 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004505 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4506 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004507 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004508 # Find out how long the conditional actually is.
4509 my @newlines = ($c =~ /\n/gs);
4510 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004511 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004512
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004513 $stat_real = raw_line($linenr, $cond_lines)
4514 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004515 if (defined($stat_real) && $cond_lines > 1) {
4516 $stat_real = "[...]\n$stat_real";
4517 }
4518
Joe Perches000d1cc12011-07-25 17:13:25 -07004519 ERROR("TRAILING_STATEMENTS",
4520 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004521 }
4522 }
4523
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004524# Check for bitwise tests written as boolean
4525 if ($line =~ /
4526 (?:
4527 (?:\[|\(|\&\&|\|\|)
4528 \s*0[xX][0-9]+\s*
4529 (?:\&\&|\|\|)
4530 |
4531 (?:\&\&|\|\|)
4532 \s*0[xX][0-9]+\s*
4533 (?:\&\&|\|\||\)|\])
4534 )/x)
4535 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004536 WARN("HEXADECIMAL_BOOLEAN_TEST",
4537 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004538 }
4539
Andy Whitcroft8905a672007-11-28 16:21:06 -08004540# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004541 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4542 my $s = $1;
4543 $s =~ s/$;//g; # Remove any comments
4544 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004545 ERROR("TRAILING_STATEMENTS",
4546 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004547 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004548 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004549# if should not continue a brace
4550 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004551 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004552 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004553 $herecurr);
4554 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004555# case and default should not have general statements after them
4556 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4557 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004558 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004559 \s*return\s+
4560 )/xg)
4561 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004562 ERROR("TRAILING_STATEMENTS",
4563 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004564 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004565
4566 # Check for }<nl>else {, these must be at the same
4567 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004568 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4569 $previndent == $indent) {
4570 if (ERROR("ELSE_AFTER_BRACE",
4571 "else should follow close brace '}'\n" . $hereprev) &&
4572 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4573 fix_delete_line($fixlinenr - 1, $prevrawline);
4574 fix_delete_line($fixlinenr, $rawline);
4575 my $fixedline = $prevrawline;
4576 $fixedline =~ s/}\s*$//;
4577 if ($fixedline !~ /^\+\s*$/) {
4578 fix_insert_line($fixlinenr, $fixedline);
4579 }
4580 $fixedline = $rawline;
4581 $fixedline =~ s/^(.\s*)else/$1} else/;
4582 fix_insert_line($fixlinenr, $fixedline);
4583 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004584 }
4585
Joe Perches8b8856f2014-08-06 16:11:14 -07004586 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4587 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004588 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4589
4590 # Find out what is on the end of the line after the
4591 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004592 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004593 $s =~ s/\n.*//g;
4594
4595 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004596 if (ERROR("WHILE_AFTER_BRACE",
4597 "while should follow close brace '}'\n" . $hereprev) &&
4598 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4599 fix_delete_line($fixlinenr - 1, $prevrawline);
4600 fix_delete_line($fixlinenr, $rawline);
4601 my $fixedline = $prevrawline;
4602 my $trailing = $rawline;
4603 $trailing =~ s/^\+//;
4604 $trailing = trim($trailing);
4605 $fixedline =~ s/}\s*$/} $trailing/;
4606 fix_insert_line($fixlinenr, $fixedline);
4607 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004608 }
4609 }
4610
Joe Perches95e2c602013-07-03 15:05:20 -07004611#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004612 while ($line =~ m{($Constant|$Lval)}g) {
4613 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004614
4615#gcc binary extension
4616 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004617 if (WARN("GCC_BINARY_CONSTANT",
4618 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4619 $fix) {
4620 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004621 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004622 s/\b$var\b/$hexval/;
4623 }
Joe Perches95e2c602013-07-03 15:05:20 -07004624 }
4625
4626#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004627 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004628 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004629#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004630 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004631#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004632 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4633#Ignore some three character SI units explicitly, like MiB and KHz
4634 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004635 while ($var =~ m{($Ident)}g) {
4636 my $word = $1;
4637 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004638 if ($check) {
4639 seed_camelcase_includes();
4640 if (!$file && !$camelcase_file_seeded) {
4641 seed_camelcase_file($realfile);
4642 $camelcase_file_seeded = 1;
4643 }
4644 }
Joe Perches7e781f62013-09-11 14:23:55 -07004645 if (!defined $camelcase{$word}) {
4646 $camelcase{$word} = 1;
4647 CHK("CAMELCASE",
4648 "Avoid CamelCase: <$word>\n" . $herecurr);
4649 }
Joe Perches34456862013-07-03 15:05:34 -07004650 }
Joe Perches323c1262012-12-17 16:02:07 -08004651 }
4652 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004653
4654#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004655 if ($line =~ /\#\s*define.*\\\s+$/) {
4656 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4657 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4658 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004659 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004660 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004661 }
4662
Fabian Frederick0e212e02015-04-16 12:44:25 -07004663# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4664# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004665 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004666 my $file = "$1.h";
4667 my $checkfile = "include/linux/$file";
4668 if (-f "$root/$checkfile" &&
4669 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004670 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004671 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004672 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4673 if ($asminclude > 0) {
4674 if ($realfile =~ m{^arch/}) {
4675 CHK("ARCH_INCLUDE_LINUX",
4676 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4677 } else {
4678 WARN("INCLUDE_LINUX",
4679 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4680 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004681 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004682 }
4683 }
4684
Andy Whitcroft653d4872007-06-23 17:16:34 -07004685# multi-statement macros should be enclosed in a do while loop, grab the
4686# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004687# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004688 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4689 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004690 my $ln = $linenr;
Gregory Bean02870be2011-05-11 09:11:12 -07004691 my $cnt = $realcnt - 1;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004692 my ($off, $dstat, $dcond, $rest);
4693 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004694 my $has_flow_statement = 0;
4695 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004696 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004697 ctx_statement_block($linenr, $realcnt, 0);
4698 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004699 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004700 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004701
Joe Perches08a28432014-10-13 15:51:55 -07004702 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004703 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004704
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004705 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004706 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004707 $dstat =~ s/\\\n.//g;
4708 $dstat =~ s/^\s*//s;
4709 $dstat =~ s/\s*$//s;
4710
4711 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004712 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4713 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004714 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004715 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004716 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004717
Gregory Bean02870be2011-05-11 09:11:12 -07004718 # Extremely long macros may fall off the end of the
4719 # available context without closing. Give a dangling
4720 # backslash the benefit of the doubt and allow it
4721 # to gobble any hanging open-parens.
4722 $dstat =~ s/\(.+\\$/1/;
4723
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004724 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004725 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4726 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004727 {
4728 }
4729
Joe Perches42e15292016-03-15 14:58:01 -07004730 # Make asm volatile uses seem like a generic function
4731 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4732
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004733 my $exceptions = qr{
4734 $Declare|
4735 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004736 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004737 DECLARE_PER_CPU|
4738 DEFINE_PER_CPU|
Matt Wagantall54afcc62010-06-03 12:28:18 -07004739 CLK_[A-Z\d_]+|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004740 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004741 union|
4742 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004743 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004744 ^\"|\"$|
4745 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004746 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004747 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004748 if ($dstat ne '' &&
4749 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4750 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004751 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004752 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004753 $dstat !~ /$exceptions/ &&
4754 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004755 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004756 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004757 $dstat !~ /^for\s*$Constant$/ && # for (...)
4758 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4759 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004760 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004761 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004762 {
4763 $ctx =~ s/\n*$//;
4764 my $herectx = $here . "\n";
4765 my $cnt = statement_rawlines($ctx);
4766
4767 for (my $n = 0; $n < $cnt; $n++) {
4768 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004769 }
4770
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004771 if ($dstat =~ /;/) {
4772 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4773 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4774 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004775 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004776 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004777 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004778 }
Joe Perches5023d342012-12-17 16:01:47 -08004779
Joe Perches08a28432014-10-13 15:51:55 -07004780# check for macros with flow control, but without ## concatenation
4781# ## concatenation is commonly a macro that defines a function so ignore those
4782 if ($has_flow_statement && !$has_arg_concat) {
4783 my $herectx = $here . "\n";
4784 my $cnt = statement_rawlines($ctx);
4785
4786 for (my $n = 0; $n < $cnt; $n++) {
4787 $herectx .= raw_line($linenr, $n) . "\n";
4788 }
4789 WARN("MACRO_WITH_FLOW_CONTROL",
4790 "Macros with flow control statements should be avoided\n" . "$herectx");
4791 }
4792
Joe Perches481eb482012-12-17 16:01:56 -08004793# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004794
4795 } else {
4796 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004797 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4798 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004799 $line =~ /^\+.*\\$/) {
4800 WARN("LINE_CONTINUATIONS",
4801 "Avoid unnecessary line continuations\n" . $herecurr);
4802 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004803 }
4804
Joe Perchesb13edf72012-07-30 14:41:24 -07004805# do {} while (0) macro tests:
4806# single-statement macros do not need to be enclosed in do while (0) loop,
4807# macro should not end with a semicolon
4808 if ($^V && $^V ge 5.10.0 &&
4809 $realfile !~ m@/vmlinux.lds.h$@ &&
4810 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4811 my $ln = $linenr;
4812 my $cnt = $realcnt;
4813 my ($off, $dstat, $dcond, $rest);
4814 my $ctx = '';
4815 ($dstat, $dcond, $ln, $cnt, $off) =
4816 ctx_statement_block($linenr, $realcnt, 0);
4817 $ctx = $dstat;
4818
4819 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004820 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004821
4822 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4823 my $stmts = $2;
4824 my $semis = $3;
4825
4826 $ctx =~ s/\n*$//;
4827 my $cnt = statement_rawlines($ctx);
4828 my $herectx = $here . "\n";
4829
4830 for (my $n = 0; $n < $cnt; $n++) {
4831 $herectx .= raw_line($linenr, $n) . "\n";
4832 }
4833
Joe Perchesac8e97f2012-08-21 16:15:53 -07004834 if (($stmts =~ tr/;/;/) == 1 &&
4835 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004836 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4837 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4838 }
4839 if (defined $semis && $semis ne "") {
4840 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4841 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4842 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004843 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4844 $ctx =~ s/\n*$//;
4845 my $cnt = statement_rawlines($ctx);
4846 my $herectx = $here . "\n";
4847
4848 for (my $n = 0; $n < $cnt; $n++) {
4849 $herectx .= raw_line($linenr, $n) . "\n";
4850 }
4851
4852 WARN("TRAILING_SEMICOLON",
4853 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004854 }
4855 }
4856
Mike Frysinger080ba922009-01-06 14:41:25 -08004857# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4858# all assignments may have only one of the following with an assignment:
4859# .
4860# ALIGN(...)
4861# VMLINUX_SYMBOL(...)
4862 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004863 WARN("MISSING_VMLINUX_SYMBOL",
4864 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004865 }
4866
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004867# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004868 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4869 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004870 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004871 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004872 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4873 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004874 my @allowed = ();
4875 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004876 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004877 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004878 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004879 for my $chunk (@chunks) {
4880 my ($cond, $block) = @{$chunk};
4881
Andy Whitcroft773647a2008-03-28 14:15:58 -07004882 # If the condition carries leading newlines, then count those as offsets.
4883 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4884 my $offset = statement_rawlines($whitespace) - 1;
4885
Joe Perchesaad4f612012-03-23 15:02:19 -07004886 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004887 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4888
4889 # We have looked at and allowed this specific line.
4890 $suppress_ifbraces{$ln + $offset} = 1;
4891
4892 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004893 $ln += statement_rawlines($block) - 1;
4894
Andy Whitcroft773647a2008-03-28 14:15:58 -07004895 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004896
4897 $seen++ if ($block =~ /^\s*{/);
4898
Joe Perchesaad4f612012-03-23 15:02:19 -07004899 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004900 if (statement_lines($cond) > 1) {
4901 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004902 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004903 }
4904 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004905 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004906 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004907 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004908 if (statement_block_size($block) > 1) {
4909 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004910 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004911 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004912 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004913 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004914 if ($seen) {
4915 my $sum_allowed = 0;
4916 foreach (@allowed) {
4917 $sum_allowed += $_;
4918 }
4919 if ($sum_allowed == 0) {
4920 WARN("BRACES",
4921 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4922 } elsif ($sum_allowed != $allow &&
4923 $seen != $allow) {
4924 CHK("BRACES",
4925 "braces {} should be used on all arms of this statement\n" . $herectx);
4926 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004927 }
4928 }
4929 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004930 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004931 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004932 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004933
Andy Whitcroftcf655042008-03-04 14:28:20 -08004934 # Check the pre-context.
4935 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4936 #print "APW: ALLOWED: pre<$1>\n";
4937 $allowed = 1;
4938 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004939
4940 my ($level, $endln, @chunks) =
4941 ctx_statement_full($linenr, $realcnt, $-[0]);
4942
Andy Whitcroftcf655042008-03-04 14:28:20 -08004943 # Check the condition.
4944 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004945 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004946 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004947 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004948 }
4949 if (statement_lines($cond) > 1) {
4950 #print "APW: ALLOWED: cond<$cond>\n";
4951 $allowed = 1;
4952 }
4953 if ($block =~/\b(?:if|for|while)\b/) {
4954 #print "APW: ALLOWED: block<$block>\n";
4955 $allowed = 1;
4956 }
4957 if (statement_block_size($block) > 1) {
4958 #print "APW: ALLOWED: lines block<$block>\n";
4959 $allowed = 1;
4960 }
4961 # Check the post-context.
4962 if (defined $chunks[1]) {
4963 my ($cond, $block) = @{$chunks[1]};
4964 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004965 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004966 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004967 if ($block =~ /^\s*\{/) {
4968 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4969 $allowed = 1;
4970 }
4971 }
4972 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004973 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004974 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004975
Andy Whitcroftf0556632008-10-15 22:02:23 -07004976 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004977 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004978 }
4979
Joe Perches000d1cc12011-07-25 17:13:25 -07004980 WARN("BRACES",
4981 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004982 }
4983 }
4984
Joe Perches0979ae62012-12-17 16:01:59 -08004985# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004986 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004987 if (CHK("BRACES",
4988 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4989 $fix && $prevrawline =~ /^\+/) {
4990 fix_delete_line($fixlinenr - 1, $prevrawline);
4991 }
Joe Perches0979ae62012-12-17 16:01:59 -08004992 }
Joe Perches77b9a532013-07-03 15:05:29 -07004993 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004994 if (CHK("BRACES",
4995 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4996 $fix) {
4997 fix_delete_line($fixlinenr, $rawline);
4998 }
Joe Perches0979ae62012-12-17 16:01:59 -08004999 }
5000
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005001# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005002 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5003 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005004 WARN("VOLATILE",
5005 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005006 }
5007
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005008# Check for user-visible strings broken across lines, which breaks the ability
5009# to grep for the string. Make exceptions when the previous string ends in a
5010# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5011# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005012 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005013 $prevline =~ /"\s*$/ &&
5014 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5015 if (WARN("SPLIT_STRING",
5016 "quoted string split across lines\n" . $hereprev) &&
5017 $fix &&
5018 $prevrawline =~ /^\+.*"\s*$/ &&
5019 $last_coalesced_string_linenr != $linenr - 1) {
5020 my $extracted_string = get_quoted_string($line, $rawline);
5021 my $comma_close = "";
5022 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5023 $comma_close = $1;
5024 }
5025
5026 fix_delete_line($fixlinenr - 1, $prevrawline);
5027 fix_delete_line($fixlinenr, $rawline);
5028 my $fixedline = $prevrawline;
5029 $fixedline =~ s/"\s*$//;
5030 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5031 fix_insert_line($fixlinenr - 1, $fixedline);
5032 $fixedline = $rawline;
5033 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5034 if ($fixedline !~ /\+\s*$/) {
5035 fix_insert_line($fixlinenr, $fixedline);
5036 }
5037 $last_coalesced_string_linenr = $linenr;
5038 }
5039 }
5040
5041# check for missing a space in a string concatenation
5042 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5043 WARN('MISSING_SPACE',
5044 "break quoted strings at a space character\n" . $hereprev);
5045 }
5046
5047# check for spaces before a quoted newline
5048 if ($rawline =~ /^.*\".*\s\\n/) {
5049 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5050 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5051 $fix) {
5052 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5053 }
5054
5055 }
5056
Joe Perchesf17dba42014-10-13 15:51:51 -07005057# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005058 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005059 CHK("CONCATENATED_STRING",
5060 "Concatenated strings should use spaces between elements\n" . $herecurr);
5061 }
5062
Joe Perches90ad30e2014-12-10 15:51:59 -08005063# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005064 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005065 WARN("STRING_FRAGMENTS",
5066 "Consecutive strings are generally better as a single string\n" . $herecurr);
5067 }
5068
Joe Perches6e300752015-09-09 15:37:47 -07005069# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005070 my $string;
5071 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5072 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5073 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005074 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005075 WARN("PRINTF_L",
5076 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5077 last;
5078 }
Joe Perches6e300752015-09-09 15:37:47 -07005079 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5080 ERROR("PRINTF_0xDECIMAL",
5081 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5082 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005083 }
5084
5085# check for line continuations in quoted strings with odd counts of "
5086 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5087 WARN("LINE_CONTINUATIONS",
5088 "Avoid line continuations in quoted strings\n" . $herecurr);
5089 }
5090
Gregory Bean6c9c6842011-03-17 14:18:20 -07005091# sys_open/read/write/close are not allowed in the kernel
5092 if ($line =~ /\b(sys_(?:open|read|write|close))\b/) {
5093 ERROR("FILE_OPS",
5094 "$1 is inappropriate in kernel code.\n" .
5095 $herecurr);
5096 }
5097
Gregory Bean3f6f2dd2011-05-02 13:50:35 -07005098# read[bwl] & write[bwl] use too many barriers, use the _relaxed variants
5099 if ($line =~ /\b((?:read|write)[bwl])\b/) {
5100 ERROR("NON_RELAXED_IO",
5101 "Use of $1 is deprecated: use $1_relaxed\n\t" .
5102 "with appropriate memory barriers instead.\n" .
5103 $herecurr);
5104 }
5105
5106# likewise, in/out[bwl] should be __raw_read/write[bwl]...
5107 if ($line =~ /\b((in|out)([bwl]))\b/) {
5108 my ($all, $pref, $suf) = ($1, $2, $3);
5109 $pref =~ s/in/read/;
5110 $pref =~ s/out/write/;
5111 ERROR("NON_RELAXED_IO",
5112 "Use of $all is deprecated: use " .
5113 "__raw_$pref$suf\n\t" .
5114 "with appropriate memory barriers instead.\n" .
5115 $herecurr);
5116 }
5117
Gregory Beandf3a3ee2011-05-10 12:34:09 -07005118# unbounded string functions are overflow risks
5119 my %str_fns = (
5120 "sprintf" => "snprintf",
5121 "strcpy" => "strlcpy",
5122 "strncpy" => "strlcpy",
5123 "strcat" => "strlcat",
5124 "strncat" => "strlcat",
5125 "vsprintf" => "vsnprintf",
5126 "strchr" => "strnchr",
5127 "strstr" => "strnstr",
5128 );
5129 foreach my $k (keys %str_fns) {
5130 if ($line =~ /\b$k\b/) {
5131 ERROR("UNBOUNDED_STRING_FNS",
5132 "Use of $k is deprecated: " .
5133 "use $str_fns{$k} instead.\n" .
5134 $herecurr);
5135 }
5136 }
5137
Andy Whitcroft00df3442007-06-08 13:47:06 -07005138# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005139 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Abhijeet Dharmapurikar800a3132009-10-01 12:01:44 -07005140 WARN("IF_0",
5141 "if this code is redundant consider removing it\n"
5142 . $herecurr);
5143 }
5144
5145# warn about #if 1
5146 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5147 WARN("IF_1",
5148 "if this code is required consider removing"
5149 . " #if 1\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005150 }
5151
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005152# check for needless "if (<foo>) fn(<foo>)" uses
5153 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005154 my $tested = quotemeta($1);
5155 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5156 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5157 my $func = $1;
5158 if (WARN('NEEDLESS_IF',
5159 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5160 $fix) {
5161 my $do_fix = 1;
5162 my $leading_tabs = "";
5163 my $new_leading_tabs = "";
5164 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5165 $leading_tabs = $1;
5166 } else {
5167 $do_fix = 0;
5168 }
5169 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5170 $new_leading_tabs = $1;
5171 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5172 $do_fix = 0;
5173 }
5174 } else {
5175 $do_fix = 0;
5176 }
5177 if ($do_fix) {
5178 fix_delete_line($fixlinenr - 1, $prevrawline);
5179 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5180 }
5181 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005182 }
5183 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005184
Joe Perchesebfdc402014-08-06 16:10:27 -07005185# check for unnecessary "Out of Memory" messages
5186 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5187 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5188 (defined $1 || defined $3) &&
5189 $linenr > 3) {
5190 my $testval = $2;
5191 my $testline = $lines[$linenr - 3];
5192
5193 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5194# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5195
5196 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5197 WARN("OOM_MESSAGE",
5198 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5199 }
5200 }
5201
Joe Perchesf78d98f2014-10-13 15:52:01 -07005202# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005203 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005204 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5205 my $level = $1;
5206 if (WARN("UNNECESSARY_KERN_LEVEL",
5207 "Possible unnecessary $level\n" . $herecurr) &&
5208 $fix) {
5209 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5210 }
5211 }
5212
Joe Perchesabb08a52014-12-10 15:51:46 -08005213# check for mask then right shift without a parentheses
5214 if ($^V && $^V ge 5.10.0 &&
5215 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5216 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5217 WARN("MASK_THEN_SHIFT",
5218 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5219 }
5220
Joe Perchesb75ac612014-12-10 15:52:02 -08005221# check for pointer comparisons to NULL
5222 if ($^V && $^V ge 5.10.0) {
5223 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5224 my $val = $1;
5225 my $equal = "!";
5226 $equal = "" if ($4 eq "!=");
5227 if (CHK("COMPARISON_TO_NULL",
5228 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5229 $fix) {
5230 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5231 }
5232 }
5233 }
5234
Joe Perches8716de32013-09-11 14:24:05 -07005235# check for bad placement of section $InitAttribute (e.g.: __initdata)
5236 if ($line =~ /(\b$InitAttribute\b)/) {
5237 my $attr = $1;
5238 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5239 my $ptr = $1;
5240 my $var = $2;
5241 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5242 ERROR("MISPLACED_INIT",
5243 "$attr should be placed after $var\n" . $herecurr)) ||
5244 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5245 WARN("MISPLACED_INIT",
5246 "$attr should be placed after $var\n" . $herecurr))) &&
5247 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005248 $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 -07005249 }
5250 }
5251 }
5252
Joe Perchese970b882013-11-12 15:10:10 -08005253# check for $InitAttributeData (ie: __initdata) with const
5254 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5255 my $attr = $1;
5256 $attr =~ /($InitAttributePrefix)(.*)/;
5257 my $attr_prefix = $1;
5258 my $attr_type = $2;
5259 if (ERROR("INIT_ATTRIBUTE",
5260 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5261 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005262 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005263 s/$InitAttributeData/${attr_prefix}initconst/;
5264 }
5265 }
5266
5267# check for $InitAttributeConst (ie: __initconst) without const
5268 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5269 my $attr = $1;
5270 if (ERROR("INIT_ATTRIBUTE",
5271 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5272 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005273 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005274 /(^\+\s*(?:static\s+))/;
5275 $lead = rtrim($1);
5276 $lead = "$lead " if ($lead !~ /^\+$/);
5277 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005278 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08005279 }
5280 }
5281
Joe Perchesc17893c2015-04-16 12:44:42 -07005282# check for __read_mostly with const non-pointer (should just be const)
5283 if ($line =~ /\b__read_mostly\b/ &&
5284 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5285 if (ERROR("CONST_READ_MOSTLY",
5286 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5287 $fix) {
5288 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5289 }
5290 }
5291
Joe Perchesfbdb8132014-04-03 14:49:14 -07005292# don't use __constant_<foo> functions outside of include/uapi/
5293 if ($realfile !~ m@^include/uapi/@ &&
5294 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5295 my $constant_func = $1;
5296 my $func = $constant_func;
5297 $func =~ s/^__constant_//;
5298 if (WARN("CONSTANT_CONVERSION",
5299 "$constant_func should be $func\n" . $herecurr) &&
5300 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005301 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005302 }
5303 }
5304
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005305# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005306 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005307 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005308 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005309 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005310 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005311 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5312 }
5313 if ($delay > 2000) {
5314 WARN("LONG_UDELAY",
5315 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005316 }
5317 }
5318
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005319# warn about unexpectedly long msleep's
5320 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5321 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005322 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005323 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005324 }
5325 }
5326
Joe Perches36ec1932013-07-03 15:05:25 -07005327# check for comparisons of jiffies
5328 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5329 WARN("JIFFIES_COMPARISON",
5330 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5331 }
5332
Joe Perches9d7a34a2013-07-03 15:05:26 -07005333# check for comparisons of get_jiffies_64()
5334 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5335 WARN("JIFFIES_COMPARISON",
5336 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5337 }
5338
Israel Schlesinger5f8c9a22010-07-21 13:34:18 -07005339# check the patch for use of mdelay
5340 if ($line =~ /\bmdelay\s*\(/) {
5341 WARN("MDELAY",
5342 "use of mdelay() found: msleep() is the preferred API.\n" . $herecurr );
5343 }
5344
Andy Whitcroft00df3442007-06-08 13:47:06 -07005345# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005346# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005347# print "#ifdef in C files should be avoided\n";
5348# print "$herecurr";
5349# $clean = 0;
5350# }
5351
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005352# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005353 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005354 if (ERROR("SPACING",
5355 "exactly one space required after that #$1\n" . $herecurr) &&
5356 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005357 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005358 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5359 }
5360
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005361 }
5362
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005363# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005364 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5365 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005366 my $which = $1;
5367 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005368 CHK("UNCOMMENTED_DEFINITION",
5369 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005370 }
5371 }
5372# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005373
5374 my $barriers = qr{
5375 mb|
5376 rmb|
5377 wmb|
5378 read_barrier_depends
5379 }x;
5380 my $barrier_stems = qr{
5381 mb__before_atomic|
5382 mb__after_atomic|
5383 store_release|
5384 load_acquire|
5385 store_mb|
5386 (?:$barriers)
5387 }x;
5388 my $all_barriers = qr{
5389 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005390 smp_(?:$barrier_stems)|
5391 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005392 }x;
5393
5394 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005395 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005396 WARN("MEMORY_BARRIER",
5397 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005398 }
5399 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005400
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005401 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5402
5403 if ($realfile !~ m@^include/asm-generic/@ &&
5404 $realfile !~ m@/barrier\.h$@ &&
5405 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5406 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5407 WARN("MEMORY_BARRIER",
5408 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5409 }
5410
Joe Perchescb426e92015-06-25 15:02:46 -07005411# check for waitqueue_active without a comment.
5412 if ($line =~ /\bwaitqueue_active\s*\(/) {
5413 if (!ctx_has_comment($first_line, $linenr)) {
5414 WARN("WAITQUEUE_ACTIVE",
5415 "waitqueue_active without comment\n" . $herecurr);
5416 }
5417 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005418
5419# Check for expedited grace periods that interrupt non-idle non-nohz
5420# online CPUs. These expedited can therefore degrade real-time response
5421# if used carelessly, and should be avoided where not absolutely
5422# needed. It is always OK to use synchronize_rcu_expedited() and
5423# synchronize_sched_expedited() at boot time (before real-time applications
5424# start) and in error situations where real-time response is compromised in
5425# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5426# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5427# Of course, nothing comes for free, and srcu_read_lock() and
5428# srcu_read_unlock() do contain full memory barriers in payment for
5429# synchronize_srcu_expedited() non-interruption properties.
5430 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5431 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5432 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5433
5434 }
5435
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005436# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005437 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005438 CHK("ARCH_DEFINES",
5439 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005440 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005441
Tobias Klauserd4977c72010-05-24 14:33:30 -07005442# Check that the storage class is at the beginning of a declaration
5443 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005444 WARN("STORAGE_CLASS",
5445 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005446 }
5447
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005448# check the location of the inline attribute, that it is between
5449# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005450 if ($line =~ /\b$Type\s+$Inline\b/ ||
5451 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005452 ERROR("INLINE_LOCATION",
5453 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005454 }
5455
Andy Whitcroft8905a672007-11-28 16:21:06 -08005456# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005457 if ($realfile !~ m@\binclude/uapi/@ &&
5458 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005459 if (WARN("INLINE",
5460 "plain inline is preferred over $1\n" . $herecurr) &&
5461 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005462 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005463
5464 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005465 }
5466
Joe Perches3d130fd2011-01-12 17:00:00 -08005467# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005468 if ($realfile !~ m@\binclude/uapi/@ &&
5469 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005470 WARN("PREFER_PACKED",
5471 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005472 }
5473
Joe Perches39b7e282011-07-25 17:13:24 -07005474# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005475 if ($realfile !~ m@\binclude/uapi/@ &&
5476 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005477 WARN("PREFER_ALIGNED",
5478 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005479 }
5480
Joe Perches5f14d3b2012-01-10 15:09:52 -08005481# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005482 if ($realfile !~ m@\binclude/uapi/@ &&
5483 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005484 if (WARN("PREFER_PRINTF",
5485 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5486 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005487 $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 -07005488
5489 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005490 }
5491
Joe Perches6061d942012-03-23 15:02:16 -07005492# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005493 if ($realfile !~ m@\binclude/uapi/@ &&
5494 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005495 if (WARN("PREFER_SCANF",
5496 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5497 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005498 $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 -07005499 }
Joe Perches6061d942012-03-23 15:02:16 -07005500 }
5501
Joe Perches619a9082014-12-10 15:51:35 -08005502# Check for __attribute__ weak, or __weak declarations (may have link issues)
5503 if ($^V && $^V ge 5.10.0 &&
5504 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5505 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5506 $line =~ /\b__weak\b/)) {
5507 ERROR("WEAK_DECLARATION",
5508 "Using weak declarations can have unintended link defects\n" . $herecurr);
5509 }
5510
Joe Perchese6176fa2015-06-25 15:02:49 -07005511# check for c99 types like uint8_t used outside of uapi/
5512 if ($realfile !~ m@\binclude/uapi/@ &&
5513 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5514 my $type = $1;
5515 if ($type =~ /\b($typeC99Typedefs)\b/) {
5516 $type = $1;
5517 my $kernel_type = 'u';
5518 $kernel_type = 's' if ($type =~ /^_*[si]/);
5519 $type =~ /(\d+)/;
5520 $kernel_type .= $1;
5521 if (CHK("PREFER_KERNEL_TYPES",
5522 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5523 $fix) {
5524 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5525 }
5526 }
5527 }
5528
Joe Perches938224b2016-01-20 14:59:15 -08005529# check for cast of C90 native int or longer types constants
5530 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5531 my $cast = $1;
5532 my $const = $2;
5533 if (WARN("TYPECAST_INT_CONSTANT",
5534 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5535 $fix) {
5536 my $suffix = "";
5537 my $newconst = $const;
5538 $newconst =~ s/${Int_type}$//;
5539 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5540 if ($cast =~ /\blong\s+long\b/) {
5541 $suffix .= 'LL';
5542 } elsif ($cast =~ /\blong\b/) {
5543 $suffix .= 'L';
5544 }
5545 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5546 }
5547 }
5548
Joe Perches8f53a9b2010-03-05 13:43:48 -08005549# check for sizeof(&)
5550 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005551 WARN("SIZEOF_ADDRESS",
5552 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005553 }
5554
Joe Perches66c80b62012-07-30 14:41:22 -07005555# check for sizeof without parenthesis
5556 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005557 if (WARN("SIZEOF_PARENTHESIS",
5558 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5559 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005560 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005561 }
Joe Perches66c80b62012-07-30 14:41:22 -07005562 }
5563
Joe Perches88982fe2012-12-17 16:02:00 -08005564# check for struct spinlock declarations
5565 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5566 WARN("USE_SPINLOCK_T",
5567 "struct spinlock should be spinlock_t\n" . $herecurr);
5568 }
5569
Joe Perchesa6962d72013-04-29 16:18:13 -07005570# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005571 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005572 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005573 $fmt =~ s/%%//g;
5574 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005575 if (WARN("PREFER_SEQ_PUTS",
5576 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5577 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005578 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005579 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005580 }
5581 }
5582
Andy Whitcroft554e1652012-01-10 15:09:57 -08005583# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005584 if ($^V && $^V ge 5.10.0 &&
5585 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005586 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005587
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005588 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005589 my $ms_val = $7;
5590 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005591
Andy Whitcroft554e1652012-01-10 15:09:57 -08005592 if ($ms_size =~ /^(0x|)0$/i) {
5593 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005594 "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 -08005595 } elsif ($ms_size =~ /^(0x|)1$/i) {
5596 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005597 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5598 }
5599 }
5600
Joe Perches98a9bba2014-01-23 15:54:52 -08005601# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5602 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005603 defined $stat &&
5604 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005605 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005606 "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 -08005607 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005608 $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 -08005609 }
5610 }
5611
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005612# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5613 if ($^V && $^V ge 5.10.0 &&
5614 defined $stat &&
5615 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5616 WARN("PREFER_ETHER_ADDR_EQUAL",
5617 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5618 }
5619
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005620# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5621# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5622 if ($^V && $^V ge 5.10.0 &&
5623 defined $stat &&
5624 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5625
5626 my $ms_val = $7;
5627
5628 if ($ms_val =~ /^(?:0x|)0+$/i) {
5629 if (WARN("PREFER_ETH_ZERO_ADDR",
5630 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5631 $fix) {
5632 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5633 }
5634 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5635 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5636 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5637 $fix) {
5638 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5639 }
5640 }
5641 }
5642
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005643# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005644 if ($^V && $^V ge 5.10.0 &&
5645 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005646 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005647 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005648 my $call = $1;
5649 my $cast1 = deparenthesize($2);
5650 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005651 my $cast2 = deparenthesize($7);
5652 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005653 my $cast;
5654
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005655 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005656 $cast = "$cast1 or $cast2";
5657 } elsif ($cast1 ne "") {
5658 $cast = $cast1;
5659 } else {
5660 $cast = $cast2;
5661 }
5662 WARN("MINMAX",
5663 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005664 }
5665 }
5666
Joe Perches4a273192012-07-30 14:41:20 -07005667# check usleep_range arguments
5668 if ($^V && $^V ge 5.10.0 &&
5669 defined $stat &&
5670 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5671 my $min = $1;
5672 my $max = $7;
5673 if ($min eq $max) {
5674 WARN("USLEEP_RANGE",
5675 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5676 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5677 $min > $max) {
5678 WARN("USLEEP_RANGE",
5679 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5680 }
5681 }
5682
Joe Perches823b7942013-11-12 15:10:15 -08005683# check for naked sscanf
5684 if ($^V && $^V ge 5.10.0 &&
5685 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005686 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005687 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5688 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5689 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5690 my $lc = $stat =~ tr@\n@@;
5691 $lc = $lc + $linenr;
5692 my $stat_real = raw_line($linenr, 0);
5693 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5694 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5695 }
5696 WARN("NAKED_SSCANF",
5697 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5698 }
5699
Joe Perchesafc819a2014-06-04 16:12:08 -07005700# check for simple sscanf that should be kstrto<foo>
5701 if ($^V && $^V ge 5.10.0 &&
5702 defined $stat &&
5703 $line =~ /\bsscanf\b/) {
5704 my $lc = $stat =~ tr@\n@@;
5705 $lc = $lc + $linenr;
5706 my $stat_real = raw_line($linenr, 0);
5707 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5708 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5709 }
5710 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5711 my $format = $6;
5712 my $count = $format =~ tr@%@%@;
5713 if ($count == 1 &&
5714 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5715 WARN("SSCANF_TO_KSTRTO",
5716 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5717 }
5718 }
5719 }
5720
Joe Perches70dc8a42013-09-11 14:23:58 -07005721# check for new externs in .h files.
5722 if ($realfile =~ /\.h$/ &&
5723 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005724 if (CHK("AVOID_EXTERNS",
5725 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005726 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005727 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005728 }
5729 }
5730
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005731# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005732 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005733 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005734 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005735 my $function_name = $1;
5736 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005737
5738 my $s = $stat;
5739 if (defined $cond) {
5740 substr($s, 0, length($cond), '');
5741 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005742 if ($s =~ /^\s*;/ &&
5743 $function_name ne 'uninitialized_var')
5744 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005745 WARN("AVOID_EXTERNS",
5746 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005747 }
5748
5749 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005750 WARN("FUNCTION_ARGUMENTS",
5751 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005752 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005753
5754 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5755 $stat =~ /^.\s*extern\s+/)
5756 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005757 WARN("AVOID_EXTERNS",
5758 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005759 }
5760
5761# checks for new __setup's
5762 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5763 my $name = $1;
5764
5765 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005766 CHK("UNDOCUMENTED_SETUP",
5767 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005768 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005769 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005770
5771# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005772 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005773 WARN("UNNECESSARY_CASTS",
5774 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005775 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005776
Joe Perchesa640d252013-07-03 15:05:21 -07005777# alloc style
5778# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5779 if ($^V && $^V ge 5.10.0 &&
5780 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5781 CHK("ALLOC_SIZEOF_STRUCT",
5782 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5783 }
5784
Joe Perches60a55362014-06-04 16:12:07 -07005785# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5786 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005787 $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 -07005788 my $oldfunc = $3;
5789 my $a1 = $4;
5790 my $a2 = $10;
5791 my $newfunc = "kmalloc_array";
5792 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005793 my $r1 = $a1;
5794 my $r2 = $a2;
5795 if ($a1 =~ /^sizeof\s*\S/) {
5796 $r1 = $a2;
5797 $r2 = $a1;
5798 }
5799 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5800 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005801 if (WARN("ALLOC_WITH_MULTIPLY",
5802 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5803 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005804 $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 -07005805
5806 }
5807 }
5808 }
5809
Joe Perches972fdea2013-04-29 16:18:12 -07005810# check for krealloc arg reuse
5811 if ($^V && $^V ge 5.10.0 &&
5812 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5813 WARN("KREALLOC_ARG_REUSE",
5814 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5815 }
5816
Joe Perches5ce59ae2013-02-21 16:44:18 -08005817# check for alloc argument mismatch
5818 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5819 WARN("ALLOC_ARRAY_ARGS",
5820 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5821 }
5822
Joe Perchescaf2a542011-01-12 16:59:56 -08005823# check for multiple semicolons
5824 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005825 if (WARN("ONE_SEMICOLON",
5826 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5827 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005828 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005829 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005830 }
5831
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005832# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5833 if ($realfile !~ m@^include/uapi/@ &&
5834 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08005835 my $ull = "";
5836 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5837 if (CHK("BIT_MACRO",
5838 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5839 $fix) {
5840 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5841 }
5842 }
5843
Joe Perches2d632742016-05-20 17:04:00 -07005844# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5845 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5846 my $config = $1;
5847 if (WARN("PREFER_IS_ENABLED",
5848 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5849 $fix) {
5850 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5851 }
5852 }
5853
Joe Perchese81f2392014-08-06 16:11:25 -07005854# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005855 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5856 my $has_break = 0;
5857 my $has_statement = 0;
5858 my $count = 0;
5859 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005860 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005861 $prevline--;
5862 my $rline = $rawlines[$prevline - 1];
5863 my $fline = $lines[$prevline - 1];
5864 last if ($fline =~ /^\@\@/);
5865 next if ($fline =~ /^\-/);
5866 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5867 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5868 next if ($fline =~ /^.[\s$;]*$/);
5869 $has_statement = 1;
5870 $count++;
5871 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5872 }
5873 if (!$has_break && $has_statement) {
5874 WARN("MISSING_BREAK",
5875 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5876 }
5877 }
5878
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005879# check for switch/default statements without a break;
5880 if ($^V && $^V ge 5.10.0 &&
5881 defined $stat &&
5882 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5883 my $ctx = '';
5884 my $herectx = $here . "\n";
5885 my $cnt = statement_rawlines($stat);
5886 for (my $n = 0; $n < $cnt; $n++) {
5887 $herectx .= raw_line($linenr, $n) . "\n";
5888 }
5889 WARN("DEFAULT_NO_BREAK",
5890 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005891 }
5892
Patrick Pannutof370e252010-07-23 13:34:18 -07005893# check for return codes on error paths
5894 if ($line =~ /\breturn\s+-\d+/) {
5895 ERROR("NO_ERROR_CODE",
Patrick Pannutoe50031c2010-08-04 14:30:59 -07005896 "illegal return value, please use an error code\n" . $herecurr);
Patrick Pannutof370e252010-07-23 13:34:18 -07005897 }
5898
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005899# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005900 if ($line =~ /\b__FUNCTION__\b/) {
5901 if (WARN("USE_FUNC",
5902 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5903 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005904 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005905 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005906 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005907
Joe Perches62ec8182015-02-13 14:38:18 -08005908# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5909 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5910 ERROR("DATE_TIME",
5911 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5912 }
5913
Joe Perches2c924882012-03-23 15:02:20 -07005914# check for use of yield()
5915 if ($line =~ /\byield\s*\(\s*\)/) {
5916 WARN("YIELD",
5917 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5918 }
5919
Joe Perches179f8f42013-07-03 15:05:30 -07005920# check for comparisons against true and false
5921 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5922 my $lead = $1;
5923 my $arg = $2;
5924 my $test = $3;
5925 my $otype = $4;
5926 my $trail = $5;
5927 my $op = "!";
5928
5929 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5930
5931 my $type = lc($otype);
5932 if ($type =~ /^(?:true|false)$/) {
5933 if (("$test" eq "==" && "$type" eq "true") ||
5934 ("$test" eq "!=" && "$type" eq "false")) {
5935 $op = "";
5936 }
5937
5938 CHK("BOOL_COMPARISON",
5939 "Using comparison to $otype is error prone\n" . $herecurr);
5940
5941## maybe suggesting a correct construct would better
5942## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5943
5944 }
5945 }
5946
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005947# check for semaphores initialized locked
5948 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005949 WARN("CONSIDER_COMPLETION",
5950 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005951 }
Joe Perches6712d852012-03-23 15:02:20 -07005952
Joe Perches67d0a072011-10-31 17:13:10 -07005953# recommend kstrto* over simple_strto* and strict_strto*
5954 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005955 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005956 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005957 }
Joe Perches6712d852012-03-23 15:02:20 -07005958
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005959# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005960 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005961 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005962 "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 -07005963 }
Joe Perches6712d852012-03-23 15:02:20 -07005964
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005965# check for various structs that are normally const (ops, kgdb, device_tree)
5966 my $const_structs = qr{
5967 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005968 address_space_operations|
5969 backlight_ops|
5970 block_device_operations|
5971 dentry_operations|
5972 dev_pm_ops|
5973 dma_map_ops|
5974 extent_io_ops|
5975 file_lock_operations|
5976 file_operations|
5977 hv_ops|
5978 ide_dma_ops|
5979 intel_dvo_dev_ops|
5980 item_operations|
5981 iwl_ops|
5982 kgdb_arch|
5983 kgdb_io|
5984 kset_uevent_ops|
5985 lock_manager_operations|
5986 microcode_ops|
5987 mtrr_ops|
5988 neigh_ops|
5989 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005990 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005991 pci_raw_ops|
5992 pipe_buf_operations|
5993 platform_hibernation_ops|
5994 platform_suspend_ops|
5995 proto_ops|
5996 rpc_pipe_ops|
5997 seq_operations|
5998 snd_ac97_build_ops|
5999 soc_pcmcia_socket_ops|
6000 stacktrace_ops|
6001 sysfs_ops|
6002 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07006003 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08006004 usb_mon_operations|
6005 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006006 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006007 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006008 WARN("CONST_STRUCT",
6009 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006010 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006011 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006012
6013# use of NR_CPUS is usually wrong
6014# ignore definitions of NR_CPUS and usage to define arrays as likely right
6015 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006016 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6017 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006018 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6019 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6020 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006021 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006022 WARN("NR_CPUS",
6023 "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 -07006024 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006025
Joe Perches52ea8502013-11-12 15:10:09 -08006026# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6027 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6028 ERROR("DEFINE_ARCH_HAS",
6029 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6030 }
6031
Joe Perchesacd93622015-02-13 14:38:38 -08006032# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6033 if ($^V && $^V ge 5.10.0 &&
6034 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6035 WARN("LIKELY_MISUSE",
6036 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6037 }
6038
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006039# whine mightly about in_atomic
6040 if ($line =~ /\bin_atomic\s*\(/) {
6041 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006042 ERROR("IN_ATOMIC",
6043 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006044 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006045 WARN("IN_ATOMIC",
6046 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006047 }
6048 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006049
Joe Perches481aea52016-05-20 17:04:08 -07006050# whine about ACCESS_ONCE
6051 if ($^V && $^V ge 5.10.0 &&
6052 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6053 my $par = $1;
6054 my $eq = $2;
6055 my $fun = $3;
6056 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6057 if (defined($eq)) {
6058 if (WARN("PREFER_WRITE_ONCE",
6059 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6060 $fix) {
6061 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6062 }
6063 } else {
6064 if (WARN("PREFER_READ_ONCE",
6065 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6066 $fix) {
6067 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6068 }
6069 }
6070 }
6071
Peter Zijlstra1704f472010-03-19 01:37:42 +01006072# check for lockdep_set_novalidate_class
6073 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6074 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6075 if ($realfile !~ m@^kernel/lockdep@ &&
6076 $realfile !~ m@^include/linux/lockdep@ &&
6077 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006078 ERROR("LOCKDEP",
6079 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006080 }
6081 }
Dave Jones88f88312011-01-12 16:59:59 -08006082
Joe Perchesb392c642015-04-16 12:44:16 -07006083 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6084 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006085 WARN("EXPORTED_WORLD_WRITABLE",
6086 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006087 }
Joe Perches24358802014-04-03 14:49:13 -07006088
Joe Perches515a2352014-04-03 14:49:24 -07006089# Mode permission misuses where it seems decimal should be octal
6090# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6091 if ($^V && $^V ge 5.10.0 &&
6092 $line =~ /$mode_perms_search/) {
6093 foreach my $entry (@mode_permission_funcs) {
6094 my $func = $entry->[0];
6095 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006096
Joe Perches515a2352014-04-03 14:49:24 -07006097 my $skip_args = "";
6098 if ($arg_pos > 1) {
6099 $arg_pos--;
6100 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6101 }
6102 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
6103 if ($line =~ /$test/) {
6104 my $val = $1;
6105 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07006106
Joe Perches515a2352014-04-03 14:49:24 -07006107 if ($val !~ /^0$/ &&
6108 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6109 length($val) ne 4)) {
6110 ERROR("NON_OCTAL_PERMISSIONS",
6111 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08006112 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6113 ERROR("EXPORTED_WORLD_WRITABLE",
6114 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006115 }
Joe Perches24358802014-04-03 14:49:13 -07006116 }
6117 }
6118 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006119
6120# validate content of MODULE_LICENSE against list from include/linux/module.h
6121 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6122 my $extracted_string = get_quoted_string($line, $rawline);
6123 my $valid_licenses = qr{
6124 GPL|
6125 GPL\ v2|
6126 GPL\ and\ additional\ rights|
6127 Dual\ BSD/GPL|
6128 Dual\ MIT/GPL|
6129 Dual\ MPL/GPL|
6130 Proprietary
6131 }x;
6132 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6133 WARN("MODULE_LICENSE",
6134 "unknown module license " . $extracted_string . "\n" . $herecurr);
6135 }
6136 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006137 }
6138
6139 # If we have no input at all, then there is nothing to report on
6140 # so just keep quiet.
6141 if ($#rawlines == -1) {
6142 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006143 }
6144
Andy Whitcroft8905a672007-11-28 16:21:06 -08006145 # In mailback mode only produce a report in the negative, for
6146 # things that appear to be patches.
6147 if ($mailback && ($clean == 1 || !$is_patch)) {
6148 exit(0);
6149 }
6150
6151 # This is not a patch, and we are are in 'no-patch' mode so
6152 # just keep quiet.
6153 if (!$chk_patch && !$is_patch) {
6154 exit(0);
6155 }
6156
Joe Perches06330fc2015-06-25 15:03:11 -07006157 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006158 ERROR("NOT_UNIFIED_DIFF",
6159 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006160 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006161 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006162 ERROR("MISSING_SIGN_OFF",
6163 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006164 }
6165
Andy Whitcroft8905a672007-11-28 16:21:06 -08006166 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006167 if ($summary && !($clean == 1 && $quiet == 1)) {
6168 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006169 print "total: $cnt_error errors, $cnt_warn warnings, " .
6170 (($check)? "$cnt_chk checks, " : "") .
6171 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006172 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006173
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006174 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006175 # If there were any defects found and not already fixing them
6176 if (!$clean and !$fix) {
6177 print << "EOM"
6178
6179NOTE: For some of the reported defects, checkpatch may be able to
6180 mechanically convert to the typical style using --fix or --fix-inplace.
6181EOM
6182 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006183 # If there were whitespace errors which cleanpatch can fix
6184 # then suggest that.
6185 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006186 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006187 print << "EOM"
6188
6189NOTE: Whitespace errors detected.
6190 You may wish to use scripts/cleanpatch or scripts/cleanfile
6191EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006192 }
6193 }
6194
Joe Perchesd752fcc2014-08-06 16:11:05 -07006195 if ($clean == 0 && $fix &&
6196 ("@rawlines" ne "@fixed" ||
6197 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006198 my $newfile = $filename;
6199 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006200 my $linecount = 0;
6201 my $f;
6202
Joe Perchesd752fcc2014-08-06 16:11:05 -07006203 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6204
Joe Perches3705ce52013-07-03 15:05:31 -07006205 open($f, '>', $newfile)
6206 or die "$P: Can't open $newfile for write\n";
6207 foreach my $fixed_line (@fixed) {
6208 $linecount++;
6209 if ($file) {
6210 if ($linecount > 3) {
6211 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006212 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006213 }
6214 } else {
6215 print $f $fixed_line . "\n";
6216 }
6217 }
6218 close($f);
6219
6220 if (!$quiet) {
6221 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006222
Joe Perches3705ce52013-07-03 15:05:31 -07006223Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6224
6225Do _NOT_ trust the results written to this file.
6226Do _NOT_ submit these changes without inspecting them for correctness.
6227
6228This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6229No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006230EOM
6231 }
6232 }
6233
Joe Perchesd8469f12015-06-25 15:03:00 -07006234 if ($quiet == 0) {
6235 print "\n";
6236 if ($clean == 1) {
6237 print "$vname has no obvious style problems and is ready for submission.\n";
6238 } else {
6239 print "$vname has style problems, please review.\n";
6240 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006241 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006242 return $clean;
6243}