blob: 34b4455740115458c127f83bd161459522298514 [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 Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy 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 Perches2ac73b42014-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 Perches2ac73b42014-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 Perches938224b2016-01-20 14:59:15 -0800486
487our $C90_int_types = qr{(?x:
488 long\s+long\s+int\s+(?:un)?signed|
489 long\s+long\s+(?:un)?signed\s+int|
490 long\s+long\s+(?:un)?signed|
491 (?:(?:un)?signed\s+)?long\s+long\s+int|
492 (?:(?:un)?signed\s+)?long\s+long|
493 int\s+long\s+long\s+(?:un)?signed|
494 int\s+(?:(?:un)?signed\s+)?long\s+long|
495
496 long\s+int\s+(?:un)?signed|
497 long\s+(?:un)?signed\s+int|
498 long\s+(?:un)?signed|
499 (?:(?:un)?signed\s+)?long\s+int|
500 (?:(?:un)?signed\s+)?long|
501 int\s+long\s+(?:un)?signed|
502 int\s+(?:(?:un)?signed\s+)?long|
503
504 int\s+(?:un)?signed|
505 (?:(?:un)?signed\s+)?int
506)};
507
Alex Dowad485ff232015-06-25 15:02:52 -0700508our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700509our @typeListWithAttr = (
510 @typeList,
511 qr{struct\s+$InitAttribute\s+$Ident},
512 qr{union\s+$InitAttribute\s+$Ident},
513);
514
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700515our @modifierList = (
516 qr{fastcall},
517);
Alex Dowad485ff232015-06-25 15:02:52 -0700518our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800519
Joe Perches24358802014-04-03 14:49:13 -0700520our @mode_permission_funcs = (
521 ["module_param", 3],
522 ["module_param_(?:array|named|string)", 4],
523 ["module_param_array_named", 5],
524 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
525 ["proc_create(?:_data|)", 2],
526 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
527);
528
Joe Perches515a2352014-04-03 14:49:24 -0700529#Create a search pattern for all these functions to speed up a loop below
530our $mode_perms_search = "";
531foreach my $entry (@mode_permission_funcs) {
532 $mode_perms_search .= '|' if ($mode_perms_search ne "");
533 $mode_perms_search .= $entry->[0];
534}
535
Joe Perchesb392c642015-04-16 12:44:16 -0700536our $mode_perms_world_writable = qr{
537 S_IWUGO |
538 S_IWOTH |
539 S_IRWXUGO |
540 S_IALLUGO |
541 0[0-7][0-7][2367]
542}x;
543
Wolfram Sang7840a942010-08-09 17:20:57 -0700544our $allowed_asm_includes = qr{(?x:
545 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700546 memory|
547 time|
548 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700549)};
550# memory.h: ARM has a custom one
551
Kees Cook66b47b42014-10-13 15:51:57 -0700552# Load common spelling mistakes and build regular expression list.
553my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700554my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700555
Joe Perches36061e32014-12-10 15:51:43 -0800556if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800557 while (<$spelling>) {
558 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700559
Joe Perches36061e32014-12-10 15:51:43 -0800560 $line =~ s/\s*\n?$//g;
561 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700562
Joe Perches36061e32014-12-10 15:51:43 -0800563 next if ($line =~ m/^\s*#/);
564 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700565
Joe Perches36061e32014-12-10 15:51:43 -0800566 my ($suspect, $fix) = split(/\|\|/, $line);
567
Joe Perches36061e32014-12-10 15:51:43 -0800568 $spelling_fix{$suspect} = $fix;
569 }
570 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800571} else {
572 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700573}
Kees Cook66b47b42014-10-13 15:51:57 -0700574
Joe Perchesebfd7d62015-04-16 12:44:14 -0700575if ($codespell) {
576 if (open(my $spelling, '<', $codespellfile)) {
577 while (<$spelling>) {
578 my $line = $_;
579
580 $line =~ s/\s*\n?$//g;
581 $line =~ s/^\s*//g;
582
583 next if ($line =~ m/^\s*#/);
584 next if ($line =~ m/^\s*$/);
585 next if ($line =~ m/, disabled/i);
586
587 $line =~ s/,.*$//;
588
589 my ($suspect, $fix) = split(/->/, $line);
590
591 $spelling_fix{$suspect} = $fix;
592 }
593 close($spelling);
594 } else {
595 warn "No codespell typos will be found - file '$codespellfile': $!\n";
596 }
597}
598
599$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
600
Andy Whitcroft8905a672007-11-28 16:21:06 -0800601sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700602 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
603 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700604 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700605 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700606 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700607 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700608 (?:$typeTypedefs\b)|
609 (?:${all}\b)
610 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800611 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700612 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800613 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800614 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700615 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700616 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800617 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700618 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800619 }x;
Joe Perches18130872014-08-06 16:11:22 -0700620 $NonptrTypeMisordered = qr{
621 (?:$Modifier\s+|const\s+)*
622 (?:
623 (?:${Misordered}\b)
624 )
625 (?:\s+$Modifier|\s+const)*
626 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700627 $NonptrTypeWithAttr = qr{
628 (?:$Modifier\s+|const\s+)*
629 (?:
630 (?:typeof|__typeof__)\s*\([^\)]*\)|
631 (?:$typeTypedefs\b)|
632 (?:${allWithAttr}\b)
633 )
634 (?:\s+$Modifier|\s+const)*
635 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800636 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700637 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700638 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700639 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800640 }x;
Joe Perches18130872014-08-06 16:11:22 -0700641 $TypeMisordered = qr{
642 $NonptrTypeMisordered
643 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
644 (?:\s+$Inline|\s+$Modifier)*
645 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700646 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700647 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800648}
649build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700650
Joe Perches7d2367a2011-07-25 17:13:22 -0700651our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700652
653# Using $balanced_parens, $LvalOrFunc, or $FuncArg
654# requires at least perl version v5.10.0
655# Any use must be runtime checked with $^V
656
657our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700658our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800659our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700660
Joe Perchesf8422302014-08-06 16:11:31 -0700661our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700662 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700663 (?:$Storage\s+)?LIST_HEAD\s*\(|
664 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
665)};
666
Joe Perches7d2367a2011-07-25 17:13:22 -0700667sub deparenthesize {
668 my ($string) = @_;
669 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700670
671 while ($string =~ /^\s*\(.*\)\s*$/) {
672 $string =~ s@^\s*\(\s*@@;
673 $string =~ s@\s*\)\s*$@@;
674 }
675
Joe Perches7d2367a2011-07-25 17:13:22 -0700676 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700677
Joe Perches7d2367a2011-07-25 17:13:22 -0700678 return $string;
679}
680
Joe Perches34456862013-07-03 15:05:34 -0700681sub seed_camelcase_file {
682 my ($file) = @_;
683
684 return if (!(-f $file));
685
686 local $/;
687
688 open(my $include_file, '<', "$file")
689 or warn "$P: Can't read '$file' $!\n";
690 my $text = <$include_file>;
691 close($include_file);
692
693 my @lines = split('\n', $text);
694
695 foreach my $line (@lines) {
696 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
697 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
698 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800699 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
700 $camelcase{$1} = 1;
701 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700702 $camelcase{$1} = 1;
703 }
704 }
705}
706
Joe Perches85b0ee12016-10-11 13:51:44 -0700707sub is_maintained_obsolete {
708 my ($filename) = @_;
709
710 return 0 if (!(-e "$root/scripts/get_maintainer.pl"));
711
712 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback $filename 2>&1`;
713
714 return $status =~ /obsolete/i;
715}
716
Joe Perches34456862013-07-03 15:05:34 -0700717my $camelcase_seeded = 0;
718sub seed_camelcase_includes {
719 return if ($camelcase_seeded);
720
721 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700722 my $camelcase_cache = "";
723 my @include_files = ();
724
725 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700726
Richard Genoud3645e322014-02-10 14:25:32 -0800727 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700728 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
729 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700730 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700731 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700732 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700733 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700734 @include_files = split('\n', $files);
735 foreach my $file (@include_files) {
736 my $date = POSIX::strftime("%Y%m%d%H%M",
737 localtime((stat $file)[9]));
738 $last_mod_date = $date if ($last_mod_date < $date);
739 }
740 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700741 }
Joe Perchesc707a812013-07-08 16:00:43 -0700742
743 if ($camelcase_cache ne "" && -f $camelcase_cache) {
744 open(my $camelcase_file, '<', "$camelcase_cache")
745 or warn "$P: Can't read '$camelcase_cache' $!\n";
746 while (<$camelcase_file>) {
747 chomp;
748 $camelcase{$_} = 1;
749 }
750 close($camelcase_file);
751
752 return;
753 }
754
Richard Genoud3645e322014-02-10 14:25:32 -0800755 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700756 $files = `git ls-files "include/*.h"`;
757 @include_files = split('\n', $files);
758 }
759
Joe Perches34456862013-07-03 15:05:34 -0700760 foreach my $file (@include_files) {
761 seed_camelcase_file($file);
762 }
Joe Perches351b2a12013-07-03 15:05:36 -0700763
Joe Perchesc707a812013-07-08 16:00:43 -0700764 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700765 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700766 open(my $camelcase_file, '>', "$camelcase_cache")
767 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700768 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
769 print $camelcase_file ("$_\n");
770 }
771 close($camelcase_file);
772 }
Joe Perches34456862013-07-03 15:05:34 -0700773}
774
Joe Perchesd311cd42014-08-06 16:10:57 -0700775sub git_commit_info {
776 my ($commit, $id, $desc) = @_;
777
778 return ($id, $desc) if ((which("git") eq "") || !(-e ".git"));
779
780 my $output = `git log --no-color --format='%H %s' -1 $commit 2>&1`;
781 $output =~ s/^\s*//gm;
782 my @lines = split("\n", $output);
783
Joe Perches0d7835f2015-02-13 14:38:35 -0800784 return ($id, $desc) if ($#lines < 0);
785
Joe Perchesd311cd42014-08-06 16:10:57 -0700786 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous\./) {
787# Maybe one day convert this block of bash into something that returns
788# all matching commit ids, but it's very slow...
789#
790# echo "checking commits $1..."
791# git rev-list --remotes | grep -i "^$1" |
792# while read line ; do
793# git log --format='%H %s' -1 $line |
794# echo "commit $(cut -c 1-12,41-)"
795# done
796 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
797 } else {
798 $id = substr($lines[0], 0, 12);
799 $desc = substr($lines[0], 41);
800 }
801
802 return ($id, $desc);
803}
804
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700805$chk_signoff = 0 if ($file);
806
Andy Whitcroft00df3442007-06-08 13:47:06 -0700807my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800808my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700809my @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700810my @fixed_inserted = ();
811my @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700812my $fixlinenr = -1;
813
Du, Changbin4a593c32016-05-20 17:04:16 -0700814# If input is git commits, extract all commits from the commit expressions.
815# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
816die "$P: No git repository found\n" if ($git && !-e ".git");
817
818if ($git) {
819 my @commits = ();
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700820 foreach my $commit_expr (@ARGV) {
Du, Changbin4a593c32016-05-20 17:04:16 -0700821 my $git_range;
Joe Perches28898fd2016-05-20 17:04:22 -0700822 if ($commit_expr =~ m/^(.*)-(\d+)$/) {
823 $git_range = "-$2 $1";
Du, Changbin4a593c32016-05-20 17:04:16 -0700824 } elsif ($commit_expr =~ m/\.\./) {
825 $git_range = "$commit_expr";
Du, Changbin4a593c32016-05-20 17:04:16 -0700826 } else {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700827 $git_range = "-1 $commit_expr";
828 }
829 my $lines = `git log --no-color --no-merges --pretty=format:'%H %s' $git_range`;
830 foreach my $line (split(/\n/, $lines)) {
Joe Perches28898fd2016-05-20 17:04:22 -0700831 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/;
832 next if (!defined($1) || !defined($2));
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700833 my $sha1 = $1;
834 my $subject = $2;
835 unshift(@commits, $sha1);
836 $git_commits{$sha1} = $subject;
Du, Changbin4a593c32016-05-20 17:04:16 -0700837 }
838 }
839 die "$P: no git commits after extraction!\n" if (@commits == 0);
840 @ARGV = @commits;
841}
842
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800843my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700844for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800845 my $FILE;
Du, Changbin4a593c32016-05-20 17:04:16 -0700846 if ($git) {
847 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") ||
848 die "$P: $filename: git format-patch failed - $!\n";
849 } elsif ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800850 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700851 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800852 } elsif ($filename eq '-') {
853 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700854 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800855 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700856 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700857 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800858 if ($filename eq '-') {
859 $vname = 'Your patch';
Du, Changbin4a593c32016-05-20 17:04:16 -0700860 } elsif ($git) {
Joe Perches0dea9f1e2016-05-20 17:04:19 -0700861 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800862 } else {
863 $vname = $filename;
864 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800865 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700866 chomp;
867 push(@rawlines, $_);
868 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800869 close($FILE);
Joe Perchesd8469f12015-06-25 15:03:00 -0700870
871 if ($#ARGV > 0 && $quiet == 0) {
872 print '-' x length($vname) . "\n";
873 print "$vname\n";
874 print '-' x length($vname) . "\n";
875 }
876
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800877 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700878 $exit = 1;
879 }
880 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800881 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700882 @fixed = ();
Joe Perchesd752fcc2014-08-06 16:11:05 -0700883 @fixed_inserted = ();
884 @fixed_deleted = ();
Joe Perches194f66f2014-08-06 16:11:03 -0700885 $fixlinenr = -1;
Alex Dowad485ff232015-06-25 15:02:52 -0700886 @modifierListFile = ();
887 @typeListFile = ();
888 build_types();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700889}
890
Joe Perchesd8469f12015-06-25 15:03:00 -0700891if (!$quiet) {
Joe Perches3c816e42015-06-25 15:03:29 -0700892 hash_show_words(\%use_type, "Used");
893 hash_show_words(\%ignore_type, "Ignored");
894
Joe Perchesd8469f12015-06-25 15:03:00 -0700895 if ($^V lt 5.10.0) {
896 print << "EOM"
897
898NOTE: perl $^V is not modern enough to detect all possible issues.
899 An upgrade to at least perl v5.10.0 is suggested.
900EOM
901 }
902 if ($exit) {
903 print << "EOM"
904
905NOTE: If any of the errors are false positives, please report
906 them to the maintainer, see CHECKPATCH in MAINTAINERS.
907EOM
908 }
909}
910
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700911exit($exit);
912
913sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700914 my ($root) = @_;
915
916 my @tree_check = (
917 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
918 "README", "Documentation", "arch", "include", "drivers",
919 "fs", "init", "ipc", "kernel", "lib", "scripts",
920 );
921
922 foreach my $check (@tree_check) {
923 if (! -e $root . '/' . $check) {
924 return 0;
925 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700926 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700927 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700928}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700929
Joe Perches20112472011-07-25 17:13:23 -0700930sub parse_email {
931 my ($formatted_email) = @_;
932
933 my $name = "";
934 my $address = "";
935 my $comment = "";
936
937 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
938 $name = $1;
939 $address = $2;
940 $comment = $3 if defined $3;
941 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
942 $address = $1;
943 $comment = $2 if defined $2;
944 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
945 $address = $1;
946 $comment = $2 if defined $2;
947 $formatted_email =~ s/$address.*$//;
948 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700949 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700950 $name =~ s/^\"|\"$//g;
951 # If there's a name left after stripping spaces and
952 # leading quotes, and the address doesn't have both
953 # leading and trailing angle brackets, the address
954 # is invalid. ie:
955 # "joe smith joe@smith.com" bad
956 # "joe smith <joe@smith.com" bad
957 if ($name ne "" && $address !~ /^<[^>]+>$/) {
958 $name = "";
959 $address = "";
960 $comment = "";
961 }
962 }
963
Joe Perches3705ce52013-07-03 15:05:31 -0700964 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700965 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700966 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700967 $address =~ s/^\<|\>$//g;
968
969 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
970 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
971 $name = "\"$name\"";
972 }
973
974 return ($name, $address, $comment);
975}
976
977sub format_email {
978 my ($name, $address) = @_;
979
980 my $formatted_email;
981
Joe Perches3705ce52013-07-03 15:05:31 -0700982 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700983 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700984 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700985
986 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
987 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
988 $name = "\"$name\"";
989 }
990
991 if ("$name" eq "") {
992 $formatted_email = "$address";
993 } else {
994 $formatted_email = "$name <$address>";
995 }
996
997 return $formatted_email;
998}
999
Joe Perchesd311cd42014-08-06 16:10:57 -07001000sub which {
Joe Perchesbd474ca2014-08-06 16:11:10 -07001001 my ($bin) = @_;
Joe Perchesd311cd42014-08-06 16:10:57 -07001002
Joe Perchesbd474ca2014-08-06 16:11:10 -07001003 foreach my $path (split(/:/, $ENV{PATH})) {
1004 if (-e "$path/$bin") {
1005 return "$path/$bin";
1006 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001007 }
Joe Perchesd311cd42014-08-06 16:10:57 -07001008
Joe Perchesbd474ca2014-08-06 16:11:10 -07001009 return "";
Joe Perchesd311cd42014-08-06 16:10:57 -07001010}
1011
Joe Perches000d1cc12011-07-25 17:13:25 -07001012sub which_conf {
1013 my ($conf) = @_;
1014
1015 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
1016 if (-e "$path/$conf") {
1017 return "$path/$conf";
1018 }
1019 }
1020
1021 return "";
1022}
1023
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001024sub expand_tabs {
1025 my ($str) = @_;
1026
1027 my $res = '';
1028 my $n = 0;
1029 for my $c (split(//, $str)) {
1030 if ($c eq "\t") {
1031 $res .= ' ';
1032 $n++;
1033 for (; ($n % 8) != 0; $n++) {
1034 $res .= ' ';
1035 }
1036 next;
1037 }
1038 $res .= $c;
1039 $n++;
1040 }
1041
1042 return $res;
1043}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001044sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001045 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001046 return $res;
1047}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001048
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001049sub line_stats {
1050 my ($line) = @_;
1051
1052 # Drop the diff line leader and expand tabs
1053 $line =~ s/^.//;
1054 $line = expand_tabs($line);
1055
1056 # Pick the indent from the front of the line.
1057 my ($white) = ($line =~ /^(\s*)/);
1058
1059 return (length($line), length($white));
1060}
1061
Andy Whitcroft773647a2008-03-28 14:15:58 -07001062my $sanitise_quote = '';
1063
1064sub sanitise_line_reset {
1065 my ($in_comment) = @_;
1066
1067 if ($in_comment) {
1068 $sanitise_quote = '*/';
1069 } else {
1070 $sanitise_quote = '';
1071 }
1072}
Andy Whitcroft00df3442007-06-08 13:47:06 -07001073sub sanitise_line {
1074 my ($line) = @_;
1075
1076 my $res = '';
1077 my $l = '';
1078
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001079 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001080 my $off = 0;
1081 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -07001082
Andy Whitcroft773647a2008-03-28 14:15:58 -07001083 # Always copy over the diff marker.
1084 $res = substr($line, 0, 1);
1085
1086 for ($off = 1; $off < length($line); $off++) {
1087 $c = substr($line, $off, 1);
1088
1089 # Comments we are wacking completly including the begin
1090 # and end, all to $;.
1091 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
1092 $sanitise_quote = '*/';
1093
1094 substr($res, $off, 2, "$;$;");
1095 $off++;
1096 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001097 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -07001098 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001099 $sanitise_quote = '';
1100 substr($res, $off, 2, "$;$;");
1101 $off++;
1102 next;
1103 }
Daniel Walker113f04a2009-09-21 17:04:35 -07001104 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
1105 $sanitise_quote = '//';
1106
1107 substr($res, $off, 2, $sanitise_quote);
1108 $off++;
1109 next;
1110 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001111
1112 # A \ in a string means ignore the next character.
1113 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
1114 $c eq "\\") {
1115 substr($res, $off, 2, 'XX');
1116 $off++;
1117 next;
1118 }
1119 # Regular quotes.
1120 if ($c eq "'" || $c eq '"') {
1121 if ($sanitise_quote eq '') {
1122 $sanitise_quote = $c;
1123
1124 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001125 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001126 } elsif ($sanitise_quote eq $c) {
1127 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -07001128 }
1129 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001130
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001131 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001132 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
1133 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -07001134 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
1135 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001136 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
1137 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -07001138 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001139 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001140 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001141 }
1142
Daniel Walker113f04a2009-09-21 17:04:35 -07001143 if ($sanitise_quote eq '//') {
1144 $sanitise_quote = '';
1145 }
1146
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001147 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001148 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001149 my $clean = 'X' x length($1);
1150 $res =~ s@\<.*\>@<$clean>@;
1151
1152 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001153 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001154 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001155 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001156 }
1157
Joe Perchesdadf6802016-08-02 14:04:33 -07001158 if ($allow_c99_comments && $res =~ m@(//.*$)@) {
1159 my $match = $1;
1160 $res =~ s/\Q$match\E/"$;" x length($match)/e;
1161 }
1162
Andy Whitcroft00df3442007-06-08 13:47:06 -07001163 return $res;
1164}
1165
Joe Perchesa6962d72013-04-29 16:18:13 -07001166sub get_quoted_string {
1167 my ($line, $rawline) = @_;
1168
Joe Perches33acb542015-06-25 15:02:54 -07001169 return "" if ($line !~ m/($String)/g);
Joe Perchesa6962d72013-04-29 16:18:13 -07001170 return substr($rawline, $-[0], $+[0] - $-[0]);
1171}
1172
Andy Whitcroft8905a672007-11-28 16:21:06 -08001173sub ctx_statement_block {
1174 my ($linenr, $remain, $off) = @_;
1175 my $line = $linenr - 1;
1176 my $blk = '';
1177 my $soff = $off;
1178 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001179 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001180
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001181 my $loff = 0;
1182
Andy Whitcroft8905a672007-11-28 16:21:06 -08001183 my $type = '';
1184 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -08001185 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -08001186 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001187 my $c;
1188 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001189
1190 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001191 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -08001192 @stack = (['', 0]) if ($#stack == -1);
1193
Andy Whitcroft773647a2008-03-28 14:15:58 -07001194 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001195 # If we are about to drop off the end, pull in more
1196 # context.
1197 if ($off >= $len) {
1198 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -07001199 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001200 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001201 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001202 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001203 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001204 $len = length($blk);
1205 $line++;
1206 last;
1207 }
1208 # Bail if there is no further context.
1209 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001210 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08001211 last;
1212 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001213 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
1214 $level++;
1215 $type = '#';
1216 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001217 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08001218 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -08001219 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001220 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001221
Andy Whitcroft773647a2008-03-28 14:15:58 -07001222 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001223
1224 # Handle nested #if/#else.
1225 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
1226 push(@stack, [ $type, $level ]);
1227 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
1228 ($type, $level) = @{$stack[$#stack - 1]};
1229 } elsif ($remainder =~ /^#\s*endif\b/) {
1230 ($type, $level) = @{pop(@stack)};
1231 }
1232
Andy Whitcroft8905a672007-11-28 16:21:06 -08001233 # Statement ends at the ';' or a close '}' at the
1234 # outermost level.
1235 if ($level == 0 && $c eq ';') {
1236 last;
1237 }
1238
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001239 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -07001240 if ($level == 0 && $coff_set == 0 &&
1241 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
1242 $remainder =~ /^(else)(?:\s|{)/ &&
1243 $remainder !~ /^else\s+if\b/) {
1244 $coff = $off + length($1) - 1;
1245 $coff_set = 1;
1246 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1247 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001248 }
1249
Andy Whitcroft8905a672007-11-28 16:21:06 -08001250 if (($type eq '' || $type eq '(') && $c eq '(') {
1251 $level++;
1252 $type = '(';
1253 }
1254 if ($type eq '(' && $c eq ')') {
1255 $level--;
1256 $type = ($level != 0)? '(' : '';
1257
1258 if ($level == 0 && $coff < $soff) {
1259 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001260 $coff_set = 1;
1261 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -08001262 }
1263 }
1264 if (($type eq '' || $type eq '{') && $c eq '{') {
1265 $level++;
1266 $type = '{';
1267 }
1268 if ($type eq '{' && $c eq '}') {
1269 $level--;
1270 $type = ($level != 0)? '{' : '';
1271
1272 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -07001273 if (substr($blk, $off + 1, 1) eq ';') {
1274 $off++;
1275 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001276 last;
1277 }
1278 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08001279 # Preprocessor commands end at the newline unless escaped.
1280 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
1281 $level--;
1282 $type = '';
1283 $off++;
1284 last;
1285 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001286 $off++;
1287 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001288 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001289 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07001290 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001291 $line++;
1292 $remain--;
1293 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001294
1295 my $statement = substr($blk, $soff, $off - $soff + 1);
1296 my $condition = substr($blk, $soff, $coff - $soff + 1);
1297
1298 #warn "STATEMENT<$statement>\n";
1299 #warn "CONDITION<$condition>\n";
1300
Andy Whitcroft773647a2008-03-28 14:15:58 -07001301 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001302
1303 return ($statement, $condition,
1304 $line, $remain + 1, $off - $loff + 1, $level);
1305}
1306
Andy Whitcroftcf655042008-03-04 14:28:20 -08001307sub statement_lines {
1308 my ($stmt) = @_;
1309
1310 # Strip the diff line prefixes and rip blank lines at start and end.
1311 $stmt =~ s/(^|\n)./$1/g;
1312 $stmt =~ s/^\s*//;
1313 $stmt =~ s/\s*$//;
1314
1315 my @stmt_lines = ($stmt =~ /\n/g);
1316
1317 return $#stmt_lines + 2;
1318}
1319
1320sub statement_rawlines {
1321 my ($stmt) = @_;
1322
1323 my @stmt_lines = ($stmt =~ /\n/g);
1324
1325 return $#stmt_lines + 2;
1326}
1327
1328sub statement_block_size {
1329 my ($stmt) = @_;
1330
1331 $stmt =~ s/(^|\n)./$1/g;
1332 $stmt =~ s/^\s*{//;
1333 $stmt =~ s/}\s*$//;
1334 $stmt =~ s/^\s*//;
1335 $stmt =~ s/\s*$//;
1336
1337 my @stmt_lines = ($stmt =~ /\n/g);
1338 my @stmt_statements = ($stmt =~ /;/g);
1339
1340 my $stmt_lines = $#stmt_lines + 2;
1341 my $stmt_statements = $#stmt_statements + 1;
1342
1343 if ($stmt_lines > $stmt_statements) {
1344 return $stmt_lines;
1345 } else {
1346 return $stmt_statements;
1347 }
1348}
1349
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001350sub ctx_statement_full {
1351 my ($linenr, $remain, $off) = @_;
1352 my ($statement, $condition, $level);
1353
1354 my (@chunks);
1355
Andy Whitcroftcf655042008-03-04 14:28:20 -08001356 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001357 ($statement, $condition, $linenr, $remain, $off, $level) =
1358 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001359 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001360 push(@chunks, [ $condition, $statement ]);
1361 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1362 return ($level, $linenr, @chunks);
1363 }
1364
1365 # Pull in the following conditional/block pairs and see if they
1366 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001367 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001368 ($statement, $condition, $linenr, $remain, $off, $level) =
1369 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001370 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001371 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001372 #print "C: push\n";
1373 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001374 }
1375
1376 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001377}
1378
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001379sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001380 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001381 my $line;
1382 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001383 my $blk = '';
1384 my @o;
1385 my @c;
1386 my @res = ();
1387
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001388 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001389 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001390 for ($line = $start; $remain > 0; $line++) {
1391 next if ($rawlines[$line] =~ /^-/);
1392 $remain--;
1393
1394 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001395
1396 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001397 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001398 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001399 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001400 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001401 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001402 $level = pop(@stack);
1403 }
1404
Andy Whitcroft01464f32010-10-26 14:23:19 -07001405 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001406 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1407 if ($off > 0) {
1408 $off--;
1409 next;
1410 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001411
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001412 if ($c eq $close && $level > 0) {
1413 $level--;
1414 last if ($level == 0);
1415 } elsif ($c eq $open) {
1416 $level++;
1417 }
1418 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001419
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001420 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001421 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001422 }
1423
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001424 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001425 }
1426
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001427 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001428}
1429sub ctx_block_outer {
1430 my ($linenr, $remain) = @_;
1431
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001432 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1433 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001434}
1435sub ctx_block {
1436 my ($linenr, $remain) = @_;
1437
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001438 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1439 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001440}
1441sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001442 my ($linenr, $remain, $off) = @_;
1443
1444 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1445 return @r;
1446}
1447sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001448 my ($linenr, $remain) = @_;
1449
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001450 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001451}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001452sub ctx_statement_level {
1453 my ($linenr, $remain, $off) = @_;
1454
1455 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1456}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001457
1458sub ctx_locate_comment {
1459 my ($first_line, $end_line) = @_;
1460
1461 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001462 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001463 return $current_comment if (defined $current_comment);
1464
1465 # Look through the context and try and figure out if there is a
1466 # comment.
1467 my $in_comment = 0;
1468 $current_comment = '';
1469 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001470 my $line = $rawlines[$linenr - 1];
1471 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001472 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1473 $in_comment = 1;
1474 }
1475 if ($line =~ m@/\*@) {
1476 $in_comment = 1;
1477 }
1478 if (!$in_comment && $current_comment ne '') {
1479 $current_comment = '';
1480 }
1481 $current_comment .= $line . "\n" if ($in_comment);
1482 if ($line =~ m@\*/@) {
1483 $in_comment = 0;
1484 }
1485 }
1486
1487 chomp($current_comment);
1488 return($current_comment);
1489}
1490sub ctx_has_comment {
1491 my ($first_line, $end_line) = @_;
1492 my $cmt = ctx_locate_comment($first_line, $end_line);
1493
Andy Whitcroft00df3442007-06-08 13:47:06 -07001494 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001495 ##print "CMMT: $cmt\n";
1496
1497 return ($cmt ne '');
1498}
1499
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001500sub raw_line {
1501 my ($linenr, $cnt) = @_;
1502
1503 my $offset = $linenr - 1;
1504 $cnt++;
1505
1506 my $line;
1507 while ($cnt) {
1508 $line = $rawlines[$offset++];
1509 next if (defined($line) && $line =~ /^-/);
1510 $cnt--;
1511 }
1512
1513 return $line;
1514}
1515
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001516sub cat_vet {
1517 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001518 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001519
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001520 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001521 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1522 $res .= $1;
1523 if ($2 ne '') {
1524 $coded = sprintf("^%c", unpack('C', $2) + 64);
1525 $res .= $coded;
1526 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001527 }
1528 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001529
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001530 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001531}
1532
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001533my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001534my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001535my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001536my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001537
1538sub annotate_reset {
1539 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001540 $av_pending = '_';
1541 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001542 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001543}
1544
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001545sub annotate_values {
1546 my ($stream, $type) = @_;
1547
1548 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001549 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001550 my $cur = $stream;
1551
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001552 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001553
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001554 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001555 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001556 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001557 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001558 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001559 print "WS($1)\n" if ($dbg_values > 1);
1560 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001561 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001562 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001563 }
1564
Florian Micklerc023e4732011-01-12 16:59:58 -08001565 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001566 print "CAST($1)\n" if ($dbg_values > 1);
1567 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001568 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001569
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001570 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001571 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001572 $type = 'T';
1573
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001574 } elsif ($cur =~ /^($Modifier)\s*/) {
1575 print "MODIFIER($1)\n" if ($dbg_values > 1);
1576 $type = 'T';
1577
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001578 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001579 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001580 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001581 push(@av_paren_type, $type);
1582 if ($2 ne '') {
1583 $av_pending = 'N';
1584 }
1585 $type = 'E';
1586
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001587 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001588 print "UNDEF($1)\n" if ($dbg_values > 1);
1589 $av_preprocessor = 1;
1590 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001591
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001592 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001593 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001594 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001595
1596 push(@av_paren_type, $type);
1597 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001598 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001599
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001600 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001601 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1602 $av_preprocessor = 1;
1603
1604 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1605
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001606 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001607
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001608 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001609 print "PRE_END($1)\n" if ($dbg_values > 1);
1610
1611 $av_preprocessor = 1;
1612
1613 # Assume all arms of the conditional end as this
1614 # one does, and continue as if the #endif was not here.
1615 pop(@av_paren_type);
1616 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001617 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001618
1619 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001620 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001621
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001622 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1623 print "ATTR($1)\n" if ($dbg_values > 1);
1624 $av_pending = $type;
1625 $type = 'N';
1626
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001627 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001628 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001629 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001630 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001631 }
1632 $type = 'N';
1633
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001634 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001635 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001636 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001637 $type = 'N';
1638
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001639 } elsif ($cur =~/^(case)/o) {
1640 print "CASE($1)\n" if ($dbg_values > 1);
1641 $av_pend_colon = 'C';
1642 $type = 'N';
1643
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001644 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001645 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001646 $type = 'N';
1647
1648 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001649 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001650 push(@av_paren_type, $av_pending);
1651 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001652 $type = 'N';
1653
1654 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001655 my $new_type = pop(@av_paren_type);
1656 if ($new_type ne '_') {
1657 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001658 print "PAREN('$1') -> $type\n"
1659 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001660 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001661 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001662 }
1663
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001664 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001665 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001666 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001667 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001668
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001669 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1670 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001671 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001672 } elsif ($type eq 'E') {
1673 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001674 }
1675 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1676 $type = 'V';
1677
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001678 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001679 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001680 $type = 'V';
1681
1682 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001683 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001684 $type = 'N';
1685
Andy Whitcroftcf655042008-03-04 14:28:20 -08001686 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001687 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001688 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001689 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001690
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001691 } elsif ($cur =~/^(,)/) {
1692 print "COMMA($1)\n" if ($dbg_values > 1);
1693 $type = 'C';
1694
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001695 } elsif ($cur =~ /^(\?)/o) {
1696 print "QUESTION($1)\n" if ($dbg_values > 1);
1697 $type = 'N';
1698
1699 } elsif ($cur =~ /^(:)/o) {
1700 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1701
1702 substr($var, length($res), 1, $av_pend_colon);
1703 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1704 $type = 'E';
1705 } else {
1706 $type = 'N';
1707 }
1708 $av_pend_colon = 'O';
1709
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001710 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001711 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001712 $type = 'N';
1713
Andy Whitcroft0d413862008-10-15 22:02:16 -07001714 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001715 my $variant;
1716
1717 print "OPV($1)\n" if ($dbg_values > 1);
1718 if ($type eq 'V') {
1719 $variant = 'B';
1720 } else {
1721 $variant = 'U';
1722 }
1723
1724 substr($var, length($res), 1, $variant);
1725 $type = 'N';
1726
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001727 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001728 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001729 if ($1 ne '++' && $1 ne '--') {
1730 $type = 'N';
1731 }
1732
1733 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001734 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001735 }
1736 if (defined $1) {
1737 $cur = substr($cur, length($1));
1738 $res .= $type x length($1);
1739 }
1740 }
1741
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001742 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001743}
1744
Andy Whitcroft8905a672007-11-28 16:21:06 -08001745sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001746 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001747 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001748 ^(?:
1749 $Modifier|
1750 $Storage|
1751 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001752 DEFINE_\S+
1753 )$|
1754 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001755 goto|
1756 return|
1757 case|
1758 else|
1759 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001760 do|
1761 \#|
1762 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001763 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001764 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001765 )}x;
1766 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1767 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001768 # Check for modifiers.
1769 $possible =~ s/\s*$Storage\s*//g;
1770 $possible =~ s/\s*$Sparse\s*//g;
1771 if ($possible =~ /^\s*$/) {
1772
1773 } elsif ($possible =~ /\s/) {
1774 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001775 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001776 if ($modifier !~ $notPermitted) {
1777 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001778 push(@modifierListFile, $modifier);
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001779 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001780 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001781
1782 } else {
1783 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
Alex Dowad485ff232015-06-25 15:02:52 -07001784 push(@typeListFile, $possible);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001785 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001786 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001787 } else {
1788 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001789 }
1790}
1791
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001792my $prefix = '';
1793
Joe Perches000d1cc12011-07-25 17:13:25 -07001794sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001795 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001796
Joe Perchescbec18a2014-04-03 14:49:19 -07001797 return defined $use_type{$type} if (scalar keys %use_type > 0);
1798
1799 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001800}
1801
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001802sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001803 my ($level, $type, $msg) = @_;
1804
1805 if (!show_type($type) ||
1806 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001807 return 0;
1808 }
Joe Perches57230292015-06-25 15:03:03 -07001809 my $output = '';
1810 if (-t STDOUT && $color) {
1811 if ($level eq 'ERROR') {
1812 $output .= RED;
1813 } elsif ($level eq 'WARNING') {
1814 $output .= YELLOW;
1815 } else {
1816 $output .= GREEN;
1817 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001818 }
Joe Perches57230292015-06-25 15:03:03 -07001819 $output .= $prefix . $level . ':';
1820 if ($show_types) {
1821 $output .= BLUE if (-t STDOUT && $color);
1822 $output .= "$type:";
1823 }
1824 $output .= RESET if (-t STDOUT && $color);
1825 $output .= ' ' . $msg . "\n";
Joe Perches34d88152015-06-25 15:03:05 -07001826
1827 if ($showfile) {
1828 my @lines = split("\n", $output, -1);
1829 splice(@lines, 1, 1);
1830 $output = join("\n", @lines);
1831 }
Joe Perches57230292015-06-25 15:03:03 -07001832 $output = (split('\n', $output))[0] . "\n" if ($terse);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001833
Joe Perches57230292015-06-25 15:03:03 -07001834 push(our @report, $output);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001835
1836 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001837}
Joe Perchescbec18a2014-04-03 14:49:19 -07001838
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001839sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001840 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001841}
Joe Perches000d1cc12011-07-25 17:13:25 -07001842
Joe Perchesd752fcc2014-08-06 16:11:05 -07001843sub fixup_current_range {
1844 my ($lineRef, $offset, $length) = @_;
1845
1846 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) {
1847 my $o = $1;
1848 my $l = $2;
1849 my $no = $o + $offset;
1850 my $nl = $l + $length;
1851 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/;
1852 }
1853}
1854
1855sub fix_inserted_deleted_lines {
1856 my ($linesRef, $insertedRef, $deletedRef) = @_;
1857
1858 my $range_last_linenr = 0;
1859 my $delta_offset = 0;
1860
1861 my $old_linenr = 0;
1862 my $new_linenr = 0;
1863
1864 my $next_insert = 0;
1865 my $next_delete = 0;
1866
1867 my @lines = ();
1868
1869 my $inserted = @{$insertedRef}[$next_insert++];
1870 my $deleted = @{$deletedRef}[$next_delete++];
1871
1872 foreach my $old_line (@{$linesRef}) {
1873 my $save_line = 1;
1874 my $line = $old_line; #don't modify the array
Joe Perches323b2672015-04-16 12:44:50 -07001875 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename
Joe Perchesd752fcc2014-08-06 16:11:05 -07001876 $delta_offset = 0;
1877 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk
1878 $range_last_linenr = $new_linenr;
1879 fixup_current_range(\$line, $delta_offset, 0);
1880 }
1881
1882 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) {
1883 $deleted = @{$deletedRef}[$next_delete++];
1884 $save_line = 0;
1885 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1);
1886 }
1887
1888 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) {
1889 push(@lines, ${$inserted}{'LINE'});
1890 $inserted = @{$insertedRef}[$next_insert++];
1891 $new_linenr++;
1892 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1);
1893 }
1894
1895 if ($save_line) {
1896 push(@lines, $line);
1897 $new_linenr++;
1898 }
1899
1900 $old_linenr++;
1901 }
1902
1903 return @lines;
1904}
1905
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07001906sub fix_insert_line {
1907 my ($linenr, $line) = @_;
1908
1909 my $inserted = {
1910 LINENR => $linenr,
1911 LINE => $line,
1912 };
1913 push(@fixed_inserted, $inserted);
1914}
1915
1916sub fix_delete_line {
1917 my ($linenr, $line) = @_;
1918
1919 my $deleted = {
1920 LINENR => $linenr,
1921 LINE => $line,
1922 };
1923
1924 push(@fixed_deleted, $deleted);
1925}
1926
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001927sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001928 my ($type, $msg) = @_;
1929
1930 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001931 our $clean = 0;
1932 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001933 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001934 }
Joe Perches3705ce52013-07-03 15:05:31 -07001935 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001936}
1937sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001938 my ($type, $msg) = @_;
1939
1940 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001941 our $clean = 0;
1942 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001943 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001944 }
Joe Perches3705ce52013-07-03 15:05:31 -07001945 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001946}
1947sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001948 my ($type, $msg) = @_;
1949
1950 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001951 our $clean = 0;
1952 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001953 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001954 }
Joe Perches3705ce52013-07-03 15:05:31 -07001955 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001956}
1957
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001958sub check_absolute_file {
1959 my ($absolute, $herecurr) = @_;
1960 my $file = $absolute;
1961
1962 ##print "absolute<$absolute>\n";
1963
1964 # See if any suffix of this path is a path within the tree.
1965 while ($file =~ s@^[^/]*/@@) {
1966 if (-f "$root/$file") {
1967 ##print "file<$file>\n";
1968 last;
1969 }
1970 }
1971 if (! -f _) {
1972 return 0;
1973 }
1974
1975 # It is, so see if the prefix is acceptable.
1976 my $prefix = $absolute;
1977 substr($prefix, -length($file)) = '';
1978
1979 ##print "prefix<$prefix>\n";
1980 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001981 WARN("USE_RELATIVE_PATH",
1982 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001983 }
1984}
1985
Joe Perches3705ce52013-07-03 15:05:31 -07001986sub trim {
1987 my ($string) = @_;
1988
Joe Perchesb34c6482013-09-11 14:24:01 -07001989 $string =~ s/^\s+|\s+$//g;
1990
1991 return $string;
1992}
1993
1994sub ltrim {
1995 my ($string) = @_;
1996
1997 $string =~ s/^\s+//;
1998
1999 return $string;
2000}
2001
2002sub rtrim {
2003 my ($string) = @_;
2004
2005 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002006
2007 return $string;
2008}
2009
Joe Perches52ea8502013-11-12 15:10:09 -08002010sub string_find_replace {
2011 my ($string, $find, $replace) = @_;
2012
2013 $string =~ s/$find/$replace/g;
2014
2015 return $string;
2016}
2017
Joe Perches3705ce52013-07-03 15:05:31 -07002018sub tabify {
2019 my ($leading) = @_;
2020
2021 my $source_indent = 8;
2022 my $max_spaces_before_tab = $source_indent - 1;
2023 my $spaces_to_tab = " " x $source_indent;
2024
2025 #convert leading spaces to tabs
2026 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
2027 #Remove spaces before a tab
2028 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
2029
2030 return "$leading";
2031}
2032
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002033sub pos_last_openparen {
2034 my ($line) = @_;
2035
2036 my $pos = 0;
2037
2038 my $opens = $line =~ tr/\(/\(/;
2039 my $closes = $line =~ tr/\)/\)/;
2040
2041 my $last_openparen = 0;
2042
2043 if (($opens == 0) || ($closes >= $opens)) {
2044 return -1;
2045 }
2046
2047 my $len = length($line);
2048
2049 for ($pos = 0; $pos < $len; $pos++) {
2050 my $string = substr($line, $pos);
2051 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2052 $pos += length($1) - 1;
2053 } elsif (substr($line, $pos, 1) eq '(') {
2054 $last_openparen = $pos;
2055 } elsif (index($string, '(') == -1) {
2056 last;
2057 }
2058 }
2059
Joe Perches91cb5192014-04-03 14:49:32 -07002060 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002061}
2062
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002063sub process {
2064 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002065
2066 my $linenr=0;
2067 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002068 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002069 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002070 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002071
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002072 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002073 my $indent;
2074 my $previndent=0;
2075 my $stashindent=0;
2076
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002077 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002078 my $signoff = 0;
2079 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002080 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002081 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002082 my $has_commit_log = 0; #Encountered lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002083 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002084 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002085 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002086 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002087 my $non_utf8_charset = 0;
2088
Joe Perches365dd4e2014-08-06 16:10:42 -07002089 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002090 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002091
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002092 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002093 our $cnt_lines = 0;
2094 our $cnt_error = 0;
2095 our $cnt_warn = 0;
2096 our $cnt_chk = 0;
2097
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002098 # Trace the real file/line as we go.
2099 my $realfile = '';
2100 my $realline = 0;
2101 my $realcnt = 0;
2102 my $here = '';
2103 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002104 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002105 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002106 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002107
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002108 my $prev_values = 'E';
2109
2110 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002111 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002112 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002113 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002114 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002115
Joe Perches7e51f192013-09-11 14:23:57 -07002116 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002117
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002118 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002119 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002120 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002121 my @setup_docs = ();
2122 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002123
Joe Perchesd8b07712013-11-12 15:10:06 -08002124 my $camelcase_file_seeded = 0;
2125
Andy Whitcroft773647a2008-03-28 14:15:58 -07002126 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002127 my $line;
2128 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002129 $linenr++;
2130 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002131
Joe Perches3705ce52013-07-03 15:05:31 -07002132 push(@fixed, $rawline) if ($fix);
2133
Andy Whitcroft773647a2008-03-28 14:15:58 -07002134 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002135 $setup_docs = 0;
2136 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2137 $setup_docs = 1;
2138 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002139 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002140 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002141 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2142 $realline=$1-1;
2143 if (defined $2) {
2144 $realcnt=$3+1;
2145 } else {
2146 $realcnt=1+1;
2147 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002148 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002149
2150 # Guestimate if this is a continuing comment. Run
2151 # the context looking for a comment "edge". If this
2152 # edge is a close comment then we must be in a comment
2153 # at context start.
2154 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002155 my $cnt = $realcnt;
2156 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2157 next if (defined $rawlines[$ln - 1] &&
2158 $rawlines[$ln - 1] =~ /^-/);
2159 $cnt--;
2160 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002161 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002162 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2163 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2164 ($edge) = $1;
2165 last;
2166 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002167 }
2168 if (defined $edge && $edge eq '*/') {
2169 $in_comment = 1;
2170 }
2171
2172 # Guestimate if this is a continuing comment. If this
2173 # is the start of a diff block and this line starts
2174 # ' *' then it is very likely a comment.
2175 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002176 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002177 {
2178 $in_comment = 1;
2179 }
2180
2181 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2182 sanitise_line_reset($in_comment);
2183
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002184 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002185 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002186 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002187 $line = sanitise_line($rawline);
2188 }
2189 push(@lines, $line);
2190
2191 if ($realcnt > 1) {
2192 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2193 } else {
2194 $realcnt = 0;
2195 }
2196
2197 #print "==>$rawline\n";
2198 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002199
2200 if ($setup_docs && $line =~ /^\+/) {
2201 push(@setup_docs, $line);
2202 }
2203 }
2204
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002205 $prefix = '';
2206
Andy Whitcroft773647a2008-03-28 14:15:58 -07002207 $realcnt = 0;
2208 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002209 $fixlinenr = -1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002210 foreach my $line (@lines) {
2211 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002212 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002213 my $sline = $line; #copy of $line
2214 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002215
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002216 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002217
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002218#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002219 if (!$in_commit_log &&
2220 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002221 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002222 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002223 $realline=$1-1;
2224 if (defined $2) {
2225 $realcnt=$3+1;
2226 } else {
2227 $realcnt=1+1;
2228 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002229 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002230 $prev_values = 'E';
2231
Andy Whitcroft773647a2008-03-28 14:15:58 -07002232 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002233 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002234 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002235 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002236 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002237
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002238# track the line number as we move through the hunk, note that
2239# new versions of GNU diff omit the leading space on completely
2240# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002241 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002242 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002243 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002244
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002245 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002246 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002247
2248 # Track the previous line.
2249 ($prevline, $stashline) = ($stashline, $line);
2250 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002251 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2252
Andy Whitcroft773647a2008-03-28 14:15:58 -07002253 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002254
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002255 } elsif ($realcnt == 1) {
2256 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002257 }
2258
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002259 my $hunk_line = ($realcnt != 0);
2260
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002261 $here = "#$linenr: " if (!$file);
2262 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002263
Joe Perches2ac73b42014-06-04 16:12:05 -07002264 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002265 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002266 if ($line =~ /^diff --git.*?(\S+)$/) {
2267 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002268 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002269 $in_commit_log = 0;
Joe Perches2ac73b42014-06-04 16:12:05 -07002270 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002271 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002272 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002273 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002274 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002275
2276 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002277 if (!$file && $tree && $p1_prefix ne '' &&
2278 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002279 WARN("PATCH_PREFIX",
2280 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002281 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002282
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002283 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002284 ERROR("MODIFIED_INCLUDE_ASM",
2285 "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 -07002286 }
Joe Perches2ac73b42014-06-04 16:12:05 -07002287 $found_file = 1;
2288 }
2289
Joe Perches34d88152015-06-25 15:03:05 -07002290#make up the handle for any error we report on this line
2291 if ($showfile) {
2292 $prefix = "$realfile:$realline: "
2293 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002294 if ($file) {
2295 $prefix = "$filename:$realline: ";
2296 } else {
2297 $prefix = "$filename:$linenr: ";
2298 }
Joe Perches34d88152015-06-25 15:03:05 -07002299 }
2300
Joe Perches2ac73b42014-06-04 16:12:05 -07002301 if ($found_file) {
Joe Perches85b0ee12016-10-11 13:51:44 -07002302 if (is_maintained_obsolete($realfile)) {
2303 WARN("OBSOLETE",
2304 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2305 }
Joe Perches7bd7e482015-09-09 15:37:44 -07002306 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b42014-06-04 16:12:05 -07002307 $check = 1;
2308 } else {
2309 $check = $check_orig;
2310 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002311 next;
2312 }
2313
Randy Dunlap389834b2007-06-08 13:47:03 -07002314 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002315
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002316 my $hereline = "$here\n$rawline\n";
2317 my $herecurr = "$here\n$rawline\n";
2318 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002319
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002320 $cnt_lines++ if ($realcnt != 0);
2321
Joe Perchese518e9a2015-06-25 15:03:27 -07002322# Check if the commit log has what seems like a diff which can confuse patch
2323 if ($in_commit_log && !$commit_log_has_diff &&
2324 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2325 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2326 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2327 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2328 ERROR("DIFF_IN_COMMIT_MSG",
2329 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2330 $commit_log_has_diff = 1;
2331 }
2332
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002333# Check for incorrect file permissions
2334 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2335 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002336 if ($realfile !~ m@scripts/@ &&
2337 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002338 ERROR("EXECUTE_PERMISSIONS",
2339 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002340 }
2341 }
2342
Joe Perches20112472011-07-25 17:13:23 -07002343# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002344 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002345 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002346 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002347 }
2348
Joe Perchese0d975b2014-12-10 15:51:49 -08002349# Check if MAINTAINERS is being updated. If so, there's probably no need to
2350# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2351 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2352 $reported_maintainer_file = 1;
2353 }
2354
Joe Perches20112472011-07-25 17:13:23 -07002355# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002356 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002357 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002358 my $space_before = $1;
2359 my $sign_off = $2;
2360 my $space_after = $3;
2361 my $email = $4;
2362 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2363
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002364 if ($sign_off !~ /$signature_tags/) {
2365 WARN("BAD_SIGN_OFF",
2366 "Non-standard signature: $sign_off\n" . $herecurr);
2367 }
Joe Perches20112472011-07-25 17:13:23 -07002368 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002369 if (WARN("BAD_SIGN_OFF",
2370 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2371 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002372 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002373 "$ucfirst_sign_off $email";
2374 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002375 }
Joe Perches20112472011-07-25 17:13:23 -07002376 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002377 if (WARN("BAD_SIGN_OFF",
2378 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2379 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002380 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002381 "$ucfirst_sign_off $email";
2382 }
2383
Joe Perches20112472011-07-25 17:13:23 -07002384 }
2385 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002386 if (WARN("BAD_SIGN_OFF",
2387 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2388 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002389 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002390 "$ucfirst_sign_off $email";
2391 }
Joe Perches20112472011-07-25 17:13:23 -07002392 }
2393
2394 my ($email_name, $email_address, $comment) = parse_email($email);
2395 my $suggested_email = format_email(($email_name, $email_address));
2396 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002397 ERROR("BAD_SIGN_OFF",
2398 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002399 } else {
2400 my $dequoted = $suggested_email;
2401 $dequoted =~ s/^"//;
2402 $dequoted =~ s/" </ </;
2403 # Don't force email to have quotes
2404 # Allow just an angle bracketed address
2405 if ("$dequoted$comment" ne $email &&
2406 "<$email_address>$comment" ne $email &&
2407 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002408 WARN("BAD_SIGN_OFF",
2409 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002410 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002411 }
Joe Perches7e51f192013-09-11 14:23:57 -07002412
2413# Check for duplicate signatures
2414 my $sig_nospace = $line;
2415 $sig_nospace =~ s/\s//g;
2416 $sig_nospace = lc($sig_nospace);
2417 if (defined $signatures{$sig_nospace}) {
2418 WARN("BAD_SIGN_OFF",
2419 "Duplicate signature\n" . $herecurr);
2420 } else {
2421 $signatures{$sig_nospace} = 1;
2422 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002423 }
2424
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002425# Check email subject for common tools that don't need to be mentioned
2426 if ($in_header_lines &&
2427 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2428 WARN("EMAIL_SUBJECT",
2429 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2430 }
2431
Joe Perches9b3189e2014-06-04 16:12:10 -07002432# Check for old stable address
2433 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2434 ERROR("STABLE_ADDRESS",
2435 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2436 }
2437
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002438# Check for unwanted Gerrit info
2439 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2440 ERROR("GERRIT_CHANGE_ID",
2441 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2442 }
2443
Joe Perches369c8dd2015-11-06 16:31:34 -08002444# Check if the commit log is in a possible stack dump
2445 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2446 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2447 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2448 # timestamp
2449 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2450 # stack dump address
2451 $commit_log_possible_stack_dump = 1;
2452 }
2453
Joe Perches2a076f42015-04-16 12:44:28 -07002454# Check for line lengths > 75 in commit log, warn once
2455 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002456 length($line) > 75 &&
2457 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2458 # file delta changes
2459 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2460 # filename then :
2461 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2462 # A Fixes: or Link: line
2463 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002464 WARN("COMMIT_LOG_LONG_LINE",
2465 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2466 $commit_log_long_line = 1;
2467 }
2468
Joe Perchesbf4daf12015-09-09 15:37:50 -07002469# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002470 if ($in_commit_log && $commit_log_possible_stack_dump &&
2471 $line =~ /^\s*$/) {
2472 $commit_log_possible_stack_dump = 0;
2473 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002474
Joe Perches0d7835f2015-02-13 14:38:35 -08002475# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002476 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002477 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002478 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002479 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002480 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2481 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002482 my $init_char = "c";
2483 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002484 my $short = 1;
2485 my $long = 0;
2486 my $case = 1;
2487 my $space = 1;
2488 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002489 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002490 my $id = '0123456789ab';
2491 my $orig_desc = "commit description";
2492 my $description = "";
2493
Joe Perchesfe043ea2015-09-09 15:37:25 -07002494 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2495 $init_char = $1;
2496 $orig_commit = lc($2);
2497 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2498 $orig_commit = lc($1);
2499 }
2500
Joe Perches0d7835f2015-02-13 14:38:35 -08002501 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2502 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2503 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2504 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2505 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2506 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002507 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002508 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2509 defined $rawlines[$linenr] &&
2510 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2511 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002512 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002513 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2514 defined $rawlines[$linenr] &&
2515 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2516 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2517 $orig_desc = $1;
2518 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2519 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002520 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002521 }
2522
2523 ($id, $description) = git_commit_info($orig_commit,
2524 $id, $orig_desc);
2525
Joe Perches19c146a2015-02-13 14:39:00 -08002526 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002527 ERROR("GIT_COMMIT_ID",
2528 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2529 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002530 }
2531
Joe Perches13f19372014-08-06 16:10:59 -07002532# Check for added, moved or deleted files
2533 if (!$reported_maintainer_file && !$in_commit_log &&
2534 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2535 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2536 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2537 (defined($1) || defined($2))))) {
2538 $reported_maintainer_file = 1;
2539 WARN("FILE_PATH_CHANGES",
2540 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2541 }
2542
Andy Whitcroft00df3442007-06-08 13:47:06 -07002543# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002544 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002545 ERROR("CORRUPTED_PATCH",
2546 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002547 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002548 }
2549
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002550# Check for absolute kernel paths.
2551 if ($tree) {
2552 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2553 my $file = $1;
2554
2555 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2556 check_absolute_file($1, $herecurr)) {
2557 #
2558 } else {
2559 check_absolute_file($file, $herecurr);
2560 }
2561 }
2562 }
2563
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002564# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2565 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002566 $rawline !~ m/^$UTF8*$/) {
2567 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2568
2569 my $blank = copy_spacing($rawline);
2570 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2571 my $hereptr = "$hereline$ptr\n";
2572
Joe Perches34d99212011-07-25 17:13:26 -07002573 CHK("INVALID_UTF8",
2574 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002575 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002576
Joe Perches15662b32011-10-31 17:13:12 -07002577# Check if it's the start of a commit log
2578# (not a header line and we haven't seen the patch filename)
2579 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002580 !($rawline =~ /^\s+\S/ ||
2581 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002582 $in_header_lines = 0;
2583 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002584 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002585 }
2586
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002587# Check if there is UTF-8 in a commit log when a mail header has explicitly
2588# declined it, i.e defined some charset where it is missing.
2589 if ($in_header_lines &&
2590 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2591 $1 !~ /utf-8/i) {
2592 $non_utf8_charset = 1;
2593 }
2594
2595 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002596 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002597 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002598 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2599 }
2600
Kees Cook66b47b42014-10-13 15:51:57 -07002601# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002602 if (defined($misspellings) &&
2603 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002604 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002605 my $typo = $1;
2606 my $typo_fix = $spelling_fix{lc($typo)};
2607 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2608 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2609 my $msg_type = \&WARN;
2610 $msg_type = \&CHK if ($file);
2611 if (&{$msg_type}("TYPO_SPELLING",
2612 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2613 $fix) {
2614 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2615 }
2616 }
2617 }
2618
Andy Whitcroft306708542008-10-15 22:02:28 -07002619# ignore non-hunk lines and lines being removed
2620 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002621
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002622#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002623 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002624 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002625 if (ERROR("DOS_LINE_ENDINGS",
2626 "DOS line endings\n" . $herevet) &&
2627 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002628 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002629 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002630 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2631 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002632 if (ERROR("TRAILING_WHITESPACE",
2633 "trailing whitespace\n" . $herevet) &&
2634 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002635 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002636 }
2637
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002638 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002639 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002640
Josh Triplett4783f892013-11-12 15:10:12 -08002641# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002642 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002643 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2644 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002645 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2646 my $msg_type = \&ERROR;
2647 $msg_type = \&CHK if ($file);
2648 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002649 "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 -08002650 }
2651
Andi Kleen33549572010-05-24 14:33:29 -07002652# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002653# Only applies when adding the entry originally, after that we do not have
2654# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002655 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002656 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002657 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002658 my $cnt = $realcnt;
2659 my $ln = $linenr + 1;
2660 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002661 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002662 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002663 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002664 $f = $lines[$ln - 1];
2665 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2666 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002667
2668 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002669 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002670
Joe Perches8d73e0e2014-08-06 16:10:46 -07002671 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002672 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002673 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002674 $length = -1;
2675 }
2676
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002677 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002678 $f =~ s/#.*//;
2679 $f =~ s/^\s+//;
2680 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002681 if ($f =~ /^\s*config\s/) {
2682 $is_end = 1;
2683 last;
2684 }
Andi Kleen33549572010-05-24 14:33:29 -07002685 $length++;
2686 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002687 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2688 WARN("CONFIG_DESCRIPTION",
2689 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2690 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002691 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002692 }
2693
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002694# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2695 if ($realfile =~ /Kconfig/ &&
2696 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2697 WARN("CONFIG_EXPERIMENTAL",
2698 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2699 }
2700
Christoph Jaeger327953e2015-02-13 14:38:29 -08002701# discourage the use of boolean for type definition attributes of Kconfig options
2702 if ($realfile =~ /Kconfig/ &&
2703 $line =~ /^\+\s*\bboolean\b/) {
2704 WARN("CONFIG_TYPE_BOOLEAN",
2705 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2706 }
2707
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002708 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2709 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2710 my $flag = $1;
2711 my $replacement = {
2712 'EXTRA_AFLAGS' => 'asflags-y',
2713 'EXTRA_CFLAGS' => 'ccflags-y',
2714 'EXTRA_CPPFLAGS' => 'cppflags-y',
2715 'EXTRA_LDFLAGS' => 'ldflags-y',
2716 };
2717
2718 WARN("DEPRECATED_VARIABLE",
2719 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2720 }
2721
Rob Herringbff5da42014-01-23 15:54:51 -08002722# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002723 if (defined $root &&
2724 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2725 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2726
Rob Herringbff5da42014-01-23 15:54:51 -08002727 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2728
Florian Vaussardcc933192014-04-03 14:49:27 -07002729 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2730 my $vp_file = $dt_path . "vendor-prefixes.txt";
2731
Rob Herringbff5da42014-01-23 15:54:51 -08002732 foreach my $compat (@compats) {
2733 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002734 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2735 my $compat3 = $compat;
2736 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2737 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002738 if ( $? >> 8 ) {
2739 WARN("UNDOCUMENTED_DT_STRING",
2740 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2741 }
2742
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002743 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2744 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002745 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002746 if ( $? >> 8 ) {
2747 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002748 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002749 }
2750 }
2751 }
2752
Andy Whitcroft5368df202008-10-15 22:02:27 -07002753# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002754 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df202008-10-15 22:02:27 -07002755
Joe Perches47e0c882015-06-25 15:02:57 -07002756# line length limit (with some exclusions)
2757#
2758# There are a few types of lines that may extend beyond $max_line_length:
2759# logging functions like pr_info that end in a string
2760# lines with a single string
2761# #defines that are a single string
2762#
2763# There are 3 different line length message types:
2764# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2765# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2766# LONG_LINE all other lines longer than $max_line_length
2767#
2768# if LONG_LINE is ignored, the other 2 types are also ignored
2769#
2770
Joe Perchesb4749e92015-07-17 16:24:01 -07002771 if ($line =~ /^\+/ && $length > $max_line_length) {
Joe Perches47e0c882015-06-25 15:02:57 -07002772 my $msg_type = "LONG_LINE";
2773
2774 # Check the allowed long line types first
2775
2776 # logging functions that end in a string that starts
2777 # before $max_line_length
2778 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2779 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2780 $msg_type = "";
2781
2782 # lines with only strings (w/ possible termination)
2783 # #defines with only strings
2784 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2785 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2786 $msg_type = "";
2787
Joe Perchesd560a5f2016-08-02 14:04:31 -07002788 # EFI_GUID is another special case
2789 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2790 $msg_type = "";
2791
Joe Perches47e0c882015-06-25 15:02:57 -07002792 # Otherwise set the alternate message types
2793
2794 # a comment starts before $max_line_length
2795 } elsif ($line =~ /($;[\s$;]*)$/ &&
2796 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2797 $msg_type = "LONG_LINE_COMMENT"
2798
2799 # a quoted string starts before $max_line_length
2800 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2801 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2802 $msg_type = "LONG_LINE_STRING"
2803 }
2804
2805 if ($msg_type ne "" &&
2806 (show_type("LONG_LINE") || show_type($msg_type))) {
2807 WARN($msg_type,
2808 "line over $max_line_length characters\n" . $herecurr);
2809 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002810 }
2811
Andy Whitcroft8905a672007-11-28 16:21:06 -08002812# check for adding lines without a newline.
2813 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002814 WARN("MISSING_EOF_NEWLINE",
2815 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002816 }
2817
Mike Frysinger42e41c52009-09-21 17:04:40 -07002818# Blackfin: use hi/lo macros
2819 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2820 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2821 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002822 ERROR("LO_MACRO",
2823 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002824 }
2825 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2826 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002827 ERROR("HI_MACRO",
2828 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002829 }
2830 }
2831
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002832# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002833 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002834
2835# at the beginning of a line any tabs must come first and anything
2836# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002837 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2838 $rawline =~ /^\+\s* \s*/) {
2839 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002840 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002841 if (ERROR("CODE_INDENT",
2842 "code indent should use tabs where possible\n" . $herevet) &&
2843 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002844 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002845 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002846 }
2847
Alberto Panizzo08e44362010-03-05 13:43:54 -08002848# check for space before tabs.
2849 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2850 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002851 if (WARN("SPACE_BEFORE_TAB",
2852 "please, no space before tabs\n" . $herevet) &&
2853 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002854 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002855 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002856 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002857 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002858 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002859 }
2860
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002861# check for && or || at the start of a line
2862 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2863 CHK("LOGICAL_CONTINUATIONS",
2864 "Logical continuations should be on the previous line\n" . $hereprev);
2865 }
2866
Joe Perchesa91e8992016-05-20 17:04:05 -07002867# check indentation starts on a tab stop
2868 if ($^V && $^V ge 5.10.0 &&
2869 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
2870 my $indent = length($1);
2871 if ($indent % 8) {
2872 if (WARN("TABSTOP",
2873 "Statements should start on a tabstop\n" . $herecurr) &&
2874 $fix) {
2875 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
2876 }
2877 }
2878 }
2879
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002880# check multi-line statement indentation matches previous line
2881 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002882 $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 -07002883 $prevline =~ /^\+(\t*)(.*)$/;
2884 my $oldindent = $1;
2885 my $rest = $2;
2886
2887 my $pos = pos_last_openparen($rest);
2888 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002889 $line =~ /^(\+| )([ \t]*)/;
2890 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002891
2892 my $goodtabindent = $oldindent .
2893 "\t" x ($pos / 8) .
2894 " " x ($pos % 8);
2895 my $goodspaceindent = $oldindent . " " x $pos;
2896
2897 if ($newindent ne $goodtabindent &&
2898 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002899
2900 if (CHK("PARENTHESIS_ALIGNMENT",
2901 "Alignment should match open parenthesis\n" . $hereprev) &&
2902 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07002903 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07002904 s/^\+[ \t]*/\+$goodtabindent/;
2905 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002906 }
2907 }
2908 }
2909
Joe Perches6ab3a972015-04-16 12:44:05 -07002910# check for space after cast like "(int) foo" or "(struct foo) bar"
2911# avoid checking a few false positives:
2912# "sizeof(<type>)" or "__alignof__(<type>)"
2913# function pointer declarations like "(*foo)(int) = bar;"
2914# structure definitions like "(struct foo) { 0 };"
2915# multiline macros that define functions
2916# known attributes or the __attribute__ keyword
2917 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
2918 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002919 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07002920 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07002921 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002922 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07002923 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07002924 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002925 }
2926
Joe Perches86406b12015-09-09 15:37:41 -07002927# Block comment styles
2928# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07002929 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002930 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002931 $rawline =~ /^\+[ \t]*\*/ &&
2932 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002933 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2934 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2935 }
2936
Joe Perches86406b12015-09-09 15:37:41 -07002937# Block comments use * on subsequent lines
2938 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
2939 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07002940 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002941 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002942 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07002943 WARN("BLOCK_COMMENT_STYLE",
2944 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07002945 }
2946
Joe Perches86406b12015-09-09 15:37:41 -07002947# Block comments use */ on trailing lines
2948 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08002949 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2950 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2951 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07002952 WARN("BLOCK_COMMENT_STYLE",
2953 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07002954 }
2955
Joe Perches7f619192014-08-06 16:10:39 -07002956# check for missing blank lines after struct/union declarations
2957# with exceptions for various attributes and macros
2958 if ($prevline =~ /^[\+ ]};?\s*$/ &&
2959 $line =~ /^\+/ &&
2960 !($line =~ /^\+\s*$/ ||
2961 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
2962 $line =~ /^\+\s*MODULE_/i ||
2963 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
2964 $line =~ /^\+[a-z_]*init/ ||
2965 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
2966 $line =~ /^\+\s*DECLARE/ ||
2967 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002968 if (CHK("LINE_SPACING",
2969 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
2970 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002971 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07002972 }
Joe Perches7f619192014-08-06 16:10:39 -07002973 }
2974
Joe Perches365dd4e2014-08-06 16:10:42 -07002975# check for multiple consecutive blank lines
2976 if ($prevline =~ /^[\+ ]\s*$/ &&
2977 $line =~ /^\+\s*$/ &&
2978 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07002979 if (CHK("LINE_SPACING",
2980 "Please don't use multiple blank lines\n" . $hereprev) &&
2981 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07002982 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07002983 }
2984
Joe Perches365dd4e2014-08-06 16:10:42 -07002985 $last_blank_line = $linenr;
2986 }
2987
Joe Perches3b617e32014-04-03 14:49:28 -07002988# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002989 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2990 # actual declarations
2991 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07002992 # function pointer declarations
2993 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002994 # foo bar; where foo is some local typedef or #define
2995 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2996 # known declaration macros
2997 $prevline =~ /^\+\s+$declaration_macros/) &&
2998 # for "else if" which can look like "$Ident $Ident"
2999 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3000 # other possible extensions of declaration lines
3001 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3002 # not starting a section or a macro "\" extended line
3003 $prevline =~ /(?:\{\s*|\\)$/) &&
3004 # looks like a declaration
3005 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003006 # function pointer declarations
3007 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003008 # foo bar; where foo is some local typedef or #define
3009 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3010 # known declaration macros
3011 $sline =~ /^\+\s+$declaration_macros/ ||
3012 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003013 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003014 # start or end of block or continuation of declaration
3015 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3016 # bitfield continuation
3017 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3018 # other possible extensions of declaration lines
3019 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3020 # indentation of previous and current line are the same
3021 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003022 if (WARN("LINE_SPACING",
3023 "Missing a blank line after declarations\n" . $hereprev) &&
3024 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003025 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003026 }
Joe Perches3b617e32014-04-03 14:49:28 -07003027 }
3028
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003029# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003030# Exceptions:
3031# 1) within comments
3032# 2) indented preprocessor commands
3033# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003034 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003035 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003036 if (WARN("LEADING_SPACE",
3037 "please, no spaces at the start of a line\n" . $herevet) &&
3038 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003039 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003040 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003041 }
3042
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003043# check we are in a valid C source file if not then ignore this hunk
3044 next if ($realfile !~ /\.(h|c)$/);
3045
Joe Perches032a4c02014-08-06 16:10:29 -07003046# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003047# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003048# if the previous line is a break or return and is indented 1 tab more...
3049 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3050 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003051 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3052 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3053 defined $lines[$linenr] &&
3054 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003055 WARN("UNNECESSARY_ELSE",
3056 "else is not generally useful after a break or return\n" . $hereprev);
3057 }
3058 }
3059
Joe Perchesc00df192014-08-06 16:11:01 -07003060# check indentation of a line with a break;
3061# if the previous line is a goto or return and is indented the same # of tabs
3062 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3063 my $tabs = $1;
3064 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3065 WARN("UNNECESSARY_BREAK",
3066 "break is not useful after a goto or return\n" . $hereprev);
3067 }
3068 }
3069
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003070# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3071 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3072 WARN("CONFIG_EXPERIMENTAL",
3073 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3074 }
3075
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003076# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003077 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003078 WARN("CVS_KEYWORD",
3079 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003080 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003081
Mike Frysinger42e41c52009-09-21 17:04:40 -07003082# Blackfin: don't use __builtin_bfin_[cs]sync
3083 if ($line =~ /__builtin_bfin_csync/) {
3084 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003085 ERROR("CSYNC",
3086 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003087 }
3088 if ($line =~ /__builtin_bfin_ssync/) {
3089 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003090 ERROR("SSYNC",
3091 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003092 }
3093
Joe Perches56e77d72013-02-21 16:44:14 -08003094# check for old HOTPLUG __dev<foo> section markings
3095 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3096 WARN("HOTPLUG_SECTION",
3097 "Using $1 is unnecessary\n" . $herecurr);
3098 }
3099
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003100# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003101 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3102 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003103#print "LINE<$line>\n";
3104 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003105 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003106 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003107 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003108 $stat =~ s/\n./\n /g;
3109 $cond =~ s/\n./\n /g;
3110
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003111#print "linenr<$linenr> <$stat>\n";
3112 # If this statement has no statement boundaries within
3113 # it there is no point in retrying a statement scan
3114 # until we hit end of it.
3115 my $frag = $stat; $frag =~ s/;+\s*$//;
3116 if ($frag !~ /(?:{|;)/) {
3117#print "skip<$line_nr_next>\n";
3118 $suppress_statement = $line_nr_next;
3119 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003120
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003121 # Find the real next line.
3122 $realline_next = $line_nr_next;
3123 if (defined $realline_next &&
3124 (!defined $lines[$realline_next - 1] ||
3125 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3126 $realline_next++;
3127 }
3128
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003129 my $s = $stat;
3130 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003131
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003132 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003133 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003134
3135 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003136 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003137
Andy Whitcroft463f2862009-09-21 17:04:34 -07003138 } elsif ($s =~ /^.\s*else\b/s) {
3139
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003140 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003141 } 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 -07003142 my $type = $1;
3143 $type =~ s/\s+/ /g;
3144 possible($type, "A:" . $s);
3145
Andy Whitcroft8905a672007-11-28 16:21:06 -08003146 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003147 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003148 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003149 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003150
3151 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003152 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003153 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003154 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003155
3156 # Check for any sort of function declaration.
3157 # int foo(something bar, other baz);
3158 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003159 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 -08003160 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003161
Andy Whitcroftcf655042008-03-04 14:28:20 -08003162 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003163 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003164 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003165
Andy Whitcroft8905a672007-11-28 16:21:06 -08003166 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003167 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003168
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003169 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003170 }
3171 }
3172 }
3173
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003174 }
3175
Andy Whitcroft653d4872007-06-23 17:16:34 -07003176#
3177# Checks which may be anchored in the context.
3178#
3179
3180# Check for switch () and associated case and default
3181# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003182 if ($line=~/\bswitch\s*\(.*\)/) {
3183 my $err = '';
3184 my $sep = '';
3185 my @ctx = ctx_block_outer($linenr, $realcnt);
3186 shift(@ctx);
3187 for my $ctx (@ctx) {
3188 my ($clen, $cindent) = line_stats($ctx);
3189 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3190 $indent != $cindent) {
3191 $err .= "$sep$ctx\n";
3192 $sep = '';
3193 } else {
3194 $sep = "[...]\n";
3195 }
3196 }
3197 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003198 ERROR("SWITCH_CASE_INDENT_LEVEL",
3199 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003200 }
3201 }
3202
3203# if/while/etc brace do not go on next line, unless defining a do while loop,
3204# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003205 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 -07003206 my $pre_ctx = "$1$2";
3207
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003208 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003209
3210 if ($line =~ /^\+\t{6,}/) {
3211 WARN("DEEP_INDENTATION",
3212 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3213 }
3214
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003215 my $ctx_cnt = $realcnt - $#ctx - 1;
3216 my $ctx = join("\n", @ctx);
3217
Andy Whitcroft548596d2008-07-23 21:29:01 -07003218 my $ctx_ln = $linenr;
3219 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003220
Andy Whitcroft548596d2008-07-23 21:29:01 -07003221 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3222 defined $lines[$ctx_ln - 1] &&
3223 $lines[$ctx_ln - 1] =~ /^-/)) {
3224 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3225 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003226 $ctx_ln++;
3227 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003228
Andy Whitcroft53210162008-07-23 21:29:03 -07003229 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3230 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003231
Joe Perchesd752fcc2014-08-06 16:11:05 -07003232 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003233 ERROR("OPEN_BRACE",
3234 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003235 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003236 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003237 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3238 $ctx =~ /\)\s*\;\s*$/ &&
3239 defined $lines[$ctx_ln - 1])
3240 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003241 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3242 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003243 WARN("TRAILING_SEMICOLON",
3244 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003245 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003246 }
3247 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003248 }
3249
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003250# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003251 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 -08003252 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3253 ctx_statement_block($linenr, $realcnt, 0)
3254 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003255 my ($s, $c) = ($stat, $cond);
3256
3257 substr($s, 0, length($c), '');
3258
Joe Perches9f5af482015-09-09 15:37:30 -07003259 # remove inline comments
3260 $s =~ s/$;/ /g;
3261 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003262
3263 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003264 my @newlines = ($c =~ /\n/gs);
3265 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003266
Joe Perches9f5af482015-09-09 15:37:30 -07003267 # Make sure we remove the line prefixes as we have
3268 # none on the first line, and are going to readd them
3269 # where necessary.
3270 $s =~ s/\n./\n/gs;
3271 while ($s =~ /\n\s+\\\n/) {
3272 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3273 }
3274
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003275 # We want to check the first line inside the block
3276 # starting at the end of the conditional, so remove:
3277 # 1) any blank line termination
3278 # 2) any opening brace { on end of the line
3279 # 3) any do (...) {
3280 my $continuation = 0;
3281 my $check = 0;
3282 $s =~ s/^.*\bdo\b//;
3283 $s =~ s/^\s*{//;
3284 if ($s =~ s/^\s*\\//) {
3285 $continuation = 1;
3286 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003287 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003288 $check = 1;
3289 $cond_lines++;
3290 }
3291
3292 # Also ignore a loop construct at the end of a
3293 # preprocessor statement.
3294 if (($prevline =~ /^.\s*#\s*define\s/ ||
3295 $prevline =~ /\\\s*$/) && $continuation == 0) {
3296 $check = 0;
3297 }
3298
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003299 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003300 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003301 while ($cond_ptr != $cond_lines) {
3302 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003303
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003304 # If we see an #else/#elif then the code
3305 # is not linear.
3306 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3307 $check = 0;
3308 }
3309
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003310 # Ignore:
3311 # 1) blank lines, they should be at 0,
3312 # 2) preprocessor lines, and
3313 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003314 if ($continuation ||
3315 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003316 $s =~ /^\s*#\s*?/ ||
3317 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003318 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003319 if ($s =~ s/^.*?\n//) {
3320 $cond_lines++;
3321 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003322 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003323 }
3324
3325 my (undef, $sindent) = line_stats("+" . $s);
3326 my $stat_real = raw_line($linenr, $cond_lines);
3327
3328 # Check if either of these lines are modified, else
3329 # this is not this patch's fault.
3330 if (!defined($stat_real) ||
3331 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3332 $check = 0;
3333 }
3334 if (defined($stat_real) && $cond_lines > 1) {
3335 $stat_real = "[...]\n$stat_real";
3336 }
3337
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003338 #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 -07003339
Joe Perches9f5af482015-09-09 15:37:30 -07003340 if ($check && $s ne '' &&
3341 (($sindent % 8) != 0 ||
3342 ($sindent < $indent) ||
3343 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003344 WARN("SUSPECT_CODE_INDENT",
3345 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003346 }
3347 }
3348
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003349 # Track the 'values' across context and added lines.
3350 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003351 my ($curr_values, $curr_vars) =
3352 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003353 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003354 if ($dbg_values) {
3355 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003356 print "$linenr > .$outline\n";
3357 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003358 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003359 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003360 $prev_values = substr($curr_values, -1);
3361
Andy Whitcroft00df3442007-06-08 13:47:06 -07003362#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003363 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003364
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003365# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003366 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 -07003367 my $type = $1;
3368 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003369 $var = "" if (!defined $var);
3370 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003371 my $sign = $1;
3372 my $pointer = $2;
3373
3374 $pointer = "" if (!defined $pointer);
3375
3376 if (WARN("UNSPECIFIED_INT",
3377 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3378 $fix) {
3379 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003380 my $comp_pointer = $pointer;
3381 $comp_pointer =~ s/\s//g;
3382 $decl .= $comp_pointer;
3383 $decl = rtrim($decl) if ($var eq "");
3384 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003385 }
3386 }
3387 }
3388
Andy Whitcroft653d4872007-06-23 17:16:34 -07003389# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003390 if ($dbg_type) {
3391 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003392 ERROR("TEST_TYPE",
3393 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003394 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003395 ERROR("TEST_NOT_TYPE",
3396 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003397 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003398 next;
3399 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003400# TEST: allow direct testing of the attribute matcher.
3401 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003402 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003403 ERROR("TEST_ATTR",
3404 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003405 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003406 ERROR("TEST_NOT_ATTR",
3407 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003408 }
3409 next;
3410 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003411
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003412# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003413 if ($line =~ /^.\s*{/ &&
3414 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003415 if (ERROR("OPEN_BRACE",
3416 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003417 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3418 fix_delete_line($fixlinenr - 1, $prevrawline);
3419 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003420 my $fixedline = $prevrawline;
3421 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003422 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003423 $fixedline = $line;
3424 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003425 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003426 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003427 }
3428
Andy Whitcroft653d4872007-06-23 17:16:34 -07003429#
3430# Checks which are anchored on the added line.
3431#
3432
3433# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003434 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003435 my $path = $1;
3436 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003437 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003438 "malformed #include filename\n" . $herecurr);
3439 }
3440 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3441 ERROR("UAPI_INCLUDE",
3442 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003443 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003444 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003445
3446# no C99 // comments
3447 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003448 if (ERROR("C99_COMMENTS",
3449 "do not use C99 // comments\n" . $herecurr) &&
3450 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003451 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003452 if ($line =~ /\/\/(.*)$/) {
3453 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003454 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003455 }
3456 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003457 }
3458 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003459 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003460 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003461
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003462# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3463# the whole statement.
3464#print "APW <$lines[$realline_next - 1]>\n";
3465 if (defined $realline_next &&
3466 exists $lines[$realline_next - 1] &&
3467 !defined $suppress_export{$realline_next} &&
3468 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3469 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003470 # Handle definitions which produce identifiers with
3471 # a prefix:
3472 # XXX(foo);
3473 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003474 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003475 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003476 $name =~ /^${Ident}_$2/) {
3477#print "FOO C name<$name>\n";
3478 $suppress_export{$realline_next} = 1;
3479
3480 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003481 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003482 ^.DEFINE_$Ident\(\Q$name\E\)|
3483 ^.DECLARE_$Ident\(\Q$name\E\)|
3484 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003485 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3486 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003487 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003488#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3489 $suppress_export{$realline_next} = 2;
3490 } else {
3491 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003492 }
3493 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003494 if (!defined $suppress_export{$linenr} &&
3495 $prevline =~ /^.\s*$/ &&
3496 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3497 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3498#print "FOO B <$lines[$linenr - 1]>\n";
3499 $suppress_export{$linenr} = 2;
3500 }
3501 if (defined $suppress_export{$linenr} &&
3502 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003503 WARN("EXPORT_SYMBOL",
3504 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003505 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003506
Joe Eloff5150bda2010-08-09 17:21:00 -07003507# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003508 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003509 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003510 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003511 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003512 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003513 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003514 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003515# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003516 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003517 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003518 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003519 $herecurr) &&
3520 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003521 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003522 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003523 }
3524
Joe Perches18130872014-08-06 16:11:22 -07003525# check for misordered declarations of char/short/int/long with signed/unsigned
3526 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3527 my $tmp = trim($1);
3528 WARN("MISORDERED_TYPE",
3529 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3530 }
3531
Joe Perchescb710ec2010-10-26 14:23:20 -07003532# check for static const char * arrays.
3533 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003534 WARN("STATIC_CONST_CHAR_ARRAY",
3535 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003536 $herecurr);
3537 }
3538
3539# check for static char foo[] = "bar" declarations.
3540 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003541 WARN("STATIC_CONST_CHAR_ARRAY",
3542 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003543 $herecurr);
3544 }
3545
Joe Perchesab7e23f2015-04-16 12:44:22 -07003546# check for const <foo> const where <foo> is not a pointer or array type
3547 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3548 my $found = $1;
3549 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3550 WARN("CONST_CONST",
3551 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3552 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3553 WARN("CONST_CONST",
3554 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3555 }
3556 }
3557
Joe Perches9b0fa602014-04-03 14:49:18 -07003558# check for non-global char *foo[] = {"bar", ...} declarations.
3559 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3560 WARN("STATIC_CONST_CHAR_ARRAY",
3561 "char * array declaration might be better as static const\n" .
3562 $herecurr);
3563 }
3564
Joe Perchesb598b672015-04-16 12:44:36 -07003565# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3566 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3567 my $array = $1;
3568 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3569 my $array_div = $1;
3570 if (WARN("ARRAY_SIZE",
3571 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3572 $fix) {
3573 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3574 }
3575 }
3576 }
3577
Joe Perchesb36190c2014-01-27 17:07:18 -08003578# check for function declarations without arguments like "int foo()"
3579 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3580 if (ERROR("FUNCTION_WITHOUT_ARGS",
3581 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3582 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003583 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003584 }
3585 }
3586
Andy Whitcroft653d4872007-06-23 17:16:34 -07003587# check for new typedefs, only function parameters and sparse annotations
3588# make sense.
3589 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003590 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003591 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003592 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003593 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003594 WARN("NEW_TYPEDEFS",
3595 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003596 }
3597
3598# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003599 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003600 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3601 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003602 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003603
Andy Whitcroft65863862009-01-06 14:41:21 -08003604 # Should start with a space.
3605 $to =~ s/^(\S)/ $1/;
3606 # Should not end with a space.
3607 $to =~ s/\s+$//;
3608 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003609 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003610 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003611
Joe Perches3705ce52013-07-03 15:05:31 -07003612## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003613 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003614 if (ERROR("POINTER_LOCATION",
3615 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3616 $fix) {
3617 my $sub_from = $ident;
3618 my $sub_to = $ident;
3619 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003620 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003621 s@\Q$sub_from\E@$sub_to@;
3622 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003623 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003624 }
3625 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3626 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003627 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003628
Andy Whitcroft65863862009-01-06 14:41:21 -08003629 # Should start with a space.
3630 $to =~ s/^(\S)/ $1/;
3631 # Should not end with a space.
3632 $to =~ s/\s+$//;
3633 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003634 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003635 }
3636 # Modifiers should have spaces.
3637 $to =~ s/(\b$Modifier$)/$1 /;
3638
Joe Perches3705ce52013-07-03 15:05:31 -07003639## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003640 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003641 if (ERROR("POINTER_LOCATION",
3642 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3643 $fix) {
3644
3645 my $sub_from = $match;
3646 my $sub_to = $match;
3647 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003648 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003649 s@\Q$sub_from\E@$sub_to@;
3650 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003651 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003652 }
3653
Joe Perches9d3e3c72015-09-09 15:37:27 -07003654# avoid BUG() or BUG_ON()
3655 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3656 my $msg_type = \&WARN;
3657 $msg_type = \&CHK if ($file);
3658 &{$msg_type}("AVOID_BUG",
3659 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3660 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003661
Joe Perches9d3e3c72015-09-09 15:37:27 -07003662# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003663 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003664 WARN("LINUX_VERSION_CODE",
3665 "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 -08003666 }
3667
Joe Perches17441222011-06-15 15:08:17 -07003668# check for uses of printk_ratelimit
3669 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003670 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003671 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003672 }
3673
Andy Whitcroft00df3442007-06-08 13:47:06 -07003674# printk should use KERN_* levels. Note that follow on printk's on the
3675# same line do not need a level, so we use the current block context
3676# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003677# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003678# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003679 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003680 my $ok = 0;
3681 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3682 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003683 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003684 # with "\n" ignore it, else it is to blame
3685 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3686 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3687 $ok = 1;
3688 }
3689 last;
3690 }
3691 }
3692 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003693 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3694 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003695 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003696 }
3697
Joe Perches243f3802012-05-31 16:26:09 -07003698 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3699 my $orig = $1;
3700 my $level = lc($orig);
3701 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003702 my $level2 = $level;
3703 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003704 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003705 "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 -07003706 }
3707
3708 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003709 if (WARN("PREFER_PR_LEVEL",
3710 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3711 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003712 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003713 s/\bpr_warning\b/pr_warn/;
3714 }
Joe Perches243f3802012-05-31 16:26:09 -07003715 }
3716
Joe Perchesdc139312013-02-21 16:44:13 -08003717 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3718 my $orig = $1;
3719 my $level = lc($orig);
3720 $level = "warn" if ($level eq "warning");
3721 $level = "dbg" if ($level eq "debug");
3722 WARN("PREFER_DEV_LEVEL",
3723 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3724 }
3725
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003726# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3727# number of false positives, but assembly files are not checked, so at
3728# least the arch entry code will not trigger this warning.
3729 if ($line =~ /\bENOSYS\b/) {
3730 WARN("ENOSYS",
3731 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3732 }
3733
Andy Whitcroft653d4872007-06-23 17:16:34 -07003734# function brace can't be on same line, except for #defines of do while,
3735# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003736 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003737 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003738 if (ERROR("OPEN_BRACE",
3739 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3740 $fix) {
3741 fix_delete_line($fixlinenr, $rawline);
3742 my $fixed_line = $rawline;
3743 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3744 my $line1 = $1;
3745 my $line2 = $2;
3746 fix_insert_line($fixlinenr, ltrim($line1));
3747 fix_insert_line($fixlinenr, "\+{");
3748 if ($line2 !~ /^\s*$/) {
3749 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3750 }
3751 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003752 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003753
Andy Whitcroft8905a672007-11-28 16:21:06 -08003754# open braces for enum, union and struct go on the same line.
3755 if ($line =~ /^.\s*{/ &&
3756 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003757 if (ERROR("OPEN_BRACE",
3758 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3759 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3760 fix_delete_line($fixlinenr - 1, $prevrawline);
3761 fix_delete_line($fixlinenr, $rawline);
3762 my $fixedline = rtrim($prevrawline) . " {";
3763 fix_insert_line($fixlinenr, $fixedline);
3764 $fixedline = $rawline;
3765 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3766 if ($fixedline !~ /^\+\s*$/) {
3767 fix_insert_line($fixlinenr, $fixedline);
3768 }
3769 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003770 }
3771
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003772# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003773 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3774 if (WARN("SPACING",
3775 "missing space after $1 definition\n" . $herecurr) &&
3776 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003777 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003778 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3779 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003780 }
3781
Joe Perches31070b52014-01-23 15:54:49 -08003782# Function pointer declarations
3783# check spacing between type, funcptr, and args
3784# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003785 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003786 my $declare = $1;
3787 my $pre_pointer_space = $2;
3788 my $post_pointer_space = $3;
3789 my $funcname = $4;
3790 my $post_funcname_space = $5;
3791 my $pre_args_space = $6;
3792
Joe Perches91f72e92014-04-03 14:49:12 -07003793# the $Declare variable will capture all spaces after the type
3794# so check it for a missing trailing missing space but pointer return types
3795# don't need a space so don't warn for those.
3796 my $post_declare_space = "";
3797 if ($declare =~ /(\s+)$/) {
3798 $post_declare_space = $1;
3799 $declare = rtrim($declare);
3800 }
3801 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003802 WARN("SPACING",
3803 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003804 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003805 }
3806
3807# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003808# This test is not currently implemented because these declarations are
3809# equivalent to
3810# int foo(int bar, ...)
3811# and this is form shouldn't/doesn't generate a checkpatch warning.
3812#
3813# elsif ($declare =~ /\s{2,}$/) {
3814# WARN("SPACING",
3815# "Multiple spaces after return type\n" . $herecurr);
3816# }
Joe Perches31070b52014-01-23 15:54:49 -08003817
3818# unnecessary space "type ( *funcptr)(args...)"
3819 if (defined $pre_pointer_space &&
3820 $pre_pointer_space =~ /^\s/) {
3821 WARN("SPACING",
3822 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3823 }
3824
3825# unnecessary space "type (* funcptr)(args...)"
3826 if (defined $post_pointer_space &&
3827 $post_pointer_space =~ /^\s/) {
3828 WARN("SPACING",
3829 "Unnecessary space before function pointer name\n" . $herecurr);
3830 }
3831
3832# unnecessary space "type (*funcptr )(args...)"
3833 if (defined $post_funcname_space &&
3834 $post_funcname_space =~ /^\s/) {
3835 WARN("SPACING",
3836 "Unnecessary space after function pointer name\n" . $herecurr);
3837 }
3838
3839# unnecessary space "type (*funcptr) (args...)"
3840 if (defined $pre_args_space &&
3841 $pre_args_space =~ /^\s/) {
3842 WARN("SPACING",
3843 "Unnecessary space before function pointer arguments\n" . $herecurr);
3844 }
3845
3846 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003847 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003848 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003849 }
3850 }
3851
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003852# check for spacing round square brackets; allowed:
3853# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003854# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3855# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003856 while ($line =~ /(.*?\s)\[/g) {
3857 my ($where, $prefix) = ($-[1], $1);
3858 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003859 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003860 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003861 if (ERROR("BRACKET_SPACE",
3862 "space prohibited before open square bracket '['\n" . $herecurr) &&
3863 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003864 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003865 s/^(\+.*?)\s+\[/$1\[/;
3866 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003867 }
3868 }
3869
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003870# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003871 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003872 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003873 my $ctx_before = substr($line, 0, $-[1]);
3874 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003875
3876 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003877 if ($name =~ /^(?:
3878 if|for|while|switch|return|case|
3879 volatile|__volatile__|
3880 __attribute__|format|__extension__|
3881 asm|__asm__)$/x)
3882 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003883 # cpp #define statements have non-optional spaces, ie
3884 # if there is a space between the name and the open
3885 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003886 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003887
3888 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003889 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003890
3891 # If this whole things ends with a type its most
3892 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003893 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003894
3895 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003896 if (WARN("SPACING",
3897 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3898 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003899 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003900 s/\b$name\s+\(/$name\(/;
3901 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003902 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003903 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003904
Andy Whitcroft653d4872007-06-23 17:16:34 -07003905# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003906 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003907 my $fixed_line = "";
3908 my $line_fixed = 0;
3909
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003910 my $ops = qr{
3911 <<=|>>=|<=|>=|==|!=|
3912 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3913 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003914 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003915 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003916 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003917 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003918
3919## print("element count: <" . $#elements . ">\n");
3920## foreach my $el (@elements) {
3921## print("el: <$el>\n");
3922## }
3923
3924 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003925 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003926
Joe Perches3705ce52013-07-03 15:05:31 -07003927 foreach my $el (@elements) {
3928 push(@fix_elements, substr($rawline, $off, length($el)));
3929 $off += length($el);
3930 }
3931
3932 $off = 0;
3933
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003934 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003935 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003936
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003937 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003938
3939 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3940
3941## print("n: <$n> good: <$good>\n");
3942
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003943 $off += length($elements[$n]);
3944
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003945 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003946 my $ca = substr($opline, 0, $off);
3947 my $cc = '';
3948 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3949 $cc = substr($opline, $off + length($elements[$n + 1]));
3950 }
3951 my $cb = "$ca$;$cc";
3952
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003953 my $a = '';
3954 $a = 'V' if ($elements[$n] ne '');
3955 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003956 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003957 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3958 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003959 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003960
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003961 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003962
3963 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003964 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003965 $c = 'V' if ($elements[$n + 2] ne '');
3966 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003967 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003968 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3969 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003970 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003971 } else {
3972 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003973 }
3974
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003975 my $ctx = "${a}x${c}";
3976
3977 my $at = "(ctx:$ctx)";
3978
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003979 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003980 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003981
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003982 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003983 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003984
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003985 # Get the full operator variant.
3986 my $opv = $op . substr($curr_vars, $off, 1);
3987
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003988 # Ignore operators passed as parameters.
3989 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07003990 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003991
Andy Whitcroftcf655042008-03-04 14:28:20 -08003992# # Ignore comments
3993# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003994
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003995 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003996 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003997 if ($ctx !~ /.x[WEBC]/ &&
3998 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003999 if (ERROR("SPACING",
4000 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004001 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004002 $line_fixed = 1;
4003 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004004 }
4005
4006 # // is a comment
4007 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004008
Joe Perchesb00e4812014-04-03 14:49:33 -07004009 # : when part of a bitfield
4010 } elsif ($opv eq ':B') {
4011 # skip the bitfield test for now
4012
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004013 # No spaces for:
4014 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004015 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004016 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004017 if (ERROR("SPACING",
4018 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004019 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004020 if (defined $fix_elements[$n + 2]) {
4021 $fix_elements[$n + 2] =~ s/^\s+//;
4022 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004023 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004024 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004025 }
4026
Joe Perches23810972014-12-10 15:51:32 -08004027 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004028 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004029 my $rtrim_before = 0;
4030 my $space_after = 0;
4031 if ($ctx =~ /Wx./) {
4032 if (ERROR("SPACING",
4033 "space prohibited before that '$op' $at\n" . $hereptr)) {
4034 $line_fixed = 1;
4035 $rtrim_before = 1;
4036 }
4037 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004038 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004039 if (ERROR("SPACING",
4040 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004041 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004042 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004043 $space_after = 1;
4044 }
4045 }
4046 if ($rtrim_before || $space_after) {
4047 if ($rtrim_before) {
4048 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4049 } else {
4050 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4051 }
4052 if ($space_after) {
4053 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004054 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004055 }
4056
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004057 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004058 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004059 #warn "'*' is part of type\n";
4060
4061 # unary operators should have a space before and
4062 # none after. May be left adjacent to another
4063 # unary operator, or a cast
4064 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004065 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004066 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004067 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004068 if (ERROR("SPACING",
4069 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004070 if ($n != $last_after + 2) {
4071 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4072 $line_fixed = 1;
4073 }
Joe Perches3705ce52013-07-03 15:05:31 -07004074 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004075 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004076 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004077 # A unary '*' may be const
4078
4079 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004080 if (ERROR("SPACING",
4081 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004082 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004083 if (defined $fix_elements[$n + 2]) {
4084 $fix_elements[$n + 2] =~ s/^\s+//;
4085 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004086 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004087 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004088 }
4089
4090 # unary ++ and unary -- are allowed no space on one side.
4091 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004092 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004093 if (ERROR("SPACING",
4094 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004095 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004096 $line_fixed = 1;
4097 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004098 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004099 if ($ctx =~ /Wx[BE]/ ||
4100 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004101 if (ERROR("SPACING",
4102 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004103 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004104 $line_fixed = 1;
4105 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004106 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004107 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004108 if (ERROR("SPACING",
4109 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004110 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004111 if (defined $fix_elements[$n + 2]) {
4112 $fix_elements[$n + 2] =~ s/^\s+//;
4113 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004114 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004115 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004116 }
4117
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004118 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004119 } elsif ($op eq '<<' or $op eq '>>' or
4120 $op eq '&' or $op eq '^' or $op eq '|' or
4121 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004122 $op eq '*' or $op eq '/' or
4123 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004124 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004125 if ($check) {
4126 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4127 if (CHK("SPACING",
4128 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4129 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4130 $fix_elements[$n + 2] =~ s/^\s+//;
4131 $line_fixed = 1;
4132 }
4133 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4134 if (CHK("SPACING",
4135 "space preferred before that '$op' $at\n" . $hereptr)) {
4136 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4137 $line_fixed = 1;
4138 }
4139 }
4140 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004141 if (ERROR("SPACING",
4142 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004143 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4144 if (defined $fix_elements[$n + 2]) {
4145 $fix_elements[$n + 2] =~ s/^\s+//;
4146 }
Joe Perches3705ce52013-07-03 15:05:31 -07004147 $line_fixed = 1;
4148 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004149 }
4150
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004151 # A colon needs no spaces before when it is
4152 # terminating a case value or a label.
4153 } elsif ($opv eq ':C' || $opv eq ':L') {
4154 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004155 if (ERROR("SPACING",
4156 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004157 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004158 $line_fixed = 1;
4159 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004160 }
4161
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004162 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004163 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004164 my $ok = 0;
4165
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004166 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004167 if (($op eq '<' &&
4168 $cc =~ /^\S+\@\S+>/) ||
4169 ($op eq '>' &&
4170 $ca =~ /<\S+\@\S+$/))
4171 {
4172 $ok = 1;
4173 }
4174
Joe Perchese0df7e12015-04-16 12:44:53 -07004175 # for asm volatile statements
4176 # ignore a colon with another
4177 # colon immediately before or after
4178 if (($op eq ':') &&
4179 ($ca =~ /:$/ || $cc =~ /^:/)) {
4180 $ok = 1;
4181 }
4182
Joe Perches84731622013-11-12 15:10:05 -08004183 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004184 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004185 my $msg_type = \&ERROR;
4186 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4187
4188 if (&{$msg_type}("SPACING",
4189 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004190 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4191 if (defined $fix_elements[$n + 2]) {
4192 $fix_elements[$n + 2] =~ s/^\s+//;
4193 }
Joe Perches3705ce52013-07-03 15:05:31 -07004194 $line_fixed = 1;
4195 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004196 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004197 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004198 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004199
4200## print("n: <$n> GOOD: <$good>\n");
4201
4202 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004203 }
Joe Perches3705ce52013-07-03 15:05:31 -07004204
4205 if (($#elements % 2) == 0) {
4206 $fixed_line = $fixed_line . $fix_elements[$#elements];
4207 }
4208
Joe Perches194f66f2014-08-06 16:11:03 -07004209 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4210 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004211 }
4212
4213
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004214 }
4215
Joe Perches786b6322013-07-03 15:05:32 -07004216# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004217 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004218 if (WARN("SPACING",
4219 "space prohibited before semicolon\n" . $herecurr) &&
4220 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004221 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004222 s/^(\+.*\S)\s+;/$1;/;
4223 }
4224 }
4225
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004226# check for multiple assignments
4227 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004228 CHK("MULTIPLE_ASSIGNMENTS",
4229 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004230 }
4231
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004232## # check for multiple declarations, allowing for a function declaration
4233## # continuation.
4234## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4235## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4236##
4237## # Remove any bracketed sections to ensure we do not
4238## # falsly report the parameters of functions.
4239## my $ln = $line;
4240## while ($ln =~ s/\([^\(\)]*\)//g) {
4241## }
4242## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004243## WARN("MULTIPLE_DECLARATION",
4244## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004245## }
4246## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004247
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004248#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004249 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004250 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004251 if (ERROR("SPACING",
4252 "space required before the open brace '{'\n" . $herecurr) &&
4253 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004254 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004255 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004256 }
4257
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004258## # check for blank lines before declarations
4259## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4260## $prevrawline =~ /^.\s*$/) {
4261## WARN("SPACING",
4262## "No blank lines before declarations\n" . $hereprev);
4263## }
4264##
4265
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004266# closing brace should have a space following it when it has anything
4267# on the line
4268 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004269 if (ERROR("SPACING",
4270 "space required after that close brace '}'\n" . $herecurr) &&
4271 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004272 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004273 s/}((?!(?:,|;|\)))\S)/} $1/;
4274 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004275 }
4276
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004277# check spacing on square brackets
4278 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004279 if (ERROR("SPACING",
4280 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4281 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004282 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004283 s/\[\s+/\[/;
4284 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004285 }
4286 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004287 if (ERROR("SPACING",
4288 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4289 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004290 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004291 s/\s+\]/\]/;
4292 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004293 }
4294
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004295# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004296 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
4297 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004298 if (ERROR("SPACING",
4299 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4300 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004301 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004302 s/\(\s+/\(/;
4303 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004304 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004305 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004306 $line !~ /for\s*\(.*;\s+\)/ &&
4307 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004308 if (ERROR("SPACING",
4309 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4310 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004311 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004312 s/\s+\)/\)/;
4313 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004314 }
4315
Joe Perchese2826fd2014-08-06 16:10:48 -07004316# check unnecessary parentheses around addressof/dereference single $Lvals
4317# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4318
4319 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004320 my $var = $1;
4321 if (CHK("UNNECESSARY_PARENTHESES",
4322 "Unnecessary parentheses around $var\n" . $herecurr) &&
4323 $fix) {
4324 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4325 }
4326 }
4327
4328# check for unnecessary parentheses around function pointer uses
4329# ie: (foo->bar)(); should be foo->bar();
4330# but not "if (foo->bar) (" to avoid some false positives
4331 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4332 my $var = $2;
4333 if (CHK("UNNECESSARY_PARENTHESES",
4334 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4335 $fix) {
4336 my $var2 = deparenthesize($var);
4337 $var2 =~ s/\s//g;
4338 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4339 }
4340 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004341
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004342#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004343 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004344 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004345 if (WARN("INDENTED_LABEL",
4346 "labels should not be indented\n" . $herecurr) &&
4347 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004348 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004349 s/^(.)\s+/$1/;
4350 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004351 }
4352
Joe Perches5b9553a2014-04-03 14:49:21 -07004353# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004354 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004355 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004356 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004357 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4358 my $value = $1;
4359 $value = deparenthesize($value);
4360 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4361 ERROR("RETURN_PARENTHESES",
4362 "return is not a function, parentheses are not required\n" . $herecurr);
4363 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004364 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004365 ERROR("SPACING",
4366 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004367 }
4368 }
Joe Perches507e5142013-11-12 15:10:13 -08004369
Joe Perchesb43ae212014-06-23 13:22:07 -07004370# unnecessary return in a void function
4371# at end-of-function, with the previous line a single leading tab, then return;
4372# and the line before that not a goto label target like "out:"
4373 if ($sline =~ /^[ \+]}\s*$/ &&
4374 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4375 $linenr >= 3 &&
4376 $lines[$linenr - 3] =~ /^[ +]/ &&
4377 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004378 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004379 "void function return statements are not generally useful\n" . $hereprev);
4380 }
Joe Perches9819cf22014-06-04 16:12:09 -07004381
Joe Perches189248d2014-01-23 15:54:47 -08004382# if statements using unnecessary parentheses - ie: if ((foo == bar))
4383 if ($^V && $^V ge 5.10.0 &&
4384 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4385 my $openparens = $1;
4386 my $count = $openparens =~ tr@\(@\(@;
4387 my $msg = "";
4388 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4389 my $comp = $4; #Not $1 because of $LvalOrFunc
4390 $msg = " - maybe == should be = ?" if ($comp eq "==");
4391 WARN("UNNECESSARY_PARENTHESES",
4392 "Unnecessary parentheses$msg\n" . $herecurr);
4393 }
4394 }
4395
Joe Perchesc5595fa2015-09-09 15:37:58 -07004396# comparisons with a constant or upper case identifier on the left
4397# avoid cases like "foo + BAR < baz"
4398# only fix matches surrounded by parentheses to avoid incorrect
4399# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4400 if ($^V && $^V ge 5.10.0 &&
4401 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4402 my $lead = $1;
4403 my $const = $2;
4404 my $comp = $3;
4405 my $to = $4;
4406 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004407 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004408 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4409 WARN("CONSTANT_COMPARISON",
4410 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4411 $fix) {
4412 if ($comp eq "<") {
4413 $newcomp = ">";
4414 } elsif ($comp eq "<=") {
4415 $newcomp = ">=";
4416 } elsif ($comp eq ">") {
4417 $newcomp = "<";
4418 } elsif ($comp eq ">=") {
4419 $newcomp = "<=";
4420 }
4421 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4422 }
4423 }
4424
Joe Perchesf34e4a42015-04-16 12:44:19 -07004425# Return of what appears to be an errno should normally be negative
4426 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004427 my $name = $1;
4428 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004429 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004430 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004431 }
4432 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004433
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004434# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004435 if ($line =~ /\b(if|while|for|switch)\(/) {
4436 if (ERROR("SPACING",
4437 "space required before the open parenthesis '('\n" . $herecurr) &&
4438 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004439 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004440 s/\b(if|while|for|switch)\(/$1 \(/;
4441 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004442 }
4443
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004444# Check for illegal assignment in if conditional -- and check for trailing
4445# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004446 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004447 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4448 ctx_statement_block($linenr, $realcnt, 0)
4449 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004450 my ($stat_next) = ctx_statement_block($line_nr_next,
4451 $remain_next, $off_next);
4452 $stat_next =~ s/\n./\n /g;
4453 ##print "stat<$stat> stat_next<$stat_next>\n";
4454
4455 if ($stat_next =~ /^\s*while\b/) {
4456 # If the statement carries leading newlines,
4457 # then count those as offsets.
4458 my ($whitespace) =
4459 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4460 my $offset =
4461 statement_rawlines($whitespace) - 1;
4462
4463 $suppress_whiletrailers{$line_nr_next +
4464 $offset} = 1;
4465 }
4466 }
4467 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004468 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004469 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004470 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004471
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004472 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004473 ERROR("ASSIGN_IN_IF",
4474 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004475 }
4476
4477 # Find out what is on the end of the line after the
4478 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004479 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004480 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004481 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004482 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4483 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004484 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004485 # Find out how long the conditional actually is.
4486 my @newlines = ($c =~ /\n/gs);
4487 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004488 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004489
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004490 $stat_real = raw_line($linenr, $cond_lines)
4491 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004492 if (defined($stat_real) && $cond_lines > 1) {
4493 $stat_real = "[...]\n$stat_real";
4494 }
4495
Joe Perches000d1cc12011-07-25 17:13:25 -07004496 ERROR("TRAILING_STATEMENTS",
4497 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004498 }
4499 }
4500
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004501# Check for bitwise tests written as boolean
4502 if ($line =~ /
4503 (?:
4504 (?:\[|\(|\&\&|\|\|)
4505 \s*0[xX][0-9]+\s*
4506 (?:\&\&|\|\|)
4507 |
4508 (?:\&\&|\|\|)
4509 \s*0[xX][0-9]+\s*
4510 (?:\&\&|\|\||\)|\])
4511 )/x)
4512 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004513 WARN("HEXADECIMAL_BOOLEAN_TEST",
4514 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004515 }
4516
Andy Whitcroft8905a672007-11-28 16:21:06 -08004517# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004518 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4519 my $s = $1;
4520 $s =~ s/$;//g; # Remove any comments
4521 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004522 ERROR("TRAILING_STATEMENTS",
4523 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004524 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004525 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004526# if should not continue a brace
4527 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004528 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004529 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004530 $herecurr);
4531 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004532# case and default should not have general statements after them
4533 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4534 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004535 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004536 \s*return\s+
4537 )/xg)
4538 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004539 ERROR("TRAILING_STATEMENTS",
4540 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004541 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004542
4543 # Check for }<nl>else {, these must be at the same
4544 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004545 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4546 $previndent == $indent) {
4547 if (ERROR("ELSE_AFTER_BRACE",
4548 "else should follow close brace '}'\n" . $hereprev) &&
4549 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4550 fix_delete_line($fixlinenr - 1, $prevrawline);
4551 fix_delete_line($fixlinenr, $rawline);
4552 my $fixedline = $prevrawline;
4553 $fixedline =~ s/}\s*$//;
4554 if ($fixedline !~ /^\+\s*$/) {
4555 fix_insert_line($fixlinenr, $fixedline);
4556 }
4557 $fixedline = $rawline;
4558 $fixedline =~ s/^(.\s*)else/$1} else/;
4559 fix_insert_line($fixlinenr, $fixedline);
4560 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004561 }
4562
Joe Perches8b8856f2014-08-06 16:11:14 -07004563 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4564 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004565 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4566
4567 # Find out what is on the end of the line after the
4568 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004569 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004570 $s =~ s/\n.*//g;
4571
4572 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004573 if (ERROR("WHILE_AFTER_BRACE",
4574 "while should follow close brace '}'\n" . $hereprev) &&
4575 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4576 fix_delete_line($fixlinenr - 1, $prevrawline);
4577 fix_delete_line($fixlinenr, $rawline);
4578 my $fixedline = $prevrawline;
4579 my $trailing = $rawline;
4580 $trailing =~ s/^\+//;
4581 $trailing = trim($trailing);
4582 $fixedline =~ s/}\s*$/} $trailing/;
4583 fix_insert_line($fixlinenr, $fixedline);
4584 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004585 }
4586 }
4587
Joe Perches95e2c602013-07-03 15:05:20 -07004588#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004589 while ($line =~ m{($Constant|$Lval)}g) {
4590 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004591
4592#gcc binary extension
4593 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004594 if (WARN("GCC_BINARY_CONSTANT",
4595 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4596 $fix) {
4597 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004598 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004599 s/\b$var\b/$hexval/;
4600 }
Joe Perches95e2c602013-07-03 15:05:20 -07004601 }
4602
4603#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004604 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004605 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004606#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004607 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004608#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004609 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4610#Ignore some three character SI units explicitly, like MiB and KHz
4611 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004612 while ($var =~ m{($Ident)}g) {
4613 my $word = $1;
4614 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004615 if ($check) {
4616 seed_camelcase_includes();
4617 if (!$file && !$camelcase_file_seeded) {
4618 seed_camelcase_file($realfile);
4619 $camelcase_file_seeded = 1;
4620 }
4621 }
Joe Perches7e781f62013-09-11 14:23:55 -07004622 if (!defined $camelcase{$word}) {
4623 $camelcase{$word} = 1;
4624 CHK("CAMELCASE",
4625 "Avoid CamelCase: <$word>\n" . $herecurr);
4626 }
Joe Perches34456862013-07-03 15:05:34 -07004627 }
Joe Perches323c1262012-12-17 16:02:07 -08004628 }
4629 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004630
4631#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004632 if ($line =~ /\#\s*define.*\\\s+$/) {
4633 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4634 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4635 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004636 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004637 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004638 }
4639
Fabian Frederick0e212e02015-04-16 12:44:25 -07004640# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4641# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004642 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004643 my $file = "$1.h";
4644 my $checkfile = "include/linux/$file";
4645 if (-f "$root/$checkfile" &&
4646 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004647 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004648 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004649 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4650 if ($asminclude > 0) {
4651 if ($realfile =~ m{^arch/}) {
4652 CHK("ARCH_INCLUDE_LINUX",
4653 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4654 } else {
4655 WARN("INCLUDE_LINUX",
4656 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4657 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004658 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004659 }
4660 }
4661
Andy Whitcroft653d4872007-06-23 17:16:34 -07004662# multi-statement macros should be enclosed in a do while loop, grab the
4663# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004664# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07004665 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4666 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004667 my $ln = $linenr;
4668 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004669 my ($off, $dstat, $dcond, $rest);
4670 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004671 my $has_flow_statement = 0;
4672 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004673 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004674 ctx_statement_block($linenr, $realcnt, 0);
4675 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004676 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004677 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004678
Joe Perches08a28432014-10-13 15:51:55 -07004679 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004680 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004681
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004682 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004683 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004684 $dstat =~ s/\\\n.//g;
4685 $dstat =~ s/^\s*//s;
4686 $dstat =~ s/\s*$//s;
4687
4688 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004689 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4690 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004691 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004692 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004693 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004694
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004695 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004696 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4697 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004698 {
4699 }
4700
Joe Perches42e15292016-03-15 14:58:01 -07004701 # Make asm volatile uses seem like a generic function
4702 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4703
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004704 my $exceptions = qr{
4705 $Declare|
4706 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004707 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004708 DECLARE_PER_CPU|
4709 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004710 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004711 union|
4712 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004713 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004714 ^\"|\"$|
4715 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004716 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004717 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004718 if ($dstat ne '' &&
4719 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4720 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004721 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004722 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004723 $dstat !~ /$exceptions/ &&
4724 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004725 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004726 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004727 $dstat !~ /^for\s*$Constant$/ && # for (...)
4728 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4729 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004730 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004731 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004732 {
4733 $ctx =~ s/\n*$//;
4734 my $herectx = $here . "\n";
4735 my $cnt = statement_rawlines($ctx);
4736
4737 for (my $n = 0; $n < $cnt; $n++) {
4738 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004739 }
4740
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004741 if ($dstat =~ /;/) {
4742 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4743 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4744 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004745 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004746 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004747 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004748 }
Joe Perches5023d342012-12-17 16:01:47 -08004749
Joe Perches08a28432014-10-13 15:51:55 -07004750# check for macros with flow control, but without ## concatenation
4751# ## concatenation is commonly a macro that defines a function so ignore those
4752 if ($has_flow_statement && !$has_arg_concat) {
4753 my $herectx = $here . "\n";
4754 my $cnt = statement_rawlines($ctx);
4755
4756 for (my $n = 0; $n < $cnt; $n++) {
4757 $herectx .= raw_line($linenr, $n) . "\n";
4758 }
4759 WARN("MACRO_WITH_FLOW_CONTROL",
4760 "Macros with flow control statements should be avoided\n" . "$herectx");
4761 }
4762
Joe Perches481eb482012-12-17 16:01:56 -08004763# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004764
4765 } else {
4766 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004767 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4768 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004769 $line =~ /^\+.*\\$/) {
4770 WARN("LINE_CONTINUATIONS",
4771 "Avoid unnecessary line continuations\n" . $herecurr);
4772 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004773 }
4774
Joe Perchesb13edf72012-07-30 14:41:24 -07004775# do {} while (0) macro tests:
4776# single-statement macros do not need to be enclosed in do while (0) loop,
4777# macro should not end with a semicolon
4778 if ($^V && $^V ge 5.10.0 &&
4779 $realfile !~ m@/vmlinux.lds.h$@ &&
4780 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4781 my $ln = $linenr;
4782 my $cnt = $realcnt;
4783 my ($off, $dstat, $dcond, $rest);
4784 my $ctx = '';
4785 ($dstat, $dcond, $ln, $cnt, $off) =
4786 ctx_statement_block($linenr, $realcnt, 0);
4787 $ctx = $dstat;
4788
4789 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004790 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004791
4792 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4793 my $stmts = $2;
4794 my $semis = $3;
4795
4796 $ctx =~ s/\n*$//;
4797 my $cnt = statement_rawlines($ctx);
4798 my $herectx = $here . "\n";
4799
4800 for (my $n = 0; $n < $cnt; $n++) {
4801 $herectx .= raw_line($linenr, $n) . "\n";
4802 }
4803
Joe Perchesac8e97f2012-08-21 16:15:53 -07004804 if (($stmts =~ tr/;/;/) == 1 &&
4805 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004806 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4807 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4808 }
4809 if (defined $semis && $semis ne "") {
4810 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4811 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4812 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004813 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4814 $ctx =~ s/\n*$//;
4815 my $cnt = statement_rawlines($ctx);
4816 my $herectx = $here . "\n";
4817
4818 for (my $n = 0; $n < $cnt; $n++) {
4819 $herectx .= raw_line($linenr, $n) . "\n";
4820 }
4821
4822 WARN("TRAILING_SEMICOLON",
4823 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004824 }
4825 }
4826
Mike Frysinger080ba922009-01-06 14:41:25 -08004827# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4828# all assignments may have only one of the following with an assignment:
4829# .
4830# ALIGN(...)
4831# VMLINUX_SYMBOL(...)
4832 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004833 WARN("MISSING_VMLINUX_SYMBOL",
4834 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004835 }
4836
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004837# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004838 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4839 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004840 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004841 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004842 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4843 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07004844 my @allowed = ();
4845 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004846 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004847 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004848 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004849 for my $chunk (@chunks) {
4850 my ($cond, $block) = @{$chunk};
4851
Andy Whitcroft773647a2008-03-28 14:15:58 -07004852 # If the condition carries leading newlines, then count those as offsets.
4853 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
4854 my $offset = statement_rawlines($whitespace) - 1;
4855
Joe Perchesaad4f612012-03-23 15:02:19 -07004856 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004857 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4858
4859 # We have looked at and allowed this specific line.
4860 $suppress_ifbraces{$ln + $offset} = 1;
4861
4862 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004863 $ln += statement_rawlines($block) - 1;
4864
Andy Whitcroft773647a2008-03-28 14:15:58 -07004865 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004866
4867 $seen++ if ($block =~ /^\s*{/);
4868
Joe Perchesaad4f612012-03-23 15:02:19 -07004869 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004870 if (statement_lines($cond) > 1) {
4871 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004872 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004873 }
4874 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004875 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004876 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004877 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004878 if (statement_block_size($block) > 1) {
4879 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07004880 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004881 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004882 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004883 }
Joe Perchesaad4f612012-03-23 15:02:19 -07004884 if ($seen) {
4885 my $sum_allowed = 0;
4886 foreach (@allowed) {
4887 $sum_allowed += $_;
4888 }
4889 if ($sum_allowed == 0) {
4890 WARN("BRACES",
4891 "braces {} are not necessary for any arm of this statement\n" . $herectx);
4892 } elsif ($sum_allowed != $allow &&
4893 $seen != $allow) {
4894 CHK("BRACES",
4895 "braces {} should be used on all arms of this statement\n" . $herectx);
4896 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004897 }
4898 }
4899 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004900 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004901 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004902 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004903
Andy Whitcroftcf655042008-03-04 14:28:20 -08004904 # Check the pre-context.
4905 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
4906 #print "APW: ALLOWED: pre<$1>\n";
4907 $allowed = 1;
4908 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004909
4910 my ($level, $endln, @chunks) =
4911 ctx_statement_full($linenr, $realcnt, $-[0]);
4912
Andy Whitcroftcf655042008-03-04 14:28:20 -08004913 # Check the condition.
4914 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07004915 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004916 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004917 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08004918 }
4919 if (statement_lines($cond) > 1) {
4920 #print "APW: ALLOWED: cond<$cond>\n";
4921 $allowed = 1;
4922 }
4923 if ($block =~/\b(?:if|for|while)\b/) {
4924 #print "APW: ALLOWED: block<$block>\n";
4925 $allowed = 1;
4926 }
4927 if (statement_block_size($block) > 1) {
4928 #print "APW: ALLOWED: lines block<$block>\n";
4929 $allowed = 1;
4930 }
4931 # Check the post-context.
4932 if (defined $chunks[1]) {
4933 my ($cond, $block) = @{$chunks[1]};
4934 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004935 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004936 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004937 if ($block =~ /^\s*\{/) {
4938 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4939 $allowed = 1;
4940 }
4941 }
4942 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004943 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07004944 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004945
Andy Whitcroftf0556632008-10-15 22:02:23 -07004946 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07004947 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004948 }
4949
Joe Perches000d1cc12011-07-25 17:13:25 -07004950 WARN("BRACES",
4951 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004952 }
4953 }
4954
Joe Perches0979ae62012-12-17 16:01:59 -08004955# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07004956 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004957 if (CHK("BRACES",
4958 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
4959 $fix && $prevrawline =~ /^\+/) {
4960 fix_delete_line($fixlinenr - 1, $prevrawline);
4961 }
Joe Perches0979ae62012-12-17 16:01:59 -08004962 }
Joe Perches77b9a532013-07-03 15:05:29 -07004963 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08004964 if (CHK("BRACES",
4965 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
4966 $fix) {
4967 fix_delete_line($fixlinenr, $rawline);
4968 }
Joe Perches0979ae62012-12-17 16:01:59 -08004969 }
4970
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004971# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004972 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
4973 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004974 WARN("VOLATILE",
4975 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004976 }
4977
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004978# Check for user-visible strings broken across lines, which breaks the ability
4979# to grep for the string. Make exceptions when the previous string ends in a
4980# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4981# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07004982 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08004983 $prevline =~ /"\s*$/ &&
4984 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
4985 if (WARN("SPLIT_STRING",
4986 "quoted string split across lines\n" . $hereprev) &&
4987 $fix &&
4988 $prevrawline =~ /^\+.*"\s*$/ &&
4989 $last_coalesced_string_linenr != $linenr - 1) {
4990 my $extracted_string = get_quoted_string($line, $rawline);
4991 my $comma_close = "";
4992 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
4993 $comma_close = $1;
4994 }
4995
4996 fix_delete_line($fixlinenr - 1, $prevrawline);
4997 fix_delete_line($fixlinenr, $rawline);
4998 my $fixedline = $prevrawline;
4999 $fixedline =~ s/"\s*$//;
5000 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5001 fix_insert_line($fixlinenr - 1, $fixedline);
5002 $fixedline = $rawline;
5003 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5004 if ($fixedline !~ /\+\s*$/) {
5005 fix_insert_line($fixlinenr, $fixedline);
5006 }
5007 $last_coalesced_string_linenr = $linenr;
5008 }
5009 }
5010
5011# check for missing a space in a string concatenation
5012 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5013 WARN('MISSING_SPACE',
5014 "break quoted strings at a space character\n" . $hereprev);
5015 }
5016
5017# check for spaces before a quoted newline
5018 if ($rawline =~ /^.*\".*\s\\n/) {
5019 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5020 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5021 $fix) {
5022 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5023 }
5024
5025 }
5026
Joe Perchesf17dba42014-10-13 15:51:51 -07005027# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005028 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005029 CHK("CONCATENATED_STRING",
5030 "Concatenated strings should use spaces between elements\n" . $herecurr);
5031 }
5032
Joe Perches90ad30e2014-12-10 15:51:59 -08005033# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005034 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005035 WARN("STRING_FRAGMENTS",
5036 "Consecutive strings are generally better as a single string\n" . $herecurr);
5037 }
5038
Joe Perches6e300752015-09-09 15:37:47 -07005039# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005040 my $string;
5041 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5042 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5043 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005044 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005045 WARN("PRINTF_L",
5046 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5047 last;
5048 }
Joe Perches6e300752015-09-09 15:37:47 -07005049 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5050 ERROR("PRINTF_0xDECIMAL",
5051 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5052 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005053 }
5054
5055# check for line continuations in quoted strings with odd counts of "
5056 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5057 WARN("LINE_CONTINUATIONS",
5058 "Avoid line continuations in quoted strings\n" . $herecurr);
5059 }
5060
Andy Whitcroft00df3442007-06-08 13:47:06 -07005061# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005062 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005063 CHK("REDUNDANT_CODE",
5064 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005065 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005066 }
5067
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005068# check for needless "if (<foo>) fn(<foo>)" uses
5069 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005070 my $tested = quotemeta($1);
5071 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5072 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5073 my $func = $1;
5074 if (WARN('NEEDLESS_IF',
5075 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5076 $fix) {
5077 my $do_fix = 1;
5078 my $leading_tabs = "";
5079 my $new_leading_tabs = "";
5080 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5081 $leading_tabs = $1;
5082 } else {
5083 $do_fix = 0;
5084 }
5085 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5086 $new_leading_tabs = $1;
5087 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5088 $do_fix = 0;
5089 }
5090 } else {
5091 $do_fix = 0;
5092 }
5093 if ($do_fix) {
5094 fix_delete_line($fixlinenr - 1, $prevrawline);
5095 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5096 }
5097 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005098 }
5099 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005100
Joe Perchesebfdc402014-08-06 16:10:27 -07005101# check for unnecessary "Out of Memory" messages
5102 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5103 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5104 (defined $1 || defined $3) &&
5105 $linenr > 3) {
5106 my $testval = $2;
5107 my $testline = $lines[$linenr - 3];
5108
5109 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5110# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5111
5112 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5113 WARN("OOM_MESSAGE",
5114 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5115 }
5116 }
5117
Joe Perchesf78d98f2014-10-13 15:52:01 -07005118# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005119 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005120 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5121 my $level = $1;
5122 if (WARN("UNNECESSARY_KERN_LEVEL",
5123 "Possible unnecessary $level\n" . $herecurr) &&
5124 $fix) {
5125 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5126 }
5127 }
5128
Joe Perchesabb08a52014-12-10 15:51:46 -08005129# check for mask then right shift without a parentheses
5130 if ($^V && $^V ge 5.10.0 &&
5131 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5132 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5133 WARN("MASK_THEN_SHIFT",
5134 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5135 }
5136
Joe Perchesb75ac612014-12-10 15:52:02 -08005137# check for pointer comparisons to NULL
5138 if ($^V && $^V ge 5.10.0) {
5139 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5140 my $val = $1;
5141 my $equal = "!";
5142 $equal = "" if ($4 eq "!=");
5143 if (CHK("COMPARISON_TO_NULL",
5144 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5145 $fix) {
5146 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5147 }
5148 }
5149 }
5150
Joe Perches8716de32013-09-11 14:24:05 -07005151# check for bad placement of section $InitAttribute (e.g.: __initdata)
5152 if ($line =~ /(\b$InitAttribute\b)/) {
5153 my $attr = $1;
5154 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5155 my $ptr = $1;
5156 my $var = $2;
5157 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5158 ERROR("MISPLACED_INIT",
5159 "$attr should be placed after $var\n" . $herecurr)) ||
5160 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5161 WARN("MISPLACED_INIT",
5162 "$attr should be placed after $var\n" . $herecurr))) &&
5163 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005164 $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 -07005165 }
5166 }
5167 }
5168
Joe Perchese970b8842013-11-12 15:10:10 -08005169# check for $InitAttributeData (ie: __initdata) with const
5170 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5171 my $attr = $1;
5172 $attr =~ /($InitAttributePrefix)(.*)/;
5173 my $attr_prefix = $1;
5174 my $attr_type = $2;
5175 if (ERROR("INIT_ATTRIBUTE",
5176 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5177 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005178 $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005179 s/$InitAttributeData/${attr_prefix}initconst/;
5180 }
5181 }
5182
5183# check for $InitAttributeConst (ie: __initconst) without const
5184 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5185 my $attr = $1;
5186 if (ERROR("INIT_ATTRIBUTE",
5187 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5188 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005189 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b8842013-11-12 15:10:10 -08005190 /(^\+\s*(?:static\s+))/;
5191 $lead = rtrim($1);
5192 $lead = "$lead " if ($lead !~ /^\+$/);
5193 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005194 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b8842013-11-12 15:10:10 -08005195 }
5196 }
5197
Joe Perchesc17893c2015-04-16 12:44:42 -07005198# check for __read_mostly with const non-pointer (should just be const)
5199 if ($line =~ /\b__read_mostly\b/ &&
5200 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5201 if (ERROR("CONST_READ_MOSTLY",
5202 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5203 $fix) {
5204 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5205 }
5206 }
5207
Joe Perchesfbdb8132014-04-03 14:49:14 -07005208# don't use __constant_<foo> functions outside of include/uapi/
5209 if ($realfile !~ m@^include/uapi/@ &&
5210 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5211 my $constant_func = $1;
5212 my $func = $constant_func;
5213 $func =~ s/^__constant_//;
5214 if (WARN("CONSTANT_CONVERSION",
5215 "$constant_func should be $func\n" . $herecurr) &&
5216 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005217 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005218 }
5219 }
5220
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005221# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005222 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005223 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005224 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005225 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005226 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005227 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5228 }
5229 if ($delay > 2000) {
5230 WARN("LONG_UDELAY",
5231 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005232 }
5233 }
5234
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005235# warn about unexpectedly long msleep's
5236 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5237 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005238 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005239 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005240 }
5241 }
5242
Joe Perches36ec1932013-07-03 15:05:25 -07005243# check for comparisons of jiffies
5244 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5245 WARN("JIFFIES_COMPARISON",
5246 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5247 }
5248
Joe Perches9d7a34a2013-07-03 15:05:26 -07005249# check for comparisons of get_jiffies_64()
5250 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5251 WARN("JIFFIES_COMPARISON",
5252 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5253 }
5254
Andy Whitcroft00df3442007-06-08 13:47:06 -07005255# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005256# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005257# print "#ifdef in C files should be avoided\n";
5258# print "$herecurr";
5259# $clean = 0;
5260# }
5261
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005262# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005263 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005264 if (ERROR("SPACING",
5265 "exactly one space required after that #$1\n" . $herecurr) &&
5266 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005267 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005268 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5269 }
5270
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005271 }
5272
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005273# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005274 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5275 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005276 my $which = $1;
5277 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005278 CHK("UNCOMMENTED_DEFINITION",
5279 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005280 }
5281 }
5282# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005283
5284 my $barriers = qr{
5285 mb|
5286 rmb|
5287 wmb|
5288 read_barrier_depends
5289 }x;
5290 my $barrier_stems = qr{
5291 mb__before_atomic|
5292 mb__after_atomic|
5293 store_release|
5294 load_acquire|
5295 store_mb|
5296 (?:$barriers)
5297 }x;
5298 my $all_barriers = qr{
5299 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005300 smp_(?:$barrier_stems)|
5301 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005302 }x;
5303
5304 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005305 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005306 WARN("MEMORY_BARRIER",
5307 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005308 }
5309 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005310
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005311 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5312
5313 if ($realfile !~ m@^include/asm-generic/@ &&
5314 $realfile !~ m@/barrier\.h$@ &&
5315 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5316 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5317 WARN("MEMORY_BARRIER",
5318 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5319 }
5320
Joe Perchescb426e92015-06-25 15:02:46 -07005321# check for waitqueue_active without a comment.
5322 if ($line =~ /\bwaitqueue_active\s*\(/) {
5323 if (!ctx_has_comment($first_line, $linenr)) {
5324 WARN("WAITQUEUE_ACTIVE",
5325 "waitqueue_active without comment\n" . $herecurr);
5326 }
5327 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005328
5329# Check for expedited grace periods that interrupt non-idle non-nohz
5330# online CPUs. These expedited can therefore degrade real-time response
5331# if used carelessly, and should be avoided where not absolutely
5332# needed. It is always OK to use synchronize_rcu_expedited() and
5333# synchronize_sched_expedited() at boot time (before real-time applications
5334# start) and in error situations where real-time response is compromised in
5335# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5336# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5337# Of course, nothing comes for free, and srcu_read_lock() and
5338# srcu_read_unlock() do contain full memory barriers in payment for
5339# synchronize_srcu_expedited() non-interruption properties.
5340 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5341 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5342 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5343
5344 }
5345
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005346# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005347 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005348 CHK("ARCH_DEFINES",
5349 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07005350 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005351
Tobias Klauserd4977c72010-05-24 14:33:30 -07005352# Check that the storage class is at the beginning of a declaration
5353 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005354 WARN("STORAGE_CLASS",
5355 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005356 }
5357
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005358# check the location of the inline attribute, that it is between
5359# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005360 if ($line =~ /\b$Type\s+$Inline\b/ ||
5361 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005362 ERROR("INLINE_LOCATION",
5363 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005364 }
5365
Andy Whitcroft8905a672007-11-28 16:21:06 -08005366# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005367 if ($realfile !~ m@\binclude/uapi/@ &&
5368 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005369 if (WARN("INLINE",
5370 "plain inline is preferred over $1\n" . $herecurr) &&
5371 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005372 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005373
5374 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005375 }
5376
Joe Perches3d130fd2011-01-12 17:00:00 -08005377# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005378 if ($realfile !~ m@\binclude/uapi/@ &&
5379 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005380 WARN("PREFER_PACKED",
5381 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005382 }
5383
Joe Perches39b7e282011-07-25 17:13:24 -07005384# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005385 if ($realfile !~ m@\binclude/uapi/@ &&
5386 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005387 WARN("PREFER_ALIGNED",
5388 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005389 }
5390
Joe Perches5f14d3b2012-01-10 15:09:52 -08005391# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005392 if ($realfile !~ m@\binclude/uapi/@ &&
5393 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005394 if (WARN("PREFER_PRINTF",
5395 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5396 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005397 $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 -07005398
5399 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005400 }
5401
Joe Perches6061d942012-03-23 15:02:16 -07005402# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005403 if ($realfile !~ m@\binclude/uapi/@ &&
5404 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005405 if (WARN("PREFER_SCANF",
5406 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5407 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005408 $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 -07005409 }
Joe Perches6061d942012-03-23 15:02:16 -07005410 }
5411
Joe Perches619a9082014-12-10 15:51:35 -08005412# Check for __attribute__ weak, or __weak declarations (may have link issues)
5413 if ($^V && $^V ge 5.10.0 &&
5414 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5415 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5416 $line =~ /\b__weak\b/)) {
5417 ERROR("WEAK_DECLARATION",
5418 "Using weak declarations can have unintended link defects\n" . $herecurr);
5419 }
5420
Joe Perchese6176fa2015-06-25 15:02:49 -07005421# check for c99 types like uint8_t used outside of uapi/
5422 if ($realfile !~ m@\binclude/uapi/@ &&
5423 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5424 my $type = $1;
5425 if ($type =~ /\b($typeC99Typedefs)\b/) {
5426 $type = $1;
5427 my $kernel_type = 'u';
5428 $kernel_type = 's' if ($type =~ /^_*[si]/);
5429 $type =~ /(\d+)/;
5430 $kernel_type .= $1;
5431 if (CHK("PREFER_KERNEL_TYPES",
5432 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5433 $fix) {
5434 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5435 }
5436 }
5437 }
5438
Joe Perches938224b2016-01-20 14:59:15 -08005439# check for cast of C90 native int or longer types constants
5440 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5441 my $cast = $1;
5442 my $const = $2;
5443 if (WARN("TYPECAST_INT_CONSTANT",
5444 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5445 $fix) {
5446 my $suffix = "";
5447 my $newconst = $const;
5448 $newconst =~ s/${Int_type}$//;
5449 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5450 if ($cast =~ /\blong\s+long\b/) {
5451 $suffix .= 'LL';
5452 } elsif ($cast =~ /\blong\b/) {
5453 $suffix .= 'L';
5454 }
5455 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5456 }
5457 }
5458
Joe Perches8f53a9b2010-03-05 13:43:48 -08005459# check for sizeof(&)
5460 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005461 WARN("SIZEOF_ADDRESS",
5462 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005463 }
5464
Joe Perches66c80b62012-07-30 14:41:22 -07005465# check for sizeof without parenthesis
5466 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005467 if (WARN("SIZEOF_PARENTHESIS",
5468 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5469 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005470 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005471 }
Joe Perches66c80b62012-07-30 14:41:22 -07005472 }
5473
Joe Perches88982fe2012-12-17 16:02:00 -08005474# check for struct spinlock declarations
5475 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5476 WARN("USE_SPINLOCK_T",
5477 "struct spinlock should be spinlock_t\n" . $herecurr);
5478 }
5479
Joe Perchesa6962d72013-04-29 16:18:13 -07005480# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005481 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005482 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005483 $fmt =~ s/%%//g;
5484 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005485 if (WARN("PREFER_SEQ_PUTS",
5486 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5487 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005488 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005489 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005490 }
5491 }
5492
Andy Whitcroft554e1652012-01-10 15:09:57 -08005493# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005494 if ($^V && $^V ge 5.10.0 &&
5495 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005496 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005497
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005498 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005499 my $ms_val = $7;
5500 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005501
Andy Whitcroft554e1652012-01-10 15:09:57 -08005502 if ($ms_size =~ /^(0x|)0$/i) {
5503 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005504 "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 -08005505 } elsif ($ms_size =~ /^(0x|)1$/i) {
5506 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005507 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5508 }
5509 }
5510
Joe Perches98a9bba2014-01-23 15:54:52 -08005511# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5512 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005513 defined $stat &&
5514 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005515 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005516 "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 -08005517 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005518 $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 -08005519 }
5520 }
5521
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005522# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5523 if ($^V && $^V ge 5.10.0 &&
5524 defined $stat &&
5525 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5526 WARN("PREFER_ETHER_ADDR_EQUAL",
5527 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5528 }
5529
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005530# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5531# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5532 if ($^V && $^V ge 5.10.0 &&
5533 defined $stat &&
5534 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5535
5536 my $ms_val = $7;
5537
5538 if ($ms_val =~ /^(?:0x|)0+$/i) {
5539 if (WARN("PREFER_ETH_ZERO_ADDR",
5540 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5541 $fix) {
5542 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5543 }
5544 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5545 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5546 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5547 $fix) {
5548 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5549 }
5550 }
5551 }
5552
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005553# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005554 if ($^V && $^V ge 5.10.0 &&
5555 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005556 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005557 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005558 my $call = $1;
5559 my $cast1 = deparenthesize($2);
5560 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005561 my $cast2 = deparenthesize($7);
5562 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005563 my $cast;
5564
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005565 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005566 $cast = "$cast1 or $cast2";
5567 } elsif ($cast1 ne "") {
5568 $cast = $cast1;
5569 } else {
5570 $cast = $cast2;
5571 }
5572 WARN("MINMAX",
5573 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005574 }
5575 }
5576
Joe Perches4a273192012-07-30 14:41:20 -07005577# check usleep_range arguments
5578 if ($^V && $^V ge 5.10.0 &&
5579 defined $stat &&
5580 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5581 my $min = $1;
5582 my $max = $7;
5583 if ($min eq $max) {
5584 WARN("USLEEP_RANGE",
5585 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5586 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5587 $min > $max) {
5588 WARN("USLEEP_RANGE",
5589 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5590 }
5591 }
5592
Joe Perches823b7942013-11-12 15:10:15 -08005593# check for naked sscanf
5594 if ($^V && $^V ge 5.10.0 &&
5595 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005596 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005597 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5598 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5599 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5600 my $lc = $stat =~ tr@\n@@;
5601 $lc = $lc + $linenr;
5602 my $stat_real = raw_line($linenr, 0);
5603 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5604 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5605 }
5606 WARN("NAKED_SSCANF",
5607 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5608 }
5609
Joe Perchesafc819a2014-06-04 16:12:08 -07005610# check for simple sscanf that should be kstrto<foo>
5611 if ($^V && $^V ge 5.10.0 &&
5612 defined $stat &&
5613 $line =~ /\bsscanf\b/) {
5614 my $lc = $stat =~ tr@\n@@;
5615 $lc = $lc + $linenr;
5616 my $stat_real = raw_line($linenr, 0);
5617 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5618 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5619 }
5620 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5621 my $format = $6;
5622 my $count = $format =~ tr@%@%@;
5623 if ($count == 1 &&
5624 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5625 WARN("SSCANF_TO_KSTRTO",
5626 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5627 }
5628 }
5629 }
5630
Joe Perches70dc8a42013-09-11 14:23:58 -07005631# check for new externs in .h files.
5632 if ($realfile =~ /\.h$/ &&
5633 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005634 if (CHK("AVOID_EXTERNS",
5635 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005636 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005637 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005638 }
5639 }
5640
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005641# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005642 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005643 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005644 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005645 my $function_name = $1;
5646 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005647
5648 my $s = $stat;
5649 if (defined $cond) {
5650 substr($s, 0, length($cond), '');
5651 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005652 if ($s =~ /^\s*;/ &&
5653 $function_name ne 'uninitialized_var')
5654 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005655 WARN("AVOID_EXTERNS",
5656 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005657 }
5658
5659 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005660 WARN("FUNCTION_ARGUMENTS",
5661 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005662 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005663
5664 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5665 $stat =~ /^.\s*extern\s+/)
5666 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005667 WARN("AVOID_EXTERNS",
5668 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005669 }
5670
5671# checks for new __setup's
5672 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5673 my $name = $1;
5674
5675 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005676 CHK("UNDOCUMENTED_SETUP",
5677 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005678 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005679 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005680
5681# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005682 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005683 WARN("UNNECESSARY_CASTS",
5684 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005685 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005686
Joe Perchesa640d252013-07-03 15:05:21 -07005687# alloc style
5688# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5689 if ($^V && $^V ge 5.10.0 &&
5690 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5691 CHK("ALLOC_SIZEOF_STRUCT",
5692 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5693 }
5694
Joe Perches60a55362014-06-04 16:12:07 -07005695# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5696 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005697 $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 -07005698 my $oldfunc = $3;
5699 my $a1 = $4;
5700 my $a2 = $10;
5701 my $newfunc = "kmalloc_array";
5702 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005703 my $r1 = $a1;
5704 my $r2 = $a2;
5705 if ($a1 =~ /^sizeof\s*\S/) {
5706 $r1 = $a2;
5707 $r2 = $a1;
5708 }
5709 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5710 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005711 if (WARN("ALLOC_WITH_MULTIPLY",
5712 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5713 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005714 $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 -07005715
5716 }
5717 }
5718 }
5719
Joe Perches972fdea2013-04-29 16:18:12 -07005720# check for krealloc arg reuse
5721 if ($^V && $^V ge 5.10.0 &&
5722 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5723 WARN("KREALLOC_ARG_REUSE",
5724 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5725 }
5726
Joe Perches5ce59ae2013-02-21 16:44:18 -08005727# check for alloc argument mismatch
5728 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5729 WARN("ALLOC_ARRAY_ARGS",
5730 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5731 }
5732
Joe Perchescaf2a542011-01-12 16:59:56 -08005733# check for multiple semicolons
5734 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005735 if (WARN("ONE_SEMICOLON",
5736 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5737 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005738 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005739 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005740 }
5741
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005742# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5743 if ($realfile !~ m@^include/uapi/@ &&
5744 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08005745 my $ull = "";
5746 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5747 if (CHK("BIT_MACRO",
5748 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5749 $fix) {
5750 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5751 }
5752 }
5753
Joe Perches2d632742016-05-20 17:04:00 -07005754# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5755 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5756 my $config = $1;
5757 if (WARN("PREFER_IS_ENABLED",
5758 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5759 $fix) {
5760 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5761 }
5762 }
5763
Joe Perchese81f2392014-08-06 16:11:25 -07005764# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005765 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5766 my $has_break = 0;
5767 my $has_statement = 0;
5768 my $count = 0;
5769 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07005770 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08005771 $prevline--;
5772 my $rline = $rawlines[$prevline - 1];
5773 my $fline = $lines[$prevline - 1];
5774 last if ($fline =~ /^\@\@/);
5775 next if ($fline =~ /^\-/);
5776 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
5777 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
5778 next if ($fline =~ /^.[\s$;]*$/);
5779 $has_statement = 1;
5780 $count++;
5781 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
5782 }
5783 if (!$has_break && $has_statement) {
5784 WARN("MISSING_BREAK",
5785 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
5786 }
5787 }
5788
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005789# check for switch/default statements without a break;
5790 if ($^V && $^V ge 5.10.0 &&
5791 defined $stat &&
5792 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
5793 my $ctx = '';
5794 my $herectx = $here . "\n";
5795 my $cnt = statement_rawlines($stat);
5796 for (my $n = 0; $n < $cnt; $n++) {
5797 $herectx .= raw_line($linenr, $n) . "\n";
5798 }
5799 WARN("DEFAULT_NO_BREAK",
5800 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08005801 }
5802
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005803# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07005804 if ($line =~ /\b__FUNCTION__\b/) {
5805 if (WARN("USE_FUNC",
5806 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
5807 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005808 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005809 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005810 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005811
Joe Perches62ec8182015-02-13 14:38:18 -08005812# check for uses of __DATE__, __TIME__, __TIMESTAMP__
5813 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
5814 ERROR("DATE_TIME",
5815 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
5816 }
5817
Joe Perches2c924882012-03-23 15:02:20 -07005818# check for use of yield()
5819 if ($line =~ /\byield\s*\(\s*\)/) {
5820 WARN("YIELD",
5821 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
5822 }
5823
Joe Perches179f8f42013-07-03 15:05:30 -07005824# check for comparisons against true and false
5825 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
5826 my $lead = $1;
5827 my $arg = $2;
5828 my $test = $3;
5829 my $otype = $4;
5830 my $trail = $5;
5831 my $op = "!";
5832
5833 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
5834
5835 my $type = lc($otype);
5836 if ($type =~ /^(?:true|false)$/) {
5837 if (("$test" eq "==" && "$type" eq "true") ||
5838 ("$test" eq "!=" && "$type" eq "false")) {
5839 $op = "";
5840 }
5841
5842 CHK("BOOL_COMPARISON",
5843 "Using comparison to $otype is error prone\n" . $herecurr);
5844
5845## maybe suggesting a correct construct would better
5846## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5847
5848 }
5849 }
5850
Thomas Gleixner4882720b2010-09-07 14:34:01 +00005851# check for semaphores initialized locked
5852 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005853 WARN("CONSIDER_COMPLETION",
5854 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005855 }
Joe Perches6712d852012-03-23 15:02:20 -07005856
Joe Perches67d0a072011-10-31 17:13:10 -07005857# recommend kstrto* over simple_strto* and strict_strto*
5858 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005859 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07005860 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07005861 }
Joe Perches6712d852012-03-23 15:02:20 -07005862
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005863# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07005864 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005865 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07005866 "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 -07005867 }
Joe Perches6712d852012-03-23 15:02:20 -07005868
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005869# check for various structs that are normally const (ops, kgdb, device_tree)
5870 my $const_structs = qr{
5871 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005872 address_space_operations|
5873 backlight_ops|
5874 block_device_operations|
5875 dentry_operations|
5876 dev_pm_ops|
5877 dma_map_ops|
5878 extent_io_ops|
5879 file_lock_operations|
5880 file_operations|
5881 hv_ops|
5882 ide_dma_ops|
5883 intel_dvo_dev_ops|
5884 item_operations|
5885 iwl_ops|
5886 kgdb_arch|
5887 kgdb_io|
5888 kset_uevent_ops|
5889 lock_manager_operations|
5890 microcode_ops|
5891 mtrr_ops|
5892 neigh_ops|
5893 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005894 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08005895 pci_raw_ops|
5896 pipe_buf_operations|
5897 platform_hibernation_ops|
5898 platform_suspend_ops|
5899 proto_ops|
5900 rpc_pipe_ops|
5901 seq_operations|
5902 snd_ac97_build_ops|
5903 soc_pcmcia_socket_ops|
5904 stacktrace_ops|
5905 sysfs_ops|
5906 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07005907 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08005908 usb_mon_operations|
5909 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005910 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08005911 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005912 WARN("CONST_STRUCT",
5913 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08005914 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08005915 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005916
5917# use of NR_CPUS is usually wrong
5918# ignore definitions of NR_CPUS and usage to define arrays as likely right
5919 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005920 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
5921 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005922 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
5923 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
5924 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07005925 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005926 WARN("NR_CPUS",
5927 "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 -07005928 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005929
Joe Perches52ea8502013-11-12 15:10:09 -08005930# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5931 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
5932 ERROR("DEFINE_ARCH_HAS",
5933 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
5934 }
5935
Joe Perchesacd93622015-02-13 14:38:38 -08005936# likely/unlikely comparisons similar to "(likely(foo) > 0)"
5937 if ($^V && $^V ge 5.10.0 &&
5938 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
5939 WARN("LIKELY_MISUSE",
5940 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
5941 }
5942
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005943# whine mightly about in_atomic
5944 if ($line =~ /\bin_atomic\s*\(/) {
5945 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005946 ERROR("IN_ATOMIC",
5947 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08005948 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005949 WARN("IN_ATOMIC",
5950 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08005951 }
5952 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01005953
Joe Perches481aea52016-05-20 17:04:08 -07005954# whine about ACCESS_ONCE
5955 if ($^V && $^V ge 5.10.0 &&
5956 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
5957 my $par = $1;
5958 my $eq = $2;
5959 my $fun = $3;
5960 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
5961 if (defined($eq)) {
5962 if (WARN("PREFER_WRITE_ONCE",
5963 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
5964 $fix) {
5965 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5966 }
5967 } else {
5968 if (WARN("PREFER_READ_ONCE",
5969 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
5970 $fix) {
5971 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
5972 }
5973 }
5974 }
5975
Peter Zijlstra1704f472010-03-19 01:37:42 +01005976# check for lockdep_set_novalidate_class
5977 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
5978 $line =~ /__lockdep_no_validate__\s*\)/ ) {
5979 if ($realfile !~ m@^kernel/lockdep@ &&
5980 $realfile !~ m@^include/linux/lockdep@ &&
5981 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005982 ERROR("LOCKDEP",
5983 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01005984 }
5985 }
Dave Jones88f88312011-01-12 16:59:59 -08005986
Joe Perchesb392c642015-04-16 12:44:16 -07005987 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
5988 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005989 WARN("EXPORTED_WORLD_WRITABLE",
5990 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08005991 }
Joe Perches24358802014-04-03 14:49:13 -07005992
Joe Perches515a2352014-04-03 14:49:24 -07005993# Mode permission misuses where it seems decimal should be octal
5994# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5995 if ($^V && $^V ge 5.10.0 &&
5996 $line =~ /$mode_perms_search/) {
5997 foreach my $entry (@mode_permission_funcs) {
5998 my $func = $entry->[0];
5999 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006000
Joe Perches515a2352014-04-03 14:49:24 -07006001 my $skip_args = "";
6002 if ($arg_pos > 1) {
6003 $arg_pos--;
6004 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6005 }
6006 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
6007 if ($line =~ /$test/) {
6008 my $val = $1;
6009 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07006010
Joe Perches515a2352014-04-03 14:49:24 -07006011 if ($val !~ /^0$/ &&
6012 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6013 length($val) ne 4)) {
6014 ERROR("NON_OCTAL_PERMISSIONS",
6015 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08006016 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6017 ERROR("EXPORTED_WORLD_WRITABLE",
6018 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006019 }
Joe Perches24358802014-04-03 14:49:13 -07006020 }
6021 }
6022 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006023
6024# validate content of MODULE_LICENSE against list from include/linux/module.h
6025 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6026 my $extracted_string = get_quoted_string($line, $rawline);
6027 my $valid_licenses = qr{
6028 GPL|
6029 GPL\ v2|
6030 GPL\ and\ additional\ rights|
6031 Dual\ BSD/GPL|
6032 Dual\ MIT/GPL|
6033 Dual\ MPL/GPL|
6034 Proprietary
6035 }x;
6036 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6037 WARN("MODULE_LICENSE",
6038 "unknown module license " . $extracted_string . "\n" . $herecurr);
6039 }
6040 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006041 }
6042
6043 # If we have no input at all, then there is nothing to report on
6044 # so just keep quiet.
6045 if ($#rawlines == -1) {
6046 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006047 }
6048
Andy Whitcroft8905a672007-11-28 16:21:06 -08006049 # In mailback mode only produce a report in the negative, for
6050 # things that appear to be patches.
6051 if ($mailback && ($clean == 1 || !$is_patch)) {
6052 exit(0);
6053 }
6054
6055 # This is not a patch, and we are are in 'no-patch' mode so
6056 # just keep quiet.
6057 if (!$chk_patch && !$is_patch) {
6058 exit(0);
6059 }
6060
Joe Perches06330fc2015-06-25 15:03:11 -07006061 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006062 ERROR("NOT_UNIFIED_DIFF",
6063 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006064 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006065 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006066 ERROR("MISSING_SIGN_OFF",
6067 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006068 }
6069
Andy Whitcroft8905a672007-11-28 16:21:06 -08006070 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006071 if ($summary && !($clean == 1 && $quiet == 1)) {
6072 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006073 print "total: $cnt_error errors, $cnt_warn warnings, " .
6074 (($check)? "$cnt_chk checks, " : "") .
6075 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006076 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006077
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006078 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006079 # If there were any defects found and not already fixing them
6080 if (!$clean and !$fix) {
6081 print << "EOM"
6082
6083NOTE: For some of the reported defects, checkpatch may be able to
6084 mechanically convert to the typical style using --fix or --fix-inplace.
6085EOM
6086 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006087 # If there were whitespace errors which cleanpatch can fix
6088 # then suggest that.
6089 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006090 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006091 print << "EOM"
6092
6093NOTE: Whitespace errors detected.
6094 You may wish to use scripts/cleanpatch or scripts/cleanfile
6095EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006096 }
6097 }
6098
Joe Perchesd752fcc2014-08-06 16:11:05 -07006099 if ($clean == 0 && $fix &&
6100 ("@rawlines" ne "@fixed" ||
6101 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006102 my $newfile = $filename;
6103 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006104 my $linecount = 0;
6105 my $f;
6106
Joe Perchesd752fcc2014-08-06 16:11:05 -07006107 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6108
Joe Perches3705ce52013-07-03 15:05:31 -07006109 open($f, '>', $newfile)
6110 or die "$P: Can't open $newfile for write\n";
6111 foreach my $fixed_line (@fixed) {
6112 $linecount++;
6113 if ($file) {
6114 if ($linecount > 3) {
6115 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006116 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006117 }
6118 } else {
6119 print $f $fixed_line . "\n";
6120 }
6121 }
6122 close($f);
6123
6124 if (!$quiet) {
6125 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006126
Joe Perches3705ce52013-07-03 15:05:31 -07006127Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6128
6129Do _NOT_ trust the results written to this file.
6130Do _NOT_ submit these changes without inspecting them for correctness.
6131
6132This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6133No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006134EOM
6135 }
6136 }
6137
Joe Perchesd8469f12015-06-25 15:03:00 -07006138 if ($quiet == 0) {
6139 print "\n";
6140 if ($clean == 1) {
6141 print "$vname has no obvious style problems and is ready for submission.\n";
6142 } else {
6143 print "$vname has style problems, please review.\n";
6144 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006145 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006146 return $clean;
6147}