blob: 79cf3532fc3985b3d9fa04174a5d7329231350d6 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Joe Perches36061e32014-12-10 15:51:43 -080010use File::Basename;
11use Cwd 'abs_path';
Joe Perches57230292015-06-25 15:03:03 -070012use Term::ANSIColor qw(:constants);
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
David Keitel72bf3e82016-03-23 20:52:44 -070014use constant BEFORE_SHORTTEXT => 0;
Steve Muckle9ed561d2012-03-05 10:12:04 -080015use constant IN_SHORTTEXT_BLANKLINE => 1;
16use constant IN_SHORTTEXT => 2;
17use constant AFTER_SHORTTEXT => 3;
18use constant CHECK_NEXT_SHORTTEXT => 4;
David Keitel72bf3e82016-03-23 20:52:44 -070019use constant SHORTTEXT_LIMIT => 75;
20
Andy Whitcroft0a920b52007-06-01 00:46:48 -070021my $P = $0;
Joe Perches36061e32014-12-10 15:51:43 -080022my $D = dirname(abs_path($P));
Andy Whitcroft0a920b52007-06-01 00:46:48 -070023
Joe Perches000d1cc12011-07-25 17:13:25 -070024my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070025
26use Getopt::Long qw(:config no_auto_abbrev);
27
28my $quiet = 0;
29my $tree = 1;
30my $chk_signoff = 1;
31my $chk_patch = 1;
Jeff Johnsondb9dbec2015-01-22 13:34:29 -080032my $chk_author = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070033my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070034my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080035my $terse = 0;
Joe Perches34d88152015-06-25 15:03:05 -070036my $showfile = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070037my $file = 0;
Du, Changbin4a593c32016-05-20 17:04:16 -070038my $git = 0;
Joe Perches0dea9f12016-05-20 17:04:19 -070039my %git_commits = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070040my $check = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -070041my $check_orig = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080042my $summary = 1;
43my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080044my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070045my $show_types = 0;
Joe Perches3beb42e2016-05-20 17:04:14 -070046my $list_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070047my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080048my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070049my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080050my %debug;
Joe Perches34456862013-07-03 15:05:34 -070051my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070052my %use_type = ();
53my @use = ();
54my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070055my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070056my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070057my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080058my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070059my $ignore_perl_version = 0;
60my $minimum_perl_version = 5.10.0;
Vadim Bendebury56193272014-10-13 15:51:48 -070061my $min_conf_desc_length = 4;
Kees Cook66b47b42014-10-13 15:51:57 -070062my $spelling_file = "$D/spelling.txt";
Joe Perchesebfd7d62015-04-16 12:44:14 -070063my $codespell = 0;
Maxim Uvarovf1a63672015-06-25 15:03:08 -070064my $codespellfile = "/usr/share/codespell/dictionary.txt";
Joe Perches57230292015-06-25 15:03:03 -070065my $color = 1;
Joe Perchesdadf6802016-08-02 14:04:33 -070066my $allow_c99_comments = 1;
Hannes Eder77f5b102009-09-21 17:04:37 -070067
68sub help {
69 my ($exitcode) = @_;
70
71 print << "EOM";
72Usage: $P [OPTION]... [FILE]...
73Version: $V
74
75Options:
76 -q, --quiet quiet
77 --no-tree run without a kernel tree
78 --no-signoff do not check for 'Signed-off-by' line
Jeff Johnsondb9dbec2015-01-22 13:34:29 -080079 --no-author do not check for unexpected authors
Hannes Eder77f5b102009-09-21 17:04:37 -070080 --patch treat FILE as patchfile (default)
81 --emacs emacs compile window format
82 --terse one line per report
Joe Perches34d88152015-06-25 15:03:05 -070083 --showfile emit diffed file position, not input file position
Du, Changbin4a593c32016-05-20 17:04:16 -070084 -g, --git treat FILE as a single commit or git revision range
85 single git commit with:
86 <rev>
87 <rev>^
88 <rev>~n
89 multiple git commits with:
90 <rev1>..<rev2>
91 <rev1>...<rev2>
92 <rev>-<count>
93 git merges are ignored
Hannes Eder77f5b102009-09-21 17:04:37 -070094 -f, --file treat FILE as regular source file
95 --subjective, --strict enable more subjective tests
Joe Perches3beb42e2016-05-20 17:04:14 -070096 --list-types list the possible message types
Joe Perches91bfe482013-09-11 14:23:59 -070097 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070098 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches3beb42e2016-05-20 17:04:14 -070099 --show-types show the specific message type in the output
Joe Perches6cd7f382012-12-17 16:01:54 -0800100 --max-line-length=n set the maximum line length, if exceeded, warn
Vadim Bendebury56193272014-10-13 15:51:48 -0700101 --min-conf-desc-length=n set the min description length, if shorter, warn
Hannes Eder77f5b102009-09-21 17:04:37 -0700102 --root=PATH PATH to the kernel tree root
103 --no-summary suppress the per-file summary
104 --mailback only produce a report in case of warnings/errors
105 --summary-file include the filename in summary
106 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
107 'values', 'possible', 'type', and 'attr' (default
108 is all off)
109 --test-only=WORD report only warnings/errors containing WORD
110 literally
Joe Perches3705ce52013-07-03 15:05:31 -0700111 --fix EXPERIMENTAL - may create horrible results
112 If correctable single-line errors exist, create
113 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
114 with potential errors corrected to the preferred
115 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -0800116 --fix-inplace EXPERIMENTAL - may create horrible results
117 Is the same as --fix, but overwrites the input
118 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -0700119 --ignore-perl-version override checking of perl version. expect
120 runtime errors.
Joe Perchesebfd7d62015-04-16 12:44:14 -0700121 --codespell Use the codespell dictionary for spelling/typos
Maxim Uvarovf1a63672015-06-25 15:03:08 -0700122 (default:/usr/share/codespell/dictionary.txt)
Joe Perchesebfd7d62015-04-16 12:44:14 -0700123 --codespellfile Use this codespell dictionary
Joe Perches57230292015-06-25 15:03:03 -0700124 --color Use colors when output is STDOUT (default: on)
Hannes Eder77f5b102009-09-21 17:04:37 -0700125 -h, --help, --version display this help and exit
126
127When FILE is - read standard input.
128EOM
129
130 exit($exitcode);
131}
132
Joe Perches3beb42e2016-05-20 17:04:14 -0700133sub uniq {
134 my %seen;
135 return grep { !$seen{$_}++ } @_;
136}
137
138sub list_types {
139 my ($exitcode) = @_;
140
141 my $count = 0;
142
143 local $/ = undef;
144
145 open(my $script, '<', abs_path($P)) or
146 die "$P: Can't read '$P' $!\n";
147
148 my $text = <$script>;
149 close($script);
150
151 my @types = ();
152 for ($text =~ /\b(?:(?:CHK|WARN|ERROR)\s*\(\s*"([^"]+)")/g) {
153 push (@types, $_);
154 }
155 @types = sort(uniq(@types));
156 print("#\tMessage type\n\n");
157 foreach my $type (@types) {
158 print(++$count . "\t" . $type . "\n");
159 }
160
161 exit($exitcode);
162}
163
Joe Perches000d1cc12011-07-25 17:13:25 -0700164my $conf = which_conf($configuration_file);
165if (-f $conf) {
166 my @conf_args;
167 open(my $conffile, '<', "$conf")
168 or warn "$P: Can't find a readable $configuration_file file $!\n";
169
170 while (<$conffile>) {
171 my $line = $_;
172
173 $line =~ s/\s*\n?$//g;
174 $line =~ s/^\s*//g;
175 $line =~ s/\s+/ /g;
176
177 next if ($line =~ m/^\s*#/);
178 next if ($line =~ m/^\s*$/);
179
180 my @words = split(" ", $line);
181 foreach my $word (@words) {
182 last if ($word =~ m/^#/);
183 push (@conf_args, $word);
184 }
185 }
186 close($conffile);
187 unshift(@ARGV, @conf_args) if @conf_args;
188}
189
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700190GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700191 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700192 'tree!' => \$tree,
193 'signoff!' => \$chk_signoff,
194 'patch!' => \$chk_patch,
Jeff Johnsondb9dbec2015-01-22 13:34:29 -0800195 'author!' => \$chk_author,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700196 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800197 'terse!' => \$terse,
Joe Perches34d88152015-06-25 15:03:05 -0700198 'showfile!' => \$showfile,
Hannes Eder77f5b102009-09-21 17:04:37 -0700199 'f|file!' => \$file,
Du, Changbin4a593c32016-05-20 17:04:16 -0700200 'g|git!' => \$git,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700201 'subjective!' => \$check,
202 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700203 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700204 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700205 'show-types!' => \$show_types,
Joe Perches3beb42e2016-05-20 17:04:14 -0700206 'list-types!' => \$list_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800207 'max-line-length=i' => \$max_line_length,
Vadim Bendebury56193272014-10-13 15:51:48 -0700208 'min-conf-desc-length=i' => \$min_conf_desc_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700209 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800210 'summary!' => \$summary,
211 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800212 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700213 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800214 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700215 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800216 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700217 'test-only=s' => \$tst_only,
Joe Perchesebfd7d62015-04-16 12:44:14 -0700218 'codespell!' => \$codespell,
219 'codespellfile=s' => \$codespellfile,
Joe Perches57230292015-06-25 15:03:03 -0700220 'color!' => \$color,
Hannes Eder77f5b102009-09-21 17:04:37 -0700221 'h|help' => \$help,
222 'version' => \$help
223) or help(1);
224
225help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700226
Joe Perches3beb42e2016-05-20 17:04:14 -0700227list_types(0) if ($list_types);
228
Joe Perches9624b8d2014-01-23 15:54:44 -0800229$fix = 1 if ($fix_inplace);
Joe Perches2ac73b4f2014-06-04 16:12:05 -0700230$check_orig = $check;
Joe Perches9624b8d2014-01-23 15:54:44 -0800231
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700232my $exit = 0;
233
Dave Hansend62a2012013-09-11 14:23:56 -0700234if ($^V && $^V lt $minimum_perl_version) {
235 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
236 if (!$ignore_perl_version) {
237 exit(1);
238 }
239}
240
Allen Hubbe45107ff2016-08-02 14:04:47 -0700241#if no filenames are given, push '-' to read patch from stdin
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700242if ($#ARGV < 0) {
Allen Hubbe45107ff2016-08-02 14:04:47 -0700243 push(@ARGV, '-');
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700244}
245
Joe Perches91bfe482013-09-11 14:23:59 -0700246sub hash_save_array_words {
247 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700248
Joe Perches91bfe482013-09-11 14:23:59 -0700249 my @array = split(/,/, join(',', @$arrayRef));
250 foreach my $word (@array) {
251 $word =~ s/\s*\n?$//g;
252 $word =~ s/^\s*//g;
253 $word =~ s/\s+/ /g;
254 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700255
Joe Perches91bfe482013-09-11 14:23:59 -0700256 next if ($word =~ m/^\s*#/);
257 next if ($word =~ m/^\s*$/);
258
259 $hashRef->{$word}++;
260 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700261}
262
Joe Perches91bfe482013-09-11 14:23:59 -0700263sub hash_show_words {
264 my ($hashRef, $prefix) = @_;
265
Joe Perches3c816e42015-06-25 15:03:29 -0700266 if (keys %$hashRef) {
Joe Perchesd8469f12015-06-25 15:03:00 -0700267 print "\nNOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700268 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700269 print " $word";
270 }
Joe Perchesd8469f12015-06-25 15:03:00 -0700271 print "\n";
Joe Perches91bfe482013-09-11 14:23:59 -0700272 }
273}
274
275hash_save_array_words(\%ignore_type, \@ignore);
276hash_save_array_words(\%use_type, \@use);
277
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800278my $dbg_values = 0;
279my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700280my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700281my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800282for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800283 ## no critic
284 eval "\${dbg_$key} = '$debug{$key}';";
285 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800286}
287
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700288my $rpt_cleaners = 0;
289
Andy Whitcroft8905a672007-11-28 16:21:06 -0800290if ($terse) {
291 $emacs = 1;
292 $quiet++;
293}
294
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700295if ($tree) {
296 if (defined $root) {
297 if (!top_of_kernel_tree($root)) {
298 die "$P: $root: --root does not point at a valid tree\n";
299 }
300 } else {
301 if (top_of_kernel_tree('.')) {
302 $root = '.';
303 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
304 top_of_kernel_tree($1)) {
305 $root = $1;
306 }
307 }
308
309 if (!defined $root) {
310 print "Must be run from the top-level dir. of a kernel tree\n";
311 exit(2);
312 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700313}
314
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700315my $emitted_corrupt = 0;
316
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700317our $Ident = qr{
318 [A-Za-z_][A-Za-z\d_]*
319 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
320 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700321our $Storage = qr{extern|static|asmlinkage};
322our $Sparse = qr{
323 __user|
324 __kernel|
325 __force|
326 __iomem|
327 __must_check|
328 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800329 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700330 __ref|
Boqun Fengad315452015-12-29 12:18:46 +0800331 __rcu|
332 __private
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700333 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800334our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
335our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
336our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
337our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
338our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700339
Wolfram Sang52131292010-03-05 13:43:51 -0800340# Notes to $Attribute:
341# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700342our $Attribute = qr{
343 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700344 __percpu|
345 __nocast|
346 __safe|
347 __bitwise__|
348 __packed__|
349 __packed2__|
350 __naked|
351 __maybe_unused|
352 __always_unused|
353 __noreturn|
354 __used|
355 __cold|
Joe Perchese23ef1f2015-02-13 14:38:24 -0800356 __pure|
Joe Perches03f1df72010-10-26 14:23:16 -0700357 __noclone|
358 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700359 __read_mostly|
360 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700361 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700362 ____cacheline_aligned|
363 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800364 ____cacheline_internodealigned_in_smp|
365 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700366 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700367our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700368our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700369our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
370our $Lval = qr{$Ident(?:$Member)*};
371
Joe Perches95e2c602013-07-03 15:05:20 -0700372our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
373our $Binary = qr{(?i)0b[01]+$Int_type?};
374our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
375our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700376our $Octal = qr{0[0-7]+$Int_type?};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800377our $String = qr{"[X\t]*"};
Joe Perches326b1ff2013-02-04 14:28:51 -0800378our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
379our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
380our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800381our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700382our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800383our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700384our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700385our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700386our $Operators = qr{
387 <=|>=|==|!=|
388 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700389 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700390 }x;
391
Joe Perches91cb5192014-04-03 14:49:32 -0700392our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
393
Joe Perchesab7e23f2015-04-16 12:44:22 -0700394our $BasicType;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800395our $NonptrType;
Joe Perches18130872014-08-06 16:11:22 -0700396our $NonptrTypeMisordered;
Joe Perches8716de32013-09-11 14:24:05 -0700397our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800398our $Type;
Joe Perches18130872014-08-06 16:11:22 -0700399our $TypeMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800400our $Declare;
Joe Perches18130872014-08-06 16:11:22 -0700401our $DeclareMisordered;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800402
Joe Perches15662b32011-10-31 17:13:12 -0700403our $NON_ASCII_UTF8 = qr{
404 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700405 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
406 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
407 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
408 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
409 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
410 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
411}x;
412
Joe Perches15662b32011-10-31 17:13:12 -0700413our $UTF8 = qr{
414 [\x09\x0A\x0D\x20-\x7E] # ASCII
415 | $NON_ASCII_UTF8
416}x;
417
Joe Perchese6176fa2015-06-25 15:02:49 -0700418our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t};
Joe Perches021158b2015-02-13 14:38:43 -0800419our $typeOtherOSTypedefs = qr{(?x:
420 u_(?:char|short|int|long) | # bsd
421 u(?:nchar|short|int|long) # sysv
422)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700423our $typeKernelTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700424 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700425 atomic_t
426)};
Joe Perchese6176fa2015-06-25 15:02:49 -0700427our $typeTypedefs = qr{(?x:
428 $typeC99Typedefs\b|
429 $typeOtherOSTypedefs\b|
430 $typeKernelTypedefs\b
431)};
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700432
Joe Perches6d32f7a2015-11-06 16:31:37 -0800433our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b};
434
Joe Perches691e6692010-03-05 13:43:51 -0800435our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700436 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700437 (?:[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 -0700438 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700439 panic|
Joe Perches06668722013-11-12 15:10:07 -0800440 MODULE_[A-Z_]+|
441 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800442)};
443
Joe Perches20112472011-07-25 17:13:23 -0700444our $signature_tags = qr{(?xi:
445 Signed-off-by:|
446 Acked-by:|
447 Tested-by:|
448 Reviewed-by:|
449 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700450 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700451 To:|
452 Cc:
453)};
454
Joe Perches18130872014-08-06 16:11:22 -0700455our @typeListMisordered = (
456 qr{char\s+(?:un)?signed},
457 qr{int\s+(?:(?:un)?signed\s+)?short\s},
458 qr{int\s+short(?:\s+(?:un)?signed)},
459 qr{short\s+int(?:\s+(?:un)?signed)},
460 qr{(?:un)?signed\s+int\s+short},
461 qr{short\s+(?:un)?signed},
462 qr{long\s+int\s+(?:un)?signed},
463 qr{int\s+long\s+(?:un)?signed},
464 qr{long\s+(?:un)?signed\s+int},
465 qr{int\s+(?:un)?signed\s+long},
466 qr{int\s+(?:un)?signed},
467 qr{int\s+long\s+long\s+(?:un)?signed},
468 qr{long\s+long\s+int\s+(?:un)?signed},
469 qr{long\s+long\s+(?:un)?signed\s+int},
470 qr{long\s+long\s+(?:un)?signed},
471 qr{long\s+(?:un)?signed},
472);
473
Andy Whitcroft8905a672007-11-28 16:21:06 -0800474our @typeList = (
475 qr{void},
Joe Perches0c773d92014-08-06 16:11:20 -0700476 qr{(?:(?:un)?signed\s+)?char},
477 qr{(?:(?:un)?signed\s+)?short\s+int},
478 qr{(?:(?:un)?signed\s+)?short},
479 qr{(?:(?:un)?signed\s+)?int},
480 qr{(?:(?:un)?signed\s+)?long\s+int},
481 qr{(?:(?:un)?signed\s+)?long\s+long\s+int},
482 qr{(?:(?:un)?signed\s+)?long\s+long},
483 qr{(?:(?:un)?signed\s+)?long},
484 qr{(?:un)?signed},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800485 qr{float},
486 qr{double},
487 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800488 qr{struct\s+$Ident},
489 qr{union\s+$Ident},
490 qr{enum\s+$Ident},
491 qr{${Ident}_t},
492 qr{${Ident}_handler},
493 qr{${Ident}_handler_fn},
Joe Perches18130872014-08-06 16:11:22 -0700494 @typeListMisordered,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800495);
Joe Perches938224b2016-01-20 14:59:15 -0800496
497our $C90_int_types = qr{(?x:
498 long\s+long\s+int\s+(?:un)?signed|
499 long\s+long\s+(?:un)?signed\s+int|
500 long\s+long\s+(?:un)?signed|
501 (?:(?:un)?signed\s+)?long\s+long\s+int|
502 (?:(?:un)?signed\s+)?long\s+long|
503 int\s+long\s+long\s+(?:un)?signed|
504 int\s+(?:(?:un)?signed\s+)?long\s+long|
505
506 long\s+int\s+(?:un)?signed|
507 long\s+(?:un)?signed\s+int|
508 long\s+(?:un)?signed|
509 (?:(?:un)?signed\s+)?long\s+int|
510 (?:(?:un)?signed\s+)?long|
511 int\s+long\s+(?:un)?signed|
512 int\s+(?:(?:un)?signed\s+)?long|
513
514 int\s+(?:un)?signed|
515 (?:(?:un)?signed\s+)?int
516)};
517
Alex Dowad485ff232015-06-25 15:02:52 -0700518our @typeListFile = ();
Joe Perches8716de32013-09-11 14:24:05 -0700519our @typeListWithAttr = (
520 @typeList,
521 qr{struct\s+$InitAttribute\s+$Ident},
522 qr{union\s+$InitAttribute\s+$Ident},
523);
524
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700525our @modifierList = (
526 qr{fastcall},
527);
Alex Dowad485ff232015-06-25 15:02:52 -0700528our @modifierListFile = ();
Andy Whitcroft8905a672007-11-28 16:21:06 -0800529
Joe Perches24358802014-04-03 14:49:13 -0700530our @mode_permission_funcs = (
531 ["module_param", 3],
532 ["module_param_(?:array|named|string)", 4],
533 ["module_param_array_named", 5],
534 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
535 ["proc_create(?:_data|)", 2],
536 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
537);
538
Joe Perches515a2352014-04-03 14:49:24 -0700539#Create a search pattern for all these functions to speed up a loop below
540our $mode_perms_search = "";
541foreach my $entry (@mode_permission_funcs) {
542 $mode_perms_search .= '|' if ($mode_perms_search ne "");
543 $mode_perms_search .= $entry->[0];
544}
545
Joe Perchesb392c642015-04-16 12:44:16 -0700546our $mode_perms_world_writable = qr{
547 S_IWUGO |
548 S_IWOTH |
549 S_IRWXUGO |
550 S_IALLUGO |
551 0[0-7][0-7][2367]
552}x;
553
Wolfram Sang7840a942010-08-09 17:20:57 -0700554our $allowed_asm_includes = qr{(?x:
555 irq|
Sergey Ryazanovcdcee682014-10-13 15:51:44 -0700556 memory|
557 time|
558 reboot
Wolfram Sang7840a942010-08-09 17:20:57 -0700559)};
560# memory.h: ARM has a custom one
561
Kees Cook66b47b42014-10-13 15:51:57 -0700562# Load common spelling mistakes and build regular expression list.
563my $misspellings;
Kees Cook66b47b42014-10-13 15:51:57 -0700564my %spelling_fix;
Kees Cook66b47b42014-10-13 15:51:57 -0700565
Joe Perches36061e32014-12-10 15:51:43 -0800566if (open(my $spelling, '<', $spelling_file)) {
Joe Perches36061e32014-12-10 15:51:43 -0800567 while (<$spelling>) {
568 my $line = $_;
Kees Cook66b47b42014-10-13 15:51:57 -0700569
Joe Perches36061e32014-12-10 15:51:43 -0800570 $line =~ s/\s*\n?$//g;
571 $line =~ s/^\s*//g;
Kees Cook66b47b42014-10-13 15:51:57 -0700572
Joe Perches36061e32014-12-10 15:51:43 -0800573 next if ($line =~ m/^\s*#/);
574 next if ($line =~ m/^\s*$/);
Kees Cook66b47b42014-10-13 15:51:57 -0700575
Joe Perches36061e32014-12-10 15:51:43 -0800576 my ($suspect, $fix) = split(/\|\|/, $line);
577
Joe Perches36061e32014-12-10 15:51:43 -0800578 $spelling_fix{$suspect} = $fix;
579 }
580 close($spelling);
Joe Perches36061e32014-12-10 15:51:43 -0800581} else {
582 warn "No typos will be found - file '$spelling_file': $!\n";
Kees Cook66b47b42014-10-13 15:51:57 -0700583}
Kees Cook66b47b42014-10-13 15:51:57 -0700584
Joe Perchesebfd7d62015-04-16 12:44:14 -0700585if ($codespell) {
586 if (open(my $spelling, '<', $codespellfile)) {
587 while (<$spelling>) {
588 my $line = $_;
589
590 $line =~ s/\s*\n?$//g;
591 $line =~ s/^\s*//g;
592
593 next if ($line =~ m/^\s*#/);
594 next if ($line =~ m/^\s*$/);
595 next if ($line =~ m/, disabled/i);
596
597 $line =~ s/,.*$//;
598
599 my ($suspect, $fix) = split(/->/, $line);
600
601 $spelling_fix{$suspect} = $fix;
602 }
603 close($spelling);
604 } else {
605 warn "No codespell typos will be found - file '$codespellfile': $!\n";
606 }
607}
608
609$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix;
610
Andy Whitcroft8905a672007-11-28 16:21:06 -0800611sub build_types {
Alex Dowad485ff232015-06-25 15:02:52 -0700612 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)";
613 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)";
Joe Perches18130872014-08-06 16:11:22 -0700614 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700615 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700616 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Joe Perchesab7e23f2015-04-16 12:44:22 -0700617 $BasicType = qr{
Joe Perchesab7e23f2015-04-16 12:44:22 -0700618 (?:$typeTypedefs\b)|
619 (?:${all}\b)
620 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800621 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700622 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800623 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800624 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700625 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700626 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800627 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700628 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800629 }x;
Joe Perches18130872014-08-06 16:11:22 -0700630 $NonptrTypeMisordered = qr{
631 (?:$Modifier\s+|const\s+)*
632 (?:
633 (?:${Misordered}\b)
634 )
635 (?:\s+$Modifier|\s+const)*
636 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700637 $NonptrTypeWithAttr = qr{
638 (?:$Modifier\s+|const\s+)*
639 (?:
640 (?:typeof|__typeof__)\s*\([^\)]*\)|
641 (?:$typeTypedefs\b)|
642 (?:${allWithAttr}\b)
643 )
644 (?:\s+$Modifier|\s+const)*
645 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800646 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700647 $NonptrType
Joe Perches1574a292014-08-06 16:10:50 -0700648 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700649 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800650 }x;
Joe Perches18130872014-08-06 16:11:22 -0700651 $TypeMisordered = qr{
652 $NonptrTypeMisordered
653 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+)?
654 (?:\s+$Inline|\s+$Modifier)*
655 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700656 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Joe Perches18130872014-08-06 16:11:22 -0700657 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800658}
659build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700660
Joe Perches7d2367a2011-07-25 17:13:22 -0700661our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700662
663# Using $balanced_parens, $LvalOrFunc, or $FuncArg
664# requires at least perl version v5.10.0
665# Any use must be runtime checked with $^V
666
667our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700668our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesc0a5c892015-02-13 14:38:21 -0800669our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700670
Joe Perchesf8422302014-08-06 16:11:31 -0700671our $declaration_macros = qr{(?x:
Joe Perches3e838b62015-09-09 15:37:33 -0700672 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(|
Joe Perchesf8422302014-08-06 16:11:31 -0700673 (?:$Storage\s+)?LIST_HEAD\s*\(|
674 (?:$Storage\s+)?${Type}\s+uninitialized_var\s*\(
675)};
676
Joe Perches7d2367a2011-07-25 17:13:22 -0700677sub deparenthesize {
678 my ($string) = @_;
679 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700680
681 while ($string =~ /^\s*\(.*\)\s*$/) {
682 $string =~ s@^\s*\(\s*@@;
683 $string =~ s@\s*\)\s*$@@;
684 }
685
Joe Perches7d2367a2011-07-25 17:13:22 -0700686 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700687
Joe Perches7d2367a2011-07-25 17:13:22 -0700688 return $string;
689}
690
Joe Perches34456862013-07-03 15:05:34 -0700691sub seed_camelcase_file {
692 my ($file) = @_;
693
694 return if (!(-f $file));
695
696 local $/;
697
698 open(my $include_file, '<', "$file")
699 or warn "$P: Can't read '$file' $!\n";
700 my $text = <$include_file>;
701 close($include_file);
702
703 my @lines = split('\n', $text);
704
705 foreach my $line (@lines) {
706 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
707 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
708 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800709 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
710 $camelcase{$1} = 1;
711 } 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 -0700712 $camelcase{$1} = 1;
713 }
714 }
715}
716
717my $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 Perches0dea9f12016-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 Perches0dea9f12016-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 Perches0dea9f12016-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 Whitcroft0a920b52007-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 Perches0dea9f12016-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -07001516sub cat_vet {
1517 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001518 my ($res, $coded);
Andy Whitcroft0a920b52007-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 Whitcroft0a920b52007-06-01 00:46:48 -07001529
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001530 return $res;
Andy Whitcroft0a920b52007-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
Gregory Beanf07523e2011-07-06 15:36:58 -07002033sub cleanup_continuation_headers {
2034 # Collapse any header-continuation lines into a single line so they
2035 # can be parsed meaningfully, as the parser only has one line
2036 # of context to work with.
2037 my $again;
2038 do {
2039 $again = 0;
2040 foreach my $n (0 .. scalar(@rawlines) - 2) {
2041 if ($rawlines[$n]=~/^\s*$/) {
2042 # A blank line means there's no more chance
2043 # of finding headers. Shortcut to done.
2044 return;
2045 }
2046 if ($rawlines[$n]=~/^[\x21-\x39\x3b-\x7e]+:/ &&
2047 $rawlines[$n+1]=~/^\s+/) {
2048 # Continuation header. Collapse it.
2049 my $line = splice @rawlines, $n+1, 1;
2050 $line=~s/^\s+/ /;
2051 $rawlines[$n] .= $line;
2052 # We've 'destabilized' the list, so restart.
2053 $again = 1;
2054 last;
2055 }
2056 }
2057 } while ($again);
2058}
2059
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002060sub pos_last_openparen {
2061 my ($line) = @_;
2062
2063 my $pos = 0;
2064
2065 my $opens = $line =~ tr/\(/\(/;
2066 my $closes = $line =~ tr/\)/\)/;
2067
2068 my $last_openparen = 0;
2069
2070 if (($opens == 0) || ($closes >= $opens)) {
2071 return -1;
2072 }
2073
2074 my $len = length($line);
2075
2076 for ($pos = 0; $pos < $len; $pos++) {
2077 my $string = substr($line, $pos);
2078 if ($string =~ /^($FuncArg|$balanced_parens)/) {
2079 $pos += length($1) - 1;
2080 } elsif (substr($line, $pos, 1) eq '(') {
2081 $last_openparen = $pos;
2082 } elsif (index($string, '(') == -1) {
2083 last;
2084 }
2085 }
2086
Joe Perches91cb5192014-04-03 14:49:32 -07002087 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002088}
2089
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002090sub process {
2091 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002092
2093 my $linenr=0;
2094 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002095 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002096 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002097 my $stashrawline="";
David Keitele288d232016-03-23 20:57:21 -07002098 my $subjectline="";
2099 my $sublinenr="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002100
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002101 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002102 my $indent;
2103 my $previndent=0;
2104 my $stashindent=0;
2105
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002106 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002107 my $signoff = 0;
2108 my $is_patch = 0;
Joe Perches29ee1b02014-08-06 16:10:35 -07002109 my $in_header_lines = $file ? 0 : 1;
Joe Perches15662b32011-10-31 17:13:12 -07002110 my $in_commit_log = 0; #Scanning lines before patch
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002111 my $has_commit_log = 0; #Encountered lines before patch
Joe Perchesbf4daf12015-09-09 15:37:50 -07002112 my $commit_log_possible_stack_dump = 0;
Joe Perches2a076f42015-04-16 12:44:28 -07002113 my $commit_log_long_line = 0;
Joe Perchese518e9a2015-06-25 15:03:27 -07002114 my $commit_log_has_diff = 0;
Joe Perches13f19372014-08-06 16:10:59 -07002115 my $reported_maintainer_file = 0;
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002116 my $non_utf8_charset = 0;
2117
Joe Perches365dd4e2014-08-06 16:10:42 -07002118 my $last_blank_line = 0;
Joe Perches5e4f6ba2014-12-10 15:52:05 -08002119 my $last_coalesced_string_linenr = -1;
Joe Perches365dd4e2014-08-06 16:10:42 -07002120
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002121 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002122 our $cnt_lines = 0;
2123 our $cnt_error = 0;
2124 our $cnt_warn = 0;
2125 our $cnt_chk = 0;
2126
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002127 # Trace the real file/line as we go.
2128 my $realfile = '';
2129 my $realline = 0;
2130 my $realcnt = 0;
2131 my $here = '';
2132 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002133 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002134 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002135 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002136
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002137 my $prev_values = 'E';
2138
2139 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07002140 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002141 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002142 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002143 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07002144
Joe Perches7e51f192013-09-11 14:23:57 -07002145 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08002146
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002147 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002148 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002149 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002150 my @setup_docs = ();
2151 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002152
Joe Perchesd8b07712013-11-12 15:10:06 -08002153 my $camelcase_file_seeded = 0;
David Keitel72bf3e82016-03-23 20:52:44 -07002154 my $shorttext = BEFORE_SHORTTEXT;
2155 my $shorttext_exspc = 0;
Steve Muckle9ed561d2012-03-05 10:12:04 -08002156 my $commit_text_present = 0;
Joe Perchesd8b07712013-11-12 15:10:06 -08002157
Andy Whitcroft773647a2008-03-28 14:15:58 -07002158 sanitise_line_reset();
Gregory Beanf07523e2011-07-06 15:36:58 -07002159 cleanup_continuation_headers();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002160 my $line;
Gregory Beanf07523e2011-07-06 15:36:58 -07002161
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002162 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002163 $linenr++;
2164 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002165
Joe Perches3705ce52013-07-03 15:05:31 -07002166 push(@fixed, $rawline) if ($fix);
2167
Andy Whitcroft773647a2008-03-28 14:15:58 -07002168 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002169 $setup_docs = 0;
2170 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
2171 $setup_docs = 1;
2172 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002173 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002174 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002175 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
2176 $realline=$1-1;
2177 if (defined $2) {
2178 $realcnt=$3+1;
2179 } else {
2180 $realcnt=1+1;
2181 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002182 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002183
2184 # Guestimate if this is a continuing comment. Run
2185 # the context looking for a comment "edge". If this
2186 # edge is a close comment then we must be in a comment
2187 # at context start.
2188 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07002189 my $cnt = $realcnt;
2190 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
2191 next if (defined $rawlines[$ln - 1] &&
2192 $rawlines[$ln - 1] =~ /^-/);
2193 $cnt--;
2194 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08002195 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08002196 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
2197 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
2198 ($edge) = $1;
2199 last;
2200 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002201 }
2202 if (defined $edge && $edge eq '*/') {
2203 $in_comment = 1;
2204 }
2205
2206 # Guestimate if this is a continuing comment. If this
2207 # is the start of a diff block and this line starts
2208 # ' *' then it is very likely a comment.
2209 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08002210 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07002211 {
2212 $in_comment = 1;
2213 }
2214
2215 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2216 sanitise_line_reset($in_comment);
2217
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002218 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002219 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002220 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002221 $line = sanitise_line($rawline);
2222 }
2223 push(@lines, $line);
2224
2225 if ($realcnt > 1) {
2226 $realcnt-- if ($line =~ /^(?:\+| |$)/);
2227 } else {
2228 $realcnt = 0;
2229 }
2230
2231 #print "==>$rawline\n";
2232 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002233
2234 if ($setup_docs && $line =~ /^\+/) {
2235 push(@setup_docs, $line);
2236 }
2237 }
2238
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002239 $prefix = '';
2240
Andy Whitcroft773647a2008-03-28 14:15:58 -07002241 $realcnt = 0;
2242 $linenr = 0;
Joe Perches194f66f2014-08-06 16:11:03 -07002243 $fixlinenr = -1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002244 foreach my $line (@lines) {
2245 $linenr++;
Joe Perches194f66f2014-08-06 16:11:03 -07002246 $fixlinenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07002247 my $sline = $line; #copy of $line
2248 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002249
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002250 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002251
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002252#extract the line range in the file after the patch is applied
Joe Perchese518e9a2015-06-25 15:03:27 -07002253 if (!$in_commit_log &&
2254 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002255 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002256 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002257 $realline=$1-1;
2258 if (defined $2) {
2259 $realcnt=$3+1;
2260 } else {
2261 $realcnt=1+1;
2262 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002263 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002264 $prev_values = 'E';
2265
Andy Whitcroft773647a2008-03-28 14:15:58 -07002266 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002267 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002268 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002269 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002270 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002271
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002272# track the line number as we move through the hunk, note that
2273# new versions of GNU diff omit the leading space on completely
2274# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002275 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002276 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002277 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002278
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002279 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002280 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002281
2282 # Track the previous line.
2283 ($prevline, $stashline) = ($stashline, $line);
2284 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002285 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
2286
Andy Whitcroft773647a2008-03-28 14:15:58 -07002287 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002288
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002289 } elsif ($realcnt == 1) {
2290 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002291 }
2292
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07002293 my $hunk_line = ($realcnt != 0);
2294
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002295 $here = "#$linenr: " if (!$file);
2296 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002297
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002298 my $found_file = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002299 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002300 if ($line =~ /^diff --git.*?(\S+)$/) {
2301 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002302 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002303 $in_commit_log = 0;
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002304 $found_file = 1;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002305 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002306 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08002307 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08002308 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08002309
2310 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08002311 if (!$file && $tree && $p1_prefix ne '' &&
2312 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002313 WARN("PATCH_PREFIX",
2314 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08002315 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002316
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07002317 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002318 ERROR("MODIFIED_INCLUDE_ASM",
2319 "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 -07002320 }
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002321 $found_file = 1;
2322 }
2323
Joe Perches34d88152015-06-25 15:03:05 -07002324#make up the handle for any error we report on this line
2325 if ($showfile) {
2326 $prefix = "$realfile:$realline: "
2327 } elsif ($emacs) {
Joe Perches7d3a9f62015-09-09 15:37:39 -07002328 if ($file) {
2329 $prefix = "$filename:$realline: ";
2330 } else {
2331 $prefix = "$filename:$linenr: ";
2332 }
Joe Perches34d88152015-06-25 15:03:05 -07002333 }
2334
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002335 if ($found_file) {
Joe Perches7bd7e482015-09-09 15:37:44 -07002336 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) {
Joe Perches2ac73b4f2014-06-04 16:12:05 -07002337 $check = 1;
2338 } else {
2339 $check = $check_orig;
2340 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002341 next;
2342 }
Randy Dunlap389834b2007-06-08 13:47:03 -07002343 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002344
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002345 my $hereline = "$here\n$rawline\n";
2346 my $herecurr = "$here\n$rawline\n";
2347 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002348
David Keitel72bf3e82016-03-23 20:52:44 -07002349 if ($shorttext != AFTER_SHORTTEXT) {
Steve Muckle9ed561d2012-03-05 10:12:04 -08002350 if ($shorttext == IN_SHORTTEXT_BLANKLINE && $line=~/\S/) {
2351 # the subject line was just processed,
2352 # a blank line must be next
2353 WARN("NONBLANK_AFTER_SUMMARY",
2354 "non-blank line after summary line\n" . $herecurr);
2355 $shorttext = IN_SHORTTEXT;
2356 # this non-blank line may or may not be commit text -
2357 # a warning has been generated so assume it is commit
2358 # text and move on
2359 $commit_text_present = 1;
2360 # fall through and treat this line as IN_SHORTTEXT
2361 }
David Keitel72bf3e82016-03-23 20:52:44 -07002362 if ($shorttext == IN_SHORTTEXT) {
2363 if ($line=~/^---/ || $line=~/^diff.*/) {
Steve Muckle9ed561d2012-03-05 10:12:04 -08002364 if ($commit_text_present == 0) {
2365 WARN("NO_COMMIT_TEXT",
2366 "please add commit text explaining " .
2367 "*why* the change is needed\n" .
2368 $herecurr);
2369 }
David Keitel72bf3e82016-03-23 20:52:44 -07002370 $shorttext = AFTER_SHORTTEXT;
2371 } elsif (length($line) > (SHORTTEXT_LIMIT +
2372 $shorttext_exspc)
2373 && $line !~ /^:([0-7]{6}\s){2}
2374 ([[:xdigit:]]+\.*
2375 \s){2}\w+\s\w+/xms) {
2376 WARN("LONG_COMMIT_TEXT",
2377 "commit text line over " .
2378 SHORTTEXT_LIMIT .
2379 " characters\n" . $herecurr);
Steve Muckled360fe42012-03-09 11:15:24 -08002380 } elsif ($line=~/^\s*change-id:/i ||
2381 $line=~/^\s*signed-off-by:/i ||
2382 $line=~/^\s*crs-fixed:/i ||
2383 $line=~/^\s*acked-by:/i) {
Steve Muckle9ed561d2012-03-05 10:12:04 -08002384 # this is a tag, there must be commit
2385 # text by now
2386 if ($commit_text_present == 0) {
2387 WARN("NO_COMMIT_TEXT",
2388 "please add commit text explaining " .
2389 "*why* the change is needed\n" .
2390 $herecurr);
2391 # prevent duplicate warnings
2392 $commit_text_present = 1;
2393 }
2394 } elsif ($line=~/\S/) {
2395 $commit_text_present = 1;
David Keitel72bf3e82016-03-23 20:52:44 -07002396 }
Steve Muckle9ed561d2012-03-05 10:12:04 -08002397 } elsif ($shorttext == IN_SHORTTEXT_BLANKLINE) {
2398 # case of non-blank line in this state handled above
2399 $shorttext = IN_SHORTTEXT;
David Keitele288d232016-03-23 20:57:21 -07002400 } elsif ($shorttext == CHECK_NEXT_SHORTTEXT) {
Gregory Beana386ec22011-03-03 13:46:41 -08002401# The Subject line doesn't have to be the last header in the patch.
2402# Avoid moving to the IN_SHORTTEXT state until clear of all headers.
2403# Per RFC5322, continuation lines must be folded, so any left-justified
2404# text which looks like a header is definitely a header.
2405 if ($line!~/^[\x21-\x39\x3b-\x7e]+:/) {
2406 $shorttext = IN_SHORTTEXT;
Steve Muckle9ed561d2012-03-05 10:12:04 -08002407 # Check for Subject line followed by a blank line.
Gregory Beana386ec22011-03-03 13:46:41 -08002408 if (length($line) != 0) {
2409 WARN("NONBLANK_AFTER_SUMMARY",
2410 "non-blank line after " .
2411 "summary line\n" .
2412 $sublinenr . $here .
2413 "\n" . $subjectline .
2414 "\n" . $line . "\n");
Steve Muckle9ed561d2012-03-05 10:12:04 -08002415 # this non-blank line may or may not
2416 # be commit text - a warning has been
2417 # generated so assume it is commit
2418 # text and move on
2419 $commit_text_present = 1;
Gregory Beana386ec22011-03-03 13:46:41 -08002420 }
David Keitele288d232016-03-23 20:57:21 -07002421 }
Steve Muckle9ed561d2012-03-05 10:12:04 -08002422 # The next two cases are BEFORE_SHORTTEXT.
David Keitele288d232016-03-23 20:57:21 -07002423 } elsif ($line=~/^Subject: \[[^\]]*\] (.*)/) {
Steve Muckle9ed561d2012-03-05 10:12:04 -08002424 # This is the subject line. Go to
2425 # CHECK_NEXT_SHORTTEXT to wait for the commit
2426 # text to show up.
David Keitele288d232016-03-23 20:57:21 -07002427 $shorttext = CHECK_NEXT_SHORTTEXT;
2428 $subjectline = $line;
2429 $sublinenr = "#$linenr & ";
2430# Check for Subject line less than line limit
David Keitel72bf3e82016-03-23 20:52:44 -07002431 if (length($1) > SHORTTEXT_LIMIT) {
2432 WARN("LONG_SUMMARY_LINE",
2433 "summary line over " .
2434 SHORTTEXT_LIMIT .
2435 " characters\n" . $herecurr);
2436 }
2437 } elsif ($line=~/^ (.*)/) {
Steve Muckle9ed561d2012-03-05 10:12:04 -08002438 # Indented format, this must be the summary
2439 # line (i.e. git show). There will be no more
2440 # headers so we are now in the shorttext.
2441 $shorttext = IN_SHORTTEXT_BLANKLINE;
David Keitel72bf3e82016-03-23 20:52:44 -07002442 $shorttext_exspc = 4;
2443 if (length($1) > SHORTTEXT_LIMIT) {
2444 WARN("LONG_SUMMARY_LINE",
2445 "summary line over " .
2446 SHORTTEXT_LIMIT .
2447 " characters\n" . $herecurr);
2448 }
2449 }
2450 }
2451
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002452 $cnt_lines++ if ($realcnt != 0);
2453
Joe Perchese518e9a2015-06-25 15:03:27 -07002454# Check if the commit log has what seems like a diff which can confuse patch
2455 if ($in_commit_log && !$commit_log_has_diff &&
2456 (($line =~ m@^\s+diff\b.*a/[\w/]+@ &&
2457 $line =~ m@^\s+diff\b.*a/([\w/]+)\s+b/$1\b@) ||
2458 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ ||
2459 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) {
2460 ERROR("DIFF_IN_COMMIT_MSG",
2461 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr);
2462 $commit_log_has_diff = 1;
2463 }
2464
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002465# Check for incorrect file permissions
2466 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
2467 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07002468 if ($realfile !~ m@scripts/@ &&
2469 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002470 ERROR("EXECUTE_PERMISSIONS",
2471 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07002472 }
2473 }
2474
Joe Perches20112472011-07-25 17:13:23 -07002475# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002476 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002477 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07002478 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07002479 }
2480
Joe Perchese0d975b2014-12-10 15:51:49 -08002481# Check if MAINTAINERS is being updated. If so, there's probably no need to
2482# emit the "does MAINTAINERS need updating?" message on file add/move/delete
2483 if ($line =~ /^\s*MAINTAINERS\s*\|/) {
2484 $reported_maintainer_file = 1;
2485 }
2486
Joe Perches20112472011-07-25 17:13:23 -07002487# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08002488 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002489 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07002490 my $space_before = $1;
2491 my $sign_off = $2;
2492 my $space_after = $3;
2493 my $email = $4;
2494 my $ucfirst_sign_off = ucfirst(lc($sign_off));
2495
Joe Perchesce0338df3c2012-07-30 14:41:18 -07002496 if ($sign_off !~ /$signature_tags/) {
2497 WARN("BAD_SIGN_OFF",
2498 "Non-standard signature: $sign_off\n" . $herecurr);
2499 }
Joe Perches20112472011-07-25 17:13:23 -07002500 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07002501 if (WARN("BAD_SIGN_OFF",
2502 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
2503 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002504 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002505 "$ucfirst_sign_off $email";
2506 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002507 }
Joe Perches20112472011-07-25 17:13:23 -07002508 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07002509 if (WARN("BAD_SIGN_OFF",
2510 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
2511 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002512 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002513 "$ucfirst_sign_off $email";
2514 }
2515
Joe Perches20112472011-07-25 17:13:23 -07002516 }
2517 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07002518 if (WARN("BAD_SIGN_OFF",
2519 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
2520 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002521 $fixed[$fixlinenr] =
Joe Perches3705ce52013-07-03 15:05:31 -07002522 "$ucfirst_sign_off $email";
2523 }
Joe Perches20112472011-07-25 17:13:23 -07002524 }
2525
2526 my ($email_name, $email_address, $comment) = parse_email($email);
2527 my $suggested_email = format_email(($email_name, $email_address));
2528 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07002529 ERROR("BAD_SIGN_OFF",
2530 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002531 } else {
2532 my $dequoted = $suggested_email;
2533 $dequoted =~ s/^"//;
2534 $dequoted =~ s/" </ </;
2535 # Don't force email to have quotes
2536 # Allow just an angle bracketed address
2537 if ("$dequoted$comment" ne $email &&
2538 "<$email_address>$comment" ne $email &&
2539 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002540 WARN("BAD_SIGN_OFF",
2541 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07002542 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002543 }
Jeff Johnsondb9dbec2015-01-22 13:34:29 -08002544 if ($chk_author && $line =~ /^\s*signed-off-by:.*(quicinc|qualcomm)\.com/i) {
Bryan Huntsmanb000c782010-05-04 17:31:32 -07002545 WARN("BAD_SIGN_OFF",
2546 "invalid Signed-off-by identity\n" . $line );
2547 }
Joe Perches7e51f192013-09-11 14:23:57 -07002548
2549# Check for duplicate signatures
2550 my $sig_nospace = $line;
2551 $sig_nospace =~ s/\s//g;
2552 $sig_nospace = lc($sig_nospace);
2553 if (defined $signatures{$sig_nospace}) {
2554 WARN("BAD_SIGN_OFF",
2555 "Duplicate signature\n" . $herecurr);
2556 } else {
2557 $signatures{$sig_nospace} = 1;
2558 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002559 }
2560
Joe Perchesa2fe16b2015-02-13 14:39:02 -08002561# Check email subject for common tools that don't need to be mentioned
2562 if ($in_header_lines &&
2563 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) {
2564 WARN("EMAIL_SUBJECT",
2565 "A patch subject line should describe the change not the tool that found it\n" . $herecurr);
2566 }
2567
Joe Perches9b3189e2014-06-04 16:12:10 -07002568# Check for old stable address
2569 if ($line =~ /^\s*cc:\s*.*<?\bstable\@kernel\.org\b>?.*$/i) {
2570 ERROR("STABLE_ADDRESS",
2571 "The 'stable' address should be 'stable\@vger.kernel.org'\n" . $herecurr);
2572 }
2573
Christopher Covington7ebd05e2014-04-03 14:49:31 -07002574# Check for unwanted Gerrit info
2575 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
2576 ERROR("GERRIT_CHANGE_ID",
2577 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
2578 }
2579
Joe Perches369c8dd2015-11-06 16:31:34 -08002580# Check if the commit log is in a possible stack dump
2581 if ($in_commit_log && !$commit_log_possible_stack_dump &&
2582 ($line =~ /^\s*(?:WARNING:|BUG:)/ ||
2583 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ ||
2584 # timestamp
2585 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/)) {
2586 # stack dump address
2587 $commit_log_possible_stack_dump = 1;
2588 }
2589
Joe Perches2a076f42015-04-16 12:44:28 -07002590# Check for line lengths > 75 in commit log, warn once
2591 if ($in_commit_log && !$commit_log_long_line &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002592 length($line) > 75 &&
2593 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ ||
2594 # file delta changes
2595 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ ||
2596 # filename then :
2597 $line =~ /^\s*(?:Fixes:|Link:)/i ||
2598 # A Fixes: or Link: line
2599 $commit_log_possible_stack_dump)) {
Joe Perches2a076f42015-04-16 12:44:28 -07002600 WARN("COMMIT_LOG_LONG_LINE",
2601 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr);
2602 $commit_log_long_line = 1;
2603 }
2604
Joe Perchesbf4daf12015-09-09 15:37:50 -07002605# Reset possible stack dump if a blank line is found
Joe Perches369c8dd2015-11-06 16:31:34 -08002606 if ($in_commit_log && $commit_log_possible_stack_dump &&
2607 $line =~ /^\s*$/) {
2608 $commit_log_possible_stack_dump = 0;
2609 }
Joe Perchesbf4daf12015-09-09 15:37:50 -07002610
Joe Perches0d7835f2015-02-13 14:38:35 -08002611# Check for git id commit length and improperly formed commit descriptions
Joe Perches369c8dd2015-11-06 16:31:34 -08002612 if ($in_commit_log && !$commit_log_possible_stack_dump &&
Joe Perchesaab38f52016-08-02 14:04:36 -07002613 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink):/i &&
Joe Perchesfe043ea2015-09-09 15:37:25 -07002614 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i ||
Joe Perchesaab38f52016-08-02 14:04:36 -07002615 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i &&
Joe Perches369c8dd2015-11-06 16:31:34 -08002616 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i &&
2617 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) {
Joe Perchesfe043ea2015-09-09 15:37:25 -07002618 my $init_char = "c";
2619 my $orig_commit = "";
Joe Perches0d7835f2015-02-13 14:38:35 -08002620 my $short = 1;
2621 my $long = 0;
2622 my $case = 1;
2623 my $space = 1;
2624 my $hasdesc = 0;
Joe Perches19c146a2015-02-13 14:39:00 -08002625 my $hasparens = 0;
Joe Perches0d7835f2015-02-13 14:38:35 -08002626 my $id = '0123456789ab';
2627 my $orig_desc = "commit description";
2628 my $description = "";
2629
Joe Perchesfe043ea2015-09-09 15:37:25 -07002630 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) {
2631 $init_char = $1;
2632 $orig_commit = lc($2);
2633 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) {
2634 $orig_commit = lc($1);
2635 }
2636
Joe Perches0d7835f2015-02-13 14:38:35 -08002637 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i);
2638 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i);
2639 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i);
2640 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/);
2641 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) {
2642 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002643 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002644 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i &&
2645 defined $rawlines[$linenr] &&
2646 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) {
2647 $orig_desc = $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002648 $hasparens = 1;
Joe Perchesb671fde2015-02-13 14:38:41 -08002649 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i &&
2650 defined $rawlines[$linenr] &&
2651 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) {
2652 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i;
2653 $orig_desc = $1;
2654 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/;
2655 $orig_desc .= " " . $1;
Joe Perches19c146a2015-02-13 14:39:00 -08002656 $hasparens = 1;
Joe Perches0d7835f2015-02-13 14:38:35 -08002657 }
2658
2659 ($id, $description) = git_commit_info($orig_commit,
2660 $id, $orig_desc);
2661
Joe Perches19c146a2015-02-13 14:39:00 -08002662 if ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens) {
Joe Perches0d7835f2015-02-13 14:38:35 -08002663 ERROR("GIT_COMMIT_ID",
2664 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2665 }
Joe Perchesd311cd42014-08-06 16:10:57 -07002666 }
2667
Joe Perches13f19372014-08-06 16:10:59 -07002668# Check for added, moved or deleted files
2669 if (!$reported_maintainer_file && !$in_commit_log &&
2670 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ ||
2671 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ ||
2672 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ &&
2673 (defined($1) || defined($2))))) {
2674 $reported_maintainer_file = 1;
2675 WARN("FILE_PATH_CHANGES",
2676 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr);
2677 }
2678
Bryan Huntsmanb000c782010-05-04 17:31:32 -07002679#check the patch for invalid author credentials
Jeff Johnsondb9dbec2015-01-22 13:34:29 -08002680 if ($chk_author && $line =~ /^From:.*(quicinc|qualcomm)\.com/) {
Bryan Huntsmanb000c782010-05-04 17:31:32 -07002681 WARN("BAD_AUTHOR", "invalid author identity\n" . $line );
2682 }
2683
Andy Whitcroft00df3442007-06-08 13:47:06 -07002684# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08002685 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002686 ERROR("CORRUPTED_PATCH",
2687 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002688 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002689 }
2690
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07002691# Check for absolute kernel paths.
2692 if ($tree) {
2693 while ($line =~ m{(?:^|\s)(/\S*)}g) {
2694 my $file = $1;
2695
2696 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
2697 check_absolute_file($1, $herecurr)) {
2698 #
2699 } else {
2700 check_absolute_file($file, $herecurr);
2701 }
2702 }
2703 }
2704
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002705# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2706 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002707 $rawline !~ m/^$UTF8*$/) {
2708 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
2709
2710 my $blank = copy_spacing($rawline);
2711 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
2712 my $hereptr = "$hereline$ptr\n";
2713
Joe Perches34d99212011-07-25 17:13:26 -07002714 CHK("INVALID_UTF8",
2715 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002716 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002717
Joe Perches15662b32011-10-31 17:13:12 -07002718# Check if it's the start of a commit log
2719# (not a header line and we haven't seen the patch filename)
2720 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches29ee1b02014-08-06 16:10:35 -07002721 !($rawline =~ /^\s+\S/ ||
2722 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) {
Joe Perches15662b32011-10-31 17:13:12 -07002723 $in_header_lines = 0;
2724 $in_commit_log = 1;
Allen Hubbeed43c4e2016-08-02 14:04:45 -07002725 $has_commit_log = 1;
Joe Perches15662b32011-10-31 17:13:12 -07002726 }
2727
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002728# Check if there is UTF-8 in a commit log when a mail header has explicitly
2729# declined it, i.e defined some charset where it is missing.
2730 if ($in_header_lines &&
2731 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
2732 $1 !~ /utf-8/i) {
2733 $non_utf8_charset = 1;
2734 }
2735
2736 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07002737 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07002738 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07002739 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
2740 }
2741
Kees Cook66b47b42014-10-13 15:51:57 -07002742# Check for various typo / spelling mistakes
Joe Perches66d7a382015-04-16 12:44:08 -07002743 if (defined($misspellings) &&
2744 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) {
Joe Perchesebfd7d62015-04-16 12:44:14 -07002745 while ($rawline =~ /(?:^|[^a-z@])($misspellings)(?:\b|$|[^a-z@])/gi) {
Kees Cook66b47b42014-10-13 15:51:57 -07002746 my $typo = $1;
2747 my $typo_fix = $spelling_fix{lc($typo)};
2748 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/);
2749 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/);
2750 my $msg_type = \&WARN;
2751 $msg_type = \&CHK if ($file);
2752 if (&{$msg_type}("TYPO_SPELLING",
2753 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $herecurr) &&
2754 $fix) {
2755 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/;
2756 }
2757 }
2758 }
2759
Andy Whitcroft306708542008-10-15 22:02:28 -07002760# ignore non-hunk lines and lines being removed
2761 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002762
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002763#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002764 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002765 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002766 if (ERROR("DOS_LINE_ENDINGS",
2767 "DOS line endings\n" . $herevet) &&
2768 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002769 $fixed[$fixlinenr] =~ s/[\s\015]+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07002770 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002771 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2772 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002773 if (ERROR("TRAILING_WHITESPACE",
2774 "trailing whitespace\n" . $herevet) &&
2775 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002776 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002777 }
2778
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002779 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002780 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002781
Josh Triplett4783f892013-11-12 15:10:12 -08002782# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002783 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002784 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2785 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002786 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2787 my $msg_type = \&ERROR;
2788 $msg_type = \&CHK if ($file);
2789 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002790 "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 -08002791 }
2792
Andi Kleen33549572010-05-24 14:33:29 -07002793# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002794# Only applies when adding the entry originally, after that we do not have
2795# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002796 if ($realfile =~ /Kconfig/ &&
Joe Perches8d73e0e2014-08-06 16:10:46 -07002797 $line =~ /^\+\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002798 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002799 my $cnt = $realcnt;
2800 my $ln = $linenr + 1;
2801 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002802 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002803 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002804 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002805 $f = $lines[$ln - 1];
2806 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2807 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002808
2809 next if ($f =~ /^-/);
Joe Perches8d73e0e2014-08-06 16:10:46 -07002810 last if (!$file && $f =~ /^\@\@/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002811
Joe Perches8d73e0e2014-08-06 16:10:46 -07002812 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate)\s*\"/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002813 $is_start = 1;
Joe Perches8d73e0e2014-08-06 16:10:46 -07002814 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) {
Andy Whitcrofta1385802012-01-10 15:10:03 -08002815 $length = -1;
2816 }
2817
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002818 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002819 $f =~ s/#.*//;
2820 $f =~ s/^\s+//;
2821 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002822 if ($f =~ /^\s*config\s/) {
2823 $is_end = 1;
2824 last;
2825 }
Andi Kleen33549572010-05-24 14:33:29 -07002826 $length++;
2827 }
Vadim Bendebury56193272014-10-13 15:51:48 -07002828 if ($is_start && $is_end && $length < $min_conf_desc_length) {
2829 WARN("CONFIG_DESCRIPTION",
2830 "please write a paragraph that describes the config symbol fully\n" . $herecurr);
2831 }
Andy Whitcrofta1385802012-01-10 15:10:03 -08002832 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002833 }
2834
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002835# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2836 if ($realfile =~ /Kconfig/ &&
2837 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2838 WARN("CONFIG_EXPERIMENTAL",
2839 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2840 }
2841
Christoph Jaeger327953e2015-02-13 14:38:29 -08002842# discourage the use of boolean for type definition attributes of Kconfig options
2843 if ($realfile =~ /Kconfig/ &&
2844 $line =~ /^\+\s*\bboolean\b/) {
2845 WARN("CONFIG_TYPE_BOOLEAN",
2846 "Use of boolean is deprecated, please use bool instead.\n" . $herecurr);
2847 }
2848
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002849 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2850 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2851 my $flag = $1;
2852 my $replacement = {
2853 'EXTRA_AFLAGS' => 'asflags-y',
2854 'EXTRA_CFLAGS' => 'ccflags-y',
2855 'EXTRA_CPPFLAGS' => 'cppflags-y',
2856 'EXTRA_LDFLAGS' => 'ldflags-y',
2857 };
2858
2859 WARN("DEPRECATED_VARIABLE",
2860 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2861 }
2862
Rob Herringbff5da42014-01-23 15:54:51 -08002863# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002864 if (defined $root &&
2865 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2866 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2867
Rob Herringbff5da42014-01-23 15:54:51 -08002868 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2869
Florian Vaussardcc933192014-04-03 14:49:27 -07002870 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2871 my $vp_file = $dt_path . "vendor-prefixes.txt";
2872
Rob Herringbff5da42014-01-23 15:54:51 -08002873 foreach my $compat (@compats) {
2874 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002875 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2876 my $compat3 = $compat;
2877 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2878 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002879 if ( $? >> 8 ) {
2880 WARN("UNDOCUMENTED_DT_STRING",
2881 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2882 }
2883
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002884 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2885 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002886 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002887 if ( $? >> 8 ) {
2888 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002889 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002890 }
2891 }
2892 }
2893
Andy Whitcroft5368df22008-10-15 22:02:27 -07002894# check we are in a valid source file if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002895 next if ($realfile !~ /\.(h|c|s|S|pl|sh|dtsi|dts)$/);
Andy Whitcroft5368df22008-10-15 22:02:27 -07002896
Joe Perches47e0c882015-06-25 15:02:57 -07002897# line length limit (with some exclusions)
2898#
2899# There are a few types of lines that may extend beyond $max_line_length:
2900# logging functions like pr_info that end in a string
2901# lines with a single string
2902# #defines that are a single string
2903#
2904# There are 3 different line length message types:
2905# LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2906# LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2907# LONG_LINE all other lines longer than $max_line_length
2908#
2909# if LONG_LINE is ignored, the other 2 types are also ignored
2910#
Israel Schlesingerc5955792010-07-27 13:28:26 -07002911 if ($line =~ /^\+/ && $length > $max_line_length && $realfile ne "scripts/checkpatch.pl") {
Joe Perches47e0c882015-06-25 15:02:57 -07002912 my $msg_type = "LONG_LINE";
2913
2914 # Check the allowed long line types first
2915
2916 # logging functions that end in a string that starts
2917 # before $max_line_length
2918 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2919 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2920 $msg_type = "";
2921
2922 # lines with only strings (w/ possible termination)
2923 # #defines with only strings
2924 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ ||
2925 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) {
2926 $msg_type = "";
2927
Joe Perchesd560a5f2016-08-02 14:04:31 -07002928 # EFI_GUID is another special case
2929 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/) {
2930 $msg_type = "";
2931
Joe Perches47e0c882015-06-25 15:02:57 -07002932 # Otherwise set the alternate message types
2933
2934 # a comment starts before $max_line_length
2935 } elsif ($line =~ /($;[\s$;]*)$/ &&
2936 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2937 $msg_type = "LONG_LINE_COMMENT"
2938
2939 # a quoted string starts before $max_line_length
2940 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ &&
2941 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) {
2942 $msg_type = "LONG_LINE_STRING"
2943 }
2944
2945 if ($msg_type ne "" &&
2946 (show_type("LONG_LINE") || show_type($msg_type))) {
2947 WARN($msg_type,
2948 "line over $max_line_length characters\n" . $herecurr);
2949 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002950 }
2951
Andy Whitcroft8905a672007-11-28 16:21:06 -08002952# check for adding lines without a newline.
2953 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002954 WARN("MISSING_EOF_NEWLINE",
2955 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002956 }
2957
Mike Frysinger42e41c52009-09-21 17:04:40 -07002958# Blackfin: use hi/lo macros
2959 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2960 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2961 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002962 ERROR("LO_MACRO",
2963 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002964 }
2965 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2966 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002967 ERROR("HI_MACRO",
2968 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002969 }
2970 }
2971
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002972# check we are in a valid source file C or perl if not then ignore this hunk
Geert Uytterhoevende4c9242014-10-13 15:51:46 -07002973 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002974
2975# at the beginning of a line any tabs must come first and anything
2976# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002977 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2978 $rawline =~ /^\+\s* \s*/) {
2979 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002980 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002981 if (ERROR("CODE_INDENT",
2982 "code indent should use tabs where possible\n" . $herevet) &&
2983 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002984 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07002985 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002986 }
2987
Alberto Panizzo08e44362010-03-05 13:43:54 -08002988# check for space before tabs.
2989 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2990 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002991 if (WARN("SPACE_BEFORE_TAB",
2992 "please, no space before tabs\n" . $herevet) &&
2993 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07002994 while ($fixed[$fixlinenr] =~
Joe Perchesd2207cc2014-10-13 15:51:53 -07002995 s/(^\+.*) {8,8}\t/$1\t\t/) {}
Joe Perches194f66f2014-08-06 16:11:03 -07002996 while ($fixed[$fixlinenr] =~
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002997 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002998 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002999 }
3000
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003001# check for && or || at the start of a line
3002 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
3003 CHK("LOGICAL_CONTINUATIONS",
3004 "Logical continuations should be on the previous line\n" . $hereprev);
3005 }
3006
Joe Perchesa91e8992016-05-20 17:04:05 -07003007# check indentation starts on a tab stop
3008 if ($^V && $^V ge 5.10.0 &&
3009 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$))/) {
3010 my $indent = length($1);
3011 if ($indent % 8) {
3012 if (WARN("TABSTOP",
3013 "Statements should start on a tabstop\n" . $herecurr) &&
3014 $fix) {
3015 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/8)@e;
3016 }
3017 }
3018 }
3019
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003020# check multi-line statement indentation matches previous line
3021 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07003022 $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 -07003023 $prevline =~ /^\+(\t*)(.*)$/;
3024 my $oldindent = $1;
3025 my $rest = $2;
3026
3027 my $pos = pos_last_openparen($rest);
3028 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07003029 $line =~ /^(\+| )([ \t]*)/;
3030 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003031
3032 my $goodtabindent = $oldindent .
3033 "\t" x ($pos / 8) .
3034 " " x ($pos % 8);
3035 my $goodspaceindent = $oldindent . " " x $pos;
3036
3037 if ($newindent ne $goodtabindent &&
3038 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07003039
3040 if (CHK("PARENTHESIS_ALIGNMENT",
3041 "Alignment should match open parenthesis\n" . $hereprev) &&
3042 $fix && $line =~ /^\+/) {
Joe Perches194f66f2014-08-06 16:11:03 -07003043 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003044 s/^\+[ \t]*/\+$goodtabindent/;
3045 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003046 }
3047 }
3048 }
3049
Joe Perches6ab3a972015-04-16 12:44:05 -07003050# check for space after cast like "(int) foo" or "(struct foo) bar"
3051# avoid checking a few false positives:
3052# "sizeof(<type>)" or "__alignof__(<type>)"
3053# function pointer declarations like "(*foo)(int) = bar;"
3054# structure definitions like "(struct foo) { 0 };"
3055# multiline macros that define functions
3056# known attributes or the __attribute__ keyword
3057 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ &&
3058 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003059 if (CHK("SPACING",
Joe Perchesf27c95d2014-08-06 16:10:52 -07003060 "No space is necessary after a cast\n" . $herecurr) &&
Joe Perches3705ce52013-07-03 15:05:31 -07003061 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003062 $fixed[$fixlinenr] =~
Joe Perchesf27c95d2014-08-06 16:10:52 -07003063 s/(\(\s*$Type\s*\))[ \t]+/$1/;
Joe Perches3705ce52013-07-03 15:05:31 -07003064 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003065 }
3066
Joe Perches86406b12015-09-09 15:37:41 -07003067# Block comment styles
3068# Networking with an initial /*
Joe Perches05880602012-10-04 17:13:35 -07003069 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07003070 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07003071 $rawline =~ /^\+[ \t]*\*/ &&
3072 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07003073 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
3074 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
3075 }
3076
Joe Perches86406b12015-09-09 15:37:41 -07003077# Block comments use * on subsequent lines
3078 if ($prevline =~ /$;[ \t]*$/ && #ends in comment
3079 $prevrawline =~ /^\+.*?\/\*/ && #starting /*
Joe Perchesa605e322013-07-03 15:05:24 -07003080 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07003081 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07003082 $rawline !~ /^\+[ \t]*\*/) { #no leading *
Joe Perches86406b12015-09-09 15:37:41 -07003083 WARN("BLOCK_COMMENT_STYLE",
3084 "Block comments use * on subsequent lines\n" . $hereprev);
Joe Perchesa605e322013-07-03 15:05:24 -07003085 }
3086
Joe Perches86406b12015-09-09 15:37:41 -07003087# Block comments use */ on trailing lines
3088 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
Joe Perchesc24f9f12012-11-08 15:53:29 -08003089 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
3090 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
3091 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches86406b12015-09-09 15:37:41 -07003092 WARN("BLOCK_COMMENT_STYLE",
3093 "Block comments use a trailing */ on a separate line\n" . $herecurr);
Joe Perches05880602012-10-04 17:13:35 -07003094 }
3095
Joe Perches7f619192014-08-06 16:10:39 -07003096# check for missing blank lines after struct/union declarations
3097# with exceptions for various attributes and macros
3098 if ($prevline =~ /^[\+ ]};?\s*$/ &&
3099 $line =~ /^\+/ &&
3100 !($line =~ /^\+\s*$/ ||
3101 $line =~ /^\+\s*EXPORT_SYMBOL/ ||
3102 $line =~ /^\+\s*MODULE_/i ||
3103 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ ||
3104 $line =~ /^\+[a-z_]*init/ ||
3105 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ ||
3106 $line =~ /^\+\s*DECLARE/ ||
3107 $line =~ /^\+\s*__setup/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003108 if (CHK("LINE_SPACING",
3109 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) &&
3110 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003111 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003112 }
Joe Perches7f619192014-08-06 16:10:39 -07003113 }
3114
Joe Perches365dd4e2014-08-06 16:10:42 -07003115# check for multiple consecutive blank lines
3116 if ($prevline =~ /^[\+ ]\s*$/ &&
3117 $line =~ /^\+\s*$/ &&
3118 $last_blank_line != ($linenr - 1)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003119 if (CHK("LINE_SPACING",
3120 "Please don't use multiple blank lines\n" . $hereprev) &&
3121 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003122 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003123 }
3124
Joe Perches365dd4e2014-08-06 16:10:42 -07003125 $last_blank_line = $linenr;
3126 }
3127
Joe Perches3b617e32014-04-03 14:49:28 -07003128# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07003129 if ($sline =~ /^\+\s+\S/ && #Not at char 1
3130 # actual declarations
3131 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003132 # function pointer declarations
3133 $prevline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003134 # foo bar; where foo is some local typedef or #define
3135 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3136 # known declaration macros
3137 $prevline =~ /^\+\s+$declaration_macros/) &&
3138 # for "else if" which can look like "$Ident $Ident"
3139 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
3140 # other possible extensions of declaration lines
3141 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
3142 # not starting a section or a macro "\" extended line
3143 $prevline =~ /(?:\{\s*|\\)$/) &&
3144 # looks like a declaration
3145 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
Joe Perches5a4e1fd2014-08-06 16:10:33 -07003146 # function pointer declarations
3147 $sline =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003148 # foo bar; where foo is some local typedef or #define
3149 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
3150 # known declaration macros
3151 $sline =~ /^\+\s+$declaration_macros/ ||
3152 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07003153 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07003154 # start or end of block or continuation of declaration
3155 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
3156 # bitfield continuation
3157 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
3158 # other possible extensions of declaration lines
3159 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
3160 # indentation of previous and current line are the same
3161 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003162 if (WARN("LINE_SPACING",
3163 "Missing a blank line after declarations\n" . $hereprev) &&
3164 $fix) {
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003165 fix_insert_line($fixlinenr, "\+");
Joe Perchesd752fcc2014-08-06 16:11:05 -07003166 }
Joe Perches3b617e32014-04-03 14:49:28 -07003167 }
3168
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003169# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07003170# Exceptions:
3171# 1) within comments
3172# 2) indented preprocessor commands
3173# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07003174 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003175 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003176 if (WARN("LEADING_SPACE",
3177 "please, no spaces at the start of a line\n" . $herevet) &&
3178 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003179 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
Joe Perches3705ce52013-07-03 15:05:31 -07003180 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07003181 }
3182
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07003183# check we are in a valid C source file if not then ignore this hunk
3184 next if ($realfile !~ /\.(h|c)$/);
3185
Joe Perches032a4c02014-08-06 16:10:29 -07003186# check indentation of any line with a bare else
Joe Perches840080a2014-10-13 15:51:59 -07003187# (but not if it is a multiple line "if (foo) return bar; else return baz;")
Joe Perches032a4c02014-08-06 16:10:29 -07003188# if the previous line is a break or return and is indented 1 tab more...
3189 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) {
3190 my $tabs = length($1) + 1;
Joe Perches840080a2014-10-13 15:51:59 -07003191 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ ||
3192 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ &&
3193 defined $lines[$linenr] &&
3194 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) {
Joe Perches032a4c02014-08-06 16:10:29 -07003195 WARN("UNNECESSARY_ELSE",
3196 "else is not generally useful after a break or return\n" . $hereprev);
3197 }
3198 }
3199
Joe Perchesc00df192014-08-06 16:11:01 -07003200# check indentation of a line with a break;
3201# if the previous line is a goto or return and is indented the same # of tabs
3202 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) {
3203 my $tabs = $1;
3204 if ($prevline =~ /^\+$tabs(?:goto|return)\b/) {
3205 WARN("UNNECESSARY_BREAK",
3206 "break is not useful after a goto or return\n" . $hereprev);
3207 }
3208 }
3209
Kees Cook1ba8dfd2012-12-17 16:01:48 -08003210# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3211 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
3212 WARN("CONFIG_EXPERIMENTAL",
3213 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3214 }
3215
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003216# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08003217 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003218 WARN("CVS_KEYWORD",
3219 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003220 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003221
Mike Frysinger42e41c52009-09-21 17:04:40 -07003222# Blackfin: don't use __builtin_bfin_[cs]sync
3223 if ($line =~ /__builtin_bfin_csync/) {
3224 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003225 ERROR("CSYNC",
3226 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003227 }
3228 if ($line =~ /__builtin_bfin_ssync/) {
3229 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07003230 ERROR("SSYNC",
3231 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07003232 }
3233
Joe Perches56e77d72013-02-21 16:44:14 -08003234# check for old HOTPLUG __dev<foo> section markings
3235 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
3236 WARN("HOTPLUG_SECTION",
3237 "Using $1 is unnecessary\n" . $herecurr);
3238 }
3239
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003240# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003241 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
3242 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003243#print "LINE<$line>\n";
3244 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07003245 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003246 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003247 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003248 $stat =~ s/\n./\n /g;
3249 $cond =~ s/\n./\n /g;
3250
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003251#print "linenr<$linenr> <$stat>\n";
3252 # If this statement has no statement boundaries within
3253 # it there is no point in retrying a statement scan
3254 # until we hit end of it.
3255 my $frag = $stat; $frag =~ s/;+\s*$//;
3256 if ($frag !~ /(?:{|;)/) {
3257#print "skip<$line_nr_next>\n";
3258 $suppress_statement = $line_nr_next;
3259 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003260
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003261 # Find the real next line.
3262 $realline_next = $line_nr_next;
3263 if (defined $realline_next &&
3264 (!defined $lines[$realline_next - 1] ||
3265 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
3266 $realline_next++;
3267 }
3268
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003269 my $s = $stat;
3270 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003271
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003272 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003273 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003274
3275 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003276 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003277
Andy Whitcroft463f2862009-09-21 17:04:34 -07003278 } elsif ($s =~ /^.\s*else\b/s) {
3279
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003280 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07003281 } 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 -07003282 my $type = $1;
3283 $type =~ s/\s+/ /g;
3284 possible($type, "A:" . $s);
3285
Andy Whitcroft8905a672007-11-28 16:21:06 -08003286 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07003287 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003288 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003289 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003290
3291 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08003292 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003293 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003294 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003295
3296 # Check for any sort of function declaration.
3297 # int foo(something bar, other baz);
3298 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003299 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 -08003300 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003301
Andy Whitcroftcf655042008-03-04 14:28:20 -08003302 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003303 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003304 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003305
Andy Whitcroft8905a672007-11-28 16:21:06 -08003306 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003307 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08003308
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003309 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003310 }
3311 }
3312 }
3313
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003314 }
3315
Andy Whitcroft653d4872007-06-23 17:16:34 -07003316#
3317# Checks which may be anchored in the context.
3318#
3319
3320# Check for switch () and associated case and default
3321# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003322 if ($line=~/\bswitch\s*\(.*\)/) {
3323 my $err = '';
3324 my $sep = '';
3325 my @ctx = ctx_block_outer($linenr, $realcnt);
3326 shift(@ctx);
3327 for my $ctx (@ctx) {
3328 my ($clen, $cindent) = line_stats($ctx);
3329 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
3330 $indent != $cindent) {
3331 $err .= "$sep$ctx\n";
3332 $sep = '';
3333 } else {
3334 $sep = "[...]\n";
3335 }
3336 }
3337 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003338 ERROR("SWITCH_CASE_INDENT_LEVEL",
3339 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003340 }
3341 }
3342
3343# if/while/etc brace do not go on next line, unless defining a do while loop,
3344# or if that brace on the next line is for something else
Joe Perches0fe3dc22014-08-06 16:11:16 -07003345 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 -07003346 my $pre_ctx = "$1$2";
3347
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003348 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08003349
3350 if ($line =~ /^\+\t{6,}/) {
3351 WARN("DEEP_INDENTATION",
3352 "Too many leading tabs - consider code refactoring\n" . $herecurr);
3353 }
3354
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003355 my $ctx_cnt = $realcnt - $#ctx - 1;
3356 my $ctx = join("\n", @ctx);
3357
Andy Whitcroft548596d2008-07-23 21:29:01 -07003358 my $ctx_ln = $linenr;
3359 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003360
Andy Whitcroft548596d2008-07-23 21:29:01 -07003361 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
3362 defined $lines[$ctx_ln - 1] &&
3363 $lines[$ctx_ln - 1] =~ /^-/)) {
3364 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3365 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003366 $ctx_ln++;
3367 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07003368
Andy Whitcroft53210162008-07-23 21:29:03 -07003369 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3370 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07003371
Joe Perchesd752fcc2014-08-06 16:11:05 -07003372 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003373 ERROR("OPEN_BRACE",
3374 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003375 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07003376 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003377 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
3378 $ctx =~ /\)\s*\;\s*$/ &&
3379 defined $lines[$ctx_ln - 1])
3380 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003381 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
3382 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003383 WARN("TRAILING_SEMICOLON",
3384 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07003385 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003386 }
3387 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003388 }
3389
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003390# Check relative indent for conditionals and blocks.
Joe Perches0fe3dc22014-08-06 16:11:16 -07003391 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 -08003392 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3393 ctx_statement_block($linenr, $realcnt, 0)
3394 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003395 my ($s, $c) = ($stat, $cond);
3396
3397 substr($s, 0, length($c), '');
3398
Joe Perches9f5af482015-09-09 15:37:30 -07003399 # remove inline comments
3400 $s =~ s/$;/ /g;
3401 $c =~ s/$;/ /g;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003402
3403 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07003404 my @newlines = ($c =~ /\n/gs);
3405 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003406
Joe Perches9f5af482015-09-09 15:37:30 -07003407 # Make sure we remove the line prefixes as we have
3408 # none on the first line, and are going to readd them
3409 # where necessary.
3410 $s =~ s/\n./\n/gs;
3411 while ($s =~ /\n\s+\\\n/) {
3412 $cond_lines += $s =~ s/\n\s+\\\n/\n/g;
3413 }
3414
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003415 # We want to check the first line inside the block
3416 # starting at the end of the conditional, so remove:
3417 # 1) any blank line termination
3418 # 2) any opening brace { on end of the line
3419 # 3) any do (...) {
3420 my $continuation = 0;
3421 my $check = 0;
3422 $s =~ s/^.*\bdo\b//;
3423 $s =~ s/^\s*{//;
3424 if ($s =~ s/^\s*\\//) {
3425 $continuation = 1;
3426 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003427 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003428 $check = 1;
3429 $cond_lines++;
3430 }
3431
3432 # Also ignore a loop construct at the end of a
3433 # preprocessor statement.
3434 if (($prevline =~ /^.\s*#\s*define\s/ ||
3435 $prevline =~ /\\\s*$/) && $continuation == 0) {
3436 $check = 0;
3437 }
3438
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003439 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07003440 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003441 while ($cond_ptr != $cond_lines) {
3442 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003443
Andy Whitcroftf16fa282008-10-15 22:02:32 -07003444 # If we see an #else/#elif then the code
3445 # is not linear.
3446 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
3447 $check = 0;
3448 }
3449
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003450 # Ignore:
3451 # 1) blank lines, they should be at 0,
3452 # 2) preprocessor lines, and
3453 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07003454 if ($continuation ||
3455 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003456 $s =~ /^\s*#\s*?/ ||
3457 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07003458 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07003459 if ($s =~ s/^.*?\n//) {
3460 $cond_lines++;
3461 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003462 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003463 }
3464
3465 my (undef, $sindent) = line_stats("+" . $s);
3466 my $stat_real = raw_line($linenr, $cond_lines);
3467
3468 # Check if either of these lines are modified, else
3469 # this is not this patch's fault.
3470 if (!defined($stat_real) ||
3471 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
3472 $check = 0;
3473 }
3474 if (defined($stat_real) && $cond_lines > 1) {
3475 $stat_real = "[...]\n$stat_real";
3476 }
3477
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07003478 #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 -07003479
Joe Perches9f5af482015-09-09 15:37:30 -07003480 if ($check && $s ne '' &&
3481 (($sindent % 8) != 0 ||
3482 ($sindent < $indent) ||
3483 ($sindent > $indent + 8))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003484 WARN("SUSPECT_CODE_INDENT",
3485 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07003486 }
3487 }
3488
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003489 # Track the 'values' across context and added lines.
3490 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003491 my ($curr_values, $curr_vars) =
3492 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003493 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003494 if ($dbg_values) {
3495 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003496 print "$linenr > .$outline\n";
3497 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003498 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003499 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003500 $prev_values = substr($curr_values, -1);
3501
Andy Whitcroft00df3442007-06-08 13:47:06 -07003502#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07003503 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003504
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003505# check for declarations of signed or unsigned without int
Joe Perchesc8447112016-08-02 14:04:42 -07003506 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 -07003507 my $type = $1;
3508 my $var = $2;
Joe Perches207a8e82016-03-15 14:58:06 -07003509 $var = "" if (!defined $var);
3510 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) {
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003511 my $sign = $1;
3512 my $pointer = $2;
3513
3514 $pointer = "" if (!defined $pointer);
3515
3516 if (WARN("UNSPECIFIED_INT",
3517 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3518 $fix) {
3519 my $decl = trim($sign) . " int ";
Joe Perches207a8e82016-03-15 14:58:06 -07003520 my $comp_pointer = $pointer;
3521 $comp_pointer =~ s/\s//g;
3522 $decl .= $comp_pointer;
3523 $decl = rtrim($decl) if ($var eq "");
3524 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@;
Joe Perchesa1ce18e2016-03-15 14:58:03 -07003525 }
3526 }
3527 }
3528
Andy Whitcroft653d4872007-06-23 17:16:34 -07003529# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07003530 if ($dbg_type) {
3531 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003532 ERROR("TEST_TYPE",
3533 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003534 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003535 ERROR("TEST_NOT_TYPE",
3536 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07003537 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003538 next;
3539 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003540# TEST: allow direct testing of the attribute matcher.
3541 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003542 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003543 ERROR("TEST_ATTR",
3544 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08003545 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003546 ERROR("TEST_NOT_ATTR",
3547 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07003548 }
3549 next;
3550 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003551
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003552# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07003553 if ($line =~ /^.\s*{/ &&
3554 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perchesd752fcc2014-08-06 16:11:05 -07003555 if (ERROR("OPEN_BRACE",
3556 "that open brace { should be on the previous line\n" . $hereprev) &&
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003557 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3558 fix_delete_line($fixlinenr - 1, $prevrawline);
3559 fix_delete_line($fixlinenr, $rawline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003560 my $fixedline = $prevrawline;
3561 $fixedline =~ s/\s*=\s*$/ = {/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003562 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003563 $fixedline = $line;
3564 $fixedline =~ s/^(.\s*){\s*/$1/;
Joe Perchesf2d7e4d2014-08-06 16:11:07 -07003565 fix_insert_line($fixlinenr, $fixedline);
Joe Perchesd752fcc2014-08-06 16:11:05 -07003566 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003567 }
3568
Andy Whitcroft653d4872007-06-23 17:16:34 -07003569#
3570# Checks which are anchored on the added line.
3571#
3572
3573# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003574 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07003575 my $path = $1;
3576 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003577 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08003578 "malformed #include filename\n" . $herecurr);
3579 }
3580 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
3581 ERROR("UAPI_INCLUDE",
3582 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003583 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003584 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003585
3586# no C99 // comments
3587 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07003588 if (ERROR("C99_COMMENTS",
3589 "do not use C99 // comments\n" . $herecurr) &&
3590 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003591 my $line = $fixed[$fixlinenr];
Joe Perches3705ce52013-07-03 15:05:31 -07003592 if ($line =~ /\/\/(.*)$/) {
3593 my $comment = trim($1);
Joe Perches194f66f2014-08-06 16:11:03 -07003594 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@;
Joe Perches3705ce52013-07-03 15:05:31 -07003595 }
3596 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07003597 }
3598 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003599 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003600 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003601
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003602# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3603# the whole statement.
3604#print "APW <$lines[$realline_next - 1]>\n";
3605 if (defined $realline_next &&
3606 exists $lines[$realline_next - 1] &&
3607 !defined $suppress_export{$realline_next} &&
3608 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3609 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003610 # Handle definitions which produce identifiers with
3611 # a prefix:
3612 # XXX(foo);
3613 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07003614 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08003615 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07003616 $name =~ /^${Ident}_$2/) {
3617#print "FOO C name<$name>\n";
3618 $suppress_export{$realline_next} = 1;
3619
3620 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003621 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07003622 ^.DEFINE_$Ident\(\Q$name\E\)|
3623 ^.DECLARE_$Ident\(\Q$name\E\)|
3624 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003625 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
3626 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07003627 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003628#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3629 $suppress_export{$realline_next} = 2;
3630 } else {
3631 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003632 }
3633 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003634 if (!defined $suppress_export{$linenr} &&
3635 $prevline =~ /^.\s*$/ &&
3636 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
3637 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
3638#print "FOO B <$lines[$linenr - 1]>\n";
3639 $suppress_export{$linenr} = 2;
3640 }
3641 if (defined $suppress_export{$linenr} &&
3642 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003643 WARN("EXPORT_SYMBOL",
3644 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07003645 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003646
Joe Eloff5150bda2010-08-09 17:21:00 -07003647# check for global initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003648 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003649 if (ERROR("GLOBAL_INITIALISERS",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003650 "do not initialise globals to $1\n" . $herecurr) &&
Joe Perchesd5e616f2013-09-11 14:23:54 -07003651 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003652 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003653 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003654 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003655# check for static initialisers.
Joe Perches6d32f7a2015-11-06 16:31:37 -08003656 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003657 if (ERROR("INITIALISED_STATIC",
Joe Perches6d32f7a2015-11-06 16:31:37 -08003658 "do not initialise statics to $1\n" .
Joe Perchesd5e616f2013-09-11 14:23:54 -07003659 $herecurr) &&
3660 $fix) {
Joe Perches6d32f7a2015-11-06 16:31:37 -08003661 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07003662 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003663 }
3664
Joe Perches18130872014-08-06 16:11:22 -07003665# check for misordered declarations of char/short/int/long with signed/unsigned
3666 while ($sline =~ m{(\b$TypeMisordered\b)}g) {
3667 my $tmp = trim($1);
3668 WARN("MISORDERED_TYPE",
3669 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3670 }
3671
Joe Perchescb710ec2010-10-26 14:23:20 -07003672# check for static const char * arrays.
3673 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003674 WARN("STATIC_CONST_CHAR_ARRAY",
3675 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003676 $herecurr);
3677 }
3678
3679# check for static char foo[] = "bar" declarations.
3680 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003681 WARN("STATIC_CONST_CHAR_ARRAY",
3682 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07003683 $herecurr);
3684 }
3685
Joe Perchesab7e23f2015-04-16 12:44:22 -07003686# check for const <foo> const where <foo> is not a pointer or array type
3687 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) {
3688 my $found = $1;
3689 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) {
3690 WARN("CONST_CONST",
3691 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr);
3692 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) {
3693 WARN("CONST_CONST",
3694 "'const $found const' should probably be 'const $found'\n" . $herecurr);
3695 }
3696 }
3697
Joe Perches9b0fa602014-04-03 14:49:18 -07003698# check for non-global char *foo[] = {"bar", ...} declarations.
3699 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
3700 WARN("STATIC_CONST_CHAR_ARRAY",
3701 "char * array declaration might be better as static const\n" .
3702 $herecurr);
3703 }
3704
Joe Perchesb598b672015-04-16 12:44:36 -07003705# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3706 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) {
3707 my $array = $1;
3708 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3709 my $array_div = $1;
3710 if (WARN("ARRAY_SIZE",
3711 "Prefer ARRAY_SIZE($array)\n" . $herecurr) &&
3712 $fix) {
3713 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/;
3714 }
3715 }
3716 }
3717
Joe Perchesb36190c2014-01-27 17:07:18 -08003718# check for function declarations without arguments like "int foo()"
3719 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
3720 if (ERROR("FUNCTION_WITHOUT_ARGS",
3721 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
3722 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003723 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
Joe Perchesb36190c2014-01-27 17:07:18 -08003724 }
3725 }
3726
Joe Perches92e112f2013-12-13 11:36:22 -07003727# check for uses of DEFINE_PCI_DEVICE_TABLE
3728 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
3729 if (WARN("DEFINE_PCI_DEVICE_TABLE",
3730 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
3731 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003732 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
Joe Perches92e112f2013-12-13 11:36:22 -07003733 }
Joe Perches93ed0e22010-10-26 14:23:21 -07003734 }
3735
Andy Whitcroft653d4872007-06-23 17:16:34 -07003736# check for new typedefs, only function parameters and sparse annotations
3737# make sense.
3738 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08003739 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003740 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07003741 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07003742 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003743 WARN("NEW_TYPEDEFS",
3744 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003745 }
3746
3747# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08003748 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003749 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
3750 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003751 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003752
Andy Whitcroft65863862009-01-06 14:41:21 -08003753 # Should start with a space.
3754 $to =~ s/^(\S)/ $1/;
3755 # Should not end with a space.
3756 $to =~ s/\s+$//;
3757 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003758 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003759 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003760
Joe Perches3705ce52013-07-03 15:05:31 -07003761## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08003762 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07003763 if (ERROR("POINTER_LOCATION",
3764 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
3765 $fix) {
3766 my $sub_from = $ident;
3767 my $sub_to = $ident;
3768 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003769 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003770 s@\Q$sub_from\E@$sub_to@;
3771 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003772 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08003773 }
3774 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
3775 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07003776 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003777
Andy Whitcroft65863862009-01-06 14:41:21 -08003778 # Should start with a space.
3779 $to =~ s/^(\S)/ $1/;
3780 # Should not end with a space.
3781 $to =~ s/\s+$//;
3782 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08003783 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08003784 }
3785 # Modifiers should have spaces.
3786 $to =~ s/(\b$Modifier$)/$1 /;
3787
Joe Perches3705ce52013-07-03 15:05:31 -07003788## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08003789 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003790 if (ERROR("POINTER_LOCATION",
3791 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
3792 $fix) {
3793
3794 my $sub_from = $match;
3795 my $sub_to = $match;
3796 $sub_to =~ s/\Q$from\E/$to/;
Joe Perches194f66f2014-08-06 16:11:03 -07003797 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003798 s@\Q$sub_from\E@$sub_to@;
3799 }
Andy Whitcroft65863862009-01-06 14:41:21 -08003800 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003801 }
3802
Joe Perches9d3e3c72015-09-09 15:37:27 -07003803# avoid BUG() or BUG_ON()
3804 if ($line =~ /\b(?:BUG|BUG_ON)\b/) {
3805 my $msg_type = \&WARN;
3806 $msg_type = \&CHK if ($file);
3807 &{$msg_type}("AVOID_BUG",
3808 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3809 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003810
Joe Perches9d3e3c72015-09-09 15:37:27 -07003811# avoid LINUX_VERSION_CODE
Andy Whitcroft8905a672007-11-28 16:21:06 -08003812 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003813 WARN("LINUX_VERSION_CODE",
3814 "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 -08003815 }
3816
Joe Perches17441222011-06-15 15:08:17 -07003817# check for uses of printk_ratelimit
3818 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003819 WARN("PRINTK_RATELIMITED",
Joe Perches101ee682015-02-13 14:38:54 -08003820 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07003821 }
3822
Andy Whitcroft00df3442007-06-08 13:47:06 -07003823# printk should use KERN_* levels. Note that follow on printk's on the
3824# same line do not need a level, so we use the current block context
3825# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003826# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07003827# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003828 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003829 my $ok = 0;
3830 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
3831 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003832 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07003833 # with "\n" ignore it, else it is to blame
3834 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
3835 if ($rawlines[$ln - 1] !~ m{\\n"}) {
3836 $ok = 1;
3837 }
3838 last;
3839 }
3840 }
3841 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003842 WARN("PRINTK_WITHOUT_KERN_LEVEL",
3843 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07003844 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003845 }
3846
Joe Perches243f3802012-05-31 16:26:09 -07003847 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
3848 my $orig = $1;
3849 my $level = lc($orig);
3850 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07003851 my $level2 = $level;
3852 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07003853 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07003854 "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 -07003855 }
3856
3857 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003858 if (WARN("PREFER_PR_LEVEL",
3859 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
3860 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003861 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07003862 s/\bpr_warning\b/pr_warn/;
3863 }
Joe Perches243f3802012-05-31 16:26:09 -07003864 }
3865
Joe Perchesdc139312013-02-21 16:44:13 -08003866 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
3867 my $orig = $1;
3868 my $level = lc($orig);
3869 $level = "warn" if ($level eq "warning");
3870 $level = "dbg" if ($level eq "debug");
3871 WARN("PREFER_DEV_LEVEL",
3872 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
3873 }
3874
Andy Lutomirski91c9afa2015-04-16 12:44:44 -07003875# ENOSYS means "bad syscall nr" and nothing else. This will have a small
3876# number of false positives, but assembly files are not checked, so at
3877# least the arch entry code will not trigger this warning.
3878 if ($line =~ /\bENOSYS\b/) {
3879 WARN("ENOSYS",
3880 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr);
3881 }
3882
Andy Whitcroft653d4872007-06-23 17:16:34 -07003883# function brace can't be on same line, except for #defines of do while,
3884# or if closed on same line
Joe Perches8d182472014-08-06 16:11:12 -07003885 if (($line=~/$Type\s*$Ident\(.*\).*\s*{/) and
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07003886 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
Joe Perches8d182472014-08-06 16:11:12 -07003887 if (ERROR("OPEN_BRACE",
3888 "open brace '{' following function declarations go on the next line\n" . $herecurr) &&
3889 $fix) {
3890 fix_delete_line($fixlinenr, $rawline);
3891 my $fixed_line = $rawline;
3892 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*){(.*)$/;
3893 my $line1 = $1;
3894 my $line2 = $2;
3895 fix_insert_line($fixlinenr, ltrim($line1));
3896 fix_insert_line($fixlinenr, "\+{");
3897 if ($line2 !~ /^\s*$/) {
3898 fix_insert_line($fixlinenr, "\+\t" . trim($line2));
3899 }
3900 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003901 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003902
Andy Whitcroft8905a672007-11-28 16:21:06 -08003903# open braces for enum, union and struct go on the same line.
3904 if ($line =~ /^.\s*{/ &&
3905 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches8d182472014-08-06 16:11:12 -07003906 if (ERROR("OPEN_BRACE",
3907 "open brace '{' following $1 go on the same line\n" . $hereprev) &&
3908 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
3909 fix_delete_line($fixlinenr - 1, $prevrawline);
3910 fix_delete_line($fixlinenr, $rawline);
3911 my $fixedline = rtrim($prevrawline) . " {";
3912 fix_insert_line($fixlinenr, $fixedline);
3913 $fixedline = $rawline;
3914 $fixedline =~ s/^(.\s*){\s*/$1\t/;
3915 if ($fixedline !~ /^\+\s*$/) {
3916 fix_insert_line($fixlinenr, $fixedline);
3917 }
3918 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003919 }
3920
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003921# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07003922 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
3923 if (WARN("SPACING",
3924 "missing space after $1 definition\n" . $herecurr) &&
3925 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003926 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07003927 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
3928 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07003929 }
3930
Joe Perches31070b52014-01-23 15:54:49 -08003931# Function pointer declarations
3932# check spacing between type, funcptr, and args
3933# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003934 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08003935 my $declare = $1;
3936 my $pre_pointer_space = $2;
3937 my $post_pointer_space = $3;
3938 my $funcname = $4;
3939 my $post_funcname_space = $5;
3940 my $pre_args_space = $6;
3941
Joe Perches91f72e92014-04-03 14:49:12 -07003942# the $Declare variable will capture all spaces after the type
3943# so check it for a missing trailing missing space but pointer return types
3944# don't need a space so don't warn for those.
3945 my $post_declare_space = "";
3946 if ($declare =~ /(\s+)$/) {
3947 $post_declare_space = $1;
3948 $declare = rtrim($declare);
3949 }
3950 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08003951 WARN("SPACING",
3952 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07003953 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08003954 }
3955
3956# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07003957# This test is not currently implemented because these declarations are
3958# equivalent to
3959# int foo(int bar, ...)
3960# and this is form shouldn't/doesn't generate a checkpatch warning.
3961#
3962# elsif ($declare =~ /\s{2,}$/) {
3963# WARN("SPACING",
3964# "Multiple spaces after return type\n" . $herecurr);
3965# }
Joe Perches31070b52014-01-23 15:54:49 -08003966
3967# unnecessary space "type ( *funcptr)(args...)"
3968 if (defined $pre_pointer_space &&
3969 $pre_pointer_space =~ /^\s/) {
3970 WARN("SPACING",
3971 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
3972 }
3973
3974# unnecessary space "type (* funcptr)(args...)"
3975 if (defined $post_pointer_space &&
3976 $post_pointer_space =~ /^\s/) {
3977 WARN("SPACING",
3978 "Unnecessary space before function pointer name\n" . $herecurr);
3979 }
3980
3981# unnecessary space "type (*funcptr )(args...)"
3982 if (defined $post_funcname_space &&
3983 $post_funcname_space =~ /^\s/) {
3984 WARN("SPACING",
3985 "Unnecessary space after function pointer name\n" . $herecurr);
3986 }
3987
3988# unnecessary space "type (*funcptr) (args...)"
3989 if (defined $pre_args_space &&
3990 $pre_args_space =~ /^\s/) {
3991 WARN("SPACING",
3992 "Unnecessary space before function pointer arguments\n" . $herecurr);
3993 }
3994
3995 if (show_type("SPACING") && $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07003996 $fixed[$fixlinenr] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003997 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003998 }
3999 }
4000
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004001# check for spacing round square brackets; allowed:
4002# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004003# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4004# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004005 while ($line =~ /(.*?\s)\[/g) {
4006 my ($where, $prefix) = ($-[1], $1);
4007 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07004008 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07004009 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004010 if (ERROR("BRACKET_SPACE",
4011 "space prohibited before open square bracket '['\n" . $herecurr) &&
4012 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004013 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004014 s/^(\+.*?)\s+\[/$1\[/;
4015 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07004016 }
4017 }
4018
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004019# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004020 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004021 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07004022 my $ctx_before = substr($line, 0, $-[1]);
4023 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004024
4025 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004026 if ($name =~ /^(?:
4027 if|for|while|switch|return|case|
4028 volatile|__volatile__|
4029 __attribute__|format|__extension__|
4030 asm|__asm__)$/x)
4031 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004032 # cpp #define statements have non-optional spaces, ie
4033 # if there is a space between the name and the open
4034 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004035 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004036
4037 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004038 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004039
4040 # If this whole things ends with a type its most
4041 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004042 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004043
4044 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07004045 if (WARN("SPACING",
4046 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
4047 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004048 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004049 s/\b$name\s+\(/$name\(/;
4050 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004051 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004052 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07004053
Andy Whitcroft653d4872007-06-23 17:16:34 -07004054# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004055 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004056 my $fixed_line = "";
4057 my $line_fixed = 0;
4058
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004059 my $ops = qr{
4060 <<=|>>=|<=|>=|==|!=|
4061 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
4062 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004063 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08004064 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004065 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08004066 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07004067
4068## print("element count: <" . $#elements . ">\n");
4069## foreach my $el (@elements) {
4070## print("el: <$el>\n");
4071## }
4072
4073 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07004074 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004075
Joe Perches3705ce52013-07-03 15:05:31 -07004076 foreach my $el (@elements) {
4077 push(@fix_elements, substr($rawline, $off, length($el)));
4078 $off += length($el);
4079 }
4080
4081 $off = 0;
4082
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004083 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07004084 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004085
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004086 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07004087
4088 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
4089
4090## print("n: <$n> good: <$good>\n");
4091
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004092 $off += length($elements[$n]);
4093
Lucas De Marchi25985ed2011-03-30 22:57:33 -03004094 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004095 my $ca = substr($opline, 0, $off);
4096 my $cc = '';
4097 if (length($opline) >= ($off + length($elements[$n + 1]))) {
4098 $cc = substr($opline, $off + length($elements[$n + 1]));
4099 }
4100 my $cb = "$ca$;$cc";
4101
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004102 my $a = '';
4103 $a = 'V' if ($elements[$n] ne '');
4104 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004105 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004106 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
4107 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07004108 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004109
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004110 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004111
4112 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004113 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004114 $c = 'V' if ($elements[$n + 2] ne '');
4115 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08004116 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004117 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
4118 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08004119 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004120 } else {
4121 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004122 }
4123
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004124 my $ctx = "${a}x${c}";
4125
4126 my $at = "(ctx:$ctx)";
4127
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004128 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004129 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004130
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004131 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07004132 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004133
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004134 # Get the full operator variant.
4135 my $opv = $op . substr($curr_vars, $off, 1);
4136
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004137 # Ignore operators passed as parameters.
4138 if ($op_type ne 'V' &&
Sam Bobroffd7fe8062015-04-16 12:44:39 -07004139 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004140
Andy Whitcroftcf655042008-03-04 14:28:20 -08004141# # Ignore comments
4142# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004143
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004144 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004145 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004146 if ($ctx !~ /.x[WEBC]/ &&
4147 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004148 if (ERROR("SPACING",
4149 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004150 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004151 $line_fixed = 1;
4152 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004153 }
4154
4155 # // is a comment
4156 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004157
Joe Perchesb00e4812014-04-03 14:49:33 -07004158 # : when part of a bitfield
4159 } elsif ($opv eq ':B') {
4160 # skip the bitfield test for now
4161
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004162 # No spaces for:
4163 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07004164 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004165 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004166 if (ERROR("SPACING",
4167 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004168 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004169 if (defined $fix_elements[$n + 2]) {
4170 $fix_elements[$n + 2] =~ s/^\s+//;
4171 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004172 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004173 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004174 }
4175
Joe Perches23810972014-12-10 15:51:32 -08004176 # , must not have a space before and must have a space on the right.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004177 } elsif ($op eq ',') {
Joe Perches23810972014-12-10 15:51:32 -08004178 my $rtrim_before = 0;
4179 my $space_after = 0;
4180 if ($ctx =~ /Wx./) {
4181 if (ERROR("SPACING",
4182 "space prohibited before that '$op' $at\n" . $hereptr)) {
4183 $line_fixed = 1;
4184 $rtrim_before = 1;
4185 }
4186 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08004187 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004188 if (ERROR("SPACING",
4189 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004190 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07004191 $last_after = $n;
Joe Perches23810972014-12-10 15:51:32 -08004192 $space_after = 1;
4193 }
4194 }
4195 if ($rtrim_before || $space_after) {
4196 if ($rtrim_before) {
4197 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
4198 } else {
4199 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
4200 }
4201 if ($space_after) {
4202 $good .= " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004203 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004204 }
4205
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004206 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004207 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004208 #warn "'*' is part of type\n";
4209
4210 # unary operators should have a space before and
4211 # none after. May be left adjacent to another
4212 # unary operator, or a cast
4213 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07004214 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07004215 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08004216 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004217 if (ERROR("SPACING",
4218 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004219 if ($n != $last_after + 2) {
4220 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
4221 $line_fixed = 1;
4222 }
Joe Perches3705ce52013-07-03 15:05:31 -07004223 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004224 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08004225 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004226 # A unary '*' may be const
4227
4228 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004229 if (ERROR("SPACING",
4230 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004231 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004232 if (defined $fix_elements[$n + 2]) {
4233 $fix_elements[$n + 2] =~ s/^\s+//;
4234 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004235 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004236 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004237 }
4238
4239 # unary ++ and unary -- are allowed no space on one side.
4240 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07004241 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004242 if (ERROR("SPACING",
4243 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004244 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07004245 $line_fixed = 1;
4246 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004247 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004248 if ($ctx =~ /Wx[BE]/ ||
4249 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004250 if (ERROR("SPACING",
4251 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004252 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004253 $line_fixed = 1;
4254 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004255 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004256 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004257 if (ERROR("SPACING",
4258 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004259 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004260 if (defined $fix_elements[$n + 2]) {
4261 $fix_elements[$n + 2] =~ s/^\s+//;
4262 }
Joe Perchesb34c6482013-09-11 14:24:01 -07004263 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07004264 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004265 }
4266
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004267 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004268 } elsif ($op eq '<<' or $op eq '>>' or
4269 $op eq '&' or $op eq '^' or $op eq '|' or
4270 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004271 $op eq '*' or $op eq '/' or
4272 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004273 {
Joe Perchesd2e025f2015-02-13 14:38:57 -08004274 if ($check) {
4275 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) {
4276 if (CHK("SPACING",
4277 "spaces preferred around that '$op' $at\n" . $hereptr)) {
4278 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4279 $fix_elements[$n + 2] =~ s/^\s+//;
4280 $line_fixed = 1;
4281 }
4282 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) {
4283 if (CHK("SPACING",
4284 "space preferred before that '$op' $at\n" . $hereptr)) {
4285 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
4286 $line_fixed = 1;
4287 }
4288 }
4289 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004290 if (ERROR("SPACING",
4291 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004292 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4293 if (defined $fix_elements[$n + 2]) {
4294 $fix_elements[$n + 2] =~ s/^\s+//;
4295 }
Joe Perches3705ce52013-07-03 15:05:31 -07004296 $line_fixed = 1;
4297 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004298 }
4299
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004300 # A colon needs no spaces before when it is
4301 # terminating a case value or a label.
4302 } elsif ($opv eq ':C' || $opv eq ':L') {
4303 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07004304 if (ERROR("SPACING",
4305 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004306 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004307 $line_fixed = 1;
4308 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004309 }
4310
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004311 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08004312 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004313 my $ok = 0;
4314
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004315 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004316 if (($op eq '<' &&
4317 $cc =~ /^\S+\@\S+>/) ||
4318 ($op eq '>' &&
4319 $ca =~ /<\S+\@\S+$/))
4320 {
4321 $ok = 1;
4322 }
4323
Joe Perchese0df7e12015-04-16 12:44:53 -07004324 # for asm volatile statements
4325 # ignore a colon with another
4326 # colon immediately before or after
4327 if (($op eq ':') &&
4328 ($ca =~ /:$/ || $cc =~ /^:/)) {
4329 $ok = 1;
4330 }
4331
Joe Perches84731622013-11-12 15:10:05 -08004332 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07004333 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08004334 my $msg_type = \&ERROR;
4335 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
4336
4337 if (&{$msg_type}("SPACING",
4338 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07004339 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
4340 if (defined $fix_elements[$n + 2]) {
4341 $fix_elements[$n + 2] =~ s/^\s+//;
4342 }
Joe Perches3705ce52013-07-03 15:05:31 -07004343 $line_fixed = 1;
4344 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004345 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004346 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004347 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07004348
4349## print("n: <$n> GOOD: <$good>\n");
4350
4351 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004352 }
Joe Perches3705ce52013-07-03 15:05:31 -07004353
4354 if (($#elements % 2) == 0) {
4355 $fixed_line = $fixed_line . $fix_elements[$#elements];
4356 }
4357
Joe Perches194f66f2014-08-06 16:11:03 -07004358 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) {
4359 $fixed[$fixlinenr] = $fixed_line;
Joe Perches3705ce52013-07-03 15:05:31 -07004360 }
4361
4362
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004363 }
4364
Joe Perches786b6322013-07-03 15:05:32 -07004365# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08004366 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07004367 if (WARN("SPACING",
4368 "space prohibited before semicolon\n" . $herecurr) &&
4369 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004370 1 while $fixed[$fixlinenr] =~
Joe Perches786b6322013-07-03 15:05:32 -07004371 s/^(\+.*\S)\s+;/$1;/;
4372 }
4373 }
4374
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004375# check for multiple assignments
4376 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004377 CHK("MULTIPLE_ASSIGNMENTS",
4378 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004379 }
4380
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004381## # check for multiple declarations, allowing for a function declaration
4382## # continuation.
4383## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4384## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4385##
4386## # Remove any bracketed sections to ensure we do not
4387## # falsly report the parameters of functions.
4388## my $ln = $line;
4389## while ($ln =~ s/\([^\(\)]*\)//g) {
4390## }
4391## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004392## WARN("MULTIPLE_DECLARATION",
4393## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004394## }
4395## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004396
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004397#need space before brace following if, while, etc
Geyslan G. Bem6b8c69e2016-03-15 14:58:09 -07004398 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004399 $line =~ /do\{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004400 if (ERROR("SPACING",
4401 "space required before the open brace '{'\n" . $herecurr) &&
4402 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004403 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07004404 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004405 }
4406
Joe Perchesc4a62ef2013-07-03 15:05:28 -07004407## # check for blank lines before declarations
4408## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4409## $prevrawline =~ /^.\s*$/) {
4410## WARN("SPACING",
4411## "No blank lines before declarations\n" . $hereprev);
4412## }
4413##
4414
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004415# closing brace should have a space following it when it has anything
4416# on the line
4417 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004418 if (ERROR("SPACING",
4419 "space required after that close brace '}'\n" . $herecurr) &&
4420 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004421 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004422 s/}((?!(?:,|;|\)))\S)/} $1/;
4423 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004424 }
4425
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004426# check spacing on square brackets
4427 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004428 if (ERROR("SPACING",
4429 "space prohibited after that open square bracket '['\n" . $herecurr) &&
4430 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004431 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004432 s/\[\s+/\[/;
4433 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004434 }
4435 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004436 if (ERROR("SPACING",
4437 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
4438 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004439 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004440 s/\s+\]/\]/;
4441 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004442 }
4443
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004444# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004445 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
Matt Wagantall54afcc62010-06-03 12:28:18 -07004446 $line !~ /for\s*\(\s+;/ && $line !~ /^\+\s*[A-Z_][A-Z\d_]*\(\s*\d+(\,.*)?\)\,?$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004447 if (ERROR("SPACING",
4448 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
4449 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004450 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004451 s/\(\s+/\(/;
4452 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004453 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004454 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004455 $line !~ /for\s*\(.*;\s+\)/ &&
4456 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004457 if (ERROR("SPACING",
4458 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
4459 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004460 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004461 s/\s+\)/\)/;
4462 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004463 }
4464
Joe Perchese2826fd2014-08-06 16:10:48 -07004465# check unnecessary parentheses around addressof/dereference single $Lvals
4466# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4467
4468 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) {
Joe Perchesea4acbb2014-12-10 15:51:51 -08004469 my $var = $1;
4470 if (CHK("UNNECESSARY_PARENTHESES",
4471 "Unnecessary parentheses around $var\n" . $herecurr) &&
4472 $fix) {
4473 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/;
4474 }
4475 }
4476
4477# check for unnecessary parentheses around function pointer uses
4478# ie: (foo->bar)(); should be foo->bar();
4479# but not "if (foo->bar) (" to avoid some false positives
4480 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) {
4481 my $var = $2;
4482 if (CHK("UNNECESSARY_PARENTHESES",
4483 "Unnecessary parentheses around function pointer $var\n" . $herecurr) &&
4484 $fix) {
4485 my $var2 = deparenthesize($var);
4486 $var2 =~ s/\s//g;
4487 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/;
4488 }
4489 }
Joe Perchese2826fd2014-08-06 16:10:48 -07004490
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004491#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004492 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004493 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07004494 if (WARN("INDENTED_LABEL",
4495 "labels should not be indented\n" . $herecurr) &&
4496 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004497 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004498 s/^(.)\s+/$1/;
4499 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004500 }
4501
Joe Perches5b9553a2014-04-03 14:49:21 -07004502# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08004503 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004504 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08004505 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07004506 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
4507 my $value = $1;
4508 $value = deparenthesize($value);
4509 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
4510 ERROR("RETURN_PARENTHESES",
4511 "return is not a function, parentheses are not required\n" . $herecurr);
4512 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004513 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004514 ERROR("SPACING",
4515 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004516 }
4517 }
Joe Perches507e5142013-11-12 15:10:13 -08004518
Joe Perchesb43ae212014-06-23 13:22:07 -07004519# unnecessary return in a void function
4520# at end-of-function, with the previous line a single leading tab, then return;
4521# and the line before that not a goto label target like "out:"
4522 if ($sline =~ /^[ \+]}\s*$/ &&
4523 $prevline =~ /^\+\treturn\s*;\s*$/ &&
4524 $linenr >= 3 &&
4525 $lines[$linenr - 3] =~ /^[ +]/ &&
4526 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) {
Joe Perches9819cf22014-06-04 16:12:09 -07004527 WARN("RETURN_VOID",
Joe Perchesb43ae212014-06-23 13:22:07 -07004528 "void function return statements are not generally useful\n" . $hereprev);
4529 }
Joe Perches9819cf22014-06-04 16:12:09 -07004530
Joe Perches189248d2014-01-23 15:54:47 -08004531# if statements using unnecessary parentheses - ie: if ((foo == bar))
4532 if ($^V && $^V ge 5.10.0 &&
4533 $line =~ /\bif\s*((?:\(\s*){2,})/) {
4534 my $openparens = $1;
4535 my $count = $openparens =~ tr@\(@\(@;
4536 my $msg = "";
4537 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4538 my $comp = $4; #Not $1 because of $LvalOrFunc
4539 $msg = " - maybe == should be = ?" if ($comp eq "==");
4540 WARN("UNNECESSARY_PARENTHESES",
4541 "Unnecessary parentheses$msg\n" . $herecurr);
4542 }
4543 }
4544
Joe Perchesc5595fa2015-09-09 15:37:58 -07004545# comparisons with a constant or upper case identifier on the left
4546# avoid cases like "foo + BAR < baz"
4547# only fix matches surrounded by parentheses to avoid incorrect
4548# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4549 if ($^V && $^V ge 5.10.0 &&
4550 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) {
4551 my $lead = $1;
4552 my $const = $2;
4553 my $comp = $3;
4554 my $to = $4;
4555 my $newcomp = $comp;
Joe Perchesf39e1762016-05-20 17:04:02 -07004556 if ($lead !~ /(?:$Operators|\.)\s*$/ &&
Joe Perchesc5595fa2015-09-09 15:37:58 -07004557 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ &&
4558 WARN("CONSTANT_COMPARISON",
4559 "Comparisons should place the constant on the right side of the test\n" . $herecurr) &&
4560 $fix) {
4561 if ($comp eq "<") {
4562 $newcomp = ">";
4563 } elsif ($comp eq "<=") {
4564 $newcomp = ">=";
4565 } elsif ($comp eq ">") {
4566 $newcomp = "<";
4567 } elsif ($comp eq ">=") {
4568 $newcomp = "<=";
4569 }
4570 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/;
4571 }
4572 }
4573
Joe Perchesf34e4a42015-04-16 12:44:19 -07004574# Return of what appears to be an errno should normally be negative
4575 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) {
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004576 my $name = $1;
4577 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07004578 WARN("USE_NEGATIVE_ERRNO",
Joe Perchesf34e4a42015-04-16 12:44:19 -07004579 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07004580 }
4581 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004582
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004583# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07004584 if ($line =~ /\b(if|while|for|switch)\(/) {
4585 if (ERROR("SPACING",
4586 "space required before the open parenthesis '('\n" . $herecurr) &&
4587 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004588 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07004589 s/\b(if|while|for|switch)\(/$1 \(/;
4590 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004591 }
4592
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07004593# Check for illegal assignment in if conditional -- and check for trailing
4594# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004595 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08004596 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
4597 ctx_statement_block($linenr, $realcnt, 0)
4598 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004599 my ($stat_next) = ctx_statement_block($line_nr_next,
4600 $remain_next, $off_next);
4601 $stat_next =~ s/\n./\n /g;
4602 ##print "stat<$stat> stat_next<$stat_next>\n";
4603
4604 if ($stat_next =~ /^\s*while\b/) {
4605 # If the statement carries leading newlines,
4606 # then count those as offsets.
4607 my ($whitespace) =
4608 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
4609 my $offset =
4610 statement_rawlines($whitespace) - 1;
4611
4612 $suppress_whiletrailers{$line_nr_next +
4613 $offset} = 1;
4614 }
4615 }
4616 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08004617 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07004618 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004619 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004620
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08004621 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004622 ERROR("ASSIGN_IN_IF",
4623 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004624 }
4625
4626 # Find out what is on the end of the line after the
4627 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004628 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08004629 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004630 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07004631 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
4632 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004633 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004634 # Find out how long the conditional actually is.
4635 my @newlines = ($c =~ /\n/gs);
4636 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004637 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004638
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08004639 $stat_real = raw_line($linenr, $cond_lines)
4640 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07004641 if (defined($stat_real) && $cond_lines > 1) {
4642 $stat_real = "[...]\n$stat_real";
4643 }
4644
Joe Perches000d1cc12011-07-25 17:13:25 -07004645 ERROR("TRAILING_STATEMENTS",
4646 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004647 }
4648 }
4649
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004650# Check for bitwise tests written as boolean
4651 if ($line =~ /
4652 (?:
4653 (?:\[|\(|\&\&|\|\|)
4654 \s*0[xX][0-9]+\s*
4655 (?:\&\&|\|\|)
4656 |
4657 (?:\&\&|\|\|)
4658 \s*0[xX][0-9]+\s*
4659 (?:\&\&|\|\||\)|\])
4660 )/x)
4661 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004662 WARN("HEXADECIMAL_BOOLEAN_TEST",
4663 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004664 }
4665
Andy Whitcroft8905a672007-11-28 16:21:06 -08004666# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004667 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
4668 my $s = $1;
4669 $s =~ s/$;//g; # Remove any comments
4670 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004671 ERROR("TRAILING_STATEMENTS",
4672 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004673 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004674 }
Andy Whitcroft39667782009-01-15 13:51:06 -08004675# if should not continue a brace
4676 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004677 ERROR("TRAILING_STATEMENTS",
Rasmus Villemoes048b1232014-08-06 16:10:37 -07004678 "trailing statements should be on next line (or did you mean 'else if'?)\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08004679 $herecurr);
4680 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004681# case and default should not have general statements after them
4682 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
4683 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07004684 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004685 \s*return\s+
4686 )/xg)
4687 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004688 ERROR("TRAILING_STATEMENTS",
4689 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07004690 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004691
4692 # Check for }<nl>else {, these must be at the same
4693 # indent level to be relevant to each other.
Joe Perches8b8856f2014-08-06 16:11:14 -07004694 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ &&
4695 $previndent == $indent) {
4696 if (ERROR("ELSE_AFTER_BRACE",
4697 "else should follow close brace '}'\n" . $hereprev) &&
4698 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4699 fix_delete_line($fixlinenr - 1, $prevrawline);
4700 fix_delete_line($fixlinenr, $rawline);
4701 my $fixedline = $prevrawline;
4702 $fixedline =~ s/}\s*$//;
4703 if ($fixedline !~ /^\+\s*$/) {
4704 fix_insert_line($fixlinenr, $fixedline);
4705 }
4706 $fixedline = $rawline;
4707 $fixedline =~ s/^(.\s*)else/$1} else/;
4708 fix_insert_line($fixlinenr, $fixedline);
4709 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004710 }
4711
Joe Perches8b8856f2014-08-06 16:11:14 -07004712 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ &&
4713 $previndent == $indent) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004714 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
4715
4716 # Find out what is on the end of the line after the
4717 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07004718 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004719 $s =~ s/\n.*//g;
4720
4721 if ($s =~ /^\s*;/) {
Joe Perches8b8856f2014-08-06 16:11:14 -07004722 if (ERROR("WHILE_AFTER_BRACE",
4723 "while should follow close brace '}'\n" . $hereprev) &&
4724 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) {
4725 fix_delete_line($fixlinenr - 1, $prevrawline);
4726 fix_delete_line($fixlinenr, $rawline);
4727 my $fixedline = $prevrawline;
4728 my $trailing = $rawline;
4729 $trailing =~ s/^\+//;
4730 $trailing = trim($trailing);
4731 $fixedline =~ s/}\s*$/} $trailing/;
4732 fix_insert_line($fixlinenr, $fixedline);
4733 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004734 }
4735 }
4736
Joe Perches95e2c602013-07-03 15:05:20 -07004737#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08004738 while ($line =~ m{($Constant|$Lval)}g) {
4739 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07004740
4741#gcc binary extension
4742 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004743 if (WARN("GCC_BINARY_CONSTANT",
4744 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
4745 $fix) {
4746 my $hexval = sprintf("0x%x", oct($var));
Joe Perches194f66f2014-08-06 16:11:03 -07004747 $fixed[$fixlinenr] =~
Joe Perchesd5e616f2013-09-11 14:23:54 -07004748 s/\b$var\b/$hexval/;
4749 }
Joe Perches95e2c602013-07-03 15:05:20 -07004750 }
4751
4752#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07004753 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07004754 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004755#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07004756 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07004757#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Julius Wernerf5123572014-12-10 15:51:54 -08004758 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/ &&
4759#Ignore some three character SI units explicitly, like MiB and KHz
4760 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07004761 while ($var =~ m{($Ident)}g) {
4762 my $word = $1;
4763 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08004764 if ($check) {
4765 seed_camelcase_includes();
4766 if (!$file && !$camelcase_file_seeded) {
4767 seed_camelcase_file($realfile);
4768 $camelcase_file_seeded = 1;
4769 }
4770 }
Joe Perches7e781f62013-09-11 14:23:55 -07004771 if (!defined $camelcase{$word}) {
4772 $camelcase{$word} = 1;
4773 CHK("CAMELCASE",
4774 "Avoid CamelCase: <$word>\n" . $herecurr);
4775 }
Joe Perches34456862013-07-03 15:05:34 -07004776 }
Joe Perches323c1262012-12-17 16:02:07 -08004777 }
4778 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004779
4780#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07004781 if ($line =~ /\#\s*define.*\\\s+$/) {
4782 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
4783 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
4784 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07004785 $fixed[$fixlinenr] =~ s/\s+$//;
Joe Perchesd5e616f2013-09-11 14:23:54 -07004786 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004787 }
4788
Fabian Frederick0e212e02015-04-16 12:44:25 -07004789# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4790# itself <asm/foo.h> (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004791 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004792 my $file = "$1.h";
4793 my $checkfile = "include/linux/$file";
4794 if (-f "$root/$checkfile" &&
4795 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07004796 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004797 {
Fabian Frederick0e212e02015-04-16 12:44:25 -07004798 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`;
4799 if ($asminclude > 0) {
4800 if ($realfile =~ m{^arch/}) {
4801 CHK("ARCH_INCLUDE_LINUX",
4802 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4803 } else {
4804 WARN("INCLUDE_LINUX",
4805 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
4806 }
Andy Whitcrofte09dec42008-10-15 22:02:20 -07004807 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004808 }
4809 }
4810
Andy Whitcroft653d4872007-06-23 17:16:34 -07004811# multi-statement macros should be enclosed in a do while loop, grab the
4812# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08004813# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07004814 if ($realfile !~ m@/vmlinux.lds.h$@ &&
4815 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004816 my $ln = $linenr;
Gregory Bean02870be2011-05-11 09:11:12 -07004817 my $cnt = $realcnt - 1;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004818 my ($off, $dstat, $dcond, $rest);
4819 my $ctx = '';
Joe Perches08a28432014-10-13 15:51:55 -07004820 my $has_flow_statement = 0;
4821 my $has_arg_concat = 0;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004822 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004823 ctx_statement_block($linenr, $realcnt, 0);
4824 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004825 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07004826 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004827
Joe Perches08a28432014-10-13 15:51:55 -07004828 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/);
Joe Perches62e15a62016-01-20 14:59:18 -08004829 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/);
Joe Perches08a28432014-10-13 15:51:55 -07004830
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004831 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07004832 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004833 $dstat =~ s/\\\n.//g;
4834 $dstat =~ s/^\s*//s;
4835 $dstat =~ s/\s*$//s;
4836
4837 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004838 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
4839 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004840 $dstat =~ s/.\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07004841 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004842 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004843
Gregory Bean02870be2011-05-11 09:11:12 -07004844 # Extremely long macros may fall off the end of the
4845 # available context without closing. Give a dangling
4846 # backslash the benefit of the doubt and allow it
4847 # to gobble any hanging open-parens.
4848 $dstat =~ s/\(.+\\$/1/;
4849
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004850 # Flatten any obvious string concatentation.
Joe Perches33acb542015-06-25 15:02:54 -07004851 while ($dstat =~ s/($String)\s*$Ident/$1/ ||
4852 $dstat =~ s/$Ident\s*($String)/$1/)
Andy Whitcrofte45bab82012-03-23 15:02:18 -07004853 {
4854 }
4855
Joe Perches42e15292016-03-15 14:58:01 -07004856 # Make asm volatile uses seem like a generic function
4857 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g;
4858
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004859 my $exceptions = qr{
4860 $Declare|
4861 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07004862 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004863 DECLARE_PER_CPU|
4864 DEFINE_PER_CPU|
Matt Wagantall54afcc62010-06-03 12:28:18 -07004865 CLK_[A-Z\d_]+|
Andy Whitcroft383099f2009-01-06 14:41:18 -08004866 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08004867 union|
4868 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07004869 \.$Ident\s*=\s*|
Vladimir Zapolskiy6b10df42016-01-20 14:59:21 -08004870 ^\"|\"$|
4871 ^\[
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004872 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07004873 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004874 if ($dstat ne '' &&
4875 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
4876 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07004877 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Joe Perches356fd392014-08-06 16:10:31 -07004878 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004879 $dstat !~ /$exceptions/ &&
4880 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07004881 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08004882 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004883 $dstat !~ /^for\s*$Constant$/ && # for (...)
4884 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
4885 $dstat !~ /^do\s*{/ && # do {...
Eddie Kovsky4e5d56b2015-09-09 15:37:52 -07004886 $dstat !~ /^\(\{/ && # ({...
Joe Perchesf95a7e62013-09-11 14:24:00 -07004887 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004888 {
4889 $ctx =~ s/\n*$//;
4890 my $herectx = $here . "\n";
4891 my $cnt = statement_rawlines($ctx);
4892
4893 for (my $n = 0; $n < $cnt; $n++) {
4894 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004895 }
4896
Andy Whitcroftf74bd192012-01-10 15:09:54 -08004897 if ($dstat =~ /;/) {
4898 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
4899 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
4900 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07004901 ERROR("COMPLEX_MACRO",
Andrew Morton388982b2014-10-13 15:51:40 -07004902 "Macros with complex values should be enclosed in parentheses\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07004903 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004904 }
Joe Perches5023d342012-12-17 16:01:47 -08004905
Joe Perches08a28432014-10-13 15:51:55 -07004906# check for macros with flow control, but without ## concatenation
4907# ## concatenation is commonly a macro that defines a function so ignore those
4908 if ($has_flow_statement && !$has_arg_concat) {
4909 my $herectx = $here . "\n";
4910 my $cnt = statement_rawlines($ctx);
4911
4912 for (my $n = 0; $n < $cnt; $n++) {
4913 $herectx .= raw_line($linenr, $n) . "\n";
4914 }
4915 WARN("MACRO_WITH_FLOW_CONTROL",
4916 "Macros with flow control statements should be avoided\n" . "$herectx");
4917 }
4918
Joe Perches481eb482012-12-17 16:01:56 -08004919# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08004920
4921 } else {
4922 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08004923 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
4924 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08004925 $line =~ /^\+.*\\$/) {
4926 WARN("LINE_CONTINUATIONS",
4927 "Avoid unnecessary line continuations\n" . $herecurr);
4928 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004929 }
4930
Joe Perchesb13edf72012-07-30 14:41:24 -07004931# do {} while (0) macro tests:
4932# single-statement macros do not need to be enclosed in do while (0) loop,
4933# macro should not end with a semicolon
4934 if ($^V && $^V ge 5.10.0 &&
4935 $realfile !~ m@/vmlinux.lds.h$@ &&
4936 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
4937 my $ln = $linenr;
4938 my $cnt = $realcnt;
4939 my ($off, $dstat, $dcond, $rest);
4940 my $ctx = '';
4941 ($dstat, $dcond, $ln, $cnt, $off) =
4942 ctx_statement_block($linenr, $realcnt, 0);
4943 $ctx = $dstat;
4944
4945 $dstat =~ s/\\\n.//g;
Joe Perches1b36b202015-02-13 14:38:32 -08004946 $dstat =~ s/$;/ /g;
Joe Perchesb13edf72012-07-30 14:41:24 -07004947
4948 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4949 my $stmts = $2;
4950 my $semis = $3;
4951
4952 $ctx =~ s/\n*$//;
4953 my $cnt = statement_rawlines($ctx);
4954 my $herectx = $here . "\n";
4955
4956 for (my $n = 0; $n < $cnt; $n++) {
4957 $herectx .= raw_line($linenr, $n) . "\n";
4958 }
4959
Joe Perchesac8e97f2012-08-21 16:15:53 -07004960 if (($stmts =~ tr/;/;/) == 1 &&
4961 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07004962 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
4963 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
4964 }
4965 if (defined $semis && $semis ne "") {
4966 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
4967 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
4968 }
Joe Perchesf5ef95b2014-06-04 16:12:06 -07004969 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) {
4970 $ctx =~ s/\n*$//;
4971 my $cnt = statement_rawlines($ctx);
4972 my $herectx = $here . "\n";
4973
4974 for (my $n = 0; $n < $cnt; $n++) {
4975 $herectx .= raw_line($linenr, $n) . "\n";
4976 }
4977
4978 WARN("TRAILING_SEMICOLON",
4979 "macros should not use a trailing semicolon\n" . "$herectx");
Joe Perchesb13edf72012-07-30 14:41:24 -07004980 }
4981 }
4982
Mike Frysinger080ba922009-01-06 14:41:25 -08004983# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4984# all assignments may have only one of the following with an assignment:
4985# .
4986# ALIGN(...)
4987# VMLINUX_SYMBOL(...)
4988 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004989 WARN("MISSING_VMLINUX_SYMBOL",
4990 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08004991 }
4992
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004993# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004994 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
4995 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08004996 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004997 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08004998 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4999 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07005000 my @allowed = ();
5001 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005002 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005003 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005004 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005005 for my $chunk (@chunks) {
5006 my ($cond, $block) = @{$chunk};
5007
Andy Whitcroft773647a2008-03-28 14:15:58 -07005008 # If the condition carries leading newlines, then count those as offsets.
5009 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
5010 my $offset = statement_rawlines($whitespace) - 1;
5011
Joe Perchesaad4f612012-03-23 15:02:19 -07005012 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07005013 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5014
5015 # We have looked at and allowed this specific line.
5016 $suppress_ifbraces{$ln + $offset} = 1;
5017
5018 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005019 $ln += statement_rawlines($block) - 1;
5020
Andy Whitcroft773647a2008-03-28 14:15:58 -07005021 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005022
5023 $seen++ if ($block =~ /^\s*{/);
5024
Joe Perchesaad4f612012-03-23 15:02:19 -07005025 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005026 if (statement_lines($cond) > 1) {
5027 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005028 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005029 }
5030 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005031 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005032 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005033 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005034 if (statement_block_size($block) > 1) {
5035 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07005036 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005037 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005038 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005039 }
Joe Perchesaad4f612012-03-23 15:02:19 -07005040 if ($seen) {
5041 my $sum_allowed = 0;
5042 foreach (@allowed) {
5043 $sum_allowed += $_;
5044 }
5045 if ($sum_allowed == 0) {
5046 WARN("BRACES",
5047 "braces {} are not necessary for any arm of this statement\n" . $herectx);
5048 } elsif ($sum_allowed != $allow &&
5049 $seen != $allow) {
5050 CHK("BRACES",
5051 "braces {} should be used on all arms of this statement\n" . $herectx);
5052 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005053 }
5054 }
5055 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005056 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005057 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08005058 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005059
Andy Whitcroftcf655042008-03-04 14:28:20 -08005060 # Check the pre-context.
5061 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
5062 #print "APW: ALLOWED: pre<$1>\n";
5063 $allowed = 1;
5064 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07005065
5066 my ($level, $endln, @chunks) =
5067 ctx_statement_full($linenr, $realcnt, $-[0]);
5068
Andy Whitcroftcf655042008-03-04 14:28:20 -08005069 # Check the condition.
5070 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07005071 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005072 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005073 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08005074 }
5075 if (statement_lines($cond) > 1) {
5076 #print "APW: ALLOWED: cond<$cond>\n";
5077 $allowed = 1;
5078 }
5079 if ($block =~/\b(?:if|for|while)\b/) {
5080 #print "APW: ALLOWED: block<$block>\n";
5081 $allowed = 1;
5082 }
5083 if (statement_block_size($block) > 1) {
5084 #print "APW: ALLOWED: lines block<$block>\n";
5085 $allowed = 1;
5086 }
5087 # Check the post-context.
5088 if (defined $chunks[1]) {
5089 my ($cond, $block) = @{$chunks[1]};
5090 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07005091 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005092 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08005093 if ($block =~ /^\s*\{/) {
5094 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5095 $allowed = 1;
5096 }
5097 }
5098 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005099 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07005100 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08005101
Andy Whitcroftf0556632008-10-15 22:02:23 -07005102 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07005103 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08005104 }
5105
Joe Perches000d1cc12011-07-25 17:13:25 -07005106 WARN("BRACES",
5107 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005108 }
5109 }
5110
Joe Perches0979ae62012-12-17 16:01:59 -08005111# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07005112 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005113 if (CHK("BRACES",
5114 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) &&
5115 $fix && $prevrawline =~ /^\+/) {
5116 fix_delete_line($fixlinenr - 1, $prevrawline);
5117 }
Joe Perches0979ae62012-12-17 16:01:59 -08005118 }
Joe Perches77b9a532013-07-03 15:05:29 -07005119 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perchesf8e58212015-02-13 14:38:46 -08005120 if (CHK("BRACES",
5121 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) &&
5122 $fix) {
5123 fix_delete_line($fixlinenr, $rawline);
5124 }
Joe Perches0979ae62012-12-17 16:01:59 -08005125 }
5126
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005127# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07005128 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
5129 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005130 WARN("VOLATILE",
5131 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005132 }
5133
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005134# Check for user-visible strings broken across lines, which breaks the ability
5135# to grep for the string. Make exceptions when the previous string ends in a
5136# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5137# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Joe Perches33acb542015-06-25 15:02:54 -07005138 if ($line =~ /^\+\s*$String/ &&
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005139 $prevline =~ /"\s*$/ &&
5140 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
5141 if (WARN("SPLIT_STRING",
5142 "quoted string split across lines\n" . $hereprev) &&
5143 $fix &&
5144 $prevrawline =~ /^\+.*"\s*$/ &&
5145 $last_coalesced_string_linenr != $linenr - 1) {
5146 my $extracted_string = get_quoted_string($line, $rawline);
5147 my $comma_close = "";
5148 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) {
5149 $comma_close = $1;
5150 }
5151
5152 fix_delete_line($fixlinenr - 1, $prevrawline);
5153 fix_delete_line($fixlinenr, $rawline);
5154 my $fixedline = $prevrawline;
5155 $fixedline =~ s/"\s*$//;
5156 $fixedline .= substr($extracted_string, 1) . trim($comma_close);
5157 fix_insert_line($fixlinenr - 1, $fixedline);
5158 $fixedline = $rawline;
5159 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//;
5160 if ($fixedline !~ /\+\s*$/) {
5161 fix_insert_line($fixlinenr, $fixedline);
5162 }
5163 $last_coalesced_string_linenr = $linenr;
5164 }
5165 }
5166
5167# check for missing a space in a string concatenation
5168 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) {
5169 WARN('MISSING_SPACE',
5170 "break quoted strings at a space character\n" . $hereprev);
5171 }
5172
5173# check for spaces before a quoted newline
5174 if ($rawline =~ /^.*\".*\s\\n/) {
5175 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
5176 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
5177 $fix) {
5178 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
5179 }
5180
5181 }
5182
Joe Perchesf17dba42014-10-13 15:51:51 -07005183# concatenated string without spaces between elements
Joe Perches33acb542015-06-25 15:02:54 -07005184 if ($line =~ /$String[A-Z_]/ || $line =~ /[A-Za-z0-9_]$String/) {
Joe Perchesf17dba42014-10-13 15:51:51 -07005185 CHK("CONCATENATED_STRING",
5186 "Concatenated strings should use spaces between elements\n" . $herecurr);
5187 }
5188
Joe Perches90ad30e2014-12-10 15:51:59 -08005189# uncoalesced string fragments
Joe Perches33acb542015-06-25 15:02:54 -07005190 if ($line =~ /$String\s*"/) {
Joe Perches90ad30e2014-12-10 15:51:59 -08005191 WARN("STRING_FRAGMENTS",
5192 "Consecutive strings are generally better as a single string\n" . $herecurr);
5193 }
5194
Joe Perches6e300752015-09-09 15:37:47 -07005195# check for %L{u,d,i} and 0x%[udi] in strings
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005196 my $string;
5197 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
5198 $string = substr($rawline, $-[1], $+[1] - $-[1]);
5199 $string =~ s/%%/__/g;
Joe Perches6e300752015-09-09 15:37:47 -07005200 if ($string =~ /(?<!%)%[\*\d\.\$]*L[udi]/) {
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005201 WARN("PRINTF_L",
5202 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
5203 last;
5204 }
Joe Perches6e300752015-09-09 15:37:47 -07005205 if ($string =~ /0x%[\*\d\.\$\Llzth]*[udi]/) {
5206 ERROR("PRINTF_0xDECIMAL",
5207 "Prefixing 0x with decimal output is defective\n" . $herecurr);
5208 }
Joe Perches5e4f6ba2014-12-10 15:52:05 -08005209 }
5210
5211# check for line continuations in quoted strings with odd counts of "
5212 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
5213 WARN("LINE_CONTINUATIONS",
5214 "Avoid line continuations in quoted strings\n" . $herecurr);
5215 }
5216
Gregory Bean6c9c6842011-03-17 14:18:20 -07005217# sys_open/read/write/close are not allowed in the kernel
5218 if ($line =~ /\b(sys_(?:open|read|write|close))\b/) {
5219 ERROR("FILE_OPS",
5220 "$1 is inappropriate in kernel code.\n" .
5221 $herecurr);
5222 }
5223
Gregory Beana7cce0a2011-06-07 08:06:45 -07005224# filp_open is a backdoor for sys_open
5225 if ($line =~ /\b(filp_open)\b/) {
5226 ERROR("FILE_OPS",
5227 "$1 is inappropriate in kernel code.\n" .
5228 $herecurr);
5229 }
5230
Gregory Bean3f6f2dd2011-05-02 13:50:35 -07005231# read[bwl] & write[bwl] use too many barriers, use the _relaxed variants
5232 if ($line =~ /\b((?:read|write)[bwl])\b/) {
5233 ERROR("NON_RELAXED_IO",
5234 "Use of $1 is deprecated: use $1_relaxed\n\t" .
5235 "with appropriate memory barriers instead.\n" .
5236 $herecurr);
5237 }
5238
5239# likewise, in/out[bwl] should be __raw_read/write[bwl]...
5240 if ($line =~ /\b((in|out)([bwl]))\b/) {
5241 my ($all, $pref, $suf) = ($1, $2, $3);
5242 $pref =~ s/in/read/;
5243 $pref =~ s/out/write/;
5244 ERROR("NON_RELAXED_IO",
5245 "Use of $all is deprecated: use " .
5246 "__raw_$pref$suf\n\t" .
5247 "with appropriate memory barriers instead.\n" .
5248 $herecurr);
5249 }
5250
Gregory Bean438bf5f2011-06-15 09:32:38 -07005251# dsb is too ARMish, and should usually be mb.
Sarangdhar Joshibbeebd52015-10-15 14:21:47 -07005252 if ($line =~ /[^-_>*\.]\bdsb\b[^-_\.;]/) {
Gregory Bean438bf5f2011-06-15 09:32:38 -07005253 WARN("ARM_BARRIER",
5254 "Use of dsb is discouranged: prefer mb.\n" .
5255 $herecurr);
5256 }
5257
Gregory Beandf3a3ee2011-05-10 12:34:09 -07005258# unbounded string functions are overflow risks
5259 my %str_fns = (
5260 "sprintf" => "snprintf",
5261 "strcpy" => "strlcpy",
5262 "strncpy" => "strlcpy",
5263 "strcat" => "strlcat",
5264 "strncat" => "strlcat",
5265 "vsprintf" => "vsnprintf",
5266 "strchr" => "strnchr",
5267 "strstr" => "strnstr",
5268 );
5269 foreach my $k (keys %str_fns) {
5270 if ($line =~ /\b$k\b/) {
5271 ERROR("UNBOUNDED_STRING_FNS",
5272 "Use of $k is deprecated: " .
5273 "use $str_fns{$k} instead.\n" .
5274 $herecurr);
5275 }
5276 }
5277
Andy Whitcroft00df3442007-06-08 13:47:06 -07005278# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005279 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Abhijeet Dharmapurikar800a3132009-10-01 12:01:44 -07005280 WARN("IF_0",
5281 "if this code is redundant consider removing it\n"
5282 . $herecurr);
5283 }
5284
5285# warn about #if 1
5286 if ($line =~ /^.\s*\#\s*if\s+1\b/) {
5287 WARN("IF_1",
5288 "if this code is required consider removing"
5289 . " #if 1\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005290 }
5291
Andy Whitcroft03df4b52012-12-17 16:01:52 -08005292# check for needless "if (<foo>) fn(<foo>)" uses
5293 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
Joe Perches100425d2015-09-09 15:37:36 -07005294 my $tested = quotemeta($1);
5295 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;';
5296 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5297 my $func = $1;
5298 if (WARN('NEEDLESS_IF',
5299 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) &&
5300 $fix) {
5301 my $do_fix = 1;
5302 my $leading_tabs = "";
5303 my $new_leading_tabs = "";
5304 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) {
5305 $leading_tabs = $1;
5306 } else {
5307 $do_fix = 0;
5308 }
5309 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) {
5310 $new_leading_tabs = $1;
5311 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) {
5312 $do_fix = 0;
5313 }
5314 } else {
5315 $do_fix = 0;
5316 }
5317 if ($do_fix) {
5318 fix_delete_line($fixlinenr - 1, $prevrawline);
5319 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/;
5320 }
5321 }
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07005322 }
5323 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07005324
Joe Perchesebfdc402014-08-06 16:10:27 -07005325# check for unnecessary "Out of Memory" messages
5326 if ($line =~ /^\+.*\b$logFunctions\s*\(/ &&
5327 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ &&
5328 (defined $1 || defined $3) &&
5329 $linenr > 3) {
5330 my $testval = $2;
5331 my $testline = $lines[$linenr - 3];
5332
5333 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0);
5334# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5335
5336 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5337 WARN("OOM_MESSAGE",
5338 "Possible unnecessary 'out of memory' message\n" . $hereprev);
5339 }
5340 }
5341
Joe Perchesf78d98f2014-10-13 15:52:01 -07005342# check for logging functions with KERN_<LEVEL>
Paolo Bonzinidcaf1122015-02-13 14:38:26 -08005343 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ &&
Joe Perchesf78d98f2014-10-13 15:52:01 -07005344 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) {
5345 my $level = $1;
5346 if (WARN("UNNECESSARY_KERN_LEVEL",
5347 "Possible unnecessary $level\n" . $herecurr) &&
5348 $fix) {
5349 $fixed[$fixlinenr] =~ s/\s*$level\s*//;
5350 }
5351 }
5352
Joe Perchesabb08a52014-12-10 15:51:46 -08005353# check for mask then right shift without a parentheses
5354 if ($^V && $^V ge 5.10.0 &&
5355 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ &&
5356 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so
5357 WARN("MASK_THEN_SHIFT",
5358 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr);
5359 }
5360
Joe Perchesb75ac612014-12-10 15:52:02 -08005361# check for pointer comparisons to NULL
5362 if ($^V && $^V ge 5.10.0) {
5363 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) {
5364 my $val = $1;
5365 my $equal = "!";
5366 $equal = "" if ($4 eq "!=");
5367 if (CHK("COMPARISON_TO_NULL",
5368 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) &&
5369 $fix) {
5370 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/;
5371 }
5372 }
5373 }
5374
Joe Perches8716de32013-09-11 14:24:05 -07005375# check for bad placement of section $InitAttribute (e.g.: __initdata)
5376 if ($line =~ /(\b$InitAttribute\b)/) {
5377 my $attr = $1;
5378 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5379 my $ptr = $1;
5380 my $var = $2;
5381 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
5382 ERROR("MISPLACED_INIT",
5383 "$attr should be placed after $var\n" . $herecurr)) ||
5384 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
5385 WARN("MISPLACED_INIT",
5386 "$attr should be placed after $var\n" . $herecurr))) &&
5387 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005388 $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 -07005389 }
5390 }
5391 }
5392
Joe Perchese970b882013-11-12 15:10:10 -08005393# check for $InitAttributeData (ie: __initdata) with const
5394 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
5395 my $attr = $1;
5396 $attr =~ /($InitAttributePrefix)(.*)/;
5397 my $attr_prefix = $1;
5398 my $attr_type = $2;
5399 if (ERROR("INIT_ATTRIBUTE",
5400 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
5401 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005402 $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005403 s/$InitAttributeData/${attr_prefix}initconst/;
5404 }
5405 }
5406
5407# check for $InitAttributeConst (ie: __initconst) without const
5408 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
5409 my $attr = $1;
5410 if (ERROR("INIT_ATTRIBUTE",
5411 "Use of $attr requires a separate use of const\n" . $herecurr) &&
5412 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005413 my $lead = $fixed[$fixlinenr] =~
Joe Perchese970b882013-11-12 15:10:10 -08005414 /(^\+\s*(?:static\s+))/;
5415 $lead = rtrim($1);
5416 $lead = "$lead " if ($lead !~ /^\+$/);
5417 $lead = "${lead}const ";
Joe Perches194f66f2014-08-06 16:11:03 -07005418 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/;
Joe Perchese970b882013-11-12 15:10:10 -08005419 }
5420 }
5421
Joe Perchesc17893c2015-04-16 12:44:42 -07005422# check for __read_mostly with const non-pointer (should just be const)
5423 if ($line =~ /\b__read_mostly\b/ &&
5424 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) {
5425 if (ERROR("CONST_READ_MOSTLY",
5426 "Invalid use of __read_mostly with const type\n" . $herecurr) &&
5427 $fix) {
5428 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//;
5429 }
5430 }
5431
Joe Perchesfbdb8132014-04-03 14:49:14 -07005432# don't use __constant_<foo> functions outside of include/uapi/
5433 if ($realfile !~ m@^include/uapi/@ &&
5434 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5435 my $constant_func = $1;
5436 my $func = $constant_func;
5437 $func =~ s/^__constant_//;
5438 if (WARN("CONSTANT_CONVERSION",
5439 "$constant_func should be $func\n" . $herecurr) &&
5440 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005441 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g;
Joe Perchesfbdb8132014-04-03 14:49:14 -07005442 }
5443 }
5444
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005445# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08005446 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07005447 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005448 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07005449 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005450 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07005451 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5452 }
5453 if ($delay > 2000) {
5454 WARN("LONG_UDELAY",
5455 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07005456 }
5457 }
5458
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005459# warn about unexpectedly long msleep's
5460 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
5461 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005462 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07005463 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07005464 }
5465 }
5466
Joe Perches36ec1932013-07-03 15:05:25 -07005467# check for comparisons of jiffies
5468 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
5469 WARN("JIFFIES_COMPARISON",
5470 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5471 }
5472
Joe Perches9d7a34a2013-07-03 15:05:26 -07005473# check for comparisons of get_jiffies_64()
5474 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
5475 WARN("JIFFIES_COMPARISON",
5476 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5477 }
5478
Israel Schlesinger5f8c9a22010-07-21 13:34:18 -07005479# check the patch for use of mdelay
5480 if ($line =~ /\bmdelay\s*\(/) {
5481 WARN("MDELAY",
5482 "use of mdelay() found: msleep() is the preferred API.\n" . $herecurr );
5483 }
5484
Andy Whitcroft00df3442007-06-08 13:47:06 -07005485# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005486# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07005487# print "#ifdef in C files should be avoided\n";
5488# print "$herecurr";
5489# $clean = 0;
5490# }
5491
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005492# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005493 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07005494 if (ERROR("SPACING",
5495 "exactly one space required after that #$1\n" . $herecurr) &&
5496 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005497 $fixed[$fixlinenr] =~
Joe Perches3705ce52013-07-03 15:05:31 -07005498 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
5499 }
5500
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07005501 }
5502
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005503# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005504 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
5505 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005506 my $which = $1;
5507 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005508 CHK("UNCOMMENTED_DEFINITION",
5509 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005510 }
5511 }
5512# check for memory barriers without a comment.
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005513
5514 my $barriers = qr{
5515 mb|
5516 rmb|
5517 wmb|
5518 read_barrier_depends
5519 }x;
5520 my $barrier_stems = qr{
5521 mb__before_atomic|
5522 mb__after_atomic|
5523 store_release|
5524 load_acquire|
5525 store_mb|
5526 (?:$barriers)
5527 }x;
5528 my $all_barriers = qr{
5529 (?:$barriers)|
Michael S. Tsirkin43e361f2016-01-04 10:00:10 +02005530 smp_(?:$barrier_stems)|
5531 virt_(?:$barrier_stems)
Michael S. Tsirkin402c2552016-01-04 09:39:01 +02005532 }x;
5533
5534 if ($line =~ /\b(?:$all_barriers)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005535 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08005536 WARN("MEMORY_BARRIER",
5537 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005538 }
5539 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005540
Michael S. Tsirkinf4073b02016-01-04 09:54:51 +02005541 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x;
5542
5543 if ($realfile !~ m@^include/asm-generic/@ &&
5544 $realfile !~ m@/barrier\.h$@ &&
5545 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ &&
5546 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) {
5547 WARN("MEMORY_BARRIER",
5548 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr);
5549 }
5550
Joe Perchescb426e92015-06-25 15:02:46 -07005551# check for waitqueue_active without a comment.
5552 if ($line =~ /\bwaitqueue_active\s*\(/) {
5553 if (!ctx_has_comment($first_line, $linenr)) {
5554 WARN("WAITQUEUE_ACTIVE",
5555 "waitqueue_active without comment\n" . $herecurr);
5556 }
5557 }
Paul E. McKenney3ad81772015-07-02 11:55:40 -07005558
5559# Check for expedited grace periods that interrupt non-idle non-nohz
5560# online CPUs. These expedited can therefore degrade real-time response
5561# if used carelessly, and should be avoided where not absolutely
5562# needed. It is always OK to use synchronize_rcu_expedited() and
5563# synchronize_sched_expedited() at boot time (before real-time applications
5564# start) and in error situations where real-time response is compromised in
5565# any case. Note that synchronize_srcu_expedited() does -not- interrupt
5566# other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5567# Of course, nothing comes for free, and srcu_read_lock() and
5568# srcu_read_unlock() do contain full memory barriers in payment for
5569# synchronize_srcu_expedited() non-interruption properties.
5570 if ($line =~ /\b(synchronize_rcu_expedited|synchronize_sched_expedited)\(/) {
5571 WARN("EXPEDITED_RCU_GRACE_PERIOD",
5572 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5573
5574 }
5575
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07005576# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005577 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005578 CHK("ARCH_DEFINES",
5579 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07005580 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005581
Tobias Klauserd4977c72010-05-24 14:33:30 -07005582# Check that the storage class is at the beginning of a declaration
5583 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005584 WARN("STORAGE_CLASS",
5585 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07005586 }
5587
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005588# check the location of the inline attribute, that it is between
5589# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005590 if ($line =~ /\b$Type\s+$Inline\b/ ||
5591 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005592 ERROR("INLINE_LOCATION",
5593 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005594 }
5595
Andy Whitcroft8905a672007-11-28 16:21:06 -08005596# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08005597 if ($realfile !~ m@\binclude/uapi/@ &&
5598 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005599 if (WARN("INLINE",
5600 "plain inline is preferred over $1\n" . $herecurr) &&
5601 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005602 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005603
5604 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08005605 }
5606
Joe Perches3d130fd2011-01-12 17:00:00 -08005607# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08005608 if ($realfile !~ m@\binclude/uapi/@ &&
5609 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005610 WARN("PREFER_PACKED",
5611 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08005612 }
5613
Joe Perches39b7e282011-07-25 17:13:24 -07005614# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08005615 if ($realfile !~ m@\binclude/uapi/@ &&
5616 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005617 WARN("PREFER_ALIGNED",
5618 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07005619 }
5620
Joe Perches5f14d3b2012-01-10 15:09:52 -08005621# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08005622 if ($realfile !~ m@\binclude/uapi/@ &&
5623 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005624 if (WARN("PREFER_PRINTF",
5625 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5626 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005627 $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 -07005628
5629 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08005630 }
5631
Joe Perches6061d942012-03-23 15:02:16 -07005632# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08005633 if ($realfile !~ m@\binclude/uapi/@ &&
5634 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005635 if (WARN("PREFER_SCANF",
5636 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5637 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005638 $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 -07005639 }
Joe Perches6061d942012-03-23 15:02:16 -07005640 }
5641
Joe Perches619a9082014-12-10 15:51:35 -08005642# Check for __attribute__ weak, or __weak declarations (may have link issues)
5643 if ($^V && $^V ge 5.10.0 &&
5644 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5645 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ ||
5646 $line =~ /\b__weak\b/)) {
5647 ERROR("WEAK_DECLARATION",
5648 "Using weak declarations can have unintended link defects\n" . $herecurr);
5649 }
5650
Joe Perchese6176fa2015-06-25 15:02:49 -07005651# check for c99 types like uint8_t used outside of uapi/
5652 if ($realfile !~ m@\binclude/uapi/@ &&
5653 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) {
5654 my $type = $1;
5655 if ($type =~ /\b($typeC99Typedefs)\b/) {
5656 $type = $1;
5657 my $kernel_type = 'u';
5658 $kernel_type = 's' if ($type =~ /^_*[si]/);
5659 $type =~ /(\d+)/;
5660 $kernel_type .= $1;
5661 if (CHK("PREFER_KERNEL_TYPES",
5662 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) &&
5663 $fix) {
5664 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/;
5665 }
5666 }
5667 }
5668
Joe Perches938224b2016-01-20 14:59:15 -08005669# check for cast of C90 native int or longer types constants
5670 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) {
5671 my $cast = $1;
5672 my $const = $2;
5673 if (WARN("TYPECAST_INT_CONSTANT",
5674 "Unnecessary typecast of c90 int constant\n" . $herecurr) &&
5675 $fix) {
5676 my $suffix = "";
5677 my $newconst = $const;
5678 $newconst =~ s/${Int_type}$//;
5679 $suffix .= 'U' if ($cast =~ /\bunsigned\b/);
5680 if ($cast =~ /\blong\s+long\b/) {
5681 $suffix .= 'LL';
5682 } elsif ($cast =~ /\blong\b/) {
5683 $suffix .= 'L';
5684 }
5685 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/;
5686 }
5687 }
5688
Joe Perches8f53a9b2010-03-05 13:43:48 -08005689# check for sizeof(&)
5690 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005691 WARN("SIZEOF_ADDRESS",
5692 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08005693 }
5694
Joe Perches66c80b62012-07-30 14:41:22 -07005695# check for sizeof without parenthesis
5696 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005697 if (WARN("SIZEOF_PARENTHESIS",
5698 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
5699 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005700 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005701 }
Joe Perches66c80b62012-07-30 14:41:22 -07005702 }
5703
Joe Perches88982fe2012-12-17 16:02:00 -08005704# check for struct spinlock declarations
5705 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
5706 WARN("USE_SPINLOCK_T",
5707 "struct spinlock should be spinlock_t\n" . $herecurr);
5708 }
5709
Joe Perchesa6962d72013-04-29 16:18:13 -07005710# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08005711 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07005712 my $fmt = get_quoted_string($line, $rawline);
Heba Aamercaac1d52015-02-13 14:38:49 -08005713 $fmt =~ s/%%//g;
5714 if ($fmt !~ /%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005715 if (WARN("PREFER_SEQ_PUTS",
5716 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
5717 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005718 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005719 }
Joe Perchesa6962d72013-04-29 16:18:13 -07005720 }
5721 }
5722
Andy Whitcroft554e1652012-01-10 15:09:57 -08005723# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005724 if ($^V && $^V ge 5.10.0 &&
5725 defined $stat &&
Mateusz Kulikowski9e20a852015-06-25 15:03:16 -07005726 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08005727
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005728 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005729 my $ms_val = $7;
5730 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005731
Andy Whitcroft554e1652012-01-10 15:09:57 -08005732 if ($ms_size =~ /^(0x|)0$/i) {
5733 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005734 "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 -08005735 } elsif ($ms_size =~ /^(0x|)1$/i) {
5736 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005737 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
5738 }
5739 }
5740
Joe Perches98a9bba2014-01-23 15:54:52 -08005741# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5742 if ($^V && $^V ge 5.10.0 &&
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005743 defined $stat &&
5744 $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
Joe Perches98a9bba2014-01-23 15:54:52 -08005745 if (WARN("PREFER_ETHER_ADDR_COPY",
Mateusz Kulikowski10895d22015-06-25 15:03:21 -07005746 "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 -08005747 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005748 $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 -08005749 }
5750 }
5751
Mateusz Kulikowskib6117d12015-06-25 15:03:13 -07005752# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5753 if ($^V && $^V ge 5.10.0 &&
5754 defined $stat &&
5755 $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5756 WARN("PREFER_ETHER_ADDR_EQUAL",
5757 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5758 }
5759
Mateusz Kulikowski8617cd02015-06-25 15:03:19 -07005760# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5761# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5762 if ($^V && $^V ge 5.10.0 &&
5763 defined $stat &&
5764 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5765
5766 my $ms_val = $7;
5767
5768 if ($ms_val =~ /^(?:0x|)0+$/i) {
5769 if (WARN("PREFER_ETH_ZERO_ADDR",
5770 "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5771 $fix) {
5772 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5773 }
5774 } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5775 if (WARN("PREFER_ETH_BROADCAST_ADDR",
5776 "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5777 $fix) {
5778 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5779 }
5780 }
5781 }
5782
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005783# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005784 if ($^V && $^V ge 5.10.0 &&
5785 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005786 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005787 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005788 my $call = $1;
5789 my $cast1 = deparenthesize($2);
5790 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005791 my $cast2 = deparenthesize($7);
5792 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005793 my $cast;
5794
Joe Perchesd1fe9c02012-03-23 15:02:16 -07005795 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08005796 $cast = "$cast1 or $cast2";
5797 } elsif ($cast1 ne "") {
5798 $cast = $cast1;
5799 } else {
5800 $cast = $cast2;
5801 }
5802 WARN("MINMAX",
5803 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08005804 }
5805 }
5806
Joe Perches4a273192012-07-30 14:41:20 -07005807# check usleep_range arguments
5808 if ($^V && $^V ge 5.10.0 &&
5809 defined $stat &&
5810 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
5811 my $min = $1;
5812 my $max = $7;
5813 if ($min eq $max) {
5814 WARN("USLEEP_RANGE",
5815 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5816 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
5817 $min > $max) {
5818 WARN("USLEEP_RANGE",
5819 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5820 }
5821 }
5822
Joe Perches823b7942013-11-12 15:10:15 -08005823# check for naked sscanf
5824 if ($^V && $^V ge 5.10.0 &&
5825 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07005826 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08005827 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
5828 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
5829 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
5830 my $lc = $stat =~ tr@\n@@;
5831 $lc = $lc + $linenr;
5832 my $stat_real = raw_line($linenr, 0);
5833 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5834 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5835 }
5836 WARN("NAKED_SSCANF",
5837 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
5838 }
5839
Joe Perchesafc819a2014-06-04 16:12:08 -07005840# check for simple sscanf that should be kstrto<foo>
5841 if ($^V && $^V ge 5.10.0 &&
5842 defined $stat &&
5843 $line =~ /\bsscanf\b/) {
5844 my $lc = $stat =~ tr@\n@@;
5845 $lc = $lc + $linenr;
5846 my $stat_real = raw_line($linenr, 0);
5847 for (my $count = $linenr + 1; $count <= $lc; $count++) {
5848 $stat_real = $stat_real . "\n" . raw_line($count, 0);
5849 }
5850 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) {
5851 my $format = $6;
5852 my $count = $format =~ tr@%@%@;
5853 if ($count == 1 &&
5854 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) {
5855 WARN("SSCANF_TO_KSTRTO",
5856 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n");
5857 }
5858 }
5859 }
5860
Joe Perches70dc8a42013-09-11 14:23:58 -07005861# check for new externs in .h files.
5862 if ($realfile =~ /\.h$/ &&
5863 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07005864 if (CHK("AVOID_EXTERNS",
5865 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07005866 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005867 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
Joe Perches70dc8a42013-09-11 14:23:58 -07005868 }
5869 }
5870
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005871# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005872 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005873 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005874 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005875 my $function_name = $1;
5876 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005877
5878 my $s = $stat;
5879 if (defined $cond) {
5880 substr($s, 0, length($cond), '');
5881 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07005882 if ($s =~ /^\s*;/ &&
5883 $function_name ne 'uninitialized_var')
5884 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005885 WARN("AVOID_EXTERNS",
5886 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005887 }
5888
5889 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005890 WARN("FUNCTION_ARGUMENTS",
5891 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07005892 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07005893
5894 } elsif ($realfile =~ /\.c$/ && defined $stat &&
5895 $stat =~ /^.\s*extern\s+/)
5896 {
Joe Perches000d1cc12011-07-25 17:13:25 -07005897 WARN("AVOID_EXTERNS",
5898 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005899 }
5900
5901# checks for new __setup's
5902 if ($rawline =~ /\b__setup\("([^"]*)"/) {
5903 my $name = $1;
5904
5905 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005906 CHK("UNDOCUMENTED_SETUP",
5907 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07005908 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07005909 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005910
5911# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08005912 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07005913 WARN("UNNECESSARY_CASTS",
5914 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07005915 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08005916
Joe Perchesa640d252013-07-03 15:05:21 -07005917# alloc style
5918# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5919 if ($^V && $^V ge 5.10.0 &&
5920 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5921 CHK("ALLOC_SIZEOF_STRUCT",
5922 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
5923 }
5924
Joe Perches60a55362014-06-04 16:12:07 -07005925# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5926 if ($^V && $^V ge 5.10.0 &&
Joe Perchese3674552014-08-06 16:10:55 -07005927 $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 -07005928 my $oldfunc = $3;
5929 my $a1 = $4;
5930 my $a2 = $10;
5931 my $newfunc = "kmalloc_array";
5932 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc");
Joe Perchese3674552014-08-06 16:10:55 -07005933 my $r1 = $a1;
5934 my $r2 = $a2;
5935 if ($a1 =~ /^sizeof\s*\S/) {
5936 $r1 = $a2;
5937 $r2 = $a1;
5938 }
5939 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ &&
5940 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) {
Joe Perches60a55362014-06-04 16:12:07 -07005941 if (WARN("ALLOC_WITH_MULTIPLY",
5942 "Prefer $newfunc over $oldfunc with multiply\n" . $herecurr) &&
5943 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005944 $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 -07005945
5946 }
5947 }
5948 }
5949
Joe Perches972fdea2013-04-29 16:18:12 -07005950# check for krealloc arg reuse
5951 if ($^V && $^V ge 5.10.0 &&
5952 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
5953 WARN("KREALLOC_ARG_REUSE",
5954 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
5955 }
5956
Joe Perches5ce59ae2013-02-21 16:44:18 -08005957# check for alloc argument mismatch
5958 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
5959 WARN("ALLOC_ARRAY_ARGS",
5960 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
5961 }
5962
Joe Perchescaf2a542011-01-12 16:59:56 -08005963# check for multiple semicolons
5964 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07005965 if (WARN("ONE_SEMICOLON",
5966 "Statements terminations use 1 semicolon\n" . $herecurr) &&
5967 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07005968 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07005969 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08005970 }
5971
Tomas Winklercec3aaa2016-08-02 14:04:39 -07005972# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5973 if ($realfile !~ m@^include/uapi/@ &&
5974 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) {
Joe Perches0ab90192014-12-10 15:51:57 -08005975 my $ull = "";
5976 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i);
5977 if (CHK("BIT_MACRO",
5978 "Prefer using the BIT$ull macro\n" . $herecurr) &&
5979 $fix) {
5980 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/;
5981 }
5982 }
5983
Joe Perches2d632742016-05-20 17:04:00 -07005984# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5985 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5986 my $config = $1;
5987 if (WARN("PREFER_IS_ENABLED",
5988 "Prefer IS_ENABLED(<FOO>) to CONFIG_<FOO> || CONFIG_<FOO>_MODULE\n" . $herecurr) &&
5989 $fix) {
5990 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)";
5991 }
5992 }
5993
Joe Perchese81f2392014-08-06 16:11:25 -07005994# check for case / default statements not preceded by break/fallthrough/switch
Joe Perchesc34c09a2014-01-23 15:54:43 -08005995 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
5996 my $has_break = 0;
5997 my $has_statement = 0;
5998 my $count = 0;
5999 my $prevline = $linenr;
Joe Perchese81f2392014-08-06 16:11:25 -07006000 while ($prevline > 1 && ($file || $count < 3) && !$has_break) {
Joe Perchesc34c09a2014-01-23 15:54:43 -08006001 $prevline--;
6002 my $rline = $rawlines[$prevline - 1];
6003 my $fline = $lines[$prevline - 1];
6004 last if ($fline =~ /^\@\@/);
6005 next if ($fline =~ /^\-/);
6006 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
6007 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
6008 next if ($fline =~ /^.[\s$;]*$/);
6009 $has_statement = 1;
6010 $count++;
6011 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
6012 }
6013 if (!$has_break && $has_statement) {
6014 WARN("MISSING_BREAK",
6015 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
6016 }
6017 }
6018
Joe Perchesd1e2ad02012-12-17 16:02:01 -08006019# check for switch/default statements without a break;
6020 if ($^V && $^V ge 5.10.0 &&
6021 defined $stat &&
6022 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
6023 my $ctx = '';
6024 my $herectx = $here . "\n";
6025 my $cnt = statement_rawlines($stat);
6026 for (my $n = 0; $n < $cnt; $n++) {
6027 $herectx .= raw_line($linenr, $n) . "\n";
6028 }
6029 WARN("DEFAULT_NO_BREAK",
6030 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08006031 }
6032
Patrick Pannutof370e252010-07-23 13:34:18 -07006033# check for return codes on error paths
6034 if ($line =~ /\breturn\s+-\d+/) {
6035 ERROR("NO_ERROR_CODE",
Patrick Pannutoe50031c2010-08-04 14:30:59 -07006036 "illegal return value, please use an error code\n" . $herecurr);
Patrick Pannutof370e252010-07-23 13:34:18 -07006037 }
6038
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006039# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07006040 if ($line =~ /\b__FUNCTION__\b/) {
6041 if (WARN("USE_FUNC",
6042 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
6043 $fix) {
Joe Perches194f66f2014-08-06 16:11:03 -07006044 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g;
Joe Perchesd5e616f2013-09-11 14:23:54 -07006045 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006046 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006047
Joe Perches62ec8182015-02-13 14:38:18 -08006048# check for uses of __DATE__, __TIME__, __TIMESTAMP__
6049 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) {
6050 ERROR("DATE_TIME",
6051 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr);
6052 }
6053
Joe Perches2c924882012-03-23 15:02:20 -07006054# check for use of yield()
6055 if ($line =~ /\byield\s*\(\s*\)/) {
6056 WARN("YIELD",
6057 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
6058 }
6059
Joe Perches179f8f42013-07-03 15:05:30 -07006060# check for comparisons against true and false
6061 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
6062 my $lead = $1;
6063 my $arg = $2;
6064 my $test = $3;
6065 my $otype = $4;
6066 my $trail = $5;
6067 my $op = "!";
6068
6069 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
6070
6071 my $type = lc($otype);
6072 if ($type =~ /^(?:true|false)$/) {
6073 if (("$test" eq "==" && "$type" eq "true") ||
6074 ("$test" eq "!=" && "$type" eq "false")) {
6075 $op = "";
6076 }
6077
6078 CHK("BOOL_COMPARISON",
6079 "Using comparison to $otype is error prone\n" . $herecurr);
6080
6081## maybe suggesting a correct construct would better
6082## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6083
6084 }
6085 }
6086
Thomas Gleixner4882720b2010-09-07 14:34:01 +00006087# check for semaphores initialized locked
6088 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006089 WARN("CONSIDER_COMPLETION",
6090 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006091 }
Joe Perches6712d852012-03-23 15:02:20 -07006092
Joe Perches67d0a072011-10-31 17:13:10 -07006093# recommend kstrto* over simple_strto* and strict_strto*
6094 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006095 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07006096 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07006097 }
Joe Perches6712d852012-03-23 15:02:20 -07006098
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006099# check for __initcall(), use device_initcall() explicitly or more appropriate function please
Michael Ellermanf3db6632008-07-23 21:28:57 -07006100 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006101 WARN("USE_DEVICE_INITCALL",
Fabian Frederickae3ccc42014-06-04 16:12:10 -07006102 "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 -07006103 }
Joe Perches6712d852012-03-23 15:02:20 -07006104
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006105# check for various structs that are normally const (ops, kgdb, device_tree)
6106 my $const_structs = qr{
6107 acpi_dock_ops|
Emese Revfy79404842010-03-05 13:43:53 -08006108 address_space_operations|
6109 backlight_ops|
6110 block_device_operations|
6111 dentry_operations|
6112 dev_pm_ops|
6113 dma_map_ops|
6114 extent_io_ops|
6115 file_lock_operations|
6116 file_operations|
6117 hv_ops|
6118 ide_dma_ops|
6119 intel_dvo_dev_ops|
6120 item_operations|
6121 iwl_ops|
6122 kgdb_arch|
6123 kgdb_io|
6124 kset_uevent_ops|
6125 lock_manager_operations|
6126 microcode_ops|
6127 mtrr_ops|
6128 neigh_ops|
6129 nlmsvc_binding|
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006130 of_device_id|
Emese Revfy79404842010-03-05 13:43:53 -08006131 pci_raw_ops|
6132 pipe_buf_operations|
6133 platform_hibernation_ops|
6134 platform_suspend_ops|
6135 proto_ops|
6136 rpc_pipe_ops|
6137 seq_operations|
6138 snd_ac97_build_ops|
6139 soc_pcmcia_socket_ops|
6140 stacktrace_ops|
6141 sysfs_ops|
6142 tty_operations|
Joe Perches6d07d01b2015-04-16 12:44:33 -07006143 uart_ops|
Emese Revfy79404842010-03-05 13:43:53 -08006144 usb_mon_operations|
6145 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006146 if ($line !~ /\bconst\b/ &&
Joe Perches0f3c5aa2015-02-13 14:39:05 -08006147 $line =~ /\bstruct\s+($const_structs)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006148 WARN("CONST_STRUCT",
6149 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08006150 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08006151 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07006152
6153# use of NR_CPUS is usually wrong
6154# ignore definitions of NR_CPUS and usage to define arrays as likely right
6155 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07006156 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
6157 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07006158 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
6159 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
6160 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07006161 {
Joe Perches000d1cc12011-07-25 17:13:25 -07006162 WARN("NR_CPUS",
6163 "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 -07006164 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07006165
Joe Perches52ea8502013-11-12 15:10:09 -08006166# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6167 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
6168 ERROR("DEFINE_ARCH_HAS",
6169 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
6170 }
6171
Joe Perchesacd93622015-02-13 14:38:38 -08006172# likely/unlikely comparisons similar to "(likely(foo) > 0)"
6173 if ($^V && $^V ge 5.10.0 &&
6174 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) {
6175 WARN("LIKELY_MISUSE",
6176 "Using $1 should generally have parentheses around the comparison\n" . $herecurr);
6177 }
6178
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006179# whine mightly about in_atomic
6180 if ($line =~ /\bin_atomic\s*\(/) {
6181 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006182 ERROR("IN_ATOMIC",
6183 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08006184 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006185 WARN("IN_ATOMIC",
6186 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08006187 }
6188 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01006189
Joe Perches481aea52016-05-20 17:04:08 -07006190# whine about ACCESS_ONCE
6191 if ($^V && $^V ge 5.10.0 &&
6192 $line =~ /\bACCESS_ONCE\s*$balanced_parens\s*(=(?!=))?\s*($FuncArg)?/) {
6193 my $par = $1;
6194 my $eq = $2;
6195 my $fun = $3;
6196 $par =~ s/^\(\s*(.*)\s*\)$/$1/;
6197 if (defined($eq)) {
6198 if (WARN("PREFER_WRITE_ONCE",
6199 "Prefer WRITE_ONCE(<FOO>, <BAR>) over ACCESS_ONCE(<FOO>) = <BAR>\n" . $herecurr) &&
6200 $fix) {
6201 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6202 }
6203 } else {
6204 if (WARN("PREFER_READ_ONCE",
6205 "Prefer READ_ONCE(<FOO>) over ACCESS_ONCE(<FOO>)\n" . $herecurr) &&
6206 $fix) {
6207 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)/READ_ONCE($par)/;
6208 }
6209 }
6210 }
6211
Peter Zijlstra1704f472010-03-19 01:37:42 +01006212# check for lockdep_set_novalidate_class
6213 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
6214 $line =~ /__lockdep_no_validate__\s*\)/ ) {
6215 if ($realfile !~ m@^kernel/lockdep@ &&
6216 $realfile !~ m@^include/linux/lockdep@ &&
6217 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006218 ERROR("LOCKDEP",
6219 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01006220 }
6221 }
Dave Jones88f88312011-01-12 16:59:59 -08006222
Joe Perchesb392c642015-04-16 12:44:16 -07006223 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ ||
6224 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006225 WARN("EXPORTED_WORLD_WRITABLE",
6226 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08006227 }
Joe Perches24358802014-04-03 14:49:13 -07006228
Joe Perches515a2352014-04-03 14:49:24 -07006229# Mode permission misuses where it seems decimal should be octal
6230# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6231 if ($^V && $^V ge 5.10.0 &&
6232 $line =~ /$mode_perms_search/) {
6233 foreach my $entry (@mode_permission_funcs) {
6234 my $func = $entry->[0];
6235 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07006236
Joe Perches515a2352014-04-03 14:49:24 -07006237 my $skip_args = "";
6238 if ($arg_pos > 1) {
6239 $arg_pos--;
6240 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
6241 }
6242 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
6243 if ($line =~ /$test/) {
6244 my $val = $1;
6245 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07006246
Joe Perches515a2352014-04-03 14:49:24 -07006247 if ($val !~ /^0$/ &&
6248 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
6249 length($val) ne 4)) {
6250 ERROR("NON_OCTAL_PERMISSIONS",
6251 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perchesc0a5c892015-02-13 14:38:21 -08006252 } elsif ($val =~ /^$Octal$/ && (oct($val) & 02)) {
6253 ERROR("EXPORTED_WORLD_WRITABLE",
6254 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Joe Perches515a2352014-04-03 14:49:24 -07006255 }
Joe Perches24358802014-04-03 14:49:13 -07006256 }
6257 }
6258 }
Bjorn Andersson5a6d20c2015-06-25 15:03:24 -07006259
6260# validate content of MODULE_LICENSE against list from include/linux/module.h
6261 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) {
6262 my $extracted_string = get_quoted_string($line, $rawline);
6263 my $valid_licenses = qr{
6264 GPL|
6265 GPL\ v2|
6266 GPL\ and\ additional\ rights|
6267 Dual\ BSD/GPL|
6268 Dual\ MIT/GPL|
6269 Dual\ MPL/GPL|
6270 Proprietary
6271 }x;
6272 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) {
6273 WARN("MODULE_LICENSE",
6274 "unknown module license " . $extracted_string . "\n" . $herecurr);
6275 }
6276 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006277 }
6278
6279 # If we have no input at all, then there is nothing to report on
6280 # so just keep quiet.
6281 if ($#rawlines == -1) {
6282 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006283 }
6284
Andy Whitcroft8905a672007-11-28 16:21:06 -08006285 # In mailback mode only produce a report in the negative, for
6286 # things that appear to be patches.
6287 if ($mailback && ($clean == 1 || !$is_patch)) {
6288 exit(0);
6289 }
6290
6291 # This is not a patch, and we are are in 'no-patch' mode so
6292 # just keep quiet.
6293 if (!$chk_patch && !$is_patch) {
6294 exit(0);
6295 }
6296
Joe Perches06330fc2015-06-25 15:03:11 -07006297 if (!$is_patch && $file !~ /cover-letter\.patch$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006298 ERROR("NOT_UNIFIED_DIFF",
6299 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006300 }
Allen Hubbeed43c4e2016-08-02 14:04:45 -07006301 if ($is_patch && $has_commit_log && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07006302 ERROR("MISSING_SIGN_OFF",
6303 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006304 }
6305
Andy Whitcroft8905a672007-11-28 16:21:06 -08006306 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08006307 if ($summary && !($clean == 1 && $quiet == 1)) {
6308 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08006309 print "total: $cnt_error errors, $cnt_warn warnings, " .
6310 (($check)? "$cnt_chk checks, " : "") .
6311 "$cnt_lines lines checked\n";
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07006312 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08006313
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006314 if ($quiet == 0) {
Joe Perchesef212192016-05-20 17:04:11 -07006315 # If there were any defects found and not already fixing them
6316 if (!$clean and !$fix) {
6317 print << "EOM"
6318
6319NOTE: For some of the reported defects, checkpatch may be able to
6320 mechanically convert to the typical style using --fix or --fix-inplace.
6321EOM
6322 }
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006323 # If there were whitespace errors which cleanpatch can fix
6324 # then suggest that.
6325 if ($rpt_cleaners) {
Mike Frysingerb0781212011-03-22 16:34:43 -07006326 $rpt_cleaners = 0;
Joe Perchesd8469f12015-06-25 15:03:00 -07006327 print << "EOM"
6328
6329NOTE: Whitespace errors detected.
6330 You may wish to use scripts/cleanpatch or scripts/cleanfile
6331EOM
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07006332 }
6333 }
6334
Joe Perchesd752fcc2014-08-06 16:11:05 -07006335 if ($clean == 0 && $fix &&
6336 ("@rawlines" ne "@fixed" ||
6337 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) {
Joe Perches9624b8d2014-01-23 15:54:44 -08006338 my $newfile = $filename;
6339 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07006340 my $linecount = 0;
6341 my $f;
6342
Joe Perchesd752fcc2014-08-06 16:11:05 -07006343 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted);
6344
Joe Perches3705ce52013-07-03 15:05:31 -07006345 open($f, '>', $newfile)
6346 or die "$P: Can't open $newfile for write\n";
6347 foreach my $fixed_line (@fixed) {
6348 $linecount++;
6349 if ($file) {
6350 if ($linecount > 3) {
6351 $fixed_line =~ s/^\+//;
Joe Perchesd752fcc2014-08-06 16:11:05 -07006352 print $f $fixed_line . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07006353 }
6354 } else {
6355 print $f $fixed_line . "\n";
6356 }
6357 }
6358 close($f);
6359
6360 if (!$quiet) {
6361 print << "EOM";
Joe Perchesd8469f12015-06-25 15:03:00 -07006362
Joe Perches3705ce52013-07-03 15:05:31 -07006363Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
6364
6365Do _NOT_ trust the results written to this file.
6366Do _NOT_ submit these changes without inspecting them for correctness.
6367
6368This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6369No warranties, expressed or implied...
Joe Perches3705ce52013-07-03 15:05:31 -07006370EOM
6371 }
6372 }
6373
Joe Perchesd8469f12015-06-25 15:03:00 -07006374 if ($quiet == 0) {
6375 print "\n";
6376 if ($clean == 1) {
6377 print "$vname has no obvious style problems and is ready for submission.\n";
6378 } else {
6379 print "$vname has style problems, please review.\n";
6380 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006381 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006382 return $clean;
6383}