blob: 894f8c61657393de96edef70d4ba54cb9e394c64 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
14my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080015my $D = dirname(abs_path($P));
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070016
Joe Perches000d1cc12011-07-25 17:13:25 -070017my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070018
19use Getopt::Long qw(:config no_auto_abbrev);
20
21my $quiet = 0;
22my $tree = 1;
23my $chk_signoff = 1;
24my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070025my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070026my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070028my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070029my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070030my $git = 0;
Joe Perches0dea9f1e2016-05-20 17:04:19 -070031my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070033my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080034my $summary = 1;
35my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080036my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070037my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070038my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070039my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080040my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070041my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080042my %debug;
Joe Perches34456862013-07-03 15:05:34 -070043my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070044my %use_type = ();
45my @use = ();
46my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070047my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070048my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070049my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080050my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070051my $ignore_perl_version = 0;
52my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070053my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070054my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070055my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070056my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perches57230292015-06-25 15:03:03 -070057my $color = 1;
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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700181GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700182 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700232if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700233 push(@ARGV, '-');
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Perchese970b8842013-11-12 15:10:10 -0800324our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
325our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
326our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
327our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
328our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700329
Wolfram Sang52131292010-03-05 13:43:51 -0800330# Notes to $Attribute:
331# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700332our $Attribute = qr{
333 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700334 __percpu|
335 __nocast|
336 __safe|
337 __bitwise__|
338 __packed__|
339 __packed2__|
340 __naked|
341 __maybe_unused|
342 __always_unused|
343 __noreturn|
344 __used|
345 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800346 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700347 __noclone|
348 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700349 __read_mostly|
350 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700351 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700352 ____cacheline_aligned|
353 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800354 ____cacheline_internodealigned_in_smp|
355 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700356 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700357our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700358our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700359our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
360our $Lval = qr{$Ident(?:$Member)*};
361
Joe Perches95e2c602013-07-03 15:05:20 -0700362our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
363our $Binary = qr{(?i)0b[01]+$Int_type?};
364our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
365our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700366our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800367our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800368our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
369our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
370our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800371our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700372our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800373our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700374our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700375our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700376our $Operators = qr{
377 <=|>=|==|!=|
378 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700379 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700380 }x;
381
Joe Perches91cb5192014-04-03 14:49:32 -0700382our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
383
Joe Perchesab7e23f2015-04-16 12:44:22 -0700384our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700386our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700387our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800388our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700389our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800390our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700391our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800392
Joe Perches15662b32011-10-31 17:13:12 -0700393our $NON_ASCII_UTF8 = qr{
394 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700395 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
396 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
397 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
398 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
399 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
400 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
401}x;
402
Joe Perches15662b32011-10-31 17:13:12 -0700403our $UTF8 = qr{
404 [\x09\x0A\x0D\x20-\x7E] # ASCII
405 | $NON_ASCII_UTF8
406}x;
407
Joe Perchese6176fa2015-06-25 15:02:49 -0700408our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800409our $typeOtherOSTypedefs = qr{(?x:
410 u_(?:char|short|int|long) | # bsd
411 u(?:nchar|short|int|long) # sysv
412)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700413our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700414 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700415 atomic_t
416)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700417our $typeTypedefs = qr{(?x:
418 $typeC99Typedefs\b|
419 $typeOtherOSTypedefs\b|
420 $typeKernelTypedefs\b
421)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700422
Joe Perches6d32f7a2015-11-06 16:31:37 -0800423our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
424
Joe Perches691e6692010-03-05 13:43:51 -0800425our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700426 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700427 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700428 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700429 panic|
Joe Perches06668722013-11-12 15:10:07 -0800430 MODULE_[A-Z_]+|
431 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800432)};
433
Joe Perches20112472011-07-25 17:13:23 -0700434our $signature_tags = qr{(?xi:
435 Signed-off-by:|
436 Acked-by:|
437 Tested-by:|
438 Reviewed-by:|
439 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700440 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700441 To:|
442 Cc:
443)};
444
Joe Perches18130872014-08-06 16:11:22 -0700445our @typeListMisordered = (
446 qr{char\s+(?:un)?signed},
447 qr{int\s+(?:(?:un)?signed\s+)?short\s},
448 qr{int\s+short(?:\s+(?:un)?signed)},
449 qr{short\s+int(?:\s+(?:un)?signed)},
450 qr{(?:un)?signed\s+int\s+short},
451 qr{short\s+(?:un)?signed},
452 qr{long\s+int\s+(?:un)?signed},
453 qr{int\s+long\s+(?:un)?signed},
454 qr{long\s+(?:un)?signed\s+int},
455 qr{int\s+(?:un)?signed\s+long},
456 qr{int\s+(?:un)?signed},
457 qr{int\s+long\s+long\s+(?:un)?signed},
458 qr{long\s+long\s+int\s+(?:un)?signed},
459 qr{long\s+long\s+(?:un)?signed\s+int},
460 qr{long\s+long\s+(?:un)?signed},
461 qr{long\s+(?:un)?signed},
462);
463
Andy Whitcroft8905a672007-11-28 16:21:06 -0800464our @typeList = (
465 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700466 qr{(?:(?:un)?signed\s+)?char},
467 qr{(?:(?:un)?signed\s+)?short\s+int},
468 qr{(?:(?:un)?signed\s+)?short},
469 qr{(?:(?:un)?signed\s+)?int},
470 qr{(?:(?:un)?signed\s+)?long\s+int},
471 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
472 qr{(?:(?:un)?signed\s+)?long\s+long},
473 qr{(?:(?:un)?signed\s+)?long},
474 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800475 qr{float},
476 qr{double},
477 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800478 qr{struct\s+$Ident},
479 qr{union\s+$Ident},
480 qr{enum\s+$Ident},
481 qr{${Ident}_t},
482 qr{${Ident}_handler},
483 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700484 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800485);
Joe Perches938224b52016-01-20 14:59:15 -0800486
487our $C90_int_types = qr{(?x:
488 long\s+long\s+int\s+(?:un)?signed|
489 long\s+long\s+(?:un)?signed\s+int|
490 long\s+long\s+(?:un)?signed|
491 (?:(?:un)?signed\s+)?long\s+long\s+int|
492 (?:(?:un)?signed\s+)?long\s+long|
493 int\s+long\s+long\s+(?:un)?signed|
494 int\s+(?:(?:un)?signed\s+)?long\s+long|
495
496 long\s+int\s+(?:un)?signed|
497 long\s+(?:un)?signed\s+int|
498 long\s+(?:un)?signed|
499 (?:(?:un)?signed\s+)?long\s+int|
500 (?:(?:un)?signed\s+)?long|
501 int\s+long\s+(?:un)?signed|
502 int\s+(?:(?:un)?signed\s+)?long|
503
504 int\s+(?:un)?signed|
505 (?:(?:un)?signed\s+)?int
506)};
507
Alex Dowad485ff232015-06-25 15:02:52 -0700508our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700509our @typeListWithAttr = (
510 @typeList,
511 qr{struct\s+$InitAttribute\s+$Ident},
512 qr{union\s+$InitAttribute\s+$Ident},
513);
514
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700515our @modifierList = (
516 qr{fastcall},
517);
Alex Dowad485ff232015-06-25 15:02:52 -0700518our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800519
Joe Perches24358802014-04-03 14:49:13 -0700520our @mode_permission_funcs = (
521 ["module_param", 3],
522 ["module_param_(?:array|named|string)", 4],
523 ["module_param_array_named", 5],
524 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
525 ["proc_create(?:_data|)", 2],
526 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
527);
528
Joe Perches515a2352014-04-03 14:49:24 -0700529#Create a search pattern for all these functions to speed up a loop below
530our $mode_perms_search = "";
531foreach my $entry (@mode_permission_funcs) {
532 $mode_perms_search .= '|' if ($mode_perms_search ne "");
533 $mode_perms_search .= $entry->[0];
534}
535
Joe Perchesb392c642015-04-16 12:44:16 -0700536our $mode_perms_world_writable = qr{
537 S_IWUGO |
538 S_IWOTH |
539 S_IRWXUGO |
540 S_IALLUGO |
541 0[0-7][0-7][2367]
542}x;
543
Joe Perchesf90774e2016-10-11 13:51:47 -0700544our %mode_permission_string_types = (
545 "S_IRWXU" => 0700,
546 "S_IRUSR" => 0400,
547 "S_IWUSR" => 0200,
548 "S_IXUSR" => 0100,
549 "S_IRWXG" => 0070,
550 "S_IRGRP" => 0040,
551 "S_IWGRP" => 0020,
552 "S_IXGRP" => 0010,
553 "S_IRWXO" => 0007,
554 "S_IROTH" => 0004,
555 "S_IWOTH" => 0002,
556 "S_IXOTH" => 0001,
557 "S_IRWXUGO" => 0777,
558 "S_IRUGO" => 0444,
559 "S_IWUGO" => 0222,
560 "S_IXUGO" => 0111,
561);
562
563#Create a search pattern for all these strings to speed up a loop below
564our $mode_perms_string_search = "";
565foreach my $entry (keys %mode_permission_string_types) {
566 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne "");
567 $mode_perms_string_search .= $entry;
568}
569
Wolfram Sang7840a942010-08-09 17:20:57 -0700570our $allowed_asm_includes = qr{(?x:
571 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700572 memory|
573 time|
574 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700575)};
576# memory.h: ARM has a custom one
577
Kees Cook66b47b42014-10-13 15:51:57 -0700578# Load common spelling mistakes and build regular expression list.
579my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700580my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700581
Joe Perches36061e32014-12-10 15:51:43 -0800582if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800583 while (<$spelling>) {
584 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700585
Joe Perches36061e32014-12-10 15:51:43 -0800586 $line =~ s/\s*\n?$//g;
587 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700588
Joe Perches36061e32014-12-10 15:51:43 -0800589 next if ($line =~ m/^\s*#/);
590 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700591
Joe Perches36061e32014-12-10 15:51:43 -0800592 my ($suspect, $fix) = split(/\|\|/, $line);
593
Joe Perches36061e32014-12-10 15:51:43 -0800594 $spelling_fix{$suspect} = $fix;
595 }
596 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800597} else {
598 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700599}
Kees Cook66b47b42014-10-13 15:51:57 -0700600
Joe Perchesebfd7d62015-04-16 12:44:14 -0700601if ($codespell) {
602 if (open(my $spelling, '<', $codespellfile)) {
603 while (<$spelling>) {
604 my $line = $_;
605
606 $line =~ s/\s*\n?$//g;
607 $line =~ s/^\s*//g;
608
609 next if ($line =~ m/^\s*#/);
610 next if ($line =~ m/^\s*$/);
611 next if ($line =~ m/, disabled/i);
612
613 $line =~ s/,.*$//;
614
615 my ($suspect, $fix) = split(/->/, $line);
616
617 $spelling_fix{$suspect} = $fix;
618 }
619 close($spelling);
620 } else {
621 warn "No codespell typos will be found - file '$codespellfile': $!\n";
622 }
623}
624
625$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
626
Andy Whitcroft8905a672007-11-28 16:21:06 -0800627sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700628 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
629 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700630 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700631 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700632 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700633 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700634 (?:$typeTypedefs\b)|
635 (?:${all}\b)
636 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800637 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700638 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800639 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800640 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700641 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700642 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800643 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700644 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800645 }x;
Joe Perches18130872014-08-06 16:11:22 -0700646 $NonptrTypeMisordered = qr{
647 (?:$Modifier\s+|const\s+)*
648 (?:
649 (?:${Misordered}\b)
650 )
651 (?:\s+$Modifier|\s+const)*
652 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700653 $NonptrTypeWithAttr = qr{
654 (?:$Modifier\s+|const\s+)*
655 (?:
656 (?:typeof|__typeof__)\s*\([^\)]*\)|
657 (?:$typeTypedefs\b)|
658 (?:${allWithAttr}\b)
659 )
660 (?:\s+$Modifier|\s+const)*
661 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800662 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700663 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700664 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700665 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800666 }x;
Joe Perches18130872014-08-06 16:11:22 -0700667 $TypeMisordered = qr{
668 $NonptrTypeMisordered
669 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
670 (?:\s+$Inline|\s+$Modifier)*
671 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700672 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700673 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800674}
675build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700676
Joe Perches7d2367a2011-07-25 17:13:22 -0700677our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700678
679# Using $balanced_parens, $LvalOrFunc, or $FuncArg
680# requires at least perl version v5.10.0
681# Any use must be runtime checked with $^V
682
683our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700684our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800685our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700686
Joe Perchesf8422302014-08-06 16:11:31 -0700687our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700688 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700689 (?:$Storage\s+)?LIST_HEAD\s*\(|
690 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
691)};
692
Joe Perches7d2367a2011-07-25 17:13:22 -0700693sub deparenthesize {
694 my ($string) = @_;
695 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700696
697 while ($string =~ /^\s*\(.*\)\s*$/) {
698 $string =~ s@^\s*\(\s*@@;
699 $string =~ s@\s*\)\s*$@@;
700 }
701
Joe Perches7d2367a2011-07-25 17:13:22 -0700702 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700703
Joe Perches7d2367a2011-07-25 17:13:22 -0700704 return $string;
705}
706
Joe Perches34456862013-07-03 15:05:34 -0700707sub seed_camelcase_file {
708 my ($file) = @_;
709
710 return if (!(-f $file));
711
712 local $/;
713
714 open(my $include_file, '<', "$file")
715 or warn "$P: Can't read '$file' $!\n";
716 my $text = <$include_file>;
717 close($include_file);
718
719 my @lines = split('\n', $text);
720
721 foreach my $line (@lines) {
722 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
723 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
724 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800725 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
726 $camelcase{$1} = 1;
727 } 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 -0700728 $camelcase{$1} = 1;
729 }
730 }
731}
732
Joe Perches85b0ee12016-10-11 13:51:44 -0700733sub is_maintained_obsolete {
734 my ($filename) = @_;
735
736 return 0 if (!(-e "$root/scripts/get_maintainer.pl"));
737
738 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback $filename 2>&1`;
739
740 return $status =~ /obsolete/i;
741}
742
Joe Perches34456862013-07-03 15:05:34 -0700743my $camelcase_seeded = 0;
744sub seed_camelcase_includes {
745 return if ($camelcase_seeded);
746
747 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700748 my $camelcase_cache = "";
749 my @include_files = ();
750
751 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700752
Richard Genoud3645e322014-02-10 14:25:32 -0800753 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700754 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
755 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700756 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700757 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700758 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700759 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700760 @include_files = split('\n', $files);
761 foreach my $file (@include_files) {
762 my $date = POSIX::strftime("%Y%m%d%H%M",
763 localtime((stat $file)[9]));
764 $last_mod_date = $date if ($last_mod_date < $date);
765 }
766 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700767 }
Joe Perchesc707a812013-07-08 16:00:43 -0700768
769 if ($camelcase_cache ne "" && -f $camelcase_cache) {
770 open(my $camelcase_file, '<', "$camelcase_cache")
771 or warn "$P: Can't read '$camelcase_cache' $!\n";
772 while (<$camelcase_file>) {
773 chomp;
774 $camelcase{$_} = 1;
775 }
776 close($camelcase_file);
777
778 return;
779 }
780
Richard Genoud3645e322014-02-10 14:25:32 -0800781 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700782 $files = `git ls-files "include/*.h"`;
783 @include_files = split('\n', $files);
784 }
785
Joe Perches34456862013-07-03 15:05:34 -0700786 foreach my $file (@include_files) {
787 seed_camelcase_file($file);
788 }
Joe Perches351b2a12013-07-03 15:05:36 -0700789
Joe Perchesc707a812013-07-08 16:00:43 -0700790 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700791 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700792 open(my $camelcase_file, '>', "$camelcase_cache")
793 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700794 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
795 print $camelcase_file ("$_\n");
796 }
797 close($camelcase_file);
798 }
Joe Perches34456862013-07-03 15:05:34 -0700799}
800
Joe Perchesd311cd42014-08-06 16:10:57 -0700801sub git_commit_info {
802 my ($commit, $id, $desc) = @_;
803
804 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
805
806 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
807 $output =~ s/^\s*//gm;
808 my @lines = split("\n", $output);
809
Joe Perches0d7835f2015-02-13 14:38:35 -0800810 return ($id, $desc) if ($#lines < 0);
811
Joe Perchesd311cd42014-08-06 16:10:57 -0700812 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
813# Maybe one day convert this block of bash into something that returns
814# all matching commit ids, but it's very slow...
815#
816# echo "checking commits $1..."
817# git rev-list --remotes | grep -i "^$1" |
818# while read line ; do
819# git log --format='%H %s' -1 $line |
820# echo "commit $(cut -c 1-12,41-)"
821# done
822 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
823 } else {
824 $id = substr($lines[0], 0, 12);
825 $desc = substr($lines[0], 41);
826 }
827
828 return ($id, $desc);
829}
830
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700831$chk_signoff = 0 if ($file);
832
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700833my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800834my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700835my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700836my @fixed_inserted = ();
837my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700838my $fixlinenr = -1;
839
Du, Changbin4a593c32016-05-20 17:04:16 -0700840# If input is git commits, extract all commits from the commit expressions.
841# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
842die "$P: No git repository found\n" if ($git && !-e ".git");
843
844if ($git) {
845 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700846 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700847 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700848 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
849 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700850 } elsif ($commit_expr =~ m/\.\./) {
851 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700852 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700853 $git_range = "-1 $commit_expr";
854 }
855 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
856 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700857 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
858 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700859 my $sha1 = $1;
860 my $subject = $2;
861 unshift(@commits, $sha1);
862 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700863 }
864 }
865 die "$P: no git commits after extraction!\n" if (@commits == 0);
866 @ARGV = @commits;
867}
868
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800869my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700870for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800871 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700872 if ($git) {
873 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
874 die "$P: $filename: git format-patch failed - $!\n";
875 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800876 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700877 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800878 } elsif ($filename eq '-') {
879 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700880 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800881 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700882 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700883 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800884 if ($filename eq '-') {
885 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700886 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700887 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800888 } else {
889 $vname = $filename;
890 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800891 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700892 chomp;
893 push(@rawlines, $_);
894 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800895 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700896
897 if ($#ARGV > 0 && $quiet == 0) {
898 print '-' x length($vname) . "\n";
899 print "$vname\n";
900 print '-' x length($vname) . "\n";
901 }
902
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800903 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700904 $exit = 1;
905 }
906 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800907 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700908 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700909 @fixed_inserted = ();
910 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700911 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700912 @modifierListFile = ();
913 @typeListFile = ();
914 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700915}
916
Joe Perchesd8469f12015-06-25 15:03:00 -0700917if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700918 hash_show_words(\%use_type, "Used");
919 hash_show_words(\%ignore_type, "Ignored");
920
Joe Perchesd8469f12015-06-25 15:03:00 -0700921 if ($^V lt 5.10.0) {
922 print << "EOM"
923
924NOTE: perl $^V is not modern enough to detect all possible issues.
925 An upgrade to at least perl v5.10.0 is suggested.
926EOM
927 }
928 if ($exit) {
929 print << "EOM"
930
931NOTE: If any of the errors are false positives, please report
932 them to the maintainer, see CHECKPATCH in MAINTAINERS.
933EOM
934 }
935}
936
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700937exit($exit);
938
939sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700940 my ($root) = @_;
941
942 my @tree_check = (
943 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
944 "README", "Documentation", "arch", "include", "drivers",
945 "fs", "init", "ipc", "kernel", "lib", "scripts",
946 );
947
948 foreach my $check (@tree_check) {
949 if (! -e $root . '/' . $check) {
950 return 0;
951 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700952 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700953 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700954}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700955
Joe Perches20112472011-07-25 17:13:23 -0700956sub parse_email {
957 my ($formatted_email) = @_;
958
959 my $name = "";
960 my $address = "";
961 my $comment = "";
962
963 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
964 $name = $1;
965 $address = $2;
966 $comment = $3 if defined $3;
967 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
968 $address = $1;
969 $comment = $2 if defined $2;
970 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
971 $address = $1;
972 $comment = $2 if defined $2;
973 $formatted_email =~ s/$address.*$//;
974 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700975 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700976 $name =~ s/^\"|\"$//g;
977 # If there's a name left after stripping spaces and
978 # leading quotes, and the address doesn't have both
979 # leading and trailing angle brackets, the address
980 # is invalid. ie:
981 # "joe smith joe@smith.com" bad
982 # "joe smith <joe@smith.com" bad
983 if ($name ne "" && $address !~ /^<[^>]+>$/) {
984 $name = "";
985 $address = "";
986 $comment = "";
987 }
988 }
989
Joe Perches3705ce52013-07-03 15:05:31 -0700990 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700991 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700992 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700993 $address =~ s/^\<|\>$//g;
994
995 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
996 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
997 $name = "\"$name\"";
998 }
999
1000 return ($name, $address, $comment);
1001}
1002
1003sub format_email {
1004 my ($name, $address) = @_;
1005
1006 my $formatted_email;
1007
Joe Perches3705ce52013-07-03 15:05:31 -07001008 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -07001009 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -07001010 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -07001011
1012 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
1013 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
1014 $name = "\"$name\"";
1015 }
1016
1017 if ("$name" eq "") {
1018 $formatted_email = "$address";
1019 } else {
1020 $formatted_email = "$name <$address>";
1021 }
1022
1023 return $formatted_email;
1024}
1025
Joe Perchesd311cd42014-08-06 16:10:57 -07001026sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001027 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001028
Joe Perchesbd474ca2014-08-06 16:11:10 -07001029 foreach my $path (split(/:/, $ENV{PATH})) {
1030 if (-e "$path/$bin") {
1031 return "$path/$bin";
1032 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001033 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001034
Joe Perchesbd474ca2014-08-06 16:11:10 -07001035 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001036}
1037
Joe Perches000d1cc12011-07-25 17:13:25 -07001038sub which_conf {
1039 my ($conf) = @_;
1040
1041 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1042 if (-e "$path/$conf") {
1043 return "$path/$conf";
1044 }
1045 }
1046
1047 return "";
1048}
1049
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001050sub expand_tabs {
1051 my ($str) = @_;
1052
1053 my $res = '';
1054 my $n = 0;
1055 for my $c (split(//, $str)) {
1056 if ($c eq "\t") {
1057 $res .= ' ';
1058 $n++;
1059 for (; ($n % 8) != 0; $n++) {
1060 $res .= ' ';
1061 }
1062 next;
1063 }
1064 $res .= $c;
1065 $n++;
1066 }
1067
1068 return $res;
1069}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001070sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001071 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001072 return $res;
1073}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001074
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001075sub line_stats {
1076 my ($line) = @_;
1077
1078 # Drop the diff line leader and expand tabs
1079 $line =~ s/^.//;
1080 $line = expand_tabs($line);
1081
1082 # Pick the indent from the front of the line.
1083 my ($white) = ($line =~ /^(\s*)/);
1084
1085 return (length($line), length($white));
1086}
1087
Andy Whitcroft773647a2008-03-28 14:15:58 -07001088my $sanitise_quote = '';
1089
1090sub sanitise_line_reset {
1091 my ($in_comment) = @_;
1092
1093 if ($in_comment) {
1094 $sanitise_quote = '*/';
1095 } else {
1096 $sanitise_quote = '';
1097 }
1098}
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001099sub sanitise_line {
1100 my ($line) = @_;
1101
1102 my $res = '';
1103 my $l = '';
1104
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001105 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001106 my $off = 0;
1107 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001108
Andy Whitcroft773647a2008-03-28 14:15:58 -07001109 # Always copy over the diff marker.
1110 $res = substr($line, 0, 1);
1111
1112 for ($off = 1; $off < length($line); $off++) {
1113 $c = substr($line, $off, 1);
1114
1115 # Comments we are wacking completly including the begin
1116 # and end, all to $;.
1117 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1118 $sanitise_quote = '*/';
1119
1120 substr($res, $off, 2, "$;$;");
1121 $off++;
1122 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001123 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001124 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001125 $sanitise_quote = '';
1126 substr($res, $off, 2, "$;$;");
1127 $off++;
1128 next;
1129 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001130 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1131 $sanitise_quote = '//';
1132
1133 substr($res, $off, 2, $sanitise_quote);
1134 $off++;
1135 next;
1136 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001137
1138 # A \ in a string means ignore the next character.
1139 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1140 $c eq "\\") {
1141 substr($res, $off, 2, 'XX');
1142 $off++;
1143 next;
1144 }
1145 # Regular quotes.
1146 if ($c eq "'" || $c eq '"') {
1147 if ($sanitise_quote eq '') {
1148 $sanitise_quote = $c;
1149
1150 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001151 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001152 } elsif ($sanitise_quote eq $c) {
1153 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001154 }
1155 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001156
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001157 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001158 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1159 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001160 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1161 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001162 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1163 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001164 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001165 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001166 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001167 }
1168
Daniel Walker113f04a2009-09-21 17:04:35 -07001169 if ($sanitise_quote eq '//') {
1170 $sanitise_quote = '';
1171 }
1172
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001173 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001174 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001175 my $clean = 'X' x length($1);
1176 $res =~ s@\<.*\>@<$clean>@;
1177
1178 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001179 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001180 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001181 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001182 }
1183
Joe Perchesdadf6802016-08-02 14:04:33 -07001184 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1185 my $match = $1;
1186 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1187 }
1188
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001189 return $res;
1190}
1191
Joe Perchesa6962d72013-04-29 16:18:13 -07001192sub get_quoted_string {
1193 my ($line, $rawline) = @_;
1194
Joe Perches33acb542015-06-25 15:02:54 -07001195 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001196 return substr($rawline, $-[0], $+[0] - $-[0]);
1197}
1198
Andy Whitcroft8905a672007-11-28 16:21:06 -08001199sub ctx_statement_block {
1200 my ($linenr, $remain, $off) = @_;
1201 my $line = $linenr - 1;
1202 my $blk = '';
1203 my $soff = $off;
1204 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001205 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001206
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001207 my $loff = 0;
1208
Andy Whitcroft8905a672007-11-28 16:21:06 -08001209 my $type = '';
1210 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001211 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001212 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001213 my $c;
1214 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001215
1216 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001217 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001218 @stack = (['', 0]) if ($#stack == -1);
1219
Andy Whitcroft773647a2008-03-28 14:15:58 -07001220 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001221 # If we are about to drop off the end, pull in more
1222 # context.
1223 if ($off >= $len) {
1224 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001225 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001226 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001227 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001228 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001229 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001230 $len = length($blk);
1231 $line++;
1232 last;
1233 }
1234 # Bail if there is no further context.
1235 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001236 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001237 last;
1238 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001239 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1240 $level++;
1241 $type = '#';
1242 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001243 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001244 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001245 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001246 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001247
Andy Whitcroft773647a2008-03-28 14:15:58 -07001248 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001249
1250 # Handle nested #if/#else.
1251 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1252 push(@stack, [ $type, $level ]);
1253 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1254 ($type, $level) = @{$stack[$#stack - 1]};
1255 } elsif ($remainder =~ /^#\s*endif\b/) {
1256 ($type, $level) = @{pop(@stack)};
1257 }
1258
Andy Whitcroft8905a672007-11-28 16:21:06 -08001259 # Statement ends at the ';' or a close '}' at the
1260 # outermost level.
1261 if ($level == 0 && $c eq ';') {
1262 last;
1263 }
1264
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001265 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001266 if ($level == 0 && $coff_set == 0 &&
1267 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1268 $remainder =~ /^(else)(?:\s|{)/ &&
1269 $remainder !~ /^else\s+if\b/) {
1270 $coff = $off + length($1) - 1;
1271 $coff_set = 1;
1272 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1273 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001274 }
1275
Andy Whitcroft8905a672007-11-28 16:21:06 -08001276 if (($type eq '' || $type eq '(') && $c eq '(') {
1277 $level++;
1278 $type = '(';
1279 }
1280 if ($type eq '(' && $c eq ')') {
1281 $level--;
1282 $type = ($level != 0)? '(' : '';
1283
1284 if ($level == 0 && $coff < $soff) {
1285 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001286 $coff_set = 1;
1287 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001288 }
1289 }
1290 if (($type eq '' || $type eq '{') && $c eq '{') {
1291 $level++;
1292 $type = '{';
1293 }
1294 if ($type eq '{' && $c eq '}') {
1295 $level--;
1296 $type = ($level != 0)? '{' : '';
1297
1298 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001299 if (substr($blk, $off + 1, 1) eq ';') {
1300 $off++;
1301 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001302 last;
1303 }
1304 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001305 # Preprocessor commands end at the newline unless escaped.
1306 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1307 $level--;
1308 $type = '';
1309 $off++;
1310 last;
1311 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001312 $off++;
1313 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001314 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001315 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001316 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001317 $line++;
1318 $remain--;
1319 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001320
1321 my $statement = substr($blk, $soff, $off - $soff + 1);
1322 my $condition = substr($blk, $soff, $coff - $soff + 1);
1323
1324 #warn "STATEMENT<$statement>\n";
1325 #warn "CONDITION<$condition>\n";
1326
Andy Whitcroft773647a2008-03-28 14:15:58 -07001327 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001328
1329 return ($statement, $condition,
1330 $line, $remain + 1, $off - $loff + 1, $level);
1331}
1332
Andy Whitcroftcf655042008-03-04 14:28:20 -08001333sub statement_lines {
1334 my ($stmt) = @_;
1335
1336 # Strip the diff line prefixes and rip blank lines at start and end.
1337 $stmt =~ s/(^|\n)./$1/g;
1338 $stmt =~ s/^\s*//;
1339 $stmt =~ s/\s*$//;
1340
1341 my @stmt_lines = ($stmt =~ /\n/g);
1342
1343 return $#stmt_lines + 2;
1344}
1345
1346sub statement_rawlines {
1347 my ($stmt) = @_;
1348
1349 my @stmt_lines = ($stmt =~ /\n/g);
1350
1351 return $#stmt_lines + 2;
1352}
1353
1354sub statement_block_size {
1355 my ($stmt) = @_;
1356
1357 $stmt =~ s/(^|\n)./$1/g;
1358 $stmt =~ s/^\s*{//;
1359 $stmt =~ s/}\s*$//;
1360 $stmt =~ s/^\s*//;
1361 $stmt =~ s/\s*$//;
1362
1363 my @stmt_lines = ($stmt =~ /\n/g);
1364 my @stmt_statements = ($stmt =~ /;/g);
1365
1366 my $stmt_lines = $#stmt_lines + 2;
1367 my $stmt_statements = $#stmt_statements + 1;
1368
1369 if ($stmt_lines > $stmt_statements) {
1370 return $stmt_lines;
1371 } else {
1372 return $stmt_statements;
1373 }
1374}
1375
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001376sub ctx_statement_full {
1377 my ($linenr, $remain, $off) = @_;
1378 my ($statement, $condition, $level);
1379
1380 my (@chunks);
1381
Andy Whitcroftcf655042008-03-04 14:28:20 -08001382 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001383 ($statement, $condition, $linenr, $remain, $off, $level) =
1384 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001385 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001386 push(@chunks, [ $condition, $statement ]);
1387 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1388 return ($level, $linenr, @chunks);
1389 }
1390
1391 # Pull in the following conditional/block pairs and see if they
1392 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001393 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001394 ($statement, $condition, $linenr, $remain, $off, $level) =
1395 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001396 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001397 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001398 #print "C: push\n";
1399 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001400 }
1401
1402 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001403}
1404
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001405sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001406 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001407 my $line;
1408 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001409 my $blk = '';
1410 my @o;
1411 my @c;
1412 my @res = ();
1413
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001414 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001415 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001416 for ($line = $start; $remain > 0; $line++) {
1417 next if ($rawlines[$line] =~ /^-/);
1418 $remain--;
1419
1420 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001421
1422 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001423 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001424 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001425 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001426 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001427 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001428 $level = pop(@stack);
1429 }
1430
Andy Whitcroft01464f32010-10-26 14:23:19 -07001431 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001432 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1433 if ($off > 0) {
1434 $off--;
1435 next;
1436 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001437
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001438 if ($c eq $close && $level > 0) {
1439 $level--;
1440 last if ($level == 0);
1441 } elsif ($c eq $open) {
1442 $level++;
1443 }
1444 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001445
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001446 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001447 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001448 }
1449
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001450 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001451 }
1452
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001453 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001454}
1455sub ctx_block_outer {
1456 my ($linenr, $remain) = @_;
1457
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001458 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1459 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001460}
1461sub ctx_block {
1462 my ($linenr, $remain) = @_;
1463
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001464 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1465 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001466}
1467sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001468 my ($linenr, $remain, $off) = @_;
1469
1470 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1471 return @r;
1472}
1473sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001474 my ($linenr, $remain) = @_;
1475
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001476 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001477}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001478sub ctx_statement_level {
1479 my ($linenr, $remain, $off) = @_;
1480
1481 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1482}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001483
1484sub ctx_locate_comment {
1485 my ($first_line, $end_line) = @_;
1486
1487 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001488 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001489 return $current_comment if (defined $current_comment);
1490
1491 # Look through the context and try and figure out if there is a
1492 # comment.
1493 my $in_comment = 0;
1494 $current_comment = '';
1495 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001496 my $line = $rawlines[$linenr - 1];
1497 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001498 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1499 $in_comment = 1;
1500 }
1501 if ($line =~ m@/\*@) {
1502 $in_comment = 1;
1503 }
1504 if (!$in_comment && $current_comment ne '') {
1505 $current_comment = '';
1506 }
1507 $current_comment .= $line . "\n" if ($in_comment);
1508 if ($line =~ m@\*/@) {
1509 $in_comment = 0;
1510 }
1511 }
1512
1513 chomp($current_comment);
1514 return($current_comment);
1515}
1516sub ctx_has_comment {
1517 my ($first_line, $end_line) = @_;
1518 my $cmt = ctx_locate_comment($first_line, $end_line);
1519
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001520 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001521 ##print "CMMT: $cmt\n";
1522
1523 return ($cmt ne '');
1524}
1525
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001526sub raw_line {
1527 my ($linenr, $cnt) = @_;
1528
1529 my $offset = $linenr - 1;
1530 $cnt++;
1531
1532 my $line;
1533 while ($cnt) {
1534 $line = $rawlines[$offset++];
1535 next if (defined($line) && $line =~ /^-/);
1536 $cnt--;
1537 }
1538
1539 return $line;
1540}
1541
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001542sub cat_vet {
1543 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001544 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001545
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001546 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001547 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1548 $res .= $1;
1549 if ($2 ne '') {
1550 $coded = sprintf("^%c", unpack('C', $2) + 64);
1551 $res .= $coded;
1552 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001553 }
1554 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001555
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001556 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001557}
1558
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001559my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001560my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001561my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001562my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001563
1564sub annotate_reset {
1565 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001566 $av_pending = '_';
1567 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001568 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001569}
1570
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001571sub annotate_values {
1572 my ($stream, $type) = @_;
1573
1574 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001575 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001576 my $cur = $stream;
1577
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001578 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001579
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001580 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001581 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001582 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001583 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001584 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001585 print "WS($1)\n" if ($dbg_values > 1);
1586 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001587 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001588 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001589 }
1590
Florian Micklerc023e4732011-01-12 16:59:58 -08001591 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001592 print "CAST($1)\n" if ($dbg_values > 1);
1593 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001594 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001595
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001596 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001597 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001598 $type = 'T';
1599
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001600 } elsif ($cur =~ /^($Modifier)\s*/) {
1601 print "MODIFIER($1)\n" if ($dbg_values > 1);
1602 $type = 'T';
1603
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001604 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001605 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001606 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001607 push(@av_paren_type, $type);
1608 if ($2 ne '') {
1609 $av_pending = 'N';
1610 }
1611 $type = 'E';
1612
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001613 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001614 print "UNDEF($1)\n" if ($dbg_values > 1);
1615 $av_preprocessor = 1;
1616 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001617
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001618 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001619 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001620 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001621
1622 push(@av_paren_type, $type);
1623 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001624 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001625
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001626 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001627 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1628 $av_preprocessor = 1;
1629
1630 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1631
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001632 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001633
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001634 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001635 print "PRE_END($1)\n" if ($dbg_values > 1);
1636
1637 $av_preprocessor = 1;
1638
1639 # Assume all arms of the conditional end as this
1640 # one does, and continue as if the #endif was not here.
1641 pop(@av_paren_type);
1642 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001643 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001644
1645 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001646 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001647
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001648 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1649 print "ATTR($1)\n" if ($dbg_values > 1);
1650 $av_pending = $type;
1651 $type = 'N';
1652
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001653 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001654 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001655 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001656 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001657 }
1658 $type = 'N';
1659
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001660 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001661 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001662 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001663 $type = 'N';
1664
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001665 } elsif ($cur =~/^(case)/o) {
1666 print "CASE($1)\n" if ($dbg_values > 1);
1667 $av_pend_colon = 'C';
1668 $type = 'N';
1669
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001670 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001671 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001672 $type = 'N';
1673
1674 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001675 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001676 push(@av_paren_type, $av_pending);
1677 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001678 $type = 'N';
1679
1680 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001681 my $new_type = pop(@av_paren_type);
1682 if ($new_type ne '_') {
1683 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001684 print "PAREN('$1') -> $type\n"
1685 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001686 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001687 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001688 }
1689
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001690 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001691 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001692 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001693 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001694
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001695 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1696 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001697 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001698 } elsif ($type eq 'E') {
1699 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001700 }
1701 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1702 $type = 'V';
1703
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001704 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001705 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001706 $type = 'V';
1707
1708 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001709 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001710 $type = 'N';
1711
Andy Whitcroftcf655042008-03-04 14:28:20 -08001712 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001713 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001714 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001715 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001716
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001717 } elsif ($cur =~/^(,)/) {
1718 print "COMMA($1)\n" if ($dbg_values > 1);
1719 $type = 'C';
1720
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001721 } elsif ($cur =~ /^(\?)/o) {
1722 print "QUESTION($1)\n" if ($dbg_values > 1);
1723 $type = 'N';
1724
1725 } elsif ($cur =~ /^(:)/o) {
1726 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1727
1728 substr($var, length($res), 1, $av_pend_colon);
1729 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1730 $type = 'E';
1731 } else {
1732 $type = 'N';
1733 }
1734 $av_pend_colon = 'O';
1735
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001736 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001737 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001738 $type = 'N';
1739
Andy Whitcroft0d413862008-10-15 22:02:16 -07001740 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001741 my $variant;
1742
1743 print "OPV($1)\n" if ($dbg_values > 1);
1744 if ($type eq 'V') {
1745 $variant = 'B';
1746 } else {
1747 $variant = 'U';
1748 }
1749
1750 substr($var, length($res), 1, $variant);
1751 $type = 'N';
1752
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001753 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001754 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001755 if ($1 ne '++' && $1 ne '--') {
1756 $type = 'N';
1757 }
1758
1759 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001760 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761 }
1762 if (defined $1) {
1763 $cur = substr($cur, length($1));
1764 $res .= $type x length($1);
1765 }
1766 }
1767
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001768 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001769}
1770
Andy Whitcroft8905a672007-11-28 16:21:06 -08001771sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001772 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001773 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001774 ^(?:
1775 $Modifier|
1776 $Storage|
1777 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001778 DEFINE_\S+
1779 )$|
1780 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001781 goto|
1782 return|
1783 case|
1784 else|
1785 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001786 do|
1787 \#|
1788 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001789 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001790 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001791 )}x;
1792 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1793 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001794 # Check for modifiers.
1795 $possible =~ s/\s*$Storage\s*//g;
1796 $possible =~ s/\s*$Sparse\s*//g;
1797 if ($possible =~ /^\s*$/) {
1798
1799 } elsif ($possible =~ /\s/) {
1800 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001801 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001802 if ($modifier !~ $notPermitted) {
1803 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001804 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001805 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001806 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001807
1808 } else {
1809 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001810 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001811 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001812 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001813 } else {
1814 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001815 }
1816}
1817
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001818my $prefix = '';
1819
Joe Perches000d1cc12011-07-25 17:13:25 -07001820sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001821 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001822
Joe Perchescbec18a2014-04-03 14:49:19 -07001823 return defined $use_type{$type} if (scalar keys %use_type > 0);
1824
1825 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001826}
1827
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001828sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001829 my ($level, $type, $msg) = @_;
1830
1831 if (!show_type($type) ||
1832 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001833 return 0;
1834 }
Joe Perches57230292015-06-25 15:03:03 -07001835 my $output = '';
1836 if (-t STDOUT && $color) {
1837 if ($level eq 'ERROR') {
1838 $output .= RED;
1839 } elsif ($level eq 'WARNING') {
1840 $output .= YELLOW;
1841 } else {
1842 $output .= GREEN;
1843 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001844 }
Joe Perches57230292015-06-25 15:03:03 -07001845 $output .= $prefix . $level . ':';
1846 if ($show_types) {
1847 $output .= BLUE if (-t STDOUT && $color);
1848 $output .= "$type:";
1849 }
1850 $output .= RESET if (-t STDOUT && $color);
1851 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001852
1853 if ($showfile) {
1854 my @lines = split("\n", $output, -1);
1855 splice(@lines, 1, 1);
1856 $output = join("\n", @lines);
1857 }
Joe Perches57230292015-06-25 15:03:03 -07001858 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001859
Joe Perches57230292015-06-25 15:03:03 -07001860 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001861
1862 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001863}
Joe Perchescbec18a2014-04-03 14:49:19 -07001864
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001865sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001866 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001867}
Joe Perches000d1cc12011-07-25 17:13:25 -07001868
Joe Perchesd752fcc2014-08-06 16:11:05 -07001869sub fixup_current_range {
1870 my ($lineRef, $offset, $length) = @_;
1871
1872 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1873 my $o = $1;
1874 my $l = $2;
1875 my $no = $o + $offset;
1876 my $nl = $l + $length;
1877 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1878 }
1879}
1880
1881sub fix_inserted_deleted_lines {
1882 my ($linesRef, $insertedRef, $deletedRef) = @_;
1883
1884 my $range_last_linenr = 0;
1885 my $delta_offset = 0;
1886
1887 my $old_linenr = 0;
1888 my $new_linenr = 0;
1889
1890 my $next_insert = 0;
1891 my $next_delete = 0;
1892
1893 my @lines = ();
1894
1895 my $inserted = @{$insertedRef}[$next_insert++];
1896 my $deleted = @{$deletedRef}[$next_delete++];
1897
1898 foreach my $old_line (@{$linesRef}) {
1899 my $save_line = 1;
1900 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001901 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001902 $delta_offset = 0;
1903 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1904 $range_last_linenr = $new_linenr;
1905 fixup_current_range(\$line, $delta_offset, 0);
1906 }
1907
1908 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1909 $deleted = @{$deletedRef}[$next_delete++];
1910 $save_line = 0;
1911 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1912 }
1913
1914 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1915 push(@lines, ${$inserted}{'LINE'});
1916 $inserted = @{$insertedRef}[$next_insert++];
1917 $new_linenr++;
1918 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1919 }
1920
1921 if ($save_line) {
1922 push(@lines, $line);
1923 $new_linenr++;
1924 }
1925
1926 $old_linenr++;
1927 }
1928
1929 return @lines;
1930}
1931
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001932sub fix_insert_line {
1933 my ($linenr, $line) = @_;
1934
1935 my $inserted = {
1936 LINENR => $linenr,
1937 LINE => $line,
1938 };
1939 push(@fixed_inserted, $inserted);
1940}
1941
1942sub fix_delete_line {
1943 my ($linenr, $line) = @_;
1944
1945 my $deleted = {
1946 LINENR => $linenr,
1947 LINE => $line,
1948 };
1949
1950 push(@fixed_deleted, $deleted);
1951}
1952
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001953sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001954 my ($type, $msg) = @_;
1955
1956 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001957 our $clean = 0;
1958 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001959 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001960 }
Joe Perches3705ce52013-07-03 15:05:31 -07001961 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001962}
1963sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001964 my ($type, $msg) = @_;
1965
1966 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001967 our $clean = 0;
1968 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001969 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001970 }
Joe Perches3705ce52013-07-03 15:05:31 -07001971 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001972}
1973sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001974 my ($type, $msg) = @_;
1975
1976 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001977 our $clean = 0;
1978 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001979 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001980 }
Joe Perches3705ce52013-07-03 15:05:31 -07001981 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001982}
1983
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001984sub check_absolute_file {
1985 my ($absolute, $herecurr) = @_;
1986 my $file = $absolute;
1987
1988 ##print "absolute<$absolute>\n";
1989
1990 # See if any suffix of this path is a path within the tree.
1991 while ($file =~ s@^[^/]*/@@) {
1992 if (-f "$root/$file") {
1993 ##print "file<$file>\n";
1994 last;
1995 }
1996 }
1997 if (! -f _) {
1998 return 0;
1999 }
2000
2001 # It is, so see if the prefix is acceptable.
2002 my $prefix = $absolute;
2003 substr($prefix, -length($file)) = '';
2004
2005 ##print "prefix<$prefix>\n";
2006 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002007 WARN("USE_RELATIVE_PATH",
2008 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002009 }
2010}
2011
Joe Perches3705ce52013-07-03 15:05:31 -07002012sub trim {
2013 my ($string) = @_;
2014
Joe Perchesb34c6482013-09-11 14:24:01 -07002015 $string =~ s/^\s+|\s+$//g;
2016
2017 return $string;
2018}
2019
2020sub ltrim {
2021 my ($string) = @_;
2022
2023 $string =~ s/^\s+//;
2024
2025 return $string;
2026}
2027
2028sub rtrim {
2029 my ($string) = @_;
2030
2031 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002032
2033 return $string;
2034}
2035
Joe Perches52ea8502013-11-12 15:10:09 -08002036sub string_find_replace {
2037 my ($string, $find, $replace) = @_;
2038
2039 $string =~ s/$find/$replace/g;
2040
2041 return $string;
2042}
2043
Joe Perches3705ce52013-07-03 15:05:31 -07002044sub tabify {
2045 my ($leading) = @_;
2046
2047 my $source_indent = 8;
2048 my $max_spaces_before_tab = $source_indent - 1;
2049 my $spaces_to_tab = " " x $source_indent;
2050
2051 #convert leading spaces to tabs
2052 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2053 #Remove spaces before a tab
2054 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2055
2056 return "$leading";
2057}
2058
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002059sub pos_last_openparen {
2060 my ($line) = @_;
2061
2062 my $pos = 0;
2063
2064 my $opens = $line =~ tr/\(/\(/;
2065 my $closes = $line =~ tr/\)/\)/;
2066
2067 my $last_openparen = 0;
2068
2069 if (($opens == 0) || ($closes >= $opens)) {
2070 return -1;
2071 }
2072
2073 my $len = length($line);
2074
2075 for ($pos = 0; $pos < $len; $pos++) {
2076 my $string = substr($line, $pos);
2077 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2078 $pos += length($1) - 1;
2079 } elsif (substr($line, $pos, 1) eq '(') {
2080 $last_openparen = $pos;
2081 } elsif (index($string, '(') == -1) {
2082 last;
2083 }
2084 }
2085
Joe Perches91cb5192014-04-03 14:49:32 -07002086 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002087}
2088
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002089sub process {
2090 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002091
2092 my $linenr=0;
2093 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002094 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002095 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002096 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002097
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002098 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002099 my $indent;
2100 my $previndent=0;
2101 my $stashindent=0;
2102
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002103 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002104 my $signoff = 0;
2105 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002106 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002107 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002108 my $has_commit_log = 0; #Encountered lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002109 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002110 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002111 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002112 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002113 my $non_utf8_charset = 0;
2114
Joe Perches365dd4e2014-08-06 16:10:42 -07002115 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002116 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002117
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002118 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002119 our $cnt_lines = 0;
2120 our $cnt_error = 0;
2121 our $cnt_warn = 0;
2122 our $cnt_chk = 0;
2123
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002124 # Trace the real file/line as we go.
2125 my $realfile = '';
2126 my $realline = 0;
2127 my $realcnt = 0;
2128 my $here = '';
2129 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002130 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002131 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002132 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002133
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002134 my $prev_values = 'E';
2135
2136 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002137 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002138 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002139 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002140 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002141
Joe Perches7e51f192013-09-11 14:23:57 -07002142 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002143
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002144 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002145 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002146 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002147 my @setup_docs = ();
2148 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002149
Joe Perchesd8b07712013-11-12 15:10:06 -08002150 my $camelcase_file_seeded = 0;
2151
Andy Whitcroft773647a2008-03-28 14:15:58 -07002152 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002153 my $line;
2154 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002155 $linenr++;
2156 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002157
Joe Perches3705ce52013-07-03 15:05:31 -07002158 push(@fixed, $rawline) if ($fix);
2159
Andy Whitcroft773647a2008-03-28 14:15:58 -07002160 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002161 $setup_docs = 0;
2162 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2163 $setup_docs = 1;
2164 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002165 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002166 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002167 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2168 $realline=$1-1;
2169 if (defined $2) {
2170 $realcnt=$3+1;
2171 } else {
2172 $realcnt=1+1;
2173 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002174 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002175
2176 # Guestimate if this is a continuing comment. Run
2177 # the context looking for a comment "edge". If this
2178 # edge is a close comment then we must be in a comment
2179 # at context start.
2180 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002181 my $cnt = $realcnt;
2182 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2183 next if (defined $rawlines[$ln - 1] &&
2184 $rawlines[$ln - 1] =~ /^-/);
2185 $cnt--;
2186 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002187 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002188 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2189 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2190 ($edge) = $1;
2191 last;
2192 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002193 }
2194 if (defined $edge && $edge eq '*/') {
2195 $in_comment = 1;
2196 }
2197
2198 # Guestimate if this is a continuing comment. If this
2199 # is the start of a diff block and this line starts
2200 # ' *' then it is very likely a comment.
2201 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002202 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002203 {
2204 $in_comment = 1;
2205 }
2206
2207 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2208 sanitise_line_reset($in_comment);
2209
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002210 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002211 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002212 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002213 $line = sanitise_line($rawline);
2214 }
2215 push(@lines, $line);
2216
2217 if ($realcnt > 1) {
2218 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2219 } else {
2220 $realcnt = 0;
2221 }
2222
2223 #print "==>$rawline\n";
2224 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002225
2226 if ($setup_docs && $line =~ /^\+/) {
2227 push(@setup_docs, $line);
2228 }
2229 }
2230
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002231 $prefix = '';
2232
Andy Whitcroft773647a2008-03-28 14:15:58 -07002233 $realcnt = 0;
2234 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002235 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002236 foreach my $line (@lines) {
2237 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002238 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002239 my $sline = $line; #copy of $line
2240 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002241
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002242 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002243
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002244#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002245 if (!$in_commit_log &&
2246 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002247 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002248 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002249 $realline=$1-1;
2250 if (defined $2) {
2251 $realcnt=$3+1;
2252 } else {
2253 $realcnt=1+1;
2254 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002255 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002256 $prev_values = 'E';
2257
Andy Whitcroft773647a2008-03-28 14:15:58 -07002258 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002259 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002260 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002261 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002262 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002263
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002264# track the line number as we move through the hunk, note that
2265# new versions of GNU diff omit the leading space on completely
2266# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002267 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002268 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002269 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002270
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002271 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002272 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002273
2274 # Track the previous line.
2275 ($prevline, $stashline) = ($stashline, $line);
2276 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002277 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2278
Andy Whitcroft773647a2008-03-28 14:15:58 -07002279 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002280
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002281 } elsif ($realcnt == 1) {
2282 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002283 }
2284
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002285 my $hunk_line = ($realcnt != 0);
2286
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002287 $here = "#$linenr: " if (!$file);
2288 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002289
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002290 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002291 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002292 if ($line =~ /^diff --git.*?(\S+)$/) {
2293 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002294 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002295 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002296 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002297 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002298 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002299 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002300 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002301
2302 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002303 if (!$file && $tree && $p1_prefix ne '' &&
2304 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002305 WARN("PATCH_PREFIX",
2306 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002307 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002308
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002309 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002310 ERROR("MODIFIED_INCLUDE_ASM",
2311 "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 -07002312 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002313 $found_file = 1;
2314 }
2315
Joe Perches34d88152015-06-25 15:03:05 -07002316#make up the handle for any error we report on this line
2317 if ($showfile) {
2318 $prefix = "$realfile:$realline: "
2319 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002320 if ($file) {
2321 $prefix = "$filename:$realline: ";
2322 } else {
2323 $prefix = "$filename:$linenr: ";
2324 }
Joe Perches34d88152015-06-25 15:03:05 -07002325 }
2326
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002327 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002328 if (is_maintained_obsolete($realfile)) {
2329 WARN("OBSOLETE",
2330 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2331 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002332 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002333 $check = 1;
2334 } else {
2335 $check = $check_orig;
2336 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002337 next;
2338 }
2339
Randy Dunlap389834b2007-06-08 13:47:03 -07002340 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002341
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002342 my $hereline = "$here\n$rawline\n";
2343 my $herecurr = "$here\n$rawline\n";
2344 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002345
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002346 $cnt_lines++ if ($realcnt != 0);
2347
Joe Perchese518e9a2015-06-25 15:03:27 -07002348# Check if the commit log has what seems like a diff which can confuse patch
2349 if ($in_commit_log && !$commit_log_has_diff &&
2350 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2351 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2352 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2353 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2354 ERROR("DIFF_IN_COMMIT_MSG",
2355 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2356 $commit_log_has_diff = 1;
2357 }
2358
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002359# Check for incorrect file permissions
2360 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2361 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002362 if ($realfile !~ m@scripts/@ &&
2363 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002364 ERROR("EXECUTE_PERMISSIONS",
2365 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002366 }
2367 }
2368
Joe Perches20112472011-07-25 17:13:23 -07002369# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002370 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002371 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002372 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002373 }
2374
Joe Perchese0d975b2014-12-10 15:51:49 -08002375# Check if MAINTAINERS is being updated. If so, there's probably no need to
2376# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2377 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2378 $reported_maintainer_file = 1;
2379 }
2380
Joe Perches20112472011-07-25 17:13:23 -07002381# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002382 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002383 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002384 my $space_before = $1;
2385 my $sign_off = $2;
2386 my $space_after = $3;
2387 my $email = $4;
2388 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2389
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002390 if ($sign_off !~ /$signature_tags/) {
2391 WARN("BAD_SIGN_OFF",
2392 "Non-standard signature: $sign_off\n" . $herecurr);
2393 }
Joe Perches20112472011-07-25 17:13:23 -07002394 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002395 if (WARN("BAD_SIGN_OFF",
2396 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2397 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002398 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002399 "$ucfirst_sign_off $email";
2400 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002401 }
Joe Perches20112472011-07-25 17:13:23 -07002402 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002403 if (WARN("BAD_SIGN_OFF",
2404 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2405 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002406 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002407 "$ucfirst_sign_off $email";
2408 }
2409
Joe Perches20112472011-07-25 17:13:23 -07002410 }
2411 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002412 if (WARN("BAD_SIGN_OFF",
2413 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2414 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002415 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002416 "$ucfirst_sign_off $email";
2417 }
Joe Perches20112472011-07-25 17:13:23 -07002418 }
2419
2420 my ($email_name, $email_address, $comment) = parse_email($email);
2421 my $suggested_email = format_email(($email_name, $email_address));
2422 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002423 ERROR("BAD_SIGN_OFF",
2424 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002425 } else {
2426 my $dequoted = $suggested_email;
2427 $dequoted =~ s/^"//;
2428 $dequoted =~ s/" </ </;
2429 # Don't force email to have quotes
2430 # Allow just an angle bracketed address
2431 if ("$dequoted$comment" ne $email &&
2432 "<$email_address>$comment" ne $email &&
2433 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002434 WARN("BAD_SIGN_OFF",
2435 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002436 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002437 }
Joe Perches7e51f192013-09-11 14:23:57 -07002438
2439# Check for duplicate signatures
2440 my $sig_nospace = $line;
2441 $sig_nospace =~ s/\s//g;
2442 $sig_nospace = lc($sig_nospace);
2443 if (defined $signatures{$sig_nospace}) {
2444 WARN("BAD_SIGN_OFF",
2445 "Duplicate signature\n" . $herecurr);
2446 } else {
2447 $signatures{$sig_nospace} = 1;
2448 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002449 }
2450
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002451# Check email subject for common tools that don't need to be mentioned
2452 if ($in_header_lines &&
2453 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2454 WARN("EMAIL_SUBJECT",
2455 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2456 }
2457
Joe Perches9b3189eb2014-06-04 16:12:10 -07002458# Check for old stable address
2459 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2460 ERROR("STABLE_ADDRESS",
2461 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2462 }
2463
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002464# Check for unwanted Gerrit info
2465 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2466 ERROR("GERRIT_CHANGE_ID",
2467 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2468 }
2469
Joe Perches369c8dd2015-11-06 16:31:34 -08002470# Check if the commit log is in a possible stack dump
2471 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2472 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2473 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2474 # timestamp
2475 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2476 # stack dump address
2477 $commit_log_possible_stack_dump = 1;
2478 }
2479
Joe Perches2a076f42015-04-16 12:44:28 -07002480# Check for line lengths > 75 in commit log, warn once
2481 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002482 length($line) > 75 &&
2483 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2484 # file delta changes
2485 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2486 # filename then :
2487 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2488 # A Fixes: or Link: line
2489 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002490 WARN("COMMIT_LOG_LONG_LINE",
2491 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2492 $commit_log_long_line = 1;
2493 }
2494
Joe Perchesbf4daf12015-09-09 15:37:50 -07002495# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002496 if ($in_commit_log && $commit_log_possible_stack_dump &&
2497 $line =~ /^\s*$/) {
2498 $commit_log_possible_stack_dump = 0;
2499 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002500
Joe Perches0d7835f2015-02-13 14:38:35 -08002501# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002502 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002503 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002504 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002505 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002506 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2507 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002508 my $init_char = "c";
2509 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002510 my $short = 1;
2511 my $long = 0;
2512 my $case = 1;
2513 my $space = 1;
2514 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002515 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002516 my $id = '0123456789ab';
2517 my $orig_desc = "commit description";
2518 my $description = "";
2519
Joe Perchesfe043ea2015-09-09 15:37:25 -07002520 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2521 $init_char = $1;
2522 $orig_commit = lc($2);
2523 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2524 $orig_commit = lc($1);
2525 }
2526
Joe Perches0d7835f2015-02-13 14:38:35 -08002527 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2528 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2529 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2530 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2531 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2532 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002533 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002534 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2535 defined $rawlines[$linenr] &&
2536 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2537 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002538 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002539 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2540 defined $rawlines[$linenr] &&
2541 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2542 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2543 $orig_desc = $1;
2544 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2545 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002546 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002547 }
2548
2549 ($id, $description) = git_commit_info($orig_commit,
2550 $id, $orig_desc);
2551
Joe Perches19c146a2015-02-13 14:39:00 -08002552 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002553 ERROR("GIT_COMMIT_ID",
2554 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2555 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002556 }
2557
Joe Perches13f19372014-08-06 16:10:59 -07002558# Check for added, moved or deleted files
2559 if (!$reported_maintainer_file && !$in_commit_log &&
2560 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2561 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2562 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2563 (defined($1) || defined($2))))) {
2564 $reported_maintainer_file = 1;
2565 WARN("FILE_PATH_CHANGES",
2566 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2567 }
2568
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002569# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002570 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002571 ERROR("CORRUPTED_PATCH",
2572 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002573 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002574 }
2575
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002576# Check for absolute kernel paths.
2577 if ($tree) {
2578 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2579 my $file = $1;
2580
2581 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2582 check_absolute_file($1, $herecurr)) {
2583 #
2584 } else {
2585 check_absolute_file($file, $herecurr);
2586 }
2587 }
2588 }
2589
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002590# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2591 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002592 $rawline !~ m/^$UTF8*$/) {
2593 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2594
2595 my $blank = copy_spacing($rawline);
2596 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2597 my $hereptr = "$hereline$ptr\n";
2598
Joe Perches34d99212011-07-25 17:13:26 -07002599 CHK("INVALID_UTF8",
2600 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002601 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002602
Joe Perches15662b32011-10-31 17:13:12 -07002603# Check if it's the start of a commit log
2604# (not a header line and we haven't seen the patch filename)
2605 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002606 !($rawline =~ /^\s+\S/ ||
2607 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002608 $in_header_lines = 0;
2609 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002610 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002611 }
2612
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002613# Check if there is UTF-8 in a commit log when a mail header has explicitly
2614# declined it, i.e defined some charset where it is missing.
2615 if ($in_header_lines &&
2616 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2617 $1 !~ /utf-8/i) {
2618 $non_utf8_charset = 1;
2619 }
2620
2621 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002622 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002623 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002624 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2625 }
2626
Kees Cook66b47b42014-10-13 15:51:57 -07002627# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002628 if (defined($misspellings) &&
2629 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002630 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002631 my $typo = $1;
2632 my $typo_fix = $spelling_fix{lc($typo)};
2633 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2634 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2635 my $msg_type = \&WARN;
2636 $msg_type = \&CHK if ($file);
2637 if (&{$msg_type}("TYPO_SPELLING",
2638 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2639 $fix) {
2640 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2641 }
2642 }
2643 }
2644
Andy Whitcroft306708542008-10-15 22:02:28 -07002645# ignore non-hunk lines and lines being removed
2646 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002647
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002648#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002649 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002650 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002651 if (ERROR("DOS_LINE_ENDINGS",
2652 "DOS line endings\n" . $herevet) &&
2653 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002654 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002655 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002656 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2657 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002658 if (ERROR("TRAILING_WHITESPACE",
2659 "trailing whitespace\n" . $herevet) &&
2660 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002661 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002662 }
2663
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002664 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002665 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002666
Josh Triplett4783f892013-11-12 15:10:12 -08002667# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08002668 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002669 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2670 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002671 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2672 my $msg_type = \&ERROR;
2673 $msg_type = \&CHK if ($file);
2674 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002675 "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 -08002676 }
2677
Andi Kleen33549572010-05-24 14:33:29 -07002678# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002679# Only applies when adding the entry originally, after that we do not have
2680# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002681 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002682 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002683 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002684 my $cnt = $realcnt;
2685 my $ln = $linenr + 1;
2686 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002687 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002688 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002689 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002690 $f = $lines[$ln - 1];
2691 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2692 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002693
2694 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002695 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002696
Joe Perches8d73e0e2014-08-06 16:10:46 -07002697 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002698 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002699 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002700 $length = -1;
2701 }
2702
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002703 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002704 $f =~ s/#.*//;
2705 $f =~ s/^\s+//;
2706 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002707 if ($f =~ /^\s*config\s/) {
2708 $is_end = 1;
2709 last;
2710 }
Andi Kleen33549572010-05-24 14:33:29 -07002711 $length++;
2712 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002713 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2714 WARN("CONFIG_DESCRIPTION",
2715 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2716 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002717 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002718 }
2719
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002720# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2721 if ($realfile =~ /Kconfig/ &&
2722 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2723 WARN("CONFIG_EXPERIMENTAL",
2724 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2725 }
2726
Christoph Jaeger327953e2015-02-13 14:38:29 -08002727# discourage the use of boolean for type definition attributes of Kconfig options
2728 if ($realfile =~ /Kconfig/ &&
2729 $line =~ /^\+\s*\bboolean\b/) {
2730 WARN("CONFIG_TYPE_BOOLEAN",
2731 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2732 }
2733
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002734 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2735 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2736 my $flag = $1;
2737 my $replacement = {
2738 'EXTRA_AFLAGS' => 'asflags-y',
2739 'EXTRA_CFLAGS' => 'ccflags-y',
2740 'EXTRA_CPPFLAGS' => 'cppflags-y',
2741 'EXTRA_LDFLAGS' => 'ldflags-y',
2742 };
2743
2744 WARN("DEPRECATED_VARIABLE",
2745 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2746 }
2747
Rob Herringbff5da42014-01-23 15:54:51 -08002748# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002749 if (defined $root &&
2750 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2751 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2752
Rob Herringbff5da42014-01-23 15:54:51 -08002753 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2754
Florian Vaussardcc933192014-04-03 14:49:27 -07002755 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2756 my $vp_file = $dt_path . "vendor-prefixes.txt";
2757
Rob Herringbff5da42014-01-23 15:54:51 -08002758 foreach my $compat (@compats) {
2759 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002760 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2761 my $compat3 = $compat;
2762 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2763 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002764 if ( $? >> 8 ) {
2765 WARN("UNDOCUMENTED_DT_STRING",
2766 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2767 }
2768
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002769 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2770 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002771 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002772 if ( $? >> 8 ) {
2773 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002774 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002775 }
2776 }
2777 }
2778
Andy Whitcroft5368df202008-10-15 22:02:27 -07002779# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002780 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002781
Joe Perches47e0c882015-06-25 15:02:57 -07002782# line length limit (with some exclusions)
2783#
2784# There are a few types of lines that may extend beyond $max_line_length:
2785# logging functions like pr_info that end in a string
2786# lines with a single string
2787# #defines that are a single string
2788#
2789# There are 3 different line length message types:
2790# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2791# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2792# LONG_LINE all other lines longer than $max_line_length
2793#
2794# if LONG_LINE is ignored, the other 2 types are also ignored
2795#
2796
Joe Perchesb4749e92015-07-17 16:24:01 -07002797 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002798 my $msg_type = "LONG_LINE";
2799
2800 # Check the allowed long line types first
2801
2802 # logging functions that end in a string that starts
2803 # before $max_line_length
2804 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2805 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2806 $msg_type = "";
2807
2808 # lines with only strings (w/ possible termination)
2809 # #defines with only strings
2810 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2811 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2812 $msg_type = "";
2813
Joe Perchesd560a5f2016-08-02 14:04:31 -07002814 # EFI_GUID is another special case
2815 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2816 $msg_type = "";
2817
Joe Perches47e0c882015-06-25 15:02:57 -07002818 # Otherwise set the alternate message types
2819
2820 # a comment starts before $max_line_length
2821 } elsif ($line =~ /($;[\s$;]*)$/ &&
2822 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2823 $msg_type = "LONG_LINE_COMMENT"
2824
2825 # a quoted string starts before $max_line_length
2826 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2827 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2828 $msg_type = "LONG_LINE_STRING"
2829 }
2830
2831 if ($msg_type ne "" &&
2832 (show_type("LONG_LINE") || show_type($msg_type))) {
2833 WARN($msg_type,
2834 "line over $max_line_length characters\n" . $herecurr);
2835 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002836 }
2837
Andy Whitcroft8905a672007-11-28 16:21:06 -08002838# check for adding lines without a newline.
2839 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002840 WARN("MISSING_EOF_NEWLINE",
2841 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002842 }
2843
Mike Frysinger42e41c52009-09-21 17:04:40 -07002844# Blackfin: use hi/lo macros
2845 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2846 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2847 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002848 ERROR("LO_MACRO",
2849 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002850 }
2851 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2852 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002853 ERROR("HI_MACRO",
2854 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002855 }
2856 }
2857
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002858# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002859 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002860
2861# at the beginning of a line any tabs must come first and anything
2862# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002863 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2864 $rawline =~ /^\+\s* \s*/) {
2865 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002866 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002867 if (ERROR("CODE_INDENT",
2868 "code indent should use tabs where possible\n" . $herevet) &&
2869 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002870 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002871 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002872 }
2873
Alberto Panizzo08e44362010-03-05 13:43:54 -08002874# check for space before tabs.
2875 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2876 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002877 if (WARN("SPACE_BEFORE_TAB",
2878 "please, no space before tabs\n" . $herevet) &&
2879 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002880 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002881 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002882 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002883 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002884 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002885 }
2886
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002887# check for && or || at the start of a line
2888 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2889 CHK("LOGICAL_CONTINUATIONS",
2890 "Logical continuations should be on the previous line\n" . $hereprev);
2891 }
2892
Joe Perchesa91e8992016-05-20 17:04:05 -07002893# check indentation starts on a tab stop
2894 if ($^V && $^V ge 5.10.0 &&
2895 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2896 my $indent = length($1);
2897 if ($indent % 8) {
2898 if (WARN("TABSTOP",
2899 "Statements should start on a tabstop\n" . $herecurr) &&
2900 $fix) {
2901 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2902 }
2903 }
2904 }
2905
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002906# check multi-line statement indentation matches previous line
2907 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002908 $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 -07002909 $prevline =~ /^\+(\t*)(.*)$/;
2910 my $oldindent = $1;
2911 my $rest = $2;
2912
2913 my $pos = pos_last_openparen($rest);
2914 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002915 $line =~ /^(\+| )([ \t]*)/;
2916 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002917
2918 my $goodtabindent = $oldindent .
2919 "\t" x ($pos / 8) .
2920 " " x ($pos % 8);
2921 my $goodspaceindent = $oldindent . " " x $pos;
2922
2923 if ($newindent ne $goodtabindent &&
2924 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002925
2926 if (CHK("PARENTHESIS_ALIGNMENT",
2927 "Alignment should match open parenthesis\n" . $hereprev) &&
2928 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002929 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002930 s/^\+[ \t]*/\+$goodtabindent/;
2931 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002932 }
2933 }
2934 }
2935
Joe Perches6ab3a972015-04-16 12:44:05 -07002936# check for space after cast like "(int) foo" or "(struct foo) bar"
2937# avoid checking a few false positives:
2938# "sizeof(<type>)" or "__alignof__(<type>)"
2939# function pointer declarations like "(*foo)(int) = bar;"
2940# structure definitions like "(struct foo) { 0 };"
2941# multiline macros that define functions
2942# known attributes or the __attribute__ keyword
2943 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2944 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002945 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002946 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002947 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002948 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002949 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002950 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002951 }
2952
Joe Perches86406b12015-09-09 15:37:41 -07002953# Block comment styles
2954# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002955 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002956 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002957 $rawline =~ /^\+[ \t]*\*/ &&
2958 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002959 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2960 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2961 }
2962
Joe Perches86406b12015-09-09 15:37:41 -07002963# Block comments use * on subsequent lines
2964 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2965 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002966 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002967 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002968 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002969 WARN("BLOCK_COMMENT_STYLE",
2970 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002971 }
2972
Joe Perches86406b12015-09-09 15:37:41 -07002973# Block comments use */ on trailing lines
2974 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002975 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2976 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2977 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002978 WARN("BLOCK_COMMENT_STYLE",
2979 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002980 }
2981
Joe Perches08eb9b82016-10-11 13:51:50 -07002982# Block comment * alignment
2983 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2984 (($prevrawline =~ /^\+.*?\/\*/ && #starting /*
2985 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */
2986 $prevrawline =~ /^\+[ \t]*\*/) && #starting *
2987 $rawline =~ /^\+[ \t]*\*/) { #rawline *
2988 $prevrawline =~ m@^\+([ \t]*/?)\*@;
2989 my $oldindent = expand_tabs($1);
2990 $rawline =~ m@^\+([ \t]*)\*@;
2991 my $newindent = $1;
2992 my $test_comment = '^\\+' . "$;" x (length($newindent) + 1);
2993 $newindent = expand_tabs($newindent);
2994 if ($line =~ /$test_comment/ &&
2995 length($oldindent) ne length($newindent)) {
2996 WARN("BLOCK_COMMENT_STYLE",
2997 "Block comments should align the * on each line\n" . $hereprev);
2998 }
2999 }
3000
Joe Perches7f619192014-08-06 16:10:39 -07003001# check for missing blank lines after struct/union declarations
3002# with exceptions for various attributes and macros
3003 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3004 $line =~ /^\+/ &&
3005 !($line =~ /^\+\s*$/ ||
3006 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3007 $line =~ /^\+\s*MODULE_/i ||
3008 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3009 $line =~ /^\+[a-z_]*init/ ||
3010 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3011 $line =~ /^\+\s*DECLARE/ ||
3012 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003013 if (CHK("LINE_SPACING",
3014 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3015 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003016 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003017 }
Joe Perches7f619192014-08-06 16:10:39 -07003018 }
3019
Joe Perches365dd4e2014-08-06 16:10:42 -07003020# check for multiple consecutive blank lines
3021 if ($prevline =~ /^[\+ ]\s*$/ &&
3022 $line =~ /^\+\s*$/ &&
3023 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003024 if (CHK("LINE_SPACING",
3025 "Please don't use multiple blank lines\n" . $hereprev) &&
3026 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003027 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003028 }
3029
Joe Perches365dd4e2014-08-06 16:10:42 -07003030 $last_blank_line = $linenr;
3031 }
3032
Joe Perches3b617e32014-04-03 14:49:28 -07003033# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003034 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3035 # actual declarations
3036 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003037 # function pointer declarations
3038 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003039 # foo bar; where foo is some local typedef or #define
3040 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3041 # known declaration macros
3042 $prevline =~ /^\+\s+$declaration_macros/) &&
3043 # for "else if" which can look like "$Ident $Ident"
3044 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3045 # other possible extensions of declaration lines
3046 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3047 # not starting a section or a macro "\" extended line
3048 $prevline =~ /(?:\{\s*|\\)$/) &&
3049 # looks like a declaration
3050 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003051 # function pointer declarations
3052 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003053 # foo bar; where foo is some local typedef or #define
3054 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3055 # known declaration macros
3056 $sline =~ /^\+\s+$declaration_macros/ ||
3057 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003058 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003059 # start or end of block or continuation of declaration
3060 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3061 # bitfield continuation
3062 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3063 # other possible extensions of declaration lines
3064 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3065 # indentation of previous and current line are the same
3066 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003067 if (WARN("LINE_SPACING",
3068 "Missing a blank line after declarations\n" . $hereprev) &&
3069 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003070 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003071 }
Joe Perches3b617e32014-04-03 14:49:28 -07003072 }
3073
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003074# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003075# Exceptions:
3076# 1) within comments
3077# 2) indented preprocessor commands
3078# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003079 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003080 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003081 if (WARN("LEADING_SPACE",
3082 "please, no spaces at the start of a line\n" . $herevet) &&
3083 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003084 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003085 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003086 }
3087
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003088# check we are in a valid C source file if not then ignore this hunk
3089 next if ($realfile !~ /\.(h|c)$/);
3090
Joe Perches032a4c02014-08-06 16:10:29 -07003091# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003092# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003093# if the previous line is a break or return and is indented 1 tab more...
3094 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3095 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003096 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3097 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3098 defined $lines[$linenr] &&
3099 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003100 WARN("UNNECESSARY_ELSE",
3101 "else is not generally useful after a break or return\n" . $hereprev);
3102 }
3103 }
3104
Joe Perchesc00df192014-08-06 16:11:01 -07003105# check indentation of a line with a break;
3106# if the previous line is a goto or return and is indented the same # of tabs
3107 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3108 my $tabs = $1;
3109 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3110 WARN("UNNECESSARY_BREAK",
3111 "break is not useful after a goto or return\n" . $hereprev);
3112 }
3113 }
3114
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003115# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3116 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3117 WARN("CONFIG_EXPERIMENTAL",
3118 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3119 }
3120
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003121# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003122 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003123 WARN("CVS_KEYWORD",
3124 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003125 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003126
Mike Frysinger42e41c52009-09-21 17:04:40 -07003127# Blackfin: don't use __builtin_bfin_[cs]sync
3128 if ($line =~ /__builtin_bfin_csync/) {
3129 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003130 ERROR("CSYNC",
3131 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003132 }
3133 if ($line =~ /__builtin_bfin_ssync/) {
3134 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003135 ERROR("SSYNC",
3136 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003137 }
3138
Joe Perches56e77d72013-02-21 16:44:14 -08003139# check for old HOTPLUG __dev<foo> section markings
3140 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3141 WARN("HOTPLUG_SECTION",
3142 "Using $1 is unnecessary\n" . $herecurr);
3143 }
3144
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003145# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003146 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3147 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003148#print "LINE<$line>\n";
3149 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003150 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003151 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003152 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003153 $stat =~ s/\n./\n /g;
3154 $cond =~ s/\n./\n /g;
3155
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003156#print "linenr<$linenr> <$stat>\n";
3157 # If this statement has no statement boundaries within
3158 # it there is no point in retrying a statement scan
3159 # until we hit end of it.
3160 my $frag = $stat; $frag =~ s/;+\s*$//;
3161 if ($frag !~ /(?:{|;)/) {
3162#print "skip<$line_nr_next>\n";
3163 $suppress_statement = $line_nr_next;
3164 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003165
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003166 # Find the real next line.
3167 $realline_next = $line_nr_next;
3168 if (defined $realline_next &&
3169 (!defined $lines[$realline_next - 1] ||
3170 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3171 $realline_next++;
3172 }
3173
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003174 my $s = $stat;
3175 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003176
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003177 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003178 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003179
3180 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003181 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003182
Andy Whitcroft463f2862009-09-21 17:04:34 -07003183 } elsif ($s =~ /^.\s*else\b/s) {
3184
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003185 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003186 } 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 -07003187 my $type = $1;
3188 $type =~ s/\s+/ /g;
3189 possible($type, "A:" . $s);
3190
Andy Whitcroft8905a672007-11-28 16:21:06 -08003191 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003192 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003193 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003194 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003195
3196 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003197 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003198 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003199 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003200
3201 # Check for any sort of function declaration.
3202 # int foo(something bar, other baz);
3203 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003204 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 -08003205 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003206
Andy Whitcroftcf655042008-03-04 14:28:20 -08003207 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003208 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003209 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003210
Andy Whitcroft8905a672007-11-28 16:21:06 -08003211 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003212 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003213
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003214 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003215 }
3216 }
3217 }
3218
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003219 }
3220
Andy Whitcroft653d4872007-06-23 17:16:34 -07003221#
3222# Checks which may be anchored in the context.
3223#
3224
3225# Check for switch () and associated case and default
3226# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003227 if ($line=~/\bswitch\s*\(.*\)/) {
3228 my $err = '';
3229 my $sep = '';
3230 my @ctx = ctx_block_outer($linenr, $realcnt);
3231 shift(@ctx);
3232 for my $ctx (@ctx) {
3233 my ($clen, $cindent) = line_stats($ctx);
3234 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3235 $indent != $cindent) {
3236 $err .= "$sep$ctx\n";
3237 $sep = '';
3238 } else {
3239 $sep = "[...]\n";
3240 }
3241 }
3242 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003243 ERROR("SWITCH_CASE_INDENT_LEVEL",
3244 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003245 }
3246 }
3247
3248# if/while/etc brace do not go on next line, unless defining a do while loop,
3249# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003250 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 -07003251 my $pre_ctx = "$1$2";
3252
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003253 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003254
3255 if ($line =~ /^\+\t{6,}/) {
3256 WARN("DEEP_INDENTATION",
3257 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3258 }
3259
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003260 my $ctx_cnt = $realcnt - $#ctx - 1;
3261 my $ctx = join("\n", @ctx);
3262
Andy Whitcroft548596d2008-07-23 21:29:01 -07003263 my $ctx_ln = $linenr;
3264 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003265
Andy Whitcroft548596d2008-07-23 21:29:01 -07003266 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3267 defined $lines[$ctx_ln - 1] &&
3268 $lines[$ctx_ln - 1] =~ /^-/)) {
3269 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3270 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003271 $ctx_ln++;
3272 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003273
Andy Whitcroft53210162008-07-23 21:29:03 -07003274 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3275 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003276
Joe Perchesd752fcc2014-08-06 16:11:05 -07003277 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003278 ERROR("OPEN_BRACE",
3279 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003280 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003281 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003282 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3283 $ctx =~ /\)\s*\;\s*$/ &&
3284 defined $lines[$ctx_ln - 1])
3285 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003286 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3287 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003288 WARN("TRAILING_SEMICOLON",
3289 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003290 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003291 }
3292 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003293 }
3294
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003295# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003296 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 -08003297 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3298 ctx_statement_block($linenr, $realcnt, 0)
3299 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003300 my ($s, $c) = ($stat, $cond);
3301
3302 substr($s, 0, length($c), '');
3303
Joe Perches9f5af482015-09-09 15:37:30 -07003304 # remove inline comments
3305 $s =~ s/$;/ /g;
3306 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003307
3308 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003309 my @newlines = ($c =~ /\n/gs);
3310 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003311
Joe Perches9f5af482015-09-09 15:37:30 -07003312 # Make sure we remove the line prefixes as we have
3313 # none on the first line, and are going to readd them
3314 # where necessary.
3315 $s =~ s/\n./\n/gs;
3316 while ($s =~ /\n\s+\\\n/) {
3317 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3318 }
3319
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003320 # We want to check the first line inside the block
3321 # starting at the end of the conditional, so remove:
3322 # 1) any blank line termination
3323 # 2) any opening brace { on end of the line
3324 # 3) any do (...) {
3325 my $continuation = 0;
3326 my $check = 0;
3327 $s =~ s/^.*\bdo\b//;
3328 $s =~ s/^\s*{//;
3329 if ($s =~ s/^\s*\\//) {
3330 $continuation = 1;
3331 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003332 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003333 $check = 1;
3334 $cond_lines++;
3335 }
3336
3337 # Also ignore a loop construct at the end of a
3338 # preprocessor statement.
3339 if (($prevline =~ /^.\s*#\s*define\s/ ||
3340 $prevline =~ /\\\s*$/) && $continuation == 0) {
3341 $check = 0;
3342 }
3343
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003344 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003345 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003346 while ($cond_ptr != $cond_lines) {
3347 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003348
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003349 # If we see an #else/#elif then the code
3350 # is not linear.
3351 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3352 $check = 0;
3353 }
3354
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003355 # Ignore:
3356 # 1) blank lines, they should be at 0,
3357 # 2) preprocessor lines, and
3358 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003359 if ($continuation ||
3360 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003361 $s =~ /^\s*#\s*?/ ||
3362 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003363 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003364 if ($s =~ s/^.*?\n//) {
3365 $cond_lines++;
3366 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003367 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003368 }
3369
3370 my (undef, $sindent) = line_stats("+" . $s);
3371 my $stat_real = raw_line($linenr, $cond_lines);
3372
3373 # Check if either of these lines are modified, else
3374 # this is not this patch's fault.
3375 if (!defined($stat_real) ||
3376 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3377 $check = 0;
3378 }
3379 if (defined($stat_real) && $cond_lines > 1) {
3380 $stat_real = "[...]\n$stat_real";
3381 }
3382
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003383 #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 -07003384
Joe Perches9f5af482015-09-09 15:37:30 -07003385 if ($check && $s ne '' &&
3386 (($sindent % 8) != 0 ||
3387 ($sindent < $indent) ||
3388 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003389 WARN("SUSPECT_CODE_INDENT",
3390 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003391 }
3392 }
3393
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003394 # Track the 'values' across context and added lines.
3395 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003396 my ($curr_values, $curr_vars) =
3397 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003398 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003399 if ($dbg_values) {
3400 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003401 print "$linenr > .$outline\n";
3402 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003403 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003404 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003405 $prev_values = substr($curr_values, -1);
3406
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003407#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003408 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003409
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003410# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003411 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 -07003412 my $type = $1;
3413 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003414 $var = "" if (!defined $var);
3415 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003416 my $sign = $1;
3417 my $pointer = $2;
3418
3419 $pointer = "" if (!defined $pointer);
3420
3421 if (WARN("UNSPECIFIED_INT",
3422 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3423 $fix) {
3424 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003425 my $comp_pointer = $pointer;
3426 $comp_pointer =~ s/\s//g;
3427 $decl .= $comp_pointer;
3428 $decl = rtrim($decl) if ($var eq "");
3429 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003430 }
3431 }
3432 }
3433
Andy Whitcroft653d4872007-06-23 17:16:34 -07003434# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003435 if ($dbg_type) {
3436 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003437 ERROR("TEST_TYPE",
3438 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003439 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003440 ERROR("TEST_NOT_TYPE",
3441 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003442 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003443 next;
3444 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003445# TEST: allow direct testing of the attribute matcher.
3446 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003447 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003448 ERROR("TEST_ATTR",
3449 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003450 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003451 ERROR("TEST_NOT_ATTR",
3452 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003453 }
3454 next;
3455 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003456
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003457# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003458 if ($line =~ /^.\s*{/ &&
3459 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003460 if (ERROR("OPEN_BRACE",
3461 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003462 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3463 fix_delete_line($fixlinenr - 1, $prevrawline);
3464 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003465 my $fixedline = $prevrawline;
3466 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003467 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003468 $fixedline = $line;
3469 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003470 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003471 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003472 }
3473
Andy Whitcroft653d4872007-06-23 17:16:34 -07003474#
3475# Checks which are anchored on the added line.
3476#
3477
3478# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003479 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003480 my $path = $1;
3481 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003482 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003483 "malformed #include filename\n" . $herecurr);
3484 }
3485 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3486 ERROR("UAPI_INCLUDE",
3487 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003488 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003489 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003490
3491# no C99 // comments
3492 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003493 if (ERROR("C99_COMMENTS",
3494 "do not use C99 // comments\n" . $herecurr) &&
3495 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003496 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003497 if ($line =~ /\/\/(.*)$/) {
3498 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003499 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003500 }
3501 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003502 }
3503 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003504 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003505 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003506
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003507# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3508# the whole statement.
3509#print "APW <$lines[$realline_next - 1]>\n";
3510 if (defined $realline_next &&
3511 exists $lines[$realline_next - 1] &&
3512 !defined $suppress_export{$realline_next} &&
3513 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3514 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003515 # Handle definitions which produce identifiers with
3516 # a prefix:
3517 # XXX(foo);
3518 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003519 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003520 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003521 $name =~ /^${Ident}_$2/) {
3522#print "FOO C name<$name>\n";
3523 $suppress_export{$realline_next} = 1;
3524
3525 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003526 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003527 ^.DEFINE_$Ident\(\Q$name\E\)|
3528 ^.DECLARE_$Ident\(\Q$name\E\)|
3529 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003530 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3531 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003532 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003533#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3534 $suppress_export{$realline_next} = 2;
3535 } else {
3536 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003537 }
3538 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003539 if (!defined $suppress_export{$linenr} &&
3540 $prevline =~ /^.\s*$/ &&
3541 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3542 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3543#print "FOO B <$lines[$linenr - 1]>\n";
3544 $suppress_export{$linenr} = 2;
3545 }
3546 if (defined $suppress_export{$linenr} &&
3547 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003548 WARN("EXPORT_SYMBOL",
3549 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003550 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003551
Joe Eloff5150bda2010-08-09 17:21:00 -07003552# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003553 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003554 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003555 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003556 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003557 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003558 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003559 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003560# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003561 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003562 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003563 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003564 $herecurr) &&
3565 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003566 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003567 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003568 }
3569
Joe Perches18130872014-08-06 16:11:22 -07003570# check for misordered declarations of char/short/int/long with signed/unsigned
3571 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3572 my $tmp = trim($1);
3573 WARN("MISORDERED_TYPE",
3574 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3575 }
3576
Joe Perchescb710ec2010-10-26 14:23:20 -07003577# check for static const char * arrays.
3578 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003579 WARN("STATIC_CONST_CHAR_ARRAY",
3580 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003581 $herecurr);
3582 }
3583
3584# check for static char foo[] = "bar" declarations.
3585 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003586 WARN("STATIC_CONST_CHAR_ARRAY",
3587 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003588 $herecurr);
3589 }
3590
Joe Perchesab7e23f2015-04-16 12:44:22 -07003591# check for const <foo> const where <foo> is not a pointer or array type
3592 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3593 my $found = $1;
3594 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3595 WARN("CONST_CONST",
3596 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3597 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3598 WARN("CONST_CONST",
3599 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3600 }
3601 }
3602
Joe Perches9b0fa602014-04-03 14:49:18 -07003603# check for non-global char *foo[] = {"bar", ...} declarations.
3604 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3605 WARN("STATIC_CONST_CHAR_ARRAY",
3606 "char * array declaration might be better as static const\n" .
3607 $herecurr);
3608 }
3609
Joe Perchesb598b672015-04-16 12:44:36 -07003610# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3611 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3612 my $array = $1;
3613 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3614 my $array_div = $1;
3615 if (WARN("ARRAY_SIZE",
3616 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3617 $fix) {
3618 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3619 }
3620 }
3621 }
3622
Joe Perchesb36190c2014-01-27 17:07:18 -08003623# check for function declarations without arguments like "int foo()"
3624 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3625 if (ERROR("FUNCTION_WITHOUT_ARGS",
3626 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3627 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003628 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003629 }
3630 }
3631
Andy Whitcroft653d4872007-06-23 17:16:34 -07003632# check for new typedefs, only function parameters and sparse annotations
3633# make sense.
3634 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003635 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003636 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003637 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003638 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003639 WARN("NEW_TYPEDEFS",
3640 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003641 }
3642
3643# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003644 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003645 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3646 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003647 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003648
Andy Whitcroft65863862009-01-06 14:41:21 -08003649 # Should start with a space.
3650 $to =~ s/^(\S)/ $1/;
3651 # Should not end with a space.
3652 $to =~ s/\s+$//;
3653 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003654 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003655 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003656
Joe Perches3705ce52013-07-03 15:05:31 -07003657## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003658 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003659 if (ERROR("POINTER_LOCATION",
3660 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3661 $fix) {
3662 my $sub_from = $ident;
3663 my $sub_to = $ident;
3664 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003665 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003666 s@\Q$sub_from\E@$sub_to@;
3667 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003668 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003669 }
3670 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3671 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003672 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003673
Andy Whitcroft65863862009-01-06 14:41:21 -08003674 # Should start with a space.
3675 $to =~ s/^(\S)/ $1/;
3676 # Should not end with a space.
3677 $to =~ s/\s+$//;
3678 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003679 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003680 }
3681 # Modifiers should have spaces.
3682 $to =~ s/(\b$Modifier$)/$1 /;
3683
Joe Perches3705ce52013-07-03 15:05:31 -07003684## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003685 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003686 if (ERROR("POINTER_LOCATION",
3687 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3688 $fix) {
3689
3690 my $sub_from = $match;
3691 my $sub_to = $match;
3692 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003693 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003694 s@\Q$sub_from\E@$sub_to@;
3695 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003696 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003697 }
3698
Joe Perches9d3e3c72015-09-09 15:37:27 -07003699# avoid BUG() or BUG_ON()
3700 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3701 my $msg_type = \&WARN;
3702 $msg_type = \&CHK if ($file);
3703 &{$msg_type}("AVOID_BUG",
3704 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3705 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003706
Joe Perches9d3e3c72015-09-09 15:37:27 -07003707# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003708 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003709 WARN("LINUX_VERSION_CODE",
3710 "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 -08003711 }
3712
Joe Perches17441222011-06-15 15:08:17 -07003713# check for uses of printk_ratelimit
3714 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003715 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003716 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003717 }
3718
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003719# printk should use KERN_* levels. Note that follow on printk's on the
3720# same line do not need a level, so we use the current block context
3721# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003722# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003723# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003724 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003725 my $ok = 0;
3726 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3727 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003728 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003729 # with "\n" ignore it, else it is to blame
3730 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3731 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3732 $ok = 1;
3733 }
3734 last;
3735 }
3736 }
3737 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003738 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3739 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003740 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003741 }
3742
Joe Perches243f3802012-05-31 16:26:09 -07003743 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3744 my $orig = $1;
3745 my $level = lc($orig);
3746 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003747 my $level2 = $level;
3748 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003749 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003750 "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 -07003751 }
3752
3753 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003754 if (WARN("PREFER_PR_LEVEL",
3755 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3756 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003757 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003758 s/\bpr_warning\b/pr_warn/;
3759 }
Joe Perches243f3802012-05-31 16:26:09 -07003760 }
3761
Joe Perchesdc139312013-02-21 16:44:13 -08003762 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3763 my $orig = $1;
3764 my $level = lc($orig);
3765 $level = "warn" if ($level eq "warning");
3766 $level = "dbg" if ($level eq "debug");
3767 WARN("PREFER_DEV_LEVEL",
3768 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3769 }
3770
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003771# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3772# number of false positives, but assembly files are not checked, so at
3773# least the arch entry code will not trigger this warning.
3774 if ($line =~ /\bENOSYS\b/) {
3775 WARN("ENOSYS",
3776 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3777 }
3778
Andy Whitcroft653d4872007-06-23 17:16:34 -07003779# function brace can't be on same line, except for #defines of do while,
3780# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003781 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003782 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003783 if (ERROR("OPEN_BRACE",
3784 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3785 $fix) {
3786 fix_delete_line($fixlinenr, $rawline);
3787 my $fixed_line = $rawline;
3788 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3789 my $line1 = $1;
3790 my $line2 = $2;
3791 fix_insert_line($fixlinenr, ltrim($line1));
3792 fix_insert_line($fixlinenr, "\+{");
3793 if ($line2 !~ /^\s*$/) {
3794 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3795 }
3796 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003797 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003798
Andy Whitcroft8905a672007-11-28 16:21:06 -08003799# open braces for enum, union and struct go on the same line.
3800 if ($line =~ /^.\s*{/ &&
3801 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003802 if (ERROR("OPEN_BRACE",
3803 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3804 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3805 fix_delete_line($fixlinenr - 1, $prevrawline);
3806 fix_delete_line($fixlinenr, $rawline);
3807 my $fixedline = rtrim($prevrawline) . " {";
3808 fix_insert_line($fixlinenr, $fixedline);
3809 $fixedline = $rawline;
3810 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3811 if ($fixedline !~ /^\+\s*$/) {
3812 fix_insert_line($fixlinenr, $fixedline);
3813 }
3814 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003815 }
3816
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003817# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003818 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3819 if (WARN("SPACING",
3820 "missing space after $1 definition\n" . $herecurr) &&
3821 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003822 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003823 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3824 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003825 }
3826
Joe Perches31070b52014-01-23 15:54:49 -08003827# Function pointer declarations
3828# check spacing between type, funcptr, and args
3829# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003830 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003831 my $declare = $1;
3832 my $pre_pointer_space = $2;
3833 my $post_pointer_space = $3;
3834 my $funcname = $4;
3835 my $post_funcname_space = $5;
3836 my $pre_args_space = $6;
3837
Joe Perches91f72e92014-04-03 14:49:12 -07003838# the $Declare variable will capture all spaces after the type
3839# so check it for a missing trailing missing space but pointer return types
3840# don't need a space so don't warn for those.
3841 my $post_declare_space = "";
3842 if ($declare =~ /(\s+)$/) {
3843 $post_declare_space = $1;
3844 $declare = rtrim($declare);
3845 }
3846 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003847 WARN("SPACING",
3848 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003849 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003850 }
3851
3852# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003853# This test is not currently implemented because these declarations are
3854# equivalent to
3855# int foo(int bar, ...)
3856# and this is form shouldn't/doesn't generate a checkpatch warning.
3857#
3858# elsif ($declare =~ /\s{2,}$/) {
3859# WARN("SPACING",
3860# "Multiple spaces after return type\n" . $herecurr);
3861# }
Joe Perches31070b52014-01-23 15:54:49 -08003862
3863# unnecessary space "type ( *funcptr)(args...)"
3864 if (defined $pre_pointer_space &&
3865 $pre_pointer_space =~ /^\s/) {
3866 WARN("SPACING",
3867 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3868 }
3869
3870# unnecessary space "type (* funcptr)(args...)"
3871 if (defined $post_pointer_space &&
3872 $post_pointer_space =~ /^\s/) {
3873 WARN("SPACING",
3874 "Unnecessary space before function pointer name\n" . $herecurr);
3875 }
3876
3877# unnecessary space "type (*funcptr )(args...)"
3878 if (defined $post_funcname_space &&
3879 $post_funcname_space =~ /^\s/) {
3880 WARN("SPACING",
3881 "Unnecessary space after function pointer name\n" . $herecurr);
3882 }
3883
3884# unnecessary space "type (*funcptr) (args...)"
3885 if (defined $pre_args_space &&
3886 $pre_args_space =~ /^\s/) {
3887 WARN("SPACING",
3888 "Unnecessary space before function pointer arguments\n" . $herecurr);
3889 }
3890
3891 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003892 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003893 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003894 }
3895 }
3896
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003897# check for spacing round square brackets; allowed:
3898# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003899# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3900# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003901 while ($line =~ /(.*?\s)\[/g) {
3902 my ($where, $prefix) = ($-[1], $1);
3903 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003904 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003905 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003906 if (ERROR("BRACKET_SPACE",
3907 "space prohibited before open square bracket '['\n" . $herecurr) &&
3908 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003909 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003910 s/^(\+.*?)\s+\[/$1\[/;
3911 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003912 }
3913 }
3914
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003915# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003916 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003917 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003918 my $ctx_before = substr($line, 0, $-[1]);
3919 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003920
3921 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003922 if ($name =~ /^(?:
3923 if|for|while|switch|return|case|
3924 volatile|__volatile__|
3925 __attribute__|format|__extension__|
3926 asm|__asm__)$/x)
3927 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003928 # cpp #define statements have non-optional spaces, ie
3929 # if there is a space between the name and the open
3930 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003931 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003932
3933 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003934 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003935
3936 # If this whole things ends with a type its most
3937 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003938 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003939
3940 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003941 if (WARN("SPACING",
3942 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3943 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003944 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003945 s/\b$name\s+\(/$name\(/;
3946 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003947 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003948 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003949
Andy Whitcroft653d4872007-06-23 17:16:34 -07003950# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003951 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003952 my $fixed_line = "";
3953 my $line_fixed = 0;
3954
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003955 my $ops = qr{
3956 <<=|>>=|<=|>=|==|!=|
3957 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3958 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003959 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003960 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003961 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003962 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003963
3964## print("element count: <" . $#elements . ">\n");
3965## foreach my $el (@elements) {
3966## print("el: <$el>\n");
3967## }
3968
3969 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003970 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003971
Joe Perches3705ce52013-07-03 15:05:31 -07003972 foreach my $el (@elements) {
3973 push(@fix_elements, substr($rawline, $off, length($el)));
3974 $off += length($el);
3975 }
3976
3977 $off = 0;
3978
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003979 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003980 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003981
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003982 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003983
3984 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3985
3986## print("n: <$n> good: <$good>\n");
3987
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003988 $off += length($elements[$n]);
3989
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003990 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003991 my $ca = substr($opline, 0, $off);
3992 my $cc = '';
3993 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3994 $cc = substr($opline, $off + length($elements[$n + 1]));
3995 }
3996 my $cb = "$ca$;$cc";
3997
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003998 my $a = '';
3999 $a = 'V' if ($elements[$n] ne '');
4000 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004001 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004002 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4003 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004004 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004005
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004006 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004007
4008 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004009 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004010 $c = 'V' if ($elements[$n + 2] ne '');
4011 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004012 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004013 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4014 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004015 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004016 } else {
4017 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004018 }
4019
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004020 my $ctx = "${a}x${c}";
4021
4022 my $at = "(ctx:$ctx)";
4023
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004024 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004025 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004026
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004027 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004028 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004029
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004030 # Get the full operator variant.
4031 my $opv = $op . substr($curr_vars, $off, 1);
4032
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004033 # Ignore operators passed as parameters.
4034 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004035 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004036
Andy Whitcroftcf655042008-03-04 14:28:20 -08004037# # Ignore comments
4038# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004039
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004040 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004041 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004042 if ($ctx !~ /.x[WEBC]/ &&
4043 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004044 if (ERROR("SPACING",
4045 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004046 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004047 $line_fixed = 1;
4048 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004049 }
4050
4051 # // is a comment
4052 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004053
Joe Perchesb00e4812014-04-03 14:49:33 -07004054 # : when part of a bitfield
4055 } elsif ($opv eq ':B') {
4056 # skip the bitfield test for now
4057
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004058 # No spaces for:
4059 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004060 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004061 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004062 if (ERROR("SPACING",
4063 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004064 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004065 if (defined $fix_elements[$n + 2]) {
4066 $fix_elements[$n + 2] =~ s/^\s+//;
4067 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004068 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004069 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004070 }
4071
Joe Perches23810972014-12-10 15:51:32 -08004072 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004073 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004074 my $rtrim_before = 0;
4075 my $space_after = 0;
4076 if ($ctx =~ /Wx./) {
4077 if (ERROR("SPACING",
4078 "space prohibited before that '$op' $at\n" . $hereptr)) {
4079 $line_fixed = 1;
4080 $rtrim_before = 1;
4081 }
4082 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004083 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004084 if (ERROR("SPACING",
4085 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004086 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004087 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004088 $space_after = 1;
4089 }
4090 }
4091 if ($rtrim_before || $space_after) {
4092 if ($rtrim_before) {
4093 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4094 } else {
4095 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4096 }
4097 if ($space_after) {
4098 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004099 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004100 }
4101
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004102 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004103 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004104 #warn "'*' is part of type\n";
4105
4106 # unary operators should have a space before and
4107 # none after. May be left adjacent to another
4108 # unary operator, or a cast
4109 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004110 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004111 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004112 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004113 if (ERROR("SPACING",
4114 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004115 if ($n != $last_after + 2) {
4116 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4117 $line_fixed = 1;
4118 }
Joe Perches3705ce52013-07-03 15:05:31 -07004119 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004120 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004121 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004122 # A unary '*' may be const
4123
4124 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004125 if (ERROR("SPACING",
4126 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004127 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004128 if (defined $fix_elements[$n + 2]) {
4129 $fix_elements[$n + 2] =~ s/^\s+//;
4130 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004131 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004132 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004133 }
4134
4135 # unary ++ and unary -- are allowed no space on one side.
4136 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004137 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004138 if (ERROR("SPACING",
4139 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004140 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004141 $line_fixed = 1;
4142 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004143 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004144 if ($ctx =~ /Wx[BE]/ ||
4145 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004146 if (ERROR("SPACING",
4147 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004148 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004149 $line_fixed = 1;
4150 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004151 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004152 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004153 if (ERROR("SPACING",
4154 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004155 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004156 if (defined $fix_elements[$n + 2]) {
4157 $fix_elements[$n + 2] =~ s/^\s+//;
4158 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004159 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004160 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004161 }
4162
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004163 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004164 } elsif ($op eq '<<' or $op eq '>>' or
4165 $op eq '&' or $op eq '^' or $op eq '|' or
4166 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004167 $op eq '*' or $op eq '/' or
4168 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004169 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004170 if ($check) {
4171 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4172 if (CHK("SPACING",
4173 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4174 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4175 $fix_elements[$n + 2] =~ s/^\s+//;
4176 $line_fixed = 1;
4177 }
4178 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4179 if (CHK("SPACING",
4180 "space preferred before that '$op' $at\n" . $hereptr)) {
4181 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4182 $line_fixed = 1;
4183 }
4184 }
4185 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004186 if (ERROR("SPACING",
4187 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004188 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4189 if (defined $fix_elements[$n + 2]) {
4190 $fix_elements[$n + 2] =~ s/^\s+//;
4191 }
Joe Perches3705ce52013-07-03 15:05:31 -07004192 $line_fixed = 1;
4193 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004194 }
4195
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004196 # A colon needs no spaces before when it is
4197 # terminating a case value or a label.
4198 } elsif ($opv eq ':C' || $opv eq ':L') {
4199 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004200 if (ERROR("SPACING",
4201 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004202 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004203 $line_fixed = 1;
4204 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004205 }
4206
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004207 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004208 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004209 my $ok = 0;
4210
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004211 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004212 if (($op eq '<' &&
4213 $cc =~ /^\S+\@\S+>/) ||
4214 ($op eq '>' &&
4215 $ca =~ /<\S+\@\S+$/))
4216 {
4217 $ok = 1;
4218 }
4219
Joe Perchese0df7e12015-04-16 12:44:53 -07004220 # for asm volatile statements
4221 # ignore a colon with another
4222 # colon immediately before or after
4223 if (($op eq ':') &&
4224 ($ca =~ /:$/ || $cc =~ /^:/)) {
4225 $ok = 1;
4226 }
4227
Joe Perches84731622013-11-12 15:10:05 -08004228 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004229 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004230 my $msg_type = \&ERROR;
4231 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4232
4233 if (&{$msg_type}("SPACING",
4234 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004235 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4236 if (defined $fix_elements[$n + 2]) {
4237 $fix_elements[$n + 2] =~ s/^\s+//;
4238 }
Joe Perches3705ce52013-07-03 15:05:31 -07004239 $line_fixed = 1;
4240 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004241 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004242 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004243 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004244
4245## print("n: <$n> GOOD: <$good>\n");
4246
4247 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004248 }
Joe Perches3705ce52013-07-03 15:05:31 -07004249
4250 if (($#elements % 2) == 0) {
4251 $fixed_line = $fixed_line . $fix_elements[$#elements];
4252 }
4253
Joe Perches194f66f2014-08-06 16:11:03 -07004254 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4255 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004256 }
4257
4258
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004259 }
4260
Joe Perches786b6322013-07-03 15:05:32 -07004261# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004262 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004263 if (WARN("SPACING",
4264 "space prohibited before semicolon\n" . $herecurr) &&
4265 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004266 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004267 s/^(\+.*\S)\s+;/$1;/;
4268 }
4269 }
4270
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004271# check for multiple assignments
4272 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004273 CHK("MULTIPLE_ASSIGNMENTS",
4274 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004275 }
4276
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004277## # check for multiple declarations, allowing for a function declaration
4278## # continuation.
4279## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4280## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4281##
4282## # Remove any bracketed sections to ensure we do not
4283## # falsly report the parameters of functions.
4284## my $ln = $line;
4285## while ($ln =~ s/\([^\(\)]*\)//g) {
4286## }
4287## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004288## WARN("MULTIPLE_DECLARATION",
4289## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004290## }
4291## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004292
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004293#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004294 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004295 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004296 if (ERROR("SPACING",
4297 "space required before the open brace '{'\n" . $herecurr) &&
4298 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004299 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004300 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004301 }
4302
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004303## # check for blank lines before declarations
4304## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4305## $prevrawline =~ /^.\s*$/) {
4306## WARN("SPACING",
4307## "No blank lines before declarations\n" . $hereprev);
4308## }
4309##
4310
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004311# closing brace should have a space following it when it has anything
4312# on the line
4313 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004314 if (ERROR("SPACING",
4315 "space required after that close brace '}'\n" . $herecurr) &&
4316 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004317 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004318 s/}((?!(?:,|;|\)))\S)/} $1/;
4319 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004320 }
4321
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004322# check spacing on square brackets
4323 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004324 if (ERROR("SPACING",
4325 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4326 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004327 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004328 s/\[\s+/\[/;
4329 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004330 }
4331 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004332 if (ERROR("SPACING",
4333 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4334 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004335 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004336 s/\s+\]/\]/;
4337 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004338 }
4339
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004340# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004341 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4342 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004343 if (ERROR("SPACING",
4344 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4345 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004346 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004347 s/\(\s+/\(/;
4348 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004349 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004350 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004351 $line !~ /for\s*\(.*;\s+\)/ &&
4352 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004353 if (ERROR("SPACING",
4354 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4355 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004356 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004357 s/\s+\)/\)/;
4358 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004359 }
4360
Joe Perchese2826fd2014-08-06 16:10:48 -07004361# check unnecessary parentheses around addressof/dereference single $Lvals
4362# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4363
4364 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004365 my $var = $1;
4366 if (CHK("UNNECESSARY_PARENTHESES",
4367 "Unnecessary parentheses around $var\n" . $herecurr) &&
4368 $fix) {
4369 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4370 }
4371 }
4372
4373# check for unnecessary parentheses around function pointer uses
4374# ie: (foo->bar)(); should be foo->bar();
4375# but not "if (foo->bar) (" to avoid some false positives
4376 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4377 my $var = $2;
4378 if (CHK("UNNECESSARY_PARENTHESES",
4379 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4380 $fix) {
4381 my $var2 = deparenthesize($var);
4382 $var2 =~ s/\s//g;
4383 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4384 }
4385 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004386
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004387#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004388 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004389 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004390 if (WARN("INDENTED_LABEL",
4391 "labels should not be indented\n" . $herecurr) &&
4392 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004393 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004394 s/^(.)\s+/$1/;
4395 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004396 }
4397
Joe Perches5b9553a2014-04-03 14:49:21 -07004398# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004399 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004400 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004401 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004402 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4403 my $value = $1;
4404 $value = deparenthesize($value);
4405 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4406 ERROR("RETURN_PARENTHESES",
4407 "return is not a function, parentheses are not required\n" . $herecurr);
4408 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004409 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004410 ERROR("SPACING",
4411 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004412 }
4413 }
Joe Perches507e5142013-11-12 15:10:13 -08004414
Joe Perchesb43ae212014-06-23 13:22:07 -07004415# unnecessary return in a void function
4416# at end-of-function, with the previous line a single leading tab, then return;
4417# and the line before that not a goto label target like "out:"
4418 if ($sline =~ /^[ \+]}\s*$/ &&
4419 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4420 $linenr >= 3 &&
4421 $lines[$linenr - 3] =~ /^[ +]/ &&
4422 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004423 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004424 "void function return statements are not generally useful\n" . $hereprev);
4425 }
Joe Perches9819cf22014-06-04 16:12:09 -07004426
Joe Perches189248d2014-01-23 15:54:47 -08004427# if statements using unnecessary parentheses - ie: if ((foo == bar))
4428 if ($^V && $^V ge 5.10.0 &&
4429 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4430 my $openparens = $1;
4431 my $count = $openparens =~ tr@\(@\(@;
4432 my $msg = "";
4433 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4434 my $comp = $4; #Not $1 because of $LvalOrFunc
4435 $msg = " - maybe == should be = ?" if ($comp eq "==");
4436 WARN("UNNECESSARY_PARENTHESES",
4437 "Unnecessary parentheses$msg\n" . $herecurr);
4438 }
4439 }
4440
Joe Perchesc5595fa2015-09-09 15:37:58 -07004441# comparisons with a constant or upper case identifier on the left
4442# avoid cases like "foo + BAR < baz"
4443# only fix matches surrounded by parentheses to avoid incorrect
4444# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4445 if ($^V && $^V ge 5.10.0 &&
4446 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4447 my $lead = $1;
4448 my $const = $2;
4449 my $comp = $3;
4450 my $to = $4;
4451 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004452 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004453 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4454 WARN("CONSTANT_COMPARISON",
4455 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4456 $fix) {
4457 if ($comp eq "<") {
4458 $newcomp = ">";
4459 } elsif ($comp eq "<=") {
4460 $newcomp = ">=";
4461 } elsif ($comp eq ">") {
4462 $newcomp = "<";
4463 } elsif ($comp eq ">=") {
4464 $newcomp = "<=";
4465 }
4466 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4467 }
4468 }
4469
Joe Perchesf34e4a42015-04-16 12:44:19 -07004470# Return of what appears to be an errno should normally be negative
4471 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004472 my $name = $1;
4473 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004474 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004475 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004476 }
4477 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004478
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004479# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004480 if ($line =~ /\b(if|while|for|switch)\(/) {
4481 if (ERROR("SPACING",
4482 "space required before the open parenthesis '('\n" . $herecurr) &&
4483 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004484 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004485 s/\b(if|while|for|switch)\(/$1 \(/;
4486 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004487 }
4488
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004489# Check for illegal assignment in if conditional -- and check for trailing
4490# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004491 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004492 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4493 ctx_statement_block($linenr, $realcnt, 0)
4494 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004495 my ($stat_next) = ctx_statement_block($line_nr_next,
4496 $remain_next, $off_next);
4497 $stat_next =~ s/\n./\n /g;
4498 ##print "stat<$stat> stat_next<$stat_next>\n";
4499
4500 if ($stat_next =~ /^\s*while\b/) {
4501 # If the statement carries leading newlines,
4502 # then count those as offsets.
4503 my ($whitespace) =
4504 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4505 my $offset =
4506 statement_rawlines($whitespace) - 1;
4507
4508 $suppress_whiletrailers{$line_nr_next +
4509 $offset} = 1;
4510 }
4511 }
4512 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004513 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004514 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004515 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004516
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004517 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004518 ERROR("ASSIGN_IN_IF",
4519 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004520 }
4521
4522 # Find out what is on the end of the line after the
4523 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004524 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004525 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004526 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004527 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4528 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004529 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004530 # Find out how long the conditional actually is.
4531 my @newlines = ($c =~ /\n/gs);
4532 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004533 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004534
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004535 $stat_real = raw_line($linenr, $cond_lines)
4536 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004537 if (defined($stat_real) && $cond_lines > 1) {
4538 $stat_real = "[...]\n$stat_real";
4539 }
4540
Joe Perches000d1cc12011-07-25 17:13:25 -07004541 ERROR("TRAILING_STATEMENTS",
4542 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004543 }
4544 }
4545
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004546# Check for bitwise tests written as boolean
4547 if ($line =~ /
4548 (?:
4549 (?:\[|\(|\&\&|\|\|)
4550 \s*0[xX][0-9]+\s*
4551 (?:\&\&|\|\|)
4552 |
4553 (?:\&\&|\|\|)
4554 \s*0[xX][0-9]+\s*
4555 (?:\&\&|\|\||\)|\])
4556 )/x)
4557 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004558 WARN("HEXADECIMAL_BOOLEAN_TEST",
4559 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004560 }
4561
Andy Whitcroft8905a672007-11-28 16:21:06 -08004562# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004563 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4564 my $s = $1;
4565 $s =~ s/$;//g; # Remove any comments
4566 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004567 ERROR("TRAILING_STATEMENTS",
4568 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004569 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004570 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004571# if should not continue a brace
4572 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004573 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004574 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004575 $herecurr);
4576 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004577# case and default should not have general statements after them
4578 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4579 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004580 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004581 \s*return\s+
4582 )/xg)
4583 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004584 ERROR("TRAILING_STATEMENTS",
4585 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004586 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004587
4588 # Check for }<nl>else {, these must be at the same
4589 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004590 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4591 $previndent == $indent) {
4592 if (ERROR("ELSE_AFTER_BRACE",
4593 "else should follow close brace '}'\n" . $hereprev) &&
4594 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4595 fix_delete_line($fixlinenr - 1, $prevrawline);
4596 fix_delete_line($fixlinenr, $rawline);
4597 my $fixedline = $prevrawline;
4598 $fixedline =~ s/}\s*$//;
4599 if ($fixedline !~ /^\+\s*$/) {
4600 fix_insert_line($fixlinenr, $fixedline);
4601 }
4602 $fixedline = $rawline;
4603 $fixedline =~ s/^(.\s*)else/$1} else/;
4604 fix_insert_line($fixlinenr, $fixedline);
4605 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004606 }
4607
Joe Perches8b8856f2014-08-06 16:11:14 -07004608 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4609 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004610 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4611
4612 # Find out what is on the end of the line after the
4613 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004614 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004615 $s =~ s/\n.*//g;
4616
4617 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004618 if (ERROR("WHILE_AFTER_BRACE",
4619 "while should follow close brace '}'\n" . $hereprev) &&
4620 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4621 fix_delete_line($fixlinenr - 1, $prevrawline);
4622 fix_delete_line($fixlinenr, $rawline);
4623 my $fixedline = $prevrawline;
4624 my $trailing = $rawline;
4625 $trailing =~ s/^\+//;
4626 $trailing = trim($trailing);
4627 $fixedline =~ s/}\s*$/} $trailing/;
4628 fix_insert_line($fixlinenr, $fixedline);
4629 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004630 }
4631 }
4632
Joe Perches95e2c602013-07-03 15:05:20 -07004633#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004634 while ($line =~ m{($Constant|$Lval)}g) {
4635 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004636
4637#gcc binary extension
4638 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004639 if (WARN("GCC_BINARY_CONSTANT",
4640 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4641 $fix) {
4642 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004643 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004644 s/\b$var\b/$hexval/;
4645 }
Joe Perches95e2c602013-07-03 15:05:20 -07004646 }
4647
4648#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004649 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004650 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004651#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004652 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004653#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004654 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4655#Ignore some three character SI units explicitly, like MiB and KHz
4656 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004657 while ($var =~ m{($Ident)}g) {
4658 my $word = $1;
4659 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004660 if ($check) {
4661 seed_camelcase_includes();
4662 if (!$file && !$camelcase_file_seeded) {
4663 seed_camelcase_file($realfile);
4664 $camelcase_file_seeded = 1;
4665 }
4666 }
Joe Perches7e781f62013-09-11 14:23:55 -07004667 if (!defined $camelcase{$word}) {
4668 $camelcase{$word} = 1;
4669 CHK("CAMELCASE",
4670 "Avoid CamelCase: <$word>\n" . $herecurr);
4671 }
Joe Perches34456862013-07-03 15:05:34 -07004672 }
Joe Perches323c1262012-12-17 16:02:07 -08004673 }
4674 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004675
4676#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004677 if ($line =~ /\#\s*define.*\\\s+$/) {
4678 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4679 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4680 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004681 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004682 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004683 }
4684
Fabian Frederick0e212e02015-04-16 12:44:25 -07004685# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4686# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004687 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004688 my $file = "$1.h";
4689 my $checkfile = "include/linux/$file";
4690 if (-f "$root/$checkfile" &&
4691 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004692 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004693 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004694 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4695 if ($asminclude > 0) {
4696 if ($realfile =~ m{^arch/}) {
4697 CHK("ARCH_INCLUDE_LINUX",
4698 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4699 } else {
4700 WARN("INCLUDE_LINUX",
4701 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4702 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004703 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004704 }
4705 }
4706
Andy Whitcroft653d4872007-06-23 17:16:34 -07004707# multi-statement macros should be enclosed in a do while loop, grab the
4708# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004709# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004710 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4711 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004712 my $ln = $linenr;
4713 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004714 my ($off, $dstat, $dcond, $rest);
4715 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004716 my $has_flow_statement = 0;
4717 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004718 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004719 ctx_statement_block($linenr, $realcnt, 0);
4720 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004721 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004722 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004723
Joe Perches08a28432014-10-13 15:51:55 -07004724 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004725 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004726
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004727 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004728 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004729 $dstat =~ s/\\\n.//g;
4730 $dstat =~ s/^\s*//s;
4731 $dstat =~ s/\s*$//s;
4732
4733 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004734 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4735 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004736 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004737 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004738 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004739
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004740 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004741 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4742 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004743 {
4744 }
4745
Joe Perches42e15292016-03-15 14:58:01 -07004746 # Make asm volatile uses seem like a generic function
4747 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4748
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004749 my $exceptions = qr{
4750 $Declare|
4751 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004752 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004753 DECLARE_PER_CPU|
4754 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004755 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004756 union|
4757 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004758 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004759 ^\"|\"$|
4760 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004761 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004762 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004763 if ($dstat ne '' &&
4764 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4765 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004766 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004767 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004768 $dstat !~ /$exceptions/ &&
4769 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004770 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004771 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004772 $dstat !~ /^for\s*$Constant$/ && # for (...)
4773 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4774 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004775 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004776 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004777 {
4778 $ctx =~ s/\n*$//;
4779 my $herectx = $here . "\n";
4780 my $cnt = statement_rawlines($ctx);
4781
4782 for (my $n = 0; $n < $cnt; $n++) {
4783 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004784 }
4785
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004786 if ($dstat =~ /;/) {
4787 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4788 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4789 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004790 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004791 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004792 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004793 }
Joe Perches5023d342012-12-17 16:01:47 -08004794
Joe Perches08a28432014-10-13 15:51:55 -07004795# check for macros with flow control, but without ## concatenation
4796# ## concatenation is commonly a macro that defines a function so ignore those
4797 if ($has_flow_statement && !$has_arg_concat) {
4798 my $herectx = $here . "\n";
4799 my $cnt = statement_rawlines($ctx);
4800
4801 for (my $n = 0; $n < $cnt; $n++) {
4802 $herectx .= raw_line($linenr, $n) . "\n";
4803 }
4804 WARN("MACRO_WITH_FLOW_CONTROL",
4805 "Macros with flow control statements should be avoided\n" . "$herectx");
4806 }
4807
Joe Perches481eb482012-12-17 16:01:56 -08004808# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004809
4810 } else {
4811 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004812 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4813 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004814 $line =~ /^\+.*\\$/) {
4815 WARN("LINE_CONTINUATIONS",
4816 "Avoid unnecessary line continuations\n" . $herecurr);
4817 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004818 }
4819
Joe Perchesb13edf72012-07-30 14:41:24 -07004820# do {} while (0) macro tests:
4821# single-statement macros do not need to be enclosed in do while (0) loop,
4822# macro should not end with a semicolon
4823 if ($^V && $^V ge 5.10.0 &&
4824 $realfile !~ m@/vmlinux.lds.h$@ &&
4825 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4826 my $ln = $linenr;
4827 my $cnt = $realcnt;
4828 my ($off, $dstat, $dcond, $rest);
4829 my $ctx = '';
4830 ($dstat, $dcond, $ln, $cnt, $off) =
4831 ctx_statement_block($linenr, $realcnt, 0);
4832 $ctx = $dstat;
4833
4834 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004835 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004836
4837 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4838 my $stmts = $2;
4839 my $semis = $3;
4840
4841 $ctx =~ s/\n*$//;
4842 my $cnt = statement_rawlines($ctx);
4843 my $herectx = $here . "\n";
4844
4845 for (my $n = 0; $n < $cnt; $n++) {
4846 $herectx .= raw_line($linenr, $n) . "\n";
4847 }
4848
Joe Perchesac8e97f2012-08-21 16:15:53 -07004849 if (($stmts =~ tr/;/;/) == 1 &&
4850 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004851 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4852 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4853 }
4854 if (defined $semis && $semis ne "") {
4855 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4856 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4857 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004858 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4859 $ctx =~ s/\n*$//;
4860 my $cnt = statement_rawlines($ctx);
4861 my $herectx = $here . "\n";
4862
4863 for (my $n = 0; $n < $cnt; $n++) {
4864 $herectx .= raw_line($linenr, $n) . "\n";
4865 }
4866
4867 WARN("TRAILING_SEMICOLON",
4868 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004869 }
4870 }
4871
Mike Frysinger080ba922009-01-06 14:41:25 -08004872# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4873# all assignments may have only one of the following with an assignment:
4874# .
4875# ALIGN(...)
4876# VMLINUX_SYMBOL(...)
4877 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004878 WARN("MISSING_VMLINUX_SYMBOL",
4879 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004880 }
4881
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004882# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004883 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4884 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004885 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004886 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004887 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4888 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004889 my @allowed = ();
4890 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004891 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004892 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004893 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004894 for my $chunk (@chunks) {
4895 my ($cond, $block) = @{$chunk};
4896
Andy Whitcroft773647a2008-03-28 14:15:58 -07004897 # If the condition carries leading newlines, then count those as offsets.
4898 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4899 my $offset = statement_rawlines($whitespace) - 1;
4900
Joe Perchesaad4f612012-03-23 15:02:19 -07004901 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004902 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4903
4904 # We have looked at and allowed this specific line.
4905 $suppress_ifbraces{$ln + $offset} = 1;
4906
4907 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004908 $ln += statement_rawlines($block) - 1;
4909
Andy Whitcroft773647a2008-03-28 14:15:58 -07004910 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004911
4912 $seen++ if ($block =~ /^\s*{/);
4913
Joe Perchesaad4f612012-03-23 15:02:19 -07004914 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004915 if (statement_lines($cond) > 1) {
4916 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004917 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004918 }
4919 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004920 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004921 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004922 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004923 if (statement_block_size($block) > 1) {
4924 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004925 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004926 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004927 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004928 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004929 if ($seen) {
4930 my $sum_allowed = 0;
4931 foreach (@allowed) {
4932 $sum_allowed += $_;
4933 }
4934 if ($sum_allowed == 0) {
4935 WARN("BRACES",
4936 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4937 } elsif ($sum_allowed != $allow &&
4938 $seen != $allow) {
4939 CHK("BRACES",
4940 "braces {} should be used on all arms of this statement\n" . $herectx);
4941 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004942 }
4943 }
4944 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004945 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004946 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004947 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004948
Andy Whitcroftcf655042008-03-04 14:28:20 -08004949 # Check the pre-context.
4950 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4951 #print "APW: ALLOWED: pre<$1>\n";
4952 $allowed = 1;
4953 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004954
4955 my ($level, $endln, @chunks) =
4956 ctx_statement_full($linenr, $realcnt, $-[0]);
4957
Andy Whitcroftcf655042008-03-04 14:28:20 -08004958 # Check the condition.
4959 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004960 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004961 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004962 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004963 }
4964 if (statement_lines($cond) > 1) {
4965 #print "APW: ALLOWED: cond<$cond>\n";
4966 $allowed = 1;
4967 }
4968 if ($block =~/\b(?:if|for|while)\b/) {
4969 #print "APW: ALLOWED: block<$block>\n";
4970 $allowed = 1;
4971 }
4972 if (statement_block_size($block) > 1) {
4973 #print "APW: ALLOWED: lines block<$block>\n";
4974 $allowed = 1;
4975 }
4976 # Check the post-context.
4977 if (defined $chunks[1]) {
4978 my ($cond, $block) = @{$chunks[1]};
4979 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004980 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004981 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004982 if ($block =~ /^\s*\{/) {
4983 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4984 $allowed = 1;
4985 }
4986 }
4987 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004988 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004989 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004990
Andy Whitcroftf0556632008-10-15 22:02:23 -07004991 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004992 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004993 }
4994
Joe Perches000d1cc12011-07-25 17:13:25 -07004995 WARN("BRACES",
4996 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004997 }
4998 }
4999
Joe Perches0979ae62012-12-17 16:01:59 -08005000# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005001 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005002 if (CHK("BRACES",
5003 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5004 $fix && $prevrawline =~ /^\+/) {
5005 fix_delete_line($fixlinenr - 1, $prevrawline);
5006 }
Joe Perches0979ae62012-12-17 16:01:59 -08005007 }
Joe Perches77b9a532013-07-03 15:05:29 -07005008 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005009 if (CHK("BRACES",
5010 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5011 $fix) {
5012 fix_delete_line($fixlinenr, $rawline);
5013 }
Joe Perches0979ae62012-12-17 16:01:59 -08005014 }
5015
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005016# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005017 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5018 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005019 WARN("VOLATILE",
5020 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005021 }
5022
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005023# Check for user-visible strings broken across lines, which breaks the ability
5024# to grep for the string. Make exceptions when the previous string ends in a
5025# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5026# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005027 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005028 $prevline =~ /"\s*$/ &&
5029 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5030 if (WARN("SPLIT_STRING",
5031 "quoted string split across lines\n" . $hereprev) &&
5032 $fix &&
5033 $prevrawline =~ /^\+.*"\s*$/ &&
5034 $last_coalesced_string_linenr != $linenr - 1) {
5035 my $extracted_string = get_quoted_string($line, $rawline);
5036 my $comma_close = "";
5037 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5038 $comma_close = $1;
5039 }
5040
5041 fix_delete_line($fixlinenr - 1, $prevrawline);
5042 fix_delete_line($fixlinenr, $rawline);
5043 my $fixedline = $prevrawline;
5044 $fixedline =~ s/"\s*$//;
5045 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5046 fix_insert_line($fixlinenr - 1, $fixedline);
5047 $fixedline = $rawline;
5048 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5049 if ($fixedline !~ /\+\s*$/) {
5050 fix_insert_line($fixlinenr, $fixedline);
5051 }
5052 $last_coalesced_string_linenr = $linenr;
5053 }
5054 }
5055
5056# check for missing a space in a string concatenation
5057 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5058 WARN('MISSING_SPACE',
5059 "break quoted strings at a space character\n" . $hereprev);
5060 }
5061
5062# check for spaces before a quoted newline
5063 if ($rawline =~ /^.*\".*\s\\n/) {
5064 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5065 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5066 $fix) {
5067 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5068 }
5069
5070 }
5071
Joe Perchesf17dba42014-10-13 15:51:51 -07005072# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005073 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005074 CHK("CONCATENATED_STRING",
5075 "Concatenated strings should use spaces between elements\n" . $herecurr);
5076 }
5077
Joe Perches90ad30e2014-12-10 15:51:59 -08005078# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005079 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005080 WARN("STRING_FRAGMENTS",
5081 "Consecutive strings are generally better as a single string\n" . $herecurr);
5082 }
5083
Joe Perches6e300752015-09-09 15:37:47 -07005084# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005085 my $string;
5086 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5087 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5088 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005089 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005090 WARN("PRINTF_L",
5091 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5092 last;
5093 }
Joe Perches6e300752015-09-09 15:37:47 -07005094 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5095 ERROR("PRINTF_0xDECIMAL",
5096 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5097 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005098 }
5099
5100# check for line continuations in quoted strings with odd counts of "
5101 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5102 WARN("LINE_CONTINUATIONS",
5103 "Avoid line continuations in quoted strings\n" . $herecurr);
5104 }
5105
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005106# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005107 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005108 CHK("REDUNDANT_CODE",
5109 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005110 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005111 }
5112
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005113# check for needless "if (<foo>) fn(<foo>)" uses
5114 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005115 my $tested = quotemeta($1);
5116 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5117 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5118 my $func = $1;
5119 if (WARN('NEEDLESS_IF',
5120 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5121 $fix) {
5122 my $do_fix = 1;
5123 my $leading_tabs = "";
5124 my $new_leading_tabs = "";
5125 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5126 $leading_tabs = $1;
5127 } else {
5128 $do_fix = 0;
5129 }
5130 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5131 $new_leading_tabs = $1;
5132 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5133 $do_fix = 0;
5134 }
5135 } else {
5136 $do_fix = 0;
5137 }
5138 if ($do_fix) {
5139 fix_delete_line($fixlinenr - 1, $prevrawline);
5140 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5141 }
5142 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005143 }
5144 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005145
Joe Perchesebfdc402014-08-06 16:10:27 -07005146# check for unnecessary "Out of Memory" messages
5147 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5148 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5149 (defined $1 || defined $3) &&
5150 $linenr > 3) {
5151 my $testval = $2;
5152 my $testline = $lines[$linenr - 3];
5153
5154 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5155# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5156
5157 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5158 WARN("OOM_MESSAGE",
5159 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5160 }
5161 }
5162
Joe Perchesf78d98f2014-10-13 15:52:01 -07005163# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005164 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005165 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5166 my $level = $1;
5167 if (WARN("UNNECESSARY_KERN_LEVEL",
5168 "Possible unnecessary $level\n" . $herecurr) &&
5169 $fix) {
5170 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5171 }
5172 }
5173
Joe Perchesabb08a52014-12-10 15:51:46 -08005174# check for mask then right shift without a parentheses
5175 if ($^V && $^V ge 5.10.0 &&
5176 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5177 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5178 WARN("MASK_THEN_SHIFT",
5179 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5180 }
5181
Joe Perchesb75ac612014-12-10 15:52:02 -08005182# check for pointer comparisons to NULL
5183 if ($^V && $^V ge 5.10.0) {
5184 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5185 my $val = $1;
5186 my $equal = "!";
5187 $equal = "" if ($4 eq "!=");
5188 if (CHK("COMPARISON_TO_NULL",
5189 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5190 $fix) {
5191 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5192 }
5193 }
5194 }
5195
Joe Perches8716de32013-09-11 14:24:05 -07005196# check for bad placement of section $InitAttribute (e.g.: __initdata)
5197 if ($line =~ /(\b$InitAttribute\b)/) {
5198 my $attr = $1;
5199 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5200 my $ptr = $1;
5201 my $var = $2;
5202 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5203 ERROR("MISPLACED_INIT",
5204 "$attr should be placed after $var\n" . $herecurr)) ||
5205 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5206 WARN("MISPLACED_INIT",
5207 "$attr should be placed after $var\n" . $herecurr))) &&
5208 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005209 $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 -07005210 }
5211 }
5212 }
5213
Joe Perchese970b8842013-11-12 15:10:10 -08005214# check for $InitAttributeData (ie: __initdata) with const
5215 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5216 my $attr = $1;
5217 $attr =~ /($InitAttributePrefix)(.*)/;
5218 my $attr_prefix = $1;
5219 my $attr_type = $2;
5220 if (ERROR("INIT_ATTRIBUTE",
5221 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5222 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005223 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005224 s/$InitAttributeData/${attr_prefix}initconst/;
5225 }
5226 }
5227
5228# check for $InitAttributeConst (ie: __initconst) without const
5229 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5230 my $attr = $1;
5231 if (ERROR("INIT_ATTRIBUTE",
5232 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5233 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005234 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005235 /(^\+\s*(?:static\s+))/;
5236 $lead = rtrim($1);
5237 $lead = "$lead " if ($lead !~ /^\+$/);
5238 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005239 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005240 }
5241 }
5242
Joe Perchesc17893c2015-04-16 12:44:42 -07005243# check for __read_mostly with const non-pointer (should just be const)
5244 if ($line =~ /\b__read_mostly\b/ &&
5245 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5246 if (ERROR("CONST_READ_MOSTLY",
5247 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5248 $fix) {
5249 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5250 }
5251 }
5252
Joe Perchesfbdb8132014-04-03 14:49:14 -07005253# don't use __constant_<foo> functions outside of include/uapi/
5254 if ($realfile !~ m@^include/uapi/@ &&
5255 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5256 my $constant_func = $1;
5257 my $func = $constant_func;
5258 $func =~ s/^__constant_//;
5259 if (WARN("CONSTANT_CONVERSION",
5260 "$constant_func should be $func\n" . $herecurr) &&
5261 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005262 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005263 }
5264 }
5265
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005266# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005267 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005268 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005269 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005270 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005271 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005272 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5273 }
5274 if ($delay > 2000) {
5275 WARN("LONG_UDELAY",
5276 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005277 }
5278 }
5279
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005280# warn about unexpectedly long msleep's
5281 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5282 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005283 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005284 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005285 }
5286 }
5287
Joe Perches36ec1932013-07-03 15:05:25 -07005288# check for comparisons of jiffies
5289 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5290 WARN("JIFFIES_COMPARISON",
5291 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5292 }
5293
Joe Perches9d7a34a2013-07-03 15:05:26 -07005294# check for comparisons of get_jiffies_64()
5295 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5296 WARN("JIFFIES_COMPARISON",
5297 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5298 }
5299
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005300# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005301# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07005302# print "#ifdef in C files should be avoided\n";
5303# print "$herecurr";
5304# $clean = 0;
5305# }
5306
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005307# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005308 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005309 if (ERROR("SPACING",
5310 "exactly one space required after that #$1\n" . $herecurr) &&
5311 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005312 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005313 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5314 }
5315
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005316 }
5317
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005318# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005319 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5320 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005321 my $which = $1;
5322 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005323 CHK("UNCOMMENTED_DEFINITION",
5324 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005325 }
5326 }
5327# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005328
5329 my $barriers = qr{
5330 mb|
5331 rmb|
5332 wmb|
5333 read_barrier_depends
5334 }x;
5335 my $barrier_stems = qr{
5336 mb__before_atomic|
5337 mb__after_atomic|
5338 store_release|
5339 load_acquire|
5340 store_mb|
5341 (?:$barriers)
5342 }x;
5343 my $all_barriers = qr{
5344 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005345 smp_(?:$barrier_stems)|
5346 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005347 }x;
5348
5349 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005350 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005351 WARN("MEMORY_BARRIER",
5352 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005353 }
5354 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005355
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005356 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5357
5358 if ($realfile !~ m@^include/asm-generic/@ &&
5359 $realfile !~ m@/barrier\.h$@ &&
5360 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5361 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5362 WARN("MEMORY_BARRIER",
5363 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5364 }
5365
Joe Perchescb426e92015-06-25 15:02:46 -07005366# check for waitqueue_active without a comment.
5367 if ($line =~ /\bwaitqueue_active\s*\(/) {
5368 if (!ctx_has_comment($first_line, $linenr)) {
5369 WARN("WAITQUEUE_ACTIVE",
5370 "waitqueue_active without comment\n" . $herecurr);
5371 }
5372 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005373
5374# Check for expedited grace periods that interrupt non-idle non-nohz
5375# online CPUs. These expedited can therefore degrade real-time response
5376# if used carelessly, and should be avoided where not absolutely
5377# needed. It is always OK to use synchronize_rcu_expedited() and
5378# synchronize_sched_expedited() at boot time (before real-time applications
5379# start) and in error situations where real-time response is compromised in
5380# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5381# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5382# Of course, nothing comes for free, and srcu_read_lock() and
5383# srcu_read_unlock() do contain full memory barriers in payment for
5384# synchronize_srcu_expedited() non-interruption properties.
5385 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5386 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5387 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5388
5389 }
5390
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005391# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005392 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005393 CHK("ARCH_DEFINES",
5394 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005395 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005396
Tobias Klauserd4977c72010-05-24 14:33:30 -07005397# Check that the storage class is at the beginning of a declaration
5398 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005399 WARN("STORAGE_CLASS",
5400 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005401 }
5402
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005403# check the location of the inline attribute, that it is between
5404# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005405 if ($line =~ /\b$Type\s+$Inline\b/ ||
5406 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005407 ERROR("INLINE_LOCATION",
5408 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005409 }
5410
Andy Whitcroft8905a672007-11-28 16:21:06 -08005411# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005412 if ($realfile !~ m@\binclude/uapi/@ &&
5413 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005414 if (WARN("INLINE",
5415 "plain inline is preferred over $1\n" . $herecurr) &&
5416 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005417 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005418
5419 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005420 }
5421
Joe Perches3d130fd2011-01-12 17:00:00 -08005422# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005423 if ($realfile !~ m@\binclude/uapi/@ &&
5424 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005425 WARN("PREFER_PACKED",
5426 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005427 }
5428
Joe Perches39b7e282011-07-25 17:13:24 -07005429# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005430 if ($realfile !~ m@\binclude/uapi/@ &&
5431 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005432 WARN("PREFER_ALIGNED",
5433 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005434 }
5435
Joe Perches5f14d3b2012-01-10 15:09:52 -08005436# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005437 if ($realfile !~ m@\binclude/uapi/@ &&
5438 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005439 if (WARN("PREFER_PRINTF",
5440 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5441 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005442 $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 -07005443
5444 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005445 }
5446
Joe Perches6061d942012-03-23 15:02:16 -07005447# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005448 if ($realfile !~ m@\binclude/uapi/@ &&
5449 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005450 if (WARN("PREFER_SCANF",
5451 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5452 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005453 $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 -07005454 }
Joe Perches6061d942012-03-23 15:02:16 -07005455 }
5456
Joe Perches619a9082014-12-10 15:51:35 -08005457# Check for __attribute__ weak, or __weak declarations (may have link issues)
5458 if ($^V && $^V ge 5.10.0 &&
5459 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5460 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5461 $line =~ /\b__weak\b/)) {
5462 ERROR("WEAK_DECLARATION",
5463 "Using weak declarations can have unintended link defects\n" . $herecurr);
5464 }
5465
Joe Perchese6176fa2015-06-25 15:02:49 -07005466# check for c99 types like uint8_t used outside of uapi/
5467 if ($realfile !~ m@\binclude/uapi/@ &&
5468 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5469 my $type = $1;
5470 if ($type =~ /\b($typeC99Typedefs)\b/) {
5471 $type = $1;
5472 my $kernel_type = 'u';
5473 $kernel_type = 's' if ($type =~ /^_*[si]/);
5474 $type =~ /(\d+)/;
5475 $kernel_type .= $1;
5476 if (CHK("PREFER_KERNEL_TYPES",
5477 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5478 $fix) {
5479 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5480 }
5481 }
5482 }
5483
Joe Perches938224b52016-01-20 14:59:15 -08005484# check for cast of C90 native int or longer types constants
5485 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5486 my $cast = $1;
5487 my $const = $2;
5488 if (WARN("TYPECAST_INT_CONSTANT",
5489 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5490 $fix) {
5491 my $suffix = "";
5492 my $newconst = $const;
5493 $newconst =~ s/${Int_type}$//;
5494 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5495 if ($cast =~ /\blong\s+long\b/) {
5496 $suffix .= 'LL';
5497 } elsif ($cast =~ /\blong\b/) {
5498 $suffix .= 'L';
5499 }
5500 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5501 }
5502 }
5503
Joe Perches8f53a9b2010-03-05 13:43:48 -08005504# check for sizeof(&)
5505 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005506 WARN("SIZEOF_ADDRESS",
5507 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005508 }
5509
Joe Perches66c80b62012-07-30 14:41:22 -07005510# check for sizeof without parenthesis
5511 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005512 if (WARN("SIZEOF_PARENTHESIS",
5513 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5514 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005515 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005516 }
Joe Perches66c80b62012-07-30 14:41:22 -07005517 }
5518
Joe Perches88982fe2012-12-17 16:02:00 -08005519# check for struct spinlock declarations
5520 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5521 WARN("USE_SPINLOCK_T",
5522 "struct spinlock should be spinlock_t\n" . $herecurr);
5523 }
5524
Joe Perchesa6962d72013-04-29 16:18:13 -07005525# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005526 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005527 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005528 $fmt =~ s/%%//g;
5529 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005530 if (WARN("PREFER_SEQ_PUTS",
5531 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5532 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005533 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005534 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005535 }
5536 }
5537
Andy Whitcroft554e1652012-01-10 15:09:57 -08005538# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005539 if ($^V && $^V ge 5.10.0 &&
5540 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005541 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005542
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005543 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005544 my $ms_val = $7;
5545 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005546
Andy Whitcroft554e1652012-01-10 15:09:57 -08005547 if ($ms_size =~ /^(0x|)0$/i) {
5548 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005549 "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 -08005550 } elsif ($ms_size =~ /^(0x|)1$/i) {
5551 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005552 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5553 }
5554 }
5555
Joe Perches98a9bba2014-01-23 15:54:52 -08005556# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5557 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005558 defined $stat &&
5559 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005560 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005561 "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 -08005562 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005563 $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 -08005564 }
5565 }
5566
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005567# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5568 if ($^V && $^V ge 5.10.0 &&
5569 defined $stat &&
5570 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5571 WARN("PREFER_ETHER_ADDR_EQUAL",
5572 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5573 }
5574
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005575# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5576# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5577 if ($^V && $^V ge 5.10.0 &&
5578 defined $stat &&
5579 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5580
5581 my $ms_val = $7;
5582
5583 if ($ms_val =~ /^(?:0x|)0+$/i) {
5584 if (WARN("PREFER_ETH_ZERO_ADDR",
5585 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5586 $fix) {
5587 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5588 }
5589 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5590 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5591 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5592 $fix) {
5593 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5594 }
5595 }
5596 }
5597
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005598# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005599 if ($^V && $^V ge 5.10.0 &&
5600 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005601 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005602 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005603 my $call = $1;
5604 my $cast1 = deparenthesize($2);
5605 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005606 my $cast2 = deparenthesize($7);
5607 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005608 my $cast;
5609
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005610 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005611 $cast = "$cast1 or $cast2";
5612 } elsif ($cast1 ne "") {
5613 $cast = $cast1;
5614 } else {
5615 $cast = $cast2;
5616 }
5617 WARN("MINMAX",
5618 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005619 }
5620 }
5621
Joe Perches4a273192012-07-30 14:41:20 -07005622# check usleep_range arguments
5623 if ($^V && $^V ge 5.10.0 &&
5624 defined $stat &&
5625 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5626 my $min = $1;
5627 my $max = $7;
5628 if ($min eq $max) {
5629 WARN("USLEEP_RANGE",
5630 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5631 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5632 $min > $max) {
5633 WARN("USLEEP_RANGE",
5634 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5635 }
5636 }
5637
Joe Perches823b7942013-11-12 15:10:15 -08005638# check for naked sscanf
5639 if ($^V && $^V ge 5.10.0 &&
5640 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005641 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005642 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5643 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5644 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5645 my $lc = $stat =~ tr@\n@@;
5646 $lc = $lc + $linenr;
5647 my $stat_real = raw_line($linenr, 0);
5648 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5649 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5650 }
5651 WARN("NAKED_SSCANF",
5652 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5653 }
5654
Joe Perchesafc819a2014-06-04 16:12:08 -07005655# check for simple sscanf that should be kstrto<foo>
5656 if ($^V && $^V ge 5.10.0 &&
5657 defined $stat &&
5658 $line =~ /\bsscanf\b/) {
5659 my $lc = $stat =~ tr@\n@@;
5660 $lc = $lc + $linenr;
5661 my $stat_real = raw_line($linenr, 0);
5662 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5663 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5664 }
5665 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5666 my $format = $6;
5667 my $count = $format =~ tr@%@%@;
5668 if ($count == 1 &&
5669 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5670 WARN("SSCANF_TO_KSTRTO",
5671 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5672 }
5673 }
5674 }
5675
Joe Perches70dc8a42013-09-11 14:23:58 -07005676# check for new externs in .h files.
5677 if ($realfile =~ /\.h$/ &&
5678 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005679 if (CHK("AVOID_EXTERNS",
5680 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005681 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005682 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005683 }
5684 }
5685
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005686# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005687 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005688 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005689 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005690 my $function_name = $1;
5691 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005692
5693 my $s = $stat;
5694 if (defined $cond) {
5695 substr($s, 0, length($cond), '');
5696 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005697 if ($s =~ /^\s*;/ &&
5698 $function_name ne 'uninitialized_var')
5699 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005700 WARN("AVOID_EXTERNS",
5701 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005702 }
5703
5704 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005705 WARN("FUNCTION_ARGUMENTS",
5706 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005707 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005708
5709 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5710 $stat =~ /^.\s*extern\s+/)
5711 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005712 WARN("AVOID_EXTERNS",
5713 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005714 }
5715
5716# checks for new __setup's
5717 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5718 my $name = $1;
5719
5720 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005721 CHK("UNDOCUMENTED_SETUP",
5722 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005723 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005724 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005725
5726# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005727 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005728 WARN("UNNECESSARY_CASTS",
5729 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005730 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005731
Joe Perchesa640d252013-07-03 15:05:21 -07005732# alloc style
5733# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5734 if ($^V && $^V ge 5.10.0 &&
5735 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5736 CHK("ALLOC_SIZEOF_STRUCT",
5737 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5738 }
5739
Joe Perches60a55362014-06-04 16:12:07 -07005740# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5741 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005742 $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 -07005743 my $oldfunc = $3;
5744 my $a1 = $4;
5745 my $a2 = $10;
5746 my $newfunc = "kmalloc_array";
5747 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005748 my $r1 = $a1;
5749 my $r2 = $a2;
5750 if ($a1 =~ /^sizeof\s*\S/) {
5751 $r1 = $a2;
5752 $r2 = $a1;
5753 }
5754 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5755 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005756 if (WARN("ALLOC_WITH_MULTIPLY",
5757 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5758 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005759 $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 -07005760
5761 }
5762 }
5763 }
5764
Joe Perches972fdea2013-04-29 16:18:12 -07005765# check for krealloc arg reuse
5766 if ($^V && $^V ge 5.10.0 &&
5767 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5768 WARN("KREALLOC_ARG_REUSE",
5769 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5770 }
5771
Joe Perches5ce59ae2013-02-21 16:44:18 -08005772# check for alloc argument mismatch
5773 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5774 WARN("ALLOC_ARRAY_ARGS",
5775 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5776 }
5777
Joe Perchescaf2a542011-01-12 16:59:56 -08005778# check for multiple semicolons
5779 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005780 if (WARN("ONE_SEMICOLON",
5781 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5782 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005783 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005784 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005785 }
5786
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005787# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5788 if ($realfile !~ m@^include/uapi/@ &&
5789 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08005790 my $ull = "";
5791 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5792 if (CHK("BIT_MACRO",
5793 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5794 $fix) {
5795 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5796 }
5797 }
5798
Joe Perches2d632742016-05-20 17:04:00 -07005799# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5800 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5801 my $config = $1;
5802 if (WARN("PREFER_IS_ENABLED",
5803 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5804 $fix) {
5805 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5806 }
5807 }
5808
Joe Perchese81f2392014-08-06 16:11:25 -07005809# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005810 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5811 my $has_break = 0;
5812 my $has_statement = 0;
5813 my $count = 0;
5814 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005815 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005816 $prevline--;
5817 my $rline = $rawlines[$prevline - 1];
5818 my $fline = $lines[$prevline - 1];
5819 last if ($fline =~ /^\@\@/);
5820 next if ($fline =~ /^\-/);
5821 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5822 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5823 next if ($fline =~ /^.[\s$;]*$/);
5824 $has_statement = 1;
5825 $count++;
5826 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5827 }
5828 if (!$has_break && $has_statement) {
5829 WARN("MISSING_BREAK",
5830 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5831 }
5832 }
5833
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005834# check for switch/default statements without a break;
5835 if ($^V && $^V ge 5.10.0 &&
5836 defined $stat &&
5837 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5838 my $ctx = '';
5839 my $herectx = $here . "\n";
5840 my $cnt = statement_rawlines($stat);
5841 for (my $n = 0; $n < $cnt; $n++) {
5842 $herectx .= raw_line($linenr, $n) . "\n";
5843 }
5844 WARN("DEFAULT_NO_BREAK",
5845 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005846 }
5847
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005848# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005849 if ($line =~ /\b__FUNCTION__\b/) {
5850 if (WARN("USE_FUNC",
5851 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5852 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005853 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005854 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005855 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005856
Joe Perches62ec8182015-02-13 14:38:18 -08005857# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5858 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5859 ERROR("DATE_TIME",
5860 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5861 }
5862
Joe Perches2c924882012-03-23 15:02:20 -07005863# check for use of yield()
5864 if ($line =~ /\byield\s*\(\s*\)/) {
5865 WARN("YIELD",
5866 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5867 }
5868
Joe Perches179f8f42013-07-03 15:05:30 -07005869# check for comparisons against true and false
5870 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5871 my $lead = $1;
5872 my $arg = $2;
5873 my $test = $3;
5874 my $otype = $4;
5875 my $trail = $5;
5876 my $op = "!";
5877
5878 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5879
5880 my $type = lc($otype);
5881 if ($type =~ /^(?:true|false)$/) {
5882 if (("$test" eq "==" && "$type" eq "true") ||
5883 ("$test" eq "!=" && "$type" eq "false")) {
5884 $op = "";
5885 }
5886
5887 CHK("BOOL_COMPARISON",
5888 "Using comparison to $otype is error prone\n" . $herecurr);
5889
5890## maybe suggesting a correct construct would better
5891## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5892
5893 }
5894 }
5895
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005896# check for semaphores initialized locked
5897 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005898 WARN("CONSIDER_COMPLETION",
5899 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005900 }
Joe Perches6712d852012-03-23 15:02:20 -07005901
Joe Perches67d0a072011-10-31 17:13:10 -07005902# recommend kstrto* over simple_strto* and strict_strto*
5903 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005904 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005905 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005906 }
Joe Perches6712d852012-03-23 15:02:20 -07005907
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005908# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005909 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005910 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005911 "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 -07005912 }
Joe Perches6712d852012-03-23 15:02:20 -07005913
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005914# check for various structs that are normally const (ops, kgdb, device_tree)
5915 my $const_structs = qr{
5916 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005917 address_space_operations|
5918 backlight_ops|
5919 block_device_operations|
5920 dentry_operations|
5921 dev_pm_ops|
5922 dma_map_ops|
5923 extent_io_ops|
5924 file_lock_operations|
5925 file_operations|
5926 hv_ops|
5927 ide_dma_ops|
5928 intel_dvo_dev_ops|
5929 item_operations|
5930 iwl_ops|
5931 kgdb_arch|
5932 kgdb_io|
5933 kset_uevent_ops|
5934 lock_manager_operations|
5935 microcode_ops|
5936 mtrr_ops|
5937 neigh_ops|
5938 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005939 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005940 pci_raw_ops|
5941 pipe_buf_operations|
5942 platform_hibernation_ops|
5943 platform_suspend_ops|
5944 proto_ops|
5945 rpc_pipe_ops|
5946 seq_operations|
5947 snd_ac97_build_ops|
5948 soc_pcmcia_socket_ops|
5949 stacktrace_ops|
5950 sysfs_ops|
5951 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005952 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005953 usb_mon_operations|
5954 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005955 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005956 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005957 WARN("CONST_STRUCT",
5958 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005959 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005960 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005961
5962# use of NR_CPUS is usually wrong
5963# ignore definitions of NR_CPUS and usage to define arrays as likely right
5964 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005965 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5966 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005967 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5968 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5969 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005970 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005971 WARN("NR_CPUS",
5972 "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 -07005973 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005974
Joe Perches52ea8502013-11-12 15:10:09 -08005975# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5976 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5977 ERROR("DEFINE_ARCH_HAS",
5978 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5979 }
5980
Joe Perchesacd93622015-02-13 14:38:38 -08005981# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5982 if ($^V && $^V ge 5.10.0 &&
5983 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5984 WARN("LIKELY_MISUSE",
5985 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5986 }
5987
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005988# whine mightly about in_atomic
5989 if ($line =~ /\bin_atomic\s*\(/) {
5990 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005991 ERROR("IN_ATOMIC",
5992 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005993 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005994 WARN("IN_ATOMIC",
5995 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005996 }
5997 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005998
Joe Perches481aea52016-05-20 17:04:08 -07005999# whine about ACCESS_ONCE
6000 if ($^V && $^V ge 5.10.0 &&
6001 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6002 my $par = $1;
6003 my $eq = $2;
6004 my $fun = $3;
6005 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6006 if (defined($eq)) {
6007 if (WARN("PREFER_WRITE_ONCE",
6008 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6009 $fix) {
6010 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6011 }
6012 } else {
6013 if (WARN("PREFER_READ_ONCE",
6014 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6015 $fix) {
6016 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6017 }
6018 }
6019 }
6020
Peter Zijlstra1704f472010-03-19 01:37:42 +01006021# check for lockdep_set_novalidate_class
6022 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6023 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6024 if ($realfile !~ m@^kernel/lockdep@ &&
6025 $realfile !~ m@^include/linux/lockdep@ &&
6026 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006027 ERROR("LOCKDEP",
6028 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006029 }
6030 }
Dave Jones88f88312011-01-12 16:59:59 -08006031
Joe Perchesb392c642015-04-16 12:44:16 -07006032 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6033 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006034 WARN("EXPORTED_WORLD_WRITABLE",
6035 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006036 }
Joe Perches24358802014-04-03 14:49:13 -07006037
Joe Perches515a2352014-04-03 14:49:24 -07006038# Mode permission misuses where it seems decimal should be octal
6039# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6040 if ($^V && $^V ge 5.10.0 &&
6041 $line =~ /$mode_perms_search/) {
6042 foreach my $entry (@mode_permission_funcs) {
6043 my $func = $entry->[0];
6044 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006045
Joe Perches515a2352014-04-03 14:49:24 -07006046 my $skip_args = "";
6047 if ($arg_pos > 1) {
6048 $arg_pos--;
6049 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6050 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006051 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]";
Joe Perches515a2352014-04-03 14:49:24 -07006052 if ($line =~ /$test/) {
6053 my $val = $1;
6054 $val = $6 if ($skip_args ne "");
Joe Perchesf90774e2016-10-11 13:51:47 -07006055 if (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6056 ($val =~ /^$Octal$/ && length($val) ne 4)) {
Joe Perches515a2352014-04-03 14:49:24 -07006057 ERROR("NON_OCTAL_PERMISSIONS",
6058 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesf90774e2016-10-11 13:51:47 -07006059 }
6060 if ($val =~ /^$Octal$/ && (oct($val) & 02)) {
Joe Perchesc0a5c892015-02-13 14:38:21 -08006061 ERROR("EXPORTED_WORLD_WRITABLE",
6062 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006063 }
Joe Perchesf90774e2016-10-11 13:51:47 -07006064 if ($val =~ /\b$mode_perms_string_search\b/) {
6065 my $to = 0;
6066 while ($val =~ /\b($mode_perms_string_search)\b(?:\s*\|\s*)?\s*/g) {
6067 $to |= $mode_permission_string_types{$1};
6068 }
6069 my $new = sprintf("%04o", $to);
6070 if (WARN("SYMBOLIC_PERMS",
6071 "Symbolic permissions are not preferred. Consider using octal permissions $new.\n" . $herecurr) &&
6072 $fix) {
6073 $fixed[$fixlinenr] =~ s/\Q$val\E/$new/;
6074 }
6075 }
Joe Perches24358802014-04-03 14:49:13 -07006076 }
6077 }
6078 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006079
6080# validate content of MODULE_LICENSE against list from include/linux/module.h
6081 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6082 my $extracted_string = get_quoted_string($line, $rawline);
6083 my $valid_licenses = qr{
6084 GPL|
6085 GPL\ v2|
6086 GPL\ and\ additional\ rights|
6087 Dual\ BSD/GPL|
6088 Dual\ MIT/GPL|
6089 Dual\ MPL/GPL|
6090 Proprietary
6091 }x;
6092 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6093 WARN("MODULE_LICENSE",
6094 "unknown module license " . $extracted_string . "\n" . $herecurr);
6095 }
6096 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006097 }
6098
6099 # If we have no input at all, then there is nothing to report on
6100 # so just keep quiet.
6101 if ($#rawlines == -1) {
6102 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006103 }
6104
Andy Whitcroft8905a672007-11-28 16:21:06 -08006105 # In mailback mode only produce a report in the negative, for
6106 # things that appear to be patches.
6107 if ($mailback && ($clean == 1 || !$is_patch)) {
6108 exit(0);
6109 }
6110
6111 # This is not a patch, and we are are in 'no-patch' mode so
6112 # just keep quiet.
6113 if (!$chk_patch && !$is_patch) {
6114 exit(0);
6115 }
6116
Joe Perches06330fc2015-06-25 15:03:11 -07006117 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006118 ERROR("NOT_UNIFIED_DIFF",
6119 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006120 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006121 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006122 ERROR("MISSING_SIGN_OFF",
6123 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006124 }
6125
Andy Whitcroft8905a672007-11-28 16:21:06 -08006126 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006127 if ($summary && !($clean == 1 && $quiet == 1)) {
6128 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006129 print "total: $cnt_error errors, $cnt_warn warnings, " .
6130 (($check)? "$cnt_chk checks, " : "") .
6131 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006132 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006133
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006134 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006135 # If there were any defects found and not already fixing them
6136 if (!$clean and !$fix) {
6137 print << "EOM"
6138
6139NOTE: For some of the reported defects, checkpatch may be able to
6140 mechanically convert to the typical style using --fix or --fix-inplace.
6141EOM
6142 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006143 # If there were whitespace errors which cleanpatch can fix
6144 # then suggest that.
6145 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006146 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006147 print << "EOM"
6148
6149NOTE: Whitespace errors detected.
6150 You may wish to use scripts/cleanpatch or scripts/cleanfile
6151EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006152 }
6153 }
6154
Joe Perchesd752fcc2014-08-06 16:11:05 -07006155 if ($clean == 0 && $fix &&
6156 ("@rawlines" ne "@fixed" ||
6157 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006158 my $newfile = $filename;
6159 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006160 my $linecount = 0;
6161 my $f;
6162
Joe Perchesd752fcc2014-08-06 16:11:05 -07006163 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6164
Joe Perches3705ce52013-07-03 15:05:31 -07006165 open($f, '>', $newfile)
6166 or die "$P: Can't open $newfile for write\n";
6167 foreach my $fixed_line (@fixed) {
6168 $linecount++;
6169 if ($file) {
6170 if ($linecount > 3) {
6171 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006172 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006173 }
6174 } else {
6175 print $f $fixed_line . "\n";
6176 }
6177 }
6178 close($f);
6179
6180 if (!$quiet) {
6181 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006182
Joe Perches3705ce52013-07-03 15:05:31 -07006183Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6184
6185Do _NOT_ trust the results written to this file.
6186Do _NOT_ submit these changes without inspecting them for correctness.
6187
6188This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6189No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006190EOM
6191 }
6192 }
6193
Joe Perchesd8469f12015-06-25 15:03:00 -07006194 if ($quiet == 0) {
6195 print "\n";
6196 if ($clean == 1) {
6197 print "$vname has no obvious style problems and is ready for submission.\n";
6198 } else {
6199 print "$vname has style problems, please review.\n";
6200 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006201 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006202 return $clean;
6203}